summaryrefslogtreecommitdiffstats
path: root/docs/part-1/1-3_install-xds-server-native.md
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2018-10-04 11:57:13 +0200
committerSebastien Douheret <sebastien.douheret@iot.bzh>2018-11-30 08:30:39 +0000
commit94bcf90898e8b17811075eb693e0d96d753b8d8b (patch)
treede1d7b1e0db7f5ad8a4c9ea9a01e20fbde3c7658 /docs/part-1/1-3_install-xds-server-native.md
parentcf4c58201681023c1722b1a2870a3ea28bab0f2a (diff)
Invert order of installation chapters
To make install process more understandable, document first installation of xds-server part and then installation of xds tools. Bug: SPEC-1993 Change-Id: I5733c5d6885f45ff98cc9fee0d04362f76a86a4c Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'docs/part-1/1-3_install-xds-server-native.md')
-rw-r--r--docs/part-1/1-3_install-xds-server-native.md86
1 files changed, 86 insertions, 0 deletions
diff --git a/docs/part-1/1-3_install-xds-server-native.md b/docs/part-1/1-3_install-xds-server-native.md
new file mode 100644
index 0000000..77ef9f8
--- /dev/null
+++ b/docs/part-1/1-3_install-xds-server-native.md
@@ -0,0 +1,86 @@
+# Native installation
+
+You can chose to install xds-server 'natively' instead of within a docker
+container but note that only Linux host OSes are supported and tested for native
+installation !
+
+You also need to install `python3` to allow `xds-server` to manage AGL sdks.
+
+## Install packages for debian distro type
+
+```bash
+# 'DISTRO' can be set to { xUbuntu_16.04, xUbuntu_16.10, xUbuntu_17.04, Debian_8.0, Debian_9.0}
+export DISTRO="xUbuntu_16.04"
+
+# AGL_RELEASE can be set to {AGL_ElectricEel, AGL_FunkyFlounder, AGL_Master}
+export AGL_RELEASE="AGL_Master"
+
+wget -O - http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/${AGL_RELEASE}/${DISTRO}/Release.key | sudo apt-key add -
+sudo bash -c "cat >> /etc/apt/sources.list.d/AGL.list <<EOF
+deb http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/${AGL_RELEASE}/${DISTRO}/ ./
+EOF"
+
+sudo apt-get update
+sudo apt-get install agl-xds-server
+
+# Install python3
+sudo apt-get install python3
+```
+
+## Install packages for openSUSE distro type
+
+```bash
+# DISTRO can be set to {openSUSE_Leap_42.3, openSUSE_Leap_15.0, openSUSE_Tumbleweed}
+export DISTRO="openSUSE_Leap_15.0"
+
+# AGL_RELEASE can be set to {AGL_ElectricEel, AGL_FunkyFlounder, AGL_Master}
+export AGL_RELEASE="AGL_Master"
+
+sudo zypper ar http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/${AGL_RELEASE}/${DISTRO}/isv:LinuxAutomotive:${AGL_RELEASE}.repo
+
+sudo zypper ref
+sudo zypper install agl-xds-server
+
+# Install python3
+sudo zypper install python3
+```
+
+## Configure xds-server
+
+<!-- section-note -->
+**Optional step**: skip this chapter if you plan to use default settings
+<!-- end-section-note -->
+
+Please refer to [Configuration chapter of xds-server](../part-2/1_xds-server/1_config.html)
+documentation for more details about JSON configuration file.
+
+## Start/Stop xds-server
+
+`xds-server` can be managed as a systemd service with the following commands:
+
+```bash
+# Status XDS server:
+systemctl --user status xds-server.service
+
+# Stop XDS server
+systemctl --user stop xds-server.service
+
+# Start XDS server
+systemctl --user start xds-server.service
+
+# Get XDS server logs
+systemctl --user --unit=xds-server.service --output=cat
+```
+
+To check if xds-server is correctly install and running, you can access the web
+interface, using a web browser :
+
+```bash
+xdg-open http://localhost:8000
+```
+
+or get the current version using the following curl command:
+
+```bash
+curl http://localhost:8000/api/v1/version
+```