summaryrefslogtreecommitdiffstats
path: root/docs/part-2
diff options
context:
space:
mode:
Diffstat (limited to 'docs/part-2')
-rw-r--r--docs/part-2/1_xds-server/2_how-to-run.md52
-rw-r--r--docs/part-2/2_xds-agent/2_start.md50
2 files changed, 88 insertions, 14 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
diff --git a/docs/part-2/2_xds-agent/2_start.md b/docs/part-2/2_xds-agent/2_start.md
index 8ff0b1d..7d6735d 100644
--- a/docs/part-2/2_xds-agent/2_start.md
+++ b/docs/part-2/2_xds-agent/2_start.md
@@ -1,14 +1,52 @@
# Start-up
-Simply to start `xds-agent` executable
+## Start-up based on systemd user service
+
+For **Linux** distro, XDS agent can be started as a user service by Systemd.
+
+```bash
+/usr/lib/systemd/user/xds-agent.service
+```
+
+Use well-known systemd commands to control `xds-agent.service` service.
+
+```bash
+# Status XDS agent:
+systemctl --user status xds-agent
+
+# Start XDS agent
+systemctl --user start xds-agent
+
+# Stop XDS agent
+systemctl --user stop xds-agent
+```
+
+Default settings are defined in `/etc/default/xds-agent` file but these
+settings you can overwritten by `$HOME/.xds/agent/agent-config.json` file,
+see [Configuration chapter](./1_config.html) for more details.
+
+## Manual start-up
+
+On **Linux or MacOS**, simply execute `xds-agent` executable:
```bash
-./xds-agent &
+/opt/AGL/bin/xds-agent
```
->**Note:**
->
->If need be, you can increase log level by setting option
+On **Windows**, simply execute `xds-agent` executable (root path may change
+depending where you installed/unzipped xds-agent tarball):
+
+```batch
+C:\AGL\bin\xds-agent.exe
+```
+
+<!-- note -->
+**Note:**
+
+If need be, you can increase log level by setting option
`--log <level>`, supported *level* are: panic, fatal, error, warn, info, debug.
-You can now use XDS dashboard and check that connection with `xds-agent` is up.
+Invoke `xds-agent --help` to get more details about possible options that allow
+for example to change logging level or select a specific configuration file.
+
+<!-- endnote -->