Skip to content

BTS-1863 Update starter doc for the latest Docker changes #539

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

Merged
merged 2 commits into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.DS_Store
.vscode/
.idea/
/tmp/
node_modules/
*.pyc
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
--agents.agency.supervision-grace-period=30 \
--starter.address=$IP \
--starter.mode=activefailover \
--starter.join=A,B,C
--starter.join=A,B,C \
--docker.net-mode=default
```

Run the above command on machine A, B & C.
Expand Down Expand Up @@ -130,7 +131,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
--agents.agency.supervision-grace-period=30 \
--starter.address=$IP \
--starter.mode=activefailover \
--starter.join=A,B,C
--starter.join=A,B,C \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -151,5 +153,6 @@ docker run -it --name=adb --rm -p 8528:8528 \
--agents.agency.supervision-grace-period=30 \
--starter.address=$IP \
--starter.mode=activefailover \
--starter.join=A,B,C
--starter.join=A,B,C \
--docker.net-mode=default
```
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,8 @@ docker run -it --name=adb1 --rm -p 8528:8528 \
-v arangodb1:/data \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

If you are running on Linux, it is also possible to use a host-mapped volume
Expand All @@ -174,7 +175,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.join A
--starter.join A \
--docker.net-mode=default
```

If you use the Enterprise Edition Docker image, you have to set the license key
Expand Down Expand Up @@ -210,7 +212,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-e DOCKER_TLS_VERIFY=1 \
-e DOCKER_CERT_PATH=$DOCKER_CERT_PATH \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -228,7 +231,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-v /path/to/cert:/root/.docker \
-e DOCKER_TLS_VERIFY=1 \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

## Under the Hood
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```

If you use the Enterprise Edition Docker image, you have to set the license key
Expand Down Expand Up @@ -82,7 +83,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
-v /path/to/certificate:/path/to/certificate
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -101,5 +103,6 @@ docker run -it --name=adb --rm -p 8528:8528 \
-e DOCKER_TLS_VERIFY=1 \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
--agents.agency.supervision-grace-period=30 \
--starter.address=$IP \
--starter.mode=activefailover \
--starter.join=A,B,C
--starter.join=A,B,C \
--docker.net-mode=default
```

Run the above command on machine A, B & C.
Expand Down Expand Up @@ -130,7 +131,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
--agents.agency.supervision-grace-period=30 \
--starter.address=$IP \
--starter.mode=activefailover \
--starter.join=A,B,C
--starter.join=A,B,C \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -151,5 +153,6 @@ docker run -it --name=adb --rm -p 8528:8528 \
--agents.agency.supervision-grace-period=30 \
--starter.address=$IP \
--starter.mode=activefailover \
--starter.join=A,B,C
--starter.join=A,B,C \
--docker.net-mode=default
```
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,8 @@ docker run -it --name=adb1 --rm -p 8528:8528 \
-v arangodb1:/data \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

If you are running on Linux, it is also possible to use a host-mapped volume
Expand All @@ -174,7 +175,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.join A
--starter.join A \
--docker.net-mode=default
```

If you use the Enterprise Edition Docker image, you have to set the license key
Expand Down Expand Up @@ -210,7 +212,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-e DOCKER_TLS_VERIFY=1 \
-e DOCKER_CERT_PATH=$DOCKER_CERT_PATH \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -228,7 +231,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-v /path/to/cert:/root/.docker \
-e DOCKER_TLS_VERIFY=1 \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

## Under the Hood
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```

If you use the Enterprise Edition Docker image, you have to set the license key
Expand Down Expand Up @@ -82,7 +83,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
-v /path/to/certificate:/path/to/certificate
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -101,5 +103,6 @@ docker run -it --name=adb --rm -p 8528:8528 \
-e DOCKER_TLS_VERIFY=1 \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,8 @@ docker run -it --name=adb1 --rm -p 8528:8528 \
-v arangodb1:/data \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

If you are running on Linux, it is also possible to use a host-mapped volume
Expand All @@ -174,7 +175,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.join A
--starter.join A \
--docker.net-mode=default
```

If you use the Enterprise Edition Docker image, you have to set the license key
Expand Down Expand Up @@ -210,7 +212,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-e DOCKER_TLS_VERIFY=1 \
-e DOCKER_CERT_PATH=$DOCKER_CERT_PATH \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -228,7 +231,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-v /path/to/cert:/root/.docker \
-e DOCKER_TLS_VERIFY=1 \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

## Under the Hood
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```

If you use the Enterprise Edition Docker image, you have to set the license key
Expand Down Expand Up @@ -82,7 +83,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
-v /path/to/certificate:/path/to/certificate
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -101,5 +103,6 @@ docker run -it --name=adb --rm -p 8528:8528 \
-e DOCKER_TLS_VERIFY=1 \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,8 @@ docker run -it --name=adb1 --rm -p 8528:8528 \
-v arangodb1:/data \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

If you are running on Linux, it is also possible to use a host-mapped volume
Expand All @@ -174,7 +175,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.join A
--starter.join A \
--docker.net-mode=default
```

If you use the Enterprise Edition Docker image, you have to set the license key
Expand Down Expand Up @@ -210,7 +212,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-e DOCKER_TLS_VERIFY=1 \
-e DOCKER_CERT_PATH=$DOCKER_CERT_PATH \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -228,7 +231,8 @@ docker run -it --name=adbN --rm -p 8528:8528 \
-v /path/to/cert:/root/.docker \
-e DOCKER_TLS_VERIFY=1 \
arangodb/arangodb-starter \
--starter.address=$IP
--starter.address=$IP \
--docker.net-mode=default
```

## Under the Hood
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
-v /var/run/docker.sock:/var/run/docker.sock \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```

If you use the Enterprise Edition Docker image, you have to set the license key
Expand Down Expand Up @@ -82,7 +83,8 @@ docker run -it --name=adb --rm -p 8528:8528 \
-v /path/to/certificate:/path/to/certificate
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```

Note that the environment variables `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
Expand All @@ -101,5 +103,6 @@ docker run -it --name=adb --rm -p 8528:8528 \
-e DOCKER_TLS_VERIFY=1 \
arangodb/arangodb-starter \
--starter.address=$IP \
--starter.mode=single
--starter.mode=single \
--docker.net-mode=default
```