X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=3b8200170a2a4957c255b05bb8b6c500ec51b7de;hb=2d3e49e1e92206147b6ab7b191e525fa3ac6f2a5;hp=a5d4440f330d04ddcc2055c6d53b0e25af458ea9;hpb=3c8eb8fc21c844cd162cb0dc1d013d116fbfb282;p=src%2Fxds%2Fxds-server.git diff --git a/README.md b/README.md index a5d4440..3b82001 100644 --- a/README.md +++ b/README.md @@ -20,35 +20,42 @@ 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 ``` ### 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 -> 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 ``` @@ -58,12 +65,20 @@ This container exposes following ports: - 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 needed you can stop / start it manually using following commands: ```bash -> ssh -p 2222 devel@localhost +# Log into docker container +ssh -p 2222 devel@localhost + +# Stop XDS server +[15:59:58] devel@agl-worker-seb-laptop-0-seb:~$ /usr/local/bin/xds-server-stop.sh + +# Start XDS server [15:59:58] devel@agl-worker-seb-laptop-0-seb:~$ /usr/local/bin/xds-server-start.sh ``` -You should get the following output: + +On `xds-server` startup, you should get the following output: ``` ### Configuration in config.json: { @@ -87,12 +102,31 @@ pid=22379 >**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` -You can now connect your browser to `xds-server` (running by default on port 8000): -[http://localhost:8000](http://localhost:8000) +### 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 --aarch 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 --aarch corei7-64 --file /tmp/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain- +3.99.1+snapshot.sh + +``` + +### XDS Dashboard + +`xds-server` serves a web-application (default port 8000: +[http://localhost:8000](http://localhost:8000) ). So you can now connect your browser to this url and use what we call the **XDS dashboard**. -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. 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. @@ -107,7 +141,6 @@ 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` - ### Building Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile: @@ -140,7 +173,7 @@ 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 +``` { "webAppDir": "webapp/dist", # location of client dashboard (default: webapp/dist) "shareRootDir": "${HOME}/.xds/projects", # root directory where projects will be copied @@ -157,7 +190,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 @@ -175,7 +207,9 @@ See head section of `xds-server-start.sh` file to see all configurable variables `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 ``` @@ -183,7 +217,9 @@ make build FLAVOUR=xds You should get `docker.automotivelinux.org/agl/worker-xds:X.Y` image ```bash +# List image that we just built docker images + REPOSITORY TAG IMAGE ID CREATED SIZE docker.automotivelinux.org/agl/worker-xds 3.2 786d65b2792c 6 days ago 602MB ```