diff options
| -rw-r--r-- | docs/devguides-book.yml | 16 | ||||
| -rw-r--r-- | docs/part-1/1-1_install-xds-server-docker.md | 196 | ||||
| -rw-r--r-- | docs/part-1/1-3_install-xds-server-native.md | 86 | ||||
| -rw-r--r-- | docs/part-1/4_build-first-app.md | 21 | ||||
| -rw-r--r-- | docs/part-1/debug-cmd-line.md (renamed from docs/part-1/5-2_debug-first-app-cmd.md) | 0 | ||||
| -rw-r--r-- | docs/part-1/debug-configuration.md (renamed from docs/part-1/5-1_debug-first-app-config.md) | 0 | ||||
| -rw-r--r-- | docs/part-1/debug-ide.md (renamed from docs/part-1/5-3_debug-first-app-ide.md) | 0 | ||||
| -rw-r--r-- | docs/part-1/debug-overview.md (renamed from docs/part-1/5_debug-first-app.md) | 0 |
8 files changed, 8 insertions, 311 deletions
diff --git a/docs/devguides-book.yml b/docs/devguides-book.yml index dc8a033..e714db0 100644 --- a/docs/devguides-book.yml +++ b/docs/devguides-book.yml @@ -32,16 +32,16 @@ books: name: Build Using the XDS Dashboard - url: part-1/create-app-build-ide.md name: Build Using an IDE - - name: Debug your first AGL application + - name: Debugging Your First AGL Application children: - - url: part-1/5-1_debug-first-app-config.md - name: Prerequisites - - url: part-1/5-2_debug-first-app-cmd.md + - url: part-1/debug-overview.md + name: Overview + - url: part-1/debug-configuration.md name: Configuration - - url: part-1/5-3_debug-first-app-ide.md - name: xds-gdb from command line - - url: part-1/5_debug-first-app.md - name: xds-gdb within an IDE + - url: part-1/debug-cmd-line.md + name: Using the Command Line + - url: part-1/debug-ide.md + name: Using an IDE - name: "X(cross) Development System: Internals" children: - url: part-2/0_Abstract.md diff --git a/docs/part-1/1-1_install-xds-server-docker.md b/docs/part-1/1-1_install-xds-server-docker.md deleted file mode 100644 index 5b30ca5..0000000 --- a/docs/part-1/1-1_install-xds-server-docker.md +++ /dev/null @@ -1,196 +0,0 @@ -# Installation based on Docker container - -## Docker container prerequisites - -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`: - -```bash -wget -O - http://iot.bzh/download/public/XDS/docker/docker_agl_worker-xds-latest.tar.xz | docker load -``` - -You should get `docker.automotivelinux.org/agl/worker-xds:X.Y` image - -```bash -# List image that we just load -docker images "docker.automotivelinux.org/agl/worker-xds*" - -REPOSITORY TAG IMAGE ID CREATED SIZE -docker.automotivelinux.org/agl/worker-xds 5.0 877979e534ff 3 hours ago 106MB -``` - -## Create and start a new container - -Use provided script to create a new docker image and start a new container: - -```bash -# Get script -wget -O xds-docker-create-container.sh 'https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-server.git;a=blob_plain;f=scripts/xds-docker-create-container.sh;hb=master' - -# Create new XDS worker container (-id option value should be changed when you get port conflict error) -bash ./xds-docker-create-container.sh -id 0 - -# Check that new container is running -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:8000->8000/tcp,0.0.0.0:10809->10809/tcp, 0.0.0.0:2222->22/tcp agl-xds-HOSTNAME-0-USERNAME -``` - -This container exposes following ports: - -| Port number | Description | -|-------------|---------------------------------------------| -| 8000 | `xds-server`: serve XDS webapp and REST API | -| 2222 | ssh | - -This container also creates the following volumes (shared folders between -inside and outside docker): - -| Directory on host | Directory inside docker | Comment | -|-------------------|-------------------------|---------| -| $HOME/xds-workspace | /home/devel/xds-workspace | XDS projects workspace location| -| $HOME/xds-workspace/.xdt_0 | /xdt | location to store SDKs | -| $USER_VOLUME | $USER_VOLUME | user path, see `--volume` option of `xds-docker-create-container.sh` script | - -### Optional settings - -**`--volume`** - -You can add a new shared directory using `--volume` option in order -to use for example with Path-Mapping folder type. - -```bash -# Create new XDS worker container and share extra '$HOME/my-workspace' directory -bash ./xds-docker-create-container.sh --volume /my-workspace:$HOME/my-workspace -``` - -**`--id`** - -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 (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: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 --> -**Note:** - -If you used `xds-docker-create-container.sh` script to create XDS -docker container, user uid/gid inside docker has already been changed by this script. -<!-- end-section-note --> - -If you plan to use **path-mapping sharing type for your projects**, you need to -have the same user id and group id inside and outside docker. - -By default user and group name inside docker is set `devel` (id `1664`). - -Use following commands to replace id `1664` with your user/group id: - -```bash -# Set docker container name to use (usually agl-xds-xxx where xxx is USERNAME@MACHINENAME-IDX-NAME) -export CONTAINER_NAME=agl-xds-seb@laptop-0-seb -docker ps | grep -q ${CONTAINER_NAME} || echo "ERROR: No container name \"${CONTAINER_NAME}\" please set a valid CONTAINER_NAME before you continue" - -# First kill all processes of devel user (including running xds-server) -docker exec ${CONTAINER_NAME} bash -c "/bin/loginctl kill-user devel" - -# Change user and group id inside docker to match your ids -docker exec ${CONTAINER_NAME} bash -c "usermod -u $(id -u) devel" -docker exec ${CONTAINER_NAME} bash -c "groupmod -g $(id -g) devel" - -# Update some files ownership -docker exec ${CONTAINER_NAME} bash -c "chown -R devel:devel /home/devel /tmp/xds*" - -# Restart devel autologin service -docker exec ${CONTAINER_NAME} bash -c "systemctl restart autologin" - -# Restart xds-server as a service (ssh port 2222 may depend on your container ID) -ssh -p 2222 devel@localhost -- "systemctl --user restart xds-server" -``` - -## Check if xds-server is running (open XDS webapp) - -**`xds-server` is automatically started** as a user service on container startup. - -If the container is running on your localhost, you can access to a basic web -application: - -```bash -xdg-open http://localhost:8000 -``` - -If needed you can status / stop / start it manually using following commands: - -```bash -# Status XDS server: -ssh -p 2222 devel@localhost systemctl --user status xds-server.service - -# Stop XDS server -ssh -p 2222 devel@localhost systemctl --user stop xds-server.service - -# Start XDS server -ssh -p 2222 devel@localhost systemctl --user start xds-server.service - -# Get XDS server logs -ssh -p 2222 devel@localhost journalctl --user --unit=xds-server.service --output=cat -``` - -`xds-server` is now up and running, you can now install AGL SDKs, please refer -to next chapter named [Installing AGL SDKs](./3_install-sdks.html) - -<!-- section-note --> -Please refer to [xds-server configuration](../part-2/1_xds-server/1_config.html) chapter for additional info about xds-server settings. -<!-- end-section-note --> diff --git a/docs/part-1/1-3_install-xds-server-native.md b/docs/part-1/1-3_install-xds-server-native.md deleted file mode 100644 index 77ef9f8..0000000 --- a/docs/part-1/1-3_install-xds-server-native.md +++ /dev/null @@ -1,86 +0,0 @@ -# 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 -``` diff --git a/docs/part-1/4_build-first-app.md b/docs/part-1/4_build-first-app.md deleted file mode 100644 index 34f895b..0000000 --- a/docs/part-1/4_build-first-app.md +++ /dev/null @@ -1,21 +0,0 @@ -# Create your first AGL application - -## Prerequisites - -- `xds-agent` is running locally on your machine - (see previous chapter: [Installing XDS client tools](./1_install-client.html) ) -- `xds-server` is running locally in a docker container or is accessible on your - network (see previous chapter: [Installing XDS server](./2_install-xds-server.html)) -- one or more SDK have been installed (see previous chapter: [Installing AGL SDKs](./3_install-sdks.html)) -- XDS configuration is correct: in other words, connection is correctly - established between `xds-agent` and `xds-server` and no error message is - displayed when you open XDS Dashboard in a web browser. - ---- - -Links to subchapters : - -- [Setup](./4-1_build-first-app-setup.html) -- [Build using command line tool](./4-2_build-first-app-cmd.html) -- [Build using XDS Dashboard](./4-3_build-first-app-dashboard.html) -- [Build using a source code editor / IDE](./4-4_build-first-app-ide.html) diff --git a/docs/part-1/5-2_debug-first-app-cmd.md b/docs/part-1/debug-cmd-line.md index 4d2ca84..4d2ca84 100644 --- a/docs/part-1/5-2_debug-first-app-cmd.md +++ b/docs/part-1/debug-cmd-line.md diff --git a/docs/part-1/5-1_debug-first-app-config.md b/docs/part-1/debug-configuration.md index 8743bc1..8743bc1 100644 --- a/docs/part-1/5-1_debug-first-app-config.md +++ b/docs/part-1/debug-configuration.md diff --git a/docs/part-1/5-3_debug-first-app-ide.md b/docs/part-1/debug-ide.md index 0473892..0473892 100644 --- a/docs/part-1/5-3_debug-first-app-ide.md +++ b/docs/part-1/debug-ide.md diff --git a/docs/part-1/5_debug-first-app.md b/docs/part-1/debug-overview.md index e1bdffd..e1bdffd 100644 --- a/docs/part-1/5_debug-first-app.md +++ b/docs/part-1/debug-overview.md |