Skip to content

Commit 1bd4bb2

Browse files
authored
Merge pull request #217 from arangodb-helper/documentation/missing-environment-variables-in-documentation
missing environment variables in documentation
2 parents 189a682 + 447e668 commit 1bd4bb2

File tree

4 files changed

+68
-8
lines changed

4 files changed

+68
-8
lines changed

docs/Manual/Deployment/ActiveFailover/UsingTheStarter.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,18 @@ docker run -it --name=adb --rm -p 8528:8528 \
109109
Note that the enviroment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
110110
as well as the additional mountpoint containing the certificate have been added above.
111111
directory. The assignment of `DOCKER_CERT_PATH` is optional, in which case it
112-
is mandatory that the certificates are stored in `$HOME/.docker`.
112+
is mandatory that the certificates are stored in `$HOME/.docker`. So
113+
the command would then be as follows
114+
115+
```bash
116+
export IP=<IP of docker host>
117+
docker volume create arangodb
118+
docker run -it --name=adb --rm -p 8528:8528 \
119+
-v arangodb:/data \
120+
-v /var/run/docker.sock:/var/run/docker.sock \
121+
-v /path/to/cert:/root/.docker \
122+
-e DOCKER_TLS_VERIFY=1 \
123+
arangodb/arangodb-starter \
124+
--starter.address=$IP \
125+
--starter.join=A,B,C
126+
```

docs/Manual/Deployment/Cluster/UsingTheStarter.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,14 @@ handed to it, so that the above command is modified as follows:
7979

8080
```bash
8181
export IP=<IP of docker host>
82-
export DOCKER_TLS_VERIFY=1
8382
export DOCKER_CERT_PATH=/path/to/certificate
8483
docker volume create arangodb
8584
docker run -it --name=adb --rm -p 8528:8528 \
8685
-v arangodb:/data \
8786
-v /var/run/docker.sock:/var/run/docker.sock \
88-
-v /path/to/certificate:/path/to/certificate
87+
-v $DOCKER_CERT_PATH:$DOCKER_CERT_PATH \
88+
-e DOCKER_TLS_VERIFY=1 \
89+
-e DOCKER_CERT_PATH=$DOCKER_CERT_PATH \
8990
arangodb/arangodb-starter \
9091
--starter.address=$IP \
9192
--starter.join=A,B,C
@@ -94,7 +95,21 @@ docker run -it --name=adb --rm -p 8528:8528 \
9495
Note that the enviroment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
9596
as well as the additional mountpoint containing the certificate have been added above.
9697
directory. The assignment of `DOCKER_CERT_PATH` is optional, in which case it
97-
is mandatory that the certificates are stored in `$HOME/.docker`.
98+
is mandatory that the certificates are stored in `$HOME/.docker`. So
99+
the command would then be as follows
100+
101+
```bash
102+
export IP=<IP of docker host>
103+
docker volume create arangodb
104+
docker run -it --name=adb --rm -p 8528:8528 \
105+
-v arangodb:/data \
106+
-v /var/run/docker.sock:/var/run/docker.sock \
107+
-v /path/to/cert:/root/.docker \
108+
-e DOCKER_TLS_VERIFY=1 \
109+
arangodb/arangodb-starter \
110+
--starter.address=$IP \
111+
--starter.join=A,B,C
112+
```
98113

99114
Under the Hood
100115
--------------

docs/Manual/Deployment/SingleInstance/UsingTheStarter.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,19 @@ docker run -it --name=adb --rm -p 8528:8528 \
7272
Note that the enviroment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
7373
as well as the additional mountpoint containing the certificate have been added above.
7474
directory. The assignment of `DOCKER_CERT_PATH` is optional, in which case it
75-
is mandatory that the certificates are stored in `$HOME/.docker`.
75+
is mandatory that the certificates are stored in `$HOME/.docker`. So
76+
the command would then be as follows
77+
78+
```bash
79+
export IP=<IP of docker host>
80+
docker volume create arangodb
81+
docker run -it --name=adb --rm -p 8528:8528 \
82+
-v arangodb:/data \
83+
-v /var/run/docker.sock:/var/run/docker.sock \
84+
-v /path/to/cert:/root/.docker \
85+
-e DOCKER_TLS_VERIFY=1 \
86+
arangodb/arangodb-starter \
87+
--starter.address=$IP \
88+
--starter.join=A,B,C
89+
```
90+

docs/Manual/Tutorials/Starter/README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,13 +105,14 @@ the above command is modified as follows:
105105

106106
```bash
107107
export IP=<IP of docker host>
108-
export DOCKER_TLS_VERIFY=1
109108
export DOCKER_CERT_PATH=/path/to/certificate
110109
docker volume create arangodb
111110
docker run -it --name=adb --rm -p 8528:8528 \
112111
-v arangodb:/data \
113112
-v /var/run/docker.sock:/var/run/docker.sock \
114-
-v /path/to/certificate:/path/to/certificate
113+
-v $DOCKER_CERT_PATH:$DOCKER_CERT_PATH
114+
-e DOCKER_TLS_VERIFY=1
115+
-e DOCKER_CERT_PATH=$DOCKER_CERT_PATH
115116
arangodb/arangodb-starter \
116117
--starter.address=$IP \
117118
--starter.join=A,B,C
@@ -120,7 +121,22 @@ docker run -it --name=adb --rm -p 8528:8528 \
120121
Note that the enviroment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
121122
as well as the additional mountpoint containing the certificate have been added above.
122123
directory. The assignment of `DOCKER_CERT_PATH` is optional, in which case it
123-
is mandatory that the certificates are stored in `$HOME/.docker`.
124+
is mandatory that the certificates are stored in `$HOME/.docker`. So
125+
the command would then be as follows
126+
127+
```bash
128+
export IP=<IP of docker host>
129+
docker volume create arangodb
130+
docker run -it --name=adb --rm -p 8528:8528 \
131+
-v arangodb:/data \
132+
-v /var/run/docker.sock:/var/run/docker.sock \
133+
-v /path/to/cert:/root/.docker \
134+
-e DOCKER_TLS_VERIFY=1 \
135+
arangodb/arangodb-starter \
136+
--starter.address=$IP \
137+
--starter.join=A,B,C
138+
```
139+
124140

125141
The TLS verification above applies equally to all below deployment modes.
126142

0 commit comments

Comments
 (0)