X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=938360c4faa0eb523f9a40c179d5e3ed8506b1f0;hb=090c194da6d5da2c0c68faddf3879fed2997d2f8;hp=a5d4440f330d04ddcc2055c6d53b0e25af458ea9;hpb=3c8eb8fc21c844cd162cb0dc1d013d116fbfb282;p=src%2Fxds%2Fxds-server.git diff --git a/README.md b/README.md index a5d4440..938360c 100644 --- a/README.md +++ b/README.md @@ -20,83 +20,131 @@ projects files. But in a near future and for restricted configurations, `xds-ser will also support "standard" folder sharing (eg. nfs mount points or docker volumes). -> **SEE ALSO**: [xds-exec and xds-make](https://github.com/iotbzh/xds-make), -wrappers on `exec` and `make` commands that allows you to send command to -`xds-server` and consequently build your application from command-line or from -your favorite IDE (eg. Netbeans or Visual Studio Code) through `xds-server`. +> **SEE ALSO**: [xds-exec](https://github.com/iotbzh/xds-exec), +wrappers on `exec` commands that allows you to send commands to `xds-server` +and for example build your application from command-line or from your favorite +IDE (such as Netbeans or Visual Studio Code) through `xds-server`. ## How to run -`xds-server` has been designed to easily cross compile +`xds-server` has been designed to easily compile and debug [AGL](https://www.automotivelinux.org/) applications. That's why `xds-server` has -been integrated in AGL SDK docker container. +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) -### Get container +### Get the container Load the pre-build AGL SDK docker image including `xds-server`: ```bash -wget http://iot.bzh/download/public/2017/XDS/docker/docker_agl_worker-xds-latest.tar.xz | docker load +wget -O - http://iot.bzh/download/public/2017/XDS/docker/docker_agl_worker-xds-latest.tar.xz | docker load +``` + +### List container +You should get `docker.automotivelinux.org/agl/worker-xds:X.Y` image + +```bash +# List image that we just built +docker images | grep worker-xds + +docker.automotivelinux.org/agl/worker-xds 3.2 786d65b2792c 6 days ago 602MB ``` ### Start xds-server within the container Use provided script to create a new docker image and start a new container: ```bash -> wget https://github.com/iotbzh/xds-server/blob/master/scripts/xds-docker-create-container.sh +# Get script +wget https://raw.githubusercontent.com/iotbzh/xds-server/master/scripts/xds-docker-create-container.sh +# [snip...] + +# Create new XDS worker container bash ./xds-docker-create-container.sh 0 docker.automotivelinux.org/agl/worker-xds:3.99.1 +# [snip...] + +# Check that new container is running +docker ps | grep worker-xds -> docker ps -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES b985d81af40c docker.automotivelinux.org/agl/worker-xds:3.99.1 "/usr/bin/wait_for..." 6 days ago Up 4 hours 0.0.0.0:8000->8000/tcp, 0.0.0.0:69->69/udp, 0.0.0.0:10809->10809/tcp, 0.0.0.0:2222->22/tcp agl-worker-seb-laptop-0-seb ``` -This container exposes following ports: +This container (ID=0) exposes following ports: - 8000 : `xds-server` to serve XDS Dashboard - 69 : TFTP - 2222 : ssh -Now you need to start manually `xds-server` inside this container: +**`xds-server` is automatically started** as a service on container startup. + +If the container is running on your localhost, you can access the web interface (what we call the "Dashboard"): ```bash -> ssh -p 2222 devel@localhost -[15:59:58] devel@agl-worker-seb-laptop-0-seb:~$ /usr/local/bin/xds-server-start.sh +xdg-open http://localhost:8000 ``` -You should get the following output: + +If needed you can status / stop / start it manually using following commands: +```bash +# Log into docker container +ssh -p 2222 devel@localhost + +# Status XDS server: +sudo systemctl status xds-server.service + +# Stop XDS server +sudo systemctl stop xds-server.service + +# Start XDS server +sudo systemctl start xds-server.service + +# Get XDS server logs +sudo journalctl --unit=xds-server.service --output=cat ``` -### Configuration in config.json: -{ - "webAppDir": "/usr/local/bin/www-xds-server", - "shareRootDir": "/home/devel/.xds/share", - "logsDir": "/tmp/xds-server/logs", - "sdkRootDir": "/xdt/sdk", - "syncthing": { - "binDir": "/usr/local/bin", - "home": "/home/devel/.xds/syncthing-config", - "gui-address": "http://localhost:8384", - "gui-apikey": "1234abcezam" - } -} -### Start XDS server -nohup /usr/local/bin/xds-server --config /home/devel/.xds/config.json -log warn > /tmp/xds-server/logs/xds-server.log 2>&1 -pid=22379 +### Manually Start XDS server + +XDS server is started as a service by Systemd. +```bash +/lib/systemd/system/xds-server.service +``` +This Systemd service starts a bash script `/usr/local/bin/xds-server-start.sh` + +If you needed you can change default setting by defining specific environment variables in `/etc/default/xds-server`. +For example to control log level, just set LOGLEVEL env variable knowing that supported *level* are: panic, fatal, error, warn, info, debug. +```bash +echo 'LOGLEVEL=debug' | sudo tee --append /etc/default/xds-server > /dev/null +sudo systemctl restart xds-server.service +tail -f /tmp/xds-server/logs/xds-server.log +``` + +### Install SDK cross-toolchain + +`xds-server` uses cross-toolchain install into directory pointed by `sdkRootDir` setting (see configuration section below for more details). +For now, you need to install manually SDK cross toolchain. There are not embedded into docker image by default because the size of these tarballs is too big. + +Use provided `install-agl-sdks` script, for example to install SDK for ARM64 and Intel corei7-64: + +```bash +# Install ARM64 SDK (automatic download) +/usr/local/bin/xds-utils/install-agl-sdks.sh --arch aarch64 + +# Install Intel corei7-64 SDK (using an SDK tarball that has been built or downloaded manually) +/usr/local/bin/xds-utils/install-agl-sdks.sh --arch corei7-64 --file /tmp/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain- +3.99.1+snapshot.sh + ``` ->**NOTE:** You can set LOGLEVEL env variable to increase log level if you need it. -> For example, to set log level to "debug" mode : ` LOGLEVEL=debug /usr/local/bin/xds-server-start.sh` +### XDS Dashboard -You can now connect your browser to `xds-server` (running by default on port 8000): -[http://localhost:8000](http://localhost:8000) +`xds-server` serves a web-application at [http://localhost:8000](http://localhost:8000) when XDS server is running on your host. Just replace `localhost` by the host name or ip when XDS server is running on another host. So you can now connect your browser to this url and use what we call the **XDS dashboard**. +```bash +xdg-open http://localhost:8000 +``` -Then follow instructions provided by dashboard, knowing that the first time you -must to download and start `xds-agent` on your local machine using download icon -in dashboard configuration page or download one of `xds-agent` [released tarball](https://github.com/iotbzh/xds-agent/releases). +Then follow instructions provided by this dashboard, knowing that the first time +you need to download and start `xds-agent` on your local machine. -See also `xds-agent` [README file](https://github.com/iotbzh/xds-agent) for more -details. +To download this tool, just click on download icon in dashboard configuration page or download one of `xds-agent` released tarball: [https://github.com/iotbzh/xds-agent/releases](https://github.com/iotbzh/xds-agent/releases). +See also `xds-agent` [README file](https://github.com/iotbzh/xds-agent) for more details. ## Build xds-server from scratch @@ -104,12 +152,34 @@ details. - Install and setup [Go](https://golang.org/doc/install) version 1.7 or higher to compile this tool. -- Install [npm](https://www.npmjs.com/) : `sudo apt install npm` -- Install [gulp](http://gulpjs.com/) : `sudo npm install -g gulp-cli` +- Install [npm](https://www.npmjs.com/) +- Install [gulp](http://gulpjs.com/) + +Ubuntu: + +```bash + sudo apt-get install golang npm curl git zip + sudo npm install -g gulp-cli +``` + +openSUSE: + +```bash + sudo zypper install go npm git curl zip + sudo npm install -g gulp-cli +``` +Don't forget to open new user session after installing the packages. ### Building +#### Native build + +Create a GOPATH variable(must be a full path): +```bash + export GOPATH=$(realpath ~/workspace_go) +``` + Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile: ```bash mkdir -p $GOPATH/src/github.com/iotbzh @@ -121,7 +191,7 @@ Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Make And to install `xds-server` (by default in `/usr/local/bin`): ```bash -make install + make install ``` >**NOTE:** Used `DESTDIR` to specify another install directory @@ -129,6 +199,20 @@ make install >make install DESTDIR=$HOME/opt/xds-server >``` +#### XDS docker image + +As an alternative to a pre-build image, you can rebuild the container from scratch. +`xds-server` has been integrated as a flavour of AGL SDK docker image. +So to rebuild docker image just execute following commands: + +```bash +# Clone docker-worker-generator git repo +git clone https://git.automotivelinux.org/AGL/docker-worker-generator +# Start build that will create a docker image +cd docker-worker-generator +make build FLAVOUR=xds +``` + ### Configuration `xds-server` configuration is driven by a JSON config file (`config.json`). @@ -140,8 +224,9 @@ Here is the logic to determine which `config.json` file will be used: 4. `/config.json` file Supported fields in configuration file are (all fields are optional and listed values are the default values): -```json +``` { + "httpPort": 8000, # HTTP port of client webapp / dashboard "webAppDir": "webapp/dist", # location of client dashboard (default: webapp/dist) "shareRootDir": "${HOME}/.xds/projects", # root directory where projects will be copied "logsDir": "/tmp/logs", # directory to store logs (eg. syncthing output) @@ -158,36 +243,6 @@ Supported fields in configuration file are (all fields are optional and listed v >**NOTE:** environment variables are supported by using `${MY_VAR}` syntax. -## Start-up - -Use `xds-server-start.sh` script to start all requested tools -```bash -/usr/local/bin/xds-server-start.sh -``` - ->**NOTE** you can define some environment variables to setup for example -logging level `LOGLEVEL` or change logs directory `LOGDIR`. -See head section of `xds-server-start.sh` file to see all configurable variables. - - -### Create XDS AGL docker worker container - -`xds-server` has been integrated as a flavour of AGL SDK docker image. So to rebuild -docker image just execute following commands: -```bash -git clone https://git.automotivelinux.org/AGL/docker-worker-generator -cd docker-worker-generator -make build FLAVOUR=xds -``` - -You should get `docker.automotivelinux.org/agl/worker-xds:X.Y` image - -```bash -docker images -REPOSITORY TAG IMAGE ID CREATED SIZE -docker.automotivelinux.org/agl/worker-xds 3.2 786d65b2792c 6 days ago 602MB -``` - ## Debugging ### XDS server architecture @@ -199,7 +254,7 @@ The server part is written in *Go* and web app / dashboard (client part) in | +-- bin/ where xds-server binary file will be built | -+-- config.json.in example of config.json file ++-- agent-config.json.in example of config.json file | +-- glide.yaml Go package dependency file |