Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements necessary #220

Open
neunhoef opened this issue Mar 26, 2019 · 2 comments
Open

Documentation improvements necessary #220

neunhoef opened this issue Mar 26, 2019 · 2 comments

Comments

@neunhoef
Copy link
Collaborator

neunhoef commented Mar 26, 2019

  • 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
Copy link

KVS85 commented Apr 5, 2019

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

@neunhoef
Copy link
Collaborator Author

neunhoef commented Apr 5, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants