From 2a297d08d6b686abe9ab8404a15aa892f4832e25 Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Tue, 16 Jan 2018 15:57:59 +0100 Subject: Update XDS documentation - remove documentation duplication for xds-server. Change-Id: Icd76d3a65a3a2ad39438524b0d43d33c0a61d077 Signed-off-by: Ronan Le Martret Signed-off-by: Sebastien Douheret --- docs/part-1/1_install-client.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) (limited to 'docs/part-1/1_install-client.md') diff --git a/docs/part-1/1_install-client.md b/docs/part-1/1_install-client.md index b482dc9..255401d 100644 --- a/docs/part-1/1_install-client.md +++ b/docs/part-1/1_install-client.md @@ -2,17 +2,21 @@ [xds-agent](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-agent.git) is a client tool that must run on your machine (user / developer host) to be able to use XDS. + You should establish the following chain: -Client (eg. `xds-cli` or XDS Dashboard) and `xds-agent` is running on your machine -and `xds-server` is running on a remote server and/or in a container. -Exchanges between these 3 tools are done though HTTP and Websocket protocols -and default url/port mentioned in schema below can be change using config files. +- XDS Client: (`xds-cli` or XDS Dashboard). +- XDS Agent: (`xds-agent`) running on your machine. +- XDS Server (`xds-server`) running on a remote server and/or in a container. + +Exchanges between these 3 tools are done though HTTP and Websocket protocols. + +Default url/port mentioned in schema below can be change using config files. ![XDS blocks chain](./pictures/xds-block-chain.png) Installation of other XDS client tools, such as `xds-cli` or `xds-gdb` is -optional and depends of what you want to do : +optional and depends of what you want to do: - [xds-cli](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-cli.git) : command line tool to used to interact with XDS (also used by IDE integration). - [xds-gdb](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-gdb.git) : requested for debugging application. @@ -71,14 +75,18 @@ sudo zypper install agl-xds-gdb XDS-agent is a client tool that must run on your local / user development machine when you use XDS. -For Linux distro, a user systemd service is provided, so you just need to enable -if you want to start it automatically at boot and you can also start it -immediately using following commands: +For Linux distro, a user systemd service is provided, `xds-agent.service`. + +To start it automatically at boot and you can enable it using following commands: ```bash # Enable xds-agent service at boot systemctl --user enable xds-agent.service +``` + +To start the XDS-agent service: +```bash # Manually start xds-agent service systemctl --user start xds-agent.service -- cgit 1.2.3-korg