Documentation improvements necessary

[neunhoef]

trafficstars

• for Docker case: document variable DOCKER_IMAGE in order to specfify the ArangoDB version using the Starter in docker (e.g. -e "DOCKER_IMAGE=arangodb/enterprise:3.4.4")

1. https://docs.arangodb.com/3.4/Manual/Deployment/SingleInstance/UsingTheStarter.html#using-the-arangodb-starter-in-docker
2. https://docs.arangodb.com/3.4/Manual/Deployment/ActiveFailover/UsingTheStarter.html#using-the-arangodb-starter-in-docker
3. https://docs.arangodb.com/3.4/Manual/Deployment/Cluster/UsingTheStarter.html#using-the-arangodb-starter-in-docker

• in general: explain which options count at every start and which ones count only at first deployment (e.g. authentication only first start!)

• add instructions on how to use JWT authentication within docker

1. mount jwt secret file (stored in local file system): -v <pathToJwtSecretFile>/<jwtSecretFile>:<pathToJwtSecretFile>/<jwtSecretFile> \
2. add jwt option to starter: arangodb/arangodb-starter \ --auth.jwt-secret <pathToJwtSecretFile>/<jwtSecretFile> \

Full command (enterprise, remove ARANGO_LICENSE_KEY and change DOCKER_IMAGE repository for community):

export IP=<IP of docker host>
docker volume create arangodb
docker run -it --name=adb --rm -p 8528:8528 \
    -e "ARANGO_LICENSE_KEY=<enterpriseLicenceKey>" \
    -e "DOCKER_IMAGE=arangodb/enterprise:<enterpriseTag>" \
    -v arangodb:/data \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -v <pathToJwtSecretFile>/<jwtSecretFile>:<pathToJwtSecretFile>/<jwtSecretFile> \
    arangodb/arangodb-starter \
    --auth.jwt-secret <pathToJwtSecretFile>/<jwtSecretFile> \
    --starter.address=$IP \
    --starter.join=A,B,C

[KVS85]

@neunhoef what is the difference between --docker.image option of ArangoDB Starter and DOCKER_IMAGE variable?

[neunhoef]

None. The command line option takes precedence, I think. This is a good convention to support both and gove precedence to command line.