Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Doc - Enterprise Edition hint boxes (#5921)

This commit is contained in:
Simran 2018-07-20 10:53:22 +02:00 committed by sleto-it
parent d7f96d2a63
commit 2080c81e80
30 changed files with 102 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/Books/Cookbook/Compiling/Debian.md
View File

@ -58,7 +58,7 @@ sudo aptitude -y install git-core \
libjemalloc-dev \
cmake \
python2.7 \
sudo aptitude -y install libldap2-dev # Enterprise version only
sudo aptitude -y install libldap2-dev # Enterprise Edition only
```
###

4
Documentation/Books/Drivers/Java/Reference/Collection/CollectionManipulation.md
View File

@ -66,7 +66,7 @@ Creates a collection with the given _options_ for this collection's name, then r
- **distributeShardsLike**: `String`
(The default is ""): in an enterprise cluster, this attribute binds the specifics of sharding for the newly created collection to follow that of a specified existing collection. Note: Using this parameter has consequences for the prototype collection. It can no longer be dropped, before sharding imitating collections are dropped. Equally, backups and restores of imitating collections alone will generate warnings, which can be overridden, about missing sharding prototype.
(The default is ""): in an Enterprise Edition cluster, this attribute binds the specifics of sharding for the newly created collection to follow that of a specified existing collection. Note: Using this parameter has consequences for the prototype collection. It can no longer be dropped, before sharding imitating collections are dropped. Equally, backups and restores of imitating collections alone will generate warnings, which can be overridden, about missing sharding prototype.
**Examples**
@ -137,7 +137,7 @@ Alternative for [ArangoDatabase.createCollection](#arangodatabasecreatecollectio
- **distributeShardsLike**: `String`
(The default is ""): in an enterprise cluster, this attribute binds the specifics of sharding for the newly created collection to follow that of a specified existing collection. Note: Using this parameter has consequences for the prototype collection. It can no longer be dropped, before sharding imitating collections are dropped. Equally, backups and restores of imitating collections alone will generate warnings, which can be overridden, about missing sharding prototype.
(The default is ""): in an Enterprise Edition cluster, this attribute binds the specifics of sharding for the newly created collection to follow that of a specified existing collection. Note: Using this parameter has consequences for the prototype collection. It can no longer be dropped, before sharding imitating collections are dropped. Equally, backups and restores of imitating collections alone will generate warnings, which can be overridden, about missing sharding prototype.
**Examples**

2
Documentation/Books/Drivers/Java/Reference/Database/Queries.md
View File

@ -70,7 +70,7 @@ Performs a database query using the given _query_ and _bindVars_, then returns a
- **satelliteSyncWait**: `Double`
This enterprise parameter allows to configure how long a DBServer will have time to bring the satellite collections involved in the query into sync. The default value is 60.0 (seconds). When the max time has been reached the query will be stopped.
This Enterprise Edition parameter allows to configure how long a DBServer will have time to bring the satellite collections involved in the query into sync. The default value is 60.0 (seconds). When the max time has been reached the query will be stopped.
- **skipInaccessibleCollections**

4
Documentation/Books/Drivers/Java/Reference/Graph/README.md
View File

@ -30,7 +30,7 @@ Create a new graph in the graph module. The creation of a graph requires the nam
- **isSmart**: `Boolean`
Define if the created graph should be smart. This only has effect in Enterprise version.
Define if the created graph should be smart. This only has effect in Enterprise Edition.
- **replicationFactor**: `Integer`
@ -82,7 +82,7 @@ Alternative for [ArangoDatabase.createGraph](#arangodatabasecreategraph).
- **isSmart**: `Boolean`
Define if the created graph should be smart. This only has effect in Enterprise version.
Define if the created graph should be smart. This only has effect in Enterprise Edition.
- **replicationFactor**: `Integer`

5
Documentation/Books/Manual/Administration/Auditing/AuditConfiguration.md
View File

@ -1,7 +1,10 @@
Audit Configuration
===================
__This feature is available in the Enterprise Edition.__
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
Output
------

5
Documentation/Books/Manual/Administration/Auditing/AuditEvents.md
View File

@ -1,7 +1,10 @@
Audit Events
============
__This feature is available in the Enterprise Edition.__
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
Authentication
--------------

5
Documentation/Books/Manual/Administration/Auditing/README.md
View File

@ -1,7 +1,10 @@
Auditing
========
**This feature is only available in the Enterprise Edition.**
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
Auditing allows you to monitor access to the database in detail. In general
audit logs are of the form

5
Documentation/Books/Manual/Administration/Configuration/Ldap.md
View File

@ -1,7 +1,10 @@
LDAP
====
**This feature is only available in the Enterprise Edition.**
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
Basics Concepts
---------------

5
Documentation/Books/Manual/Administration/Configuration/SSL.md
View File

@ -112,7 +112,10 @@ Set to true if SSL session caching should be used.
### SSL peer certificate
__This feature is available in the Enterprise Edition.__
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
`--ssl.require-peer-certificate`

7
Documentation/Books/Manual/Administration/DC2DC/README.md
View File

@ -1,12 +1,17 @@
<!-- don't edit here, its from https://@github.com/arangodb/arangosync.git / docs/Manual/ -->
# Datacenter to datacenter replication administration
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
This Section includes information related to the administration of the _datacenter
to datacenter replication_.
For a general introduction to the _datacenter to datacenter replication_, please
refer to the [Datacenter to datacenter replication](../../Scalability/DC2DC/README.md)
chapther.
chapter.
## Starting synchronization

5
Documentation/Books/Manual/Administration/Encryption/README.md
View File

@ -1,6 +1,9 @@
# Encryption
**This feature is only available in the Enterprise Edition.**
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
When you store sensitive data in your ArangoDB database, you want
to protect that data under all circumstances.

5
Documentation/Books/Manual/Administration/ManagingUsers/README.md
View File

@ -288,7 +288,10 @@ database. All changes to the access levels must be done using the
### LDAP Users
__This feature is only available in the Enterprise Edition.__
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
ArangoDB supports LDAP as an external authentication system. For detailed information please have look into
the [LDAP configuration guide](../Configuration/Ldap.md).

5
Documentation/Books/Manual/Administration/Satellites.md
View File

@ -1,7 +1,10 @@
Satellite Collections
=====================
**This feature is only available in the Enterprise Edition.**
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
When doing Joins in an ArangoDB cluster data has to exchanged between different servers.

4
Documentation/Books/Manual/DataModeling/Collections/DatabaseMethods.md
View File

@ -158,7 +158,7 @@ to the [naming conventions](../NamingConventions/README.md).
servers holding copies take over, usually without an error being
reported.
When using the *Enterprise* version of ArangoDB the replicationFactor
When using the *Enterprise Edition* of ArangoDB the replicationFactor
may be set to "satellite" making the collection locally joinable
on every database server. This reduces the number of network hops
dramatically when using joins in AQL at the costs of reduced write
@ -168,7 +168,7 @@ to the [naming conventions](../NamingConventions/README.md).
cloning the shard distribution of another. If this value is set
it will copy *replicationFactor* and *numberOfShards* from the
other collection, the attributes in this collection will be
ignored and can be ommited.
ignored and can be omitted.
`db._create(collection-name, properties, type)`

5
Documentation/Books/Manual/Deployment/DC2DC/README.md
View File

@ -1,6 +1,11 @@
<!-- don't edit here, its from https://@github.com/arangodb/arangosync.git / docs/Manual/ -->
# Datacenter to datacenter replication deployment
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
This chapter describes how to deploy all the components needed for _datacenter to
datacenter replication_.

7
Documentation/Books/Manual/Deployment/Kubernetes/DeploymentResource.md
View File

@ -127,14 +127,17 @@ cluster is down, or in a bad state, irrespective of the value of this setting.
### `spec.rocksdb.encryption.keySecretName`
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
This setting specifies the name of a Kubernetes `Secret` that contains
an encryption key used for encrypting all data stored by ArangoDB servers.
When an encryption key is used, encryption of the data in the cluster is enabled,
without it encryption is disabled.
The default value is empty.
This requires the Enterprise version.
The encryption key cannot be changed after the cluster has been created.
The secret specified by this setting, must have a data field named 'key' containing

5
Documentation/Books/Manual/Graphs/SmartGraphs/README.md
View File

@ -1,7 +1,10 @@
SmartGraphs
===========
**This feature is only available in the Enterprise Edition.**
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
This chapter describes the [smart-graph](../README.md) module.
It enables you to manage graphs at scale, it will give a vast performance benefit for all graphs sharded in an ArangoDB Cluster.

5
Documentation/Books/Manual/Monitoring/DC2DC/README.md
View File

@ -1,6 +1,11 @@
<!-- don't edit here, its from https://@github.com/arangodb/arangosync.git / docs/Manual/ -->
# Monitoring datacenter to datacenter replication
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
This section includes information related to the monitoring of the _datacenter
to datacenter replication_.

2
Documentation/Books/Manual/ReleaseNotes/NewFeatures32.md
View File

@ -117,7 +117,7 @@ operations on sharded collections can be avoided and response times can be close
that of a single instance.
[Satellite collections](../Administration/Satellites.md)
are available in the *Enterprise* edition.
are available in the *Enterprise Edition*.
Memory management

8
Documentation/Books/Manual/ReleaseNotes/NewFeatures33.md
View File

@ -31,7 +31,7 @@ the data-centers has enough bandwidth. It is fault-tolerant
without a single point of failure and includes a lot of
metrics for monitoring in a production scenario.
[DC2DC](../Deployment/DC2DC/README.md) is available in the *Enterprise* edition.
[DC2DC](../Deployment/DC2DC/README.md) is available in the *Enterprise Edition*.
Encrypted backups
-----------------
@ -81,7 +81,7 @@ RocksDB encryption-at-rest feature, but they can also be used for the MMFiles
engine, which does not have encryption-at-rest.
[Encrypted backups](../Programs/Arangodump/Examples.md#encryption) are available
in the *Enterprise* edition.
in the *Enterprise Edition*.
Server-level replication
------------------------
@ -205,7 +205,7 @@ which speeds up collection creation by roughly 50 to 60 percent.
LDAP authentication
-------------------
The LDAP authentication module in the *Enterprise* edition has been enhanced.
The LDAP authentication module in the *Enterprise Edition* has been enhanced.
The following options have been added to it:
- the option `--server.local-authentication` controls whether the local *_users*
@ -217,7 +217,7 @@ The following options have been added to it:
- the option `--server.authentication-timeout` controls the expiration time for
cached LDAP user information entries in arangod.
- basic role support has been added for the LDAP module in the *Enterprise* edition.
- basic role support has been added for the LDAP module in the *Enterprise Edition*.
New configuration options for LDAP in 3.3 are:
- `--ldap.roles-attribute-name`

5
Documentation/Books/Manual/Scalability/DC2DC/README.md
View File

@ -1,6 +1,11 @@
<!-- don't edit here, its from https://@github.com/arangodb/arangosync.git / docs/Manual/ -->
# Datacenter to datacenter replication
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
This chapter introduces ArangoDB's _datacenter to datacenter replication_ (DC2DC).
**Sections:**

2
Documentation/Books/Manual/Scalability/DC2DC/Requirements.md
View File

@ -3,7 +3,7 @@
To use _datacenter to datacenter replication_ you need the following:
- Two datacenters, each running an ArangoDB Enterprise cluster, version 3.3 or higher.
- Two datacenters, each running an ArangoDB Enterprise Edition cluster, version 3.3 or higher.
- A network connection between both datacenters with accessible endpoints
for several components (see individual components for details).
- TLS certificates for ArangoSync master instances (can be self-signed).

5
Documentation/Books/Manual/Security/DC2DC/README.md
View File

@ -1,6 +1,11 @@
<!-- don't edit here, its from https://@github.com/arangodb/arangosync.git / docs/Manual/ -->
# Datacenter to datacenter Security
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
This section includes information related to the _datacenter to datacenter replication_
security.

5
Documentation/Books/Manual/Troubleshooting/DC2DC/README.md
View File

@ -1,6 +1,11 @@
<!-- don't edit here, its from https://@github.com/arangodb/arangosync.git / docs/Manual/ -->
# Troubleshooting datacenter to datacenter replication
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
The _datacenter to datacenter replication_ is a distributed system with a lot
different components. As with any such system, it requires some, but not a lot,
of operational support.

7
Documentation/Books/Manual/Tutorials/DC2DC/README.md
View File

@ -1,6 +1,11 @@
<!-- don't edit here, its from https://@github.com/arangodb/arangosync.git / docs/Manual/ -->
# Datacenter to datacenter Replication
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
## About
At some point in the growth of a database, there comes a need for
@ -67,7 +72,7 @@ ArangoSync is not a good solution when one of the following applies:
To use ArangoSync you need the following:
- Two datacenters, each running an ArangoDB Enterprise cluster, version 3.3 or higher.
- Two datacenters, each running an ArangoDB Enterprise Edition cluster, version 3.3 or higher.
- A network connection between both datacenters with accessible endpoints
for several components (see individual components for details).
- TLS certificates for ArangoSync master instances (can be self-signed).

5
Documentation/Books/Manual/Tutorials/Kubernetes/DC2DC.md
View File

@ -5,6 +5,11 @@ This tutorial guides you through the steps needed to configure
an ArangoDB datacenter to datacenter replication between two ArangoDB
clusters running in Kubernetes.
{% hint 'info' %}
This feature is only available in the
[**Enterprise Edition**](https://www.arangodb.com/why-arangodb/arangodb-enterprise/)
{% endhint %}
## Requirements
1. This tutorial assumes that you have 2 ArangoDB clusters running in 2 different Kubernetes clusters.

2
Documentation/Books/Manual/Tutorials/Starter/README.md
View File

@ -153,7 +153,7 @@ Datacenter to datacenter replication (DC2DC) requires a normal ArangoDB cluster
and one or more (`arangosync`) syncmasters & syncworkers in both data centers.
The starter enables you to run these syncmasters & syncworkers in combination with your normal
cluster.
Note: Datacenter to datacenter replication is an ArangoDB Enterprise feature.
Note: Datacenter to datacenter replication is an ArangoDB Enterprise Edition feature.
To run a starter with DC2DC support you add the following arguments to the starters command line:

2
Documentation/DocuBlocks/Rest/Collections/post_api_collection.md
View File

@ -126,7 +126,7 @@ If a server fails, this is detected automatically and one of the servers holding
copies take over, usually without an error being reported.
@RESTBODYPARAM{distributeShardsLike,string,optional,string}
(The default is *""*): in an enterprise cluster, this attribute binds
(The default is *""*): in an Enterprise Edition cluster, this attribute binds
the specifics of sharding for the newly created collection to follow that of a
specified existing collection.
**Note**: Using this parameter has consequences for the prototype

2
Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md
View File

@ -102,7 +102,7 @@ per query plan node in sub-attribute *stats.nodes* of the *extra* return attribu
Additionally the query plan is returned in the sub-attribute *extra.plan*.
@RESTSTRUCT{satelliteSyncWait,post_api_cursor_opts,boolean,optional,}
This *enterprise* parameter allows to configure how long a DBServer will have time
This *Enterprise Edition* parameter allows to configure how long a DBServer will have time
to bring the satellite collections involved in the query into sync.
The default value is *60.0* (seconds). When the max time has been reached the query
will be stopped.

4
Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md
View File

@ -19,10 +19,10 @@ An array of additional vertex collections.
@RESTBODYPARAM{isSmart,boolean,optional,boolean}
Define if the created graph should be smart.
This only has effect in Enterprise version.
This only has effect in Enterprise Edition.
@RESTBODYPARAM{options,object,optional,post_api_gharial_create_opts}
a JSON object which is only useful in Enterprise version and with isSmart set to true.
a JSON object which is only useful in Enterprise Edition and with isSmart set to true.
It can contain the following attributes:
@RESTSTRUCT{smartGraphAttribute,post_api_gharial_create_opts,string,required,}