summaryrefslogtreecommitdiffstats
path: root/docs/part-2/1_xds-server/2_how-to-run.md
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-18 11:04:11 +0100
committerSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-18 11:04:11 +0100
commit92f9fb1ebda0eb607c5ae5189034b4503e81666e (patch)
tree410edec8b8c61ce4f1623b80ca85638bd82fc69a /docs/part-2/1_xds-server/2_how-to-run.md
parentbd814eafac20a5264782bad69ce2df1599921c68 (diff)
Update xds-server/xds-agent start-up doc
Change-Id: I3183073e1e84789ba3081d79f4f0721e67542311 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'docs/part-2/1_xds-server/2_how-to-run.md')
-rw-r--r--docs/part-2/1_xds-server/2_how-to-run.md52
1 files changed, 44 insertions, 8 deletions
diff --git a/docs/part-2/1_xds-server/2_how-to-run.md b/docs/part-2/1_xds-server/2_how-to-run.md
index 36bc9a6..5ca8d28 100644
--- a/docs/part-2/1_xds-server/2_how-to-run.md
+++ b/docs/part-2/1_xds-server/2_how-to-run.md
@@ -7,23 +7,37 @@ been integrated into AGL SDK docker container.
>**Note:** For more info about AGL SDK docker container, please refer to
[AGL SDK Quick Setup](http://docs.automotivelinux.org/docs/getting_started/en/dev/reference/setup-sdk-environment.html)
-## Start xds-server within the container
+## Start xds-server
-See [Installation based on Docker container](../../part-1/2-1_install-xds-server-docker.html)
-chapter.
+There are several way to install xds-server and start-up depend of installation type:
-## Manually Start XDS server
+| Installation type | Supported<br> host OS | Start-up | Install instructions |
+|-------------------|-------------------------|---------------------------------------------------|----------------------|
+| Docker container | Linux or MacOS | Automatic based on systemd user service | [see Installation based on Docker container](../../part-1/2-1_install-xds-server-docker.html) |
+| Virtual Machine | Linux, MacOS or Windows | Automatic based on systemd user service | [see Installation based on VirtualBox appliance](../../part-1/2-2_install-xds-server-vm.html) |
+| Native | Linux | Automatic based on systemd user service or manual | [see Native installation](../../part-1/2-3_install-xds-server-native.html) |
+| Native | MacOS or Windows | Manually | [see Native installation](../../part-1/2-3_install-xds-server-native.html) |
-XDS server is started as a service by Systemd.
+### Automatic start-up based on systemd user service
+
+XDS server is started as a user service by Systemd.
```bash
-/lib/systemd/system/xds-server.service
+/usr/lib/systemd/user/xds-server.service
```
-This Systemd service starts a bash script
+Use well-known systemd commands to control `xds-server.service` service.
```bash
-/opt/AGL/xds/server/xds-server-start.sh
+# Enter in docker container or VM
+# (optional, depending on installation type)
+ssh -p 2222 devel@localhost
+
+# Status XDS server:
+systemctl --user status xds-server
+
+# Restart XDS server
+systemctl --user restart xds-server
```
If needed you can change default setting by defining specific environment
@@ -49,6 +63,28 @@ docker exec ${CONTAINER_NAME} bash -c "echo 'LOG_LEVEL=debug' >> /etc/default/xd
ssh -p 2222 devel@localhost -- "systemctl --user restart xds-server"
```
+### Manual start-up
+
+On **Linux or MacOS**, simply execute `xds-server` executable:
+
+```bash
+/opt/AGL/bin/xds-server
+```
+
+On **Windows**, simply execute `xds-server` executable:
+
+```batch
+C:\AGL\bin\xds-server.exe
+```
+
+<!-- note -->
+**Note:**
+
+Invoke `xds-server --help` to get more details about possible options that allow
+for example to change logging level or select another configuration file.
+
+<!-- endnote -->
+
## SDK cross-toolchain Management
### Setup to add support of a new SDK family