XDS - X(cross) Development System Server

XDS-server is a web server that allows user to remotely cross build applications.

The first goal is to provide a multi-platform cross development tool with near-zero installation. The second goals is to keep application sources locally (on user's machine) to make it compatible with existing IT policies (e.g. corporate backup or SCM).

This powerful webserver (written in Go) exposes a REST interface over HTTP and also provides a Web dashboard to configure projects and execute only (for now) basics commands.

XDS-server also uses Syncthing tool to synchronize projects files from user machine to build server machine or container.

NOTE: For now, only Syncthing sharing method is supported to synchronize projects files.

SEE ALSO: xds-make, a wrapper on make command that allows you to build your application from command-line through xds-server.

How to build

Dependencies

Install and setup Go version 1.7 or higher to compile this tool.
Install npm : sudo apt install npm
Install gulp : sudo npm install -g gulp-cli

Building

Clone this repo into your $GOPATH/src/github.com/iotbzh and use delivered Makefile:

 mkdir -p $GOPATH/src/github.com/iotbzh
 cd $GOPATH/src/github.com/iotbzh
 git clone https://github.com/iotbzh/xds-server.git
 cd xds-server
 make all

And to install xds-server in /usr/local/bin:

make install

How to run

Configuration

xds-server configuration is driven by a JSON config file (config.json).

Here is the logic to determine which config.json file will be used:

from command line option: --config myConfig.json
$HOME/.xds/config.json file
<current dir>/config.json file
<xds-server executable dir>/config.json file

Supported fields in configuration file are:

{
    "webAppDir": "location of client dashboard (default: webapp/dist)",
    "shareRootDir": "root directory where projects will be copied",
    "logsDir": "directory to store logs (eg. syncthing output)",
    "sdkRootDir": "root directory where cross SDKs are installed",
    "syncthing": {
        "binDir": "syncthing binaries directory (default: executable directory)",
        "home": "syncthing home directory (usually .../syncthing-config)",
        "gui-address": "syncthing gui url (default http://localhost:8384)",
        "gui-apikey": "syncthing api-key to use (default auto-generated)"
    }
}

NOTE: environment variables are supported by using ${MY_VAR} syntax.

Start-up

Use xds-server-start.sh script to start all requested tools

/usr/local/bin/xds-server-start.sh

NOTE you can define some environment variables to setup for example config file XDS_CONFFILE or change logs directory LOGDIR. See head section of xds-server-start.sh file to see all configurable variables.

Install XDS-server in AGL SDK docker container

XDS-server has been designed to easily cross compile AGL applications. That's why XDS-server is integrated in AGL SDK docker container.

NOTE For more info about AGL SDK docker container, please refer to AGL SDK Quick Setup

Create XDS AGL docker worker container

You can either load a pre-build docker image or rebuild this image with latest source code.

load pre-build docker image:

wget http://iot.bzh/download/public/2017/XDS/docker/docker_agl_worker-xds-3.2.tar.xz | docker load

OR execute following commands to rebuild docker image:

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

docker images
REPOSITORY                                      TAG                 IMAGE ID            CREATED             SIZE
docker.automotivelinux.org/agl/worker-xds       3.2                 786d65b2792c        6 days ago          602MB

Start XDS AGL docker worker container

Use provided script to create a new docker image and start a new container:

> ./docker-worker-generator/contrib/create_container 0 docker.automotivelinux.org/agl/worker-xds:3.2

> docker ps
CONTAINER ID        IMAGE                                               COMMAND                  CREATED              STATUS              PORTS                                                                                         NAMES
b985d81af40c        docker.automotivelinux.org/agl/worker-xds:3.2       "/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:

8000 : XDS-server to serve XDS Dashboard
69 : TFTP
2222 : ssh

Now start xds-server inside this container:

> ssh -p 2222 devel@localhost
[15:59:58] devel@agl-worker-seb-laptop-0-seb:~$ /usr/local/bin/xds-server-start.sh
### 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

You can now connect your browser to XDS-server (running by default on port 8000): http://localhost:8000

Debugging

XDS server architecture

The server part is written in Go and web app / dashboard (client part) in Angular2.

|
+-- bin/                where xds-server binary file will be built
|
+-- config.json.in      example of config.json file
|
+-- glide.yaml          Go package dependency file
|
+-- lib/                sources of server part (Go)
|
+-- main.go             main entry point of of Web server (Go)
|
+-- Makefile            makefile including
|
+-- README.md           this readme
|
+-- scripts/            hold various scripts used for installation or startup
|
+-- tools/              temporary directory to hold development tools (like glide)
|
+-- vendor/             temporary directory to hold Go dependencies packages
|
+-- webapp/             source client dashboard (Angular2 app)

Visual Studio Code launcher settings can be found into .vscode/launch.json.

TODO:

replace makefile by build.go to make Windows build support easier
add more tests
add more documentation
add authentication / login (oauth) + HTTPS
enable syncthing user/password + HTTPS

dominig/xds-server