summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2018-12-18 19:35:52 +0100
committerSebastien Douheret <sebastien.douheret@iot.bzh>2018-12-18 19:35:54 +0100
commit4d793161db28ea11e50ea2b99719918dd43a2fdd (patch)
treeb21b82803cac8a01341e1767736a83d2164058a2
parent7d738af4518f0083fcb3c1270bc58e82bf6224c8 (diff)
Improved xds docker image installation instructions
- Add warning section about the fact that user must be part of docker group - Add warning section about impact of changing container id on xds-server port Bug: SPEC-2032 Change-Id: I3a8e50c079af9f99a99a0fc02afcd55e7bc83b38 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
-rw-r--r--docs/part-1/1-1_install-xds-server-docker.md48
1 files changed, 46 insertions, 2 deletions
diff --git a/docs/part-1/1-1_install-xds-server-docker.md b/docs/part-1/1-1_install-xds-server-docker.md
index 0d16815..5b30ca5 100644
--- a/docs/part-1/1-1_install-xds-server-docker.md
+++ b/docs/part-1/1-1_install-xds-server-docker.md
@@ -4,6 +4,26 @@
Docker is installed on the host machine, please refer to [Docker documentation](https://docs.docker.com/engine/installation/) for more details.
+<!-- section-warning -->
+>**Warning:**
+>
+>Your user must be part of docker group. You can use following command to check it :
+>```bash
+>groups | grep docker
+>```
+>
+>If not, please refer to [docker post install instructions](https://docs.docker.com/install/linux/linux-postinstall/).
+>
+>Here are a short recap of commands you must execute :
+>
+>```bash
+>sudo groupadd docker
+>sudo usermod -aG docker $USER
+># Log out and log back in so that your group membership is re-evaluated
+>```
+>
+<!-- end-section-warning -->
+
## Get the container
Load the pre-build AGL SDK docker image including `xds-server`:
@@ -72,13 +92,37 @@ You can change docker used port with `-id` option
```bash
# Create new XDS worker container with a different port number
+ID=3
bash ./xds-docker-create-container.sh -id ${ID}
-# Check that new container is running
+# Check that new container is running (in example below id has been set to 3)
docker ps | grep worker-xds
-f67079db4339 docker.automotivelinux.org/agl/worker-xds:5.0 "/usr/bin/wait_for..." About a minute ago Up 34 seconds 0.0.0.0:(2222+ID)->22/tcp, 0.0.0.0:(8000+ID)->8000/tcp, 0.0.0.0:(10809+ID)->10809/tcp agl-xds-HOSTNAME-ID-USERNAME
+f67079db4339 docker.automotivelinux.org/agl/worker-xds:5.0 "/usr/bin/wait_for..." About a minute ago Up 34 seconds 0.0.0.0:2225->22/tcp, 0.0.0.0:8003->8000/tcp, 0.0.0.0:10892->10809/tcp agl-xds-3
```
+<!-- section-warning -->
+>**Warning:**
+> Changing container id will impact the port number used to connect to xds-server.
+> So you may need to adjust xds-agent config in order to match the right port number.
+>
+>In above example, with `id` set to 3, the export port number will be `8003` and >consequently
+>you must define xds-server `url` in `xds-agent` configuration as follow:
+>
+>```json
+>{
+> ...
+> "xdsServers": [
+> {
+> "url": "http://localhost:8003"
+> }
+> ],
+> ...
+>}
+>```
+>
+>See also [xds-agent configuration](../part-2/1_xds-agent/1_config.html) chapter for >more details.
+<!-- end-section-warning -->
+
### Manually setup docker user id
<!-- section-note -->