Using the ArangoDB Starter

As a precondition you should create a secret to activate authentication. The Starter provides a handyfunctionality to generate such a file:

Set appropriate privilege on the generated secret file, e.g. on Linux:

If you want to start a local Active Failover setup quickly, use the —starter.localoption of the Starter. This will start all servers within the context of a singlestarter process:

Please adapt the path to your secret file accordingly.

Note that to avoid unnecessary failovers, it may make sense to increase the valuefor the startup option —agents.agency.supervision-grace-period to a valuebeyond 30 seconds.

Note: When you restart the Starter, it remembers the original —starter.local flag.

Please adapt the path to your secret file accordingly.

Note that to avoid unnecessary failovers, it may make sense to increase the valuefor the startup option —agents.agency.supervision-grace-period to a valuebeyond 30 seconds.

Run the above command on machine A, B & C.

Once all the processes started by the Starter are up and running, and joined theActive Failover setup (this may take a while depending on your system), the Starter will informyou where to connect the Active Failover from a Browser, shell or your program.

For a full list of options of the Starter please refer to section.

The Starter can also be used to launch an Active Failover setup based on _Docker_containers. To do this, you can use the normal Docker arguments, combined with—starter.mode=activefailover:

Note that to avoid unnecessary failovers, it may make sense to increase the valuefor the startup option —agents.agency.supervision-grace-period to a valuebeyond 30 seconds.

The Starter will decide on which 2 machines to run a single server instance.To override this decision (only valid while bootstrapping), add a to the machine where the single serverinstance should not be started.

If you use an ArangoDB version of 3.4 or above and use the EnterpriseEdition Docker image, you have to set the license key in an environmentvariable by adding this option to the above docker command:

    -e ARANGO_LICENSE_KEY=<thekey>

You can get a free evaluation license key by visiting:

www.arangodb.com/download-arangodb-enterprise/

Then replace <thekey> above with the actual license key. The startwill then hand on the license key to the Docker containers it launchesfor ArangoDB.

Note that the environment variables DOCKER_TLS_VERIFY and DOCKER_CERT_PATH as well as the additional mountpoint containing the certificate have been added above. directory. The assignment of DOCKER_CERT_PATH is optional, in which case it is mandatory that the certificates are stored in $HOME/.docker. Sothe command would then be as follows

export IP=<IP of docker host>
docker run -it --name=adb --rm -p 8528:8528 \
    -v arangodb:/data \
    -v /path/to/cert:/root/.docker \
    -e DOCKER_TLS_VERIFY=1 \
    arangodb/arangodb-starter \
    --agents.agency.supervision-grace-period=30 \
    --starter.address=$IP \
    --starter.join=A,B,C