README.md

   1 # XDS - X(cross) Development System Server
   2
   3 `xds-server` is a web server that allows user to remotely cross build applications.
   4
   5 The first goal is to provide a multi-platform cross development tool with
   6 near-zero installation.
   7 The second goal is to keep application sources locally (on user's machine) to
   8 make it compatible with existing IT policies (e.g. corporate backup or SCM),
   9 and let user to continue to work as usual (use his favorite editor,
  10 keep performance while editing/browsing sources).
  11
  12 This powerful and portable webserver (written in [Go](https://golang.org))
  13 exposes a REST interface over HTTP and also provides a Web dashboard to configure projects and execute _(for now)_ only basics commands.
  14
  15 `xds-server` uses [Syncthing](https://syncthing.net/) tool to synchronize
  16 projects files from user machine to build server machine or container.
  17
  18 > **NOTE**: For now, only Syncthing sharing method is supported to synchronize
  19 projects files. But in a near future and for restricted configurations, `xds-server`
  20 will also support "standard" folder sharing (eg. nfs mount points or docker
  21 volumes).
  22
  23 > **SEE ALSO**: [xds-exec](https://github.com/iotbzh/xds-exec),
  24 wrappers on `exec` commands that allows you to send commands to `xds-server`
  25 and for example build your application from command-line or from your favorite
  26 IDE (such as Netbeans or Visual Studio Code) through `xds-server`.
  27
  28 ## How to run
  29
  30 `xds-server` has been designed to easily compile and debug
  31 [AGL](https://www.automotivelinux.org/) applications. That's why `xds-server` has
  32 been integrated into AGL SDK docker container.
  33
  34 >**NOTE** For more info about AGL SDK docker container, please refer to
  35 [AGL SDK Quick Setup](http://docs.automotivelinux.org/docs/getting_started/en/dev/reference/setup-sdk-environment.html)
  36
  37 ### Get the container
  38
  39 Load the pre-build AGL SDK docker image including `xds-server`:
  40 ```bash
  41 wget -O - http://iot.bzh/download/public/2017/XDS/docker/docker_agl_worker-xds-latest.tar.xz | docker load
  42 ```
  43
  44 ### List container
  45 You should get `docker.automotivelinux.org/agl/worker-xds:X.Y` image
  46
  47 ```bash
  48 # List image that we just built
  49 docker images | grep worker-xds
  50
  51 docker.automotivelinux.org/agl/worker-xds       3.2                 786d65b2792c        6 days ago          602MB
  52 ```
  53
  54 ### Start xds-server within the container
  55
  56 Use provided script to create a new docker image and start a new container:
  57 ```bash
  58 # Get script
  59 wget https://raw.githubusercontent.com/iotbzh/xds-server/master/scripts/xds-docker-create-container.sh
  60 # [snip...]
  61
  62 # Create new XDS worker container
  63 bash ./xds-docker-create-container.sh 0 docker.automotivelinux.org/agl/worker-xds:3.99.1
  64 # [snip...]
  65
  66 # Check that new container is running
  67 docker ps | grep worker-xds
  68
  69 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
  70 ```
  71
  72 This container (ID=0) exposes following ports:
  73   - 8000 : `xds-server` to serve XDS Dashboard
  74   - 69   : TFTP
  75   - 2222 : ssh
  76
  77 **`xds-server` is automatically started** as a service on container startup.
  78
  79 If the container is running on your localhost, you can access the web interface (what we call the "Dashboard"):
  80 ```bash
  81 xdg-open http://localhost:8000
  82 ```
  83
  84 If needed you can status / stop / start  it manually using following commands:
  85 ```bash
  86 # Log into docker container
  87 ssh -p 2222 devel@localhost
  88
  89 # Status XDS server:
  90 sudo systemctl status xds-server.service
  91
  92 # Stop XDS server
  93 sudo systemctl stop xds-server.service
  94
  95 # Start XDS server
  96 sudo systemctl start xds-server.service
  97
  98 # Get XDS server logs
  99 sudo journalctl --unit=xds-server.service --output=cat
 100 Starting XDS Server...
 101 ### Configuration in config.json:
 102 {
 103 "webAppDir": "/var/www/xds-server",
 104 "shareRootDir": "/home/devel/.xds/projects",
 105 "sdkRootDir": "/xdt/sdk",
 106 "syncthing": {
 107 "home": "/home/devel/.xds/syncthing-config",
 108 "gui-address": "http://localhost:8384"
 109 }
 110 }
 111 Downloading xds-agent_darwin-amd64-v0.1.0_59b0682.zip... OK
 112 Downloading xds-agent_linux-amd64-v0.1.0_59b0682.zip... OK
 113 Downloading xds-agent_windows-amd64-v0.1.0_59b0682.zip... OK
 114 ### Start XDS server
 115 nohup /usr/local/bin/xds-server --config /home/devel/.xds/config.json -log info > /tmp/xds-server/logs/xds-server.lo
 116 pid=140
 117 Started XDS Server.
 118 ```
 119
 120 ### Manually Start XDS server
 121
 122 XDS server is started as a service by Systemd.
 123 ```bash
 124 /lib/systemd/system/xds-server.service
 125 ```
 126 This Systemd service starts a bash script `/usr/local/bin/xds-server-start.sh`
 127
 128 If you needed you can change default setting by defining specific environment variables in `/etc/default/xds-server`.
 129 For example to control log level, just set LOGLEVEL env variable knowing that supported *level* are: panic, fatal, error, warn, info, debug.
 130 ```bash
 131 echo 'LOGLEVEL=debug' | sudo tee --append /etc/default/xds-server > /dev/null
 132 sudo systemctl restart xds-server.service
 133 tail -f /tmp/xds-server/logs/xds-server.log
 134 ```
 135
 136 ### Install SDK cross-toolchain
 137
 138 `xds-server` uses cross-toolchain install into directory pointed by `sdkRootDir` setting (see configuration section below for more details).
 139 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.
 140
 141 Use provided `install-agl-sdks` script, for example to install SDK for ARM64 and Intel corei7-64:
 142
 143 ```bash
 144 # Install ARM64 SDK (automatic download)
 145 /usr/local/bin/xds-utils/install-agl-sdks.sh --arch aarch64
 146
 147 # Install Intel corei7-64 SDK (using an SDK tarball that has been built or downloaded manually)
 148 /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-
 149 3.99.1+snapshot.sh
 150
 151 ```
 152
 153 ### XDS Dashboard
 154
 155 `xds-server` serves a web-application (default port 8000). :
 156 [http://localhost:8000](http://localhost:8000) ). So you can now connect your browser to this url and use what we call the **XDS dashboard**.
 157
 158 Then follow instructions provided by this dashboard, knowing that the first time
 159 you need to download and start `xds-agent` on your local machine.
 160
 161 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).
 162
 163 See also `xds-agent` [README file](https://github.com/iotbzh/xds-agent) for more details.
 164
 165 ## Build xds-server from scratch
 166
 167 ### Dependencies
 168
 169 - Install and setup [Go](https://golang.org/doc/install) version 1.7 or
 170 higher to compile this tool.
 171 - Install [npm](https://www.npmjs.com/)
 172 - Install [gulp](http://gulpjs.com/)
 173
 174 Ubuntu:
 175
 176 ```bash
 177  sudo apt-get install golang npm curl git zip
 178  sudo npm install -g gulp-cli
 179 ```
 180
 181 openSUSE:
 182
 183 ```bash
 184  sudo zypper install go npm git curl zip
 185  sudo npm install -g gulp-cli
 186 ```
 187
 188 Don't forget to open new user session after installing the packages.
 189
 190 ### Building
 191
 192 #### Native build
 193
 194 Create a GOPATH variable(must be a full path):
 195 ```bash
 196  export GOPATH=$(realpath ~/workspace_go)
 197 ```
 198
 199 Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile:
 200 ```bash
 201  mkdir -p $GOPATH/src/github.com/iotbzh
 202  cd $GOPATH/src/github.com/iotbzh
 203  git clone https://github.com/iotbzh/xds-server.git
 204  cd xds-server
 205  make all
 206 ```
 207
 208 And to install `xds-server` (by default in `/usr/local/bin`):
 209 ```bash
 210  make install
 211 ```
 212
 213 >**NOTE:** Used `DESTDIR` to specify another install directory
 214 >```bash
 215 >make install DESTDIR=$HOME/opt/xds-server
 216 >```
 217
 218 #### XDS docker image
 219
 220 As an alternative to a pre-build image, you can rebuild the container from scratch.
 221 `xds-server` has been integrated as a flavour of AGL SDK docker image.
 222 So to rebuild docker image just execute following commands:
 223
 224 ```bash
 225 # Clone docker-worker-generator git repo
 226 git clone https://git.automotivelinux.org/AGL/docker-worker-generator
 227 # Start build that will create a docker image
 228 cd docker-worker-generator
 229 make build FLAVOUR=xds
 230 ```
 231
 232 ### Configuration
 233
 234 `xds-server` configuration is driven by a JSON config file (`config.json`).
 235
 236 Here is the logic to determine which `config.json` file will be used:
 237 1. from command line option: `--config myConfig.json`
 238 2. `$HOME/.xds/config.json` file
 239 3. `<current dir>/config.json` file
 240 4. `<xds-server executable dir>/config.json` file
 241
 242 Supported fields in configuration file are (all fields are optional and listed values are the default values):
 243 ```
 244 {
 245     "HTTPPort": 8000,
 246     "webAppDir": "webapp/dist",                     # location of client dashboard (default: webapp/dist)
 247     "shareRootDir": "${HOME}/.xds/projects",        # root directory where projects will be copied
 248     "logsDir": "/tmp/logs",                         # directory to store logs (eg. syncthing output)
 249     "sdkRootDir": "/xdt/sdk",                       # root directory where cross SDKs are installed
 250     "syncthing": {
 251         "binDir": "./bin",                          # syncthing binaries directory (default: executable directory)
 252         "home": "${HOME}/.xds/syncthing-config",    # syncthing home directory (usually .../syncthing-config)
 253         "gui-address": "http://localhost:8384",     # syncthing gui url (default http://localhost:8384)
 254         "gui-apikey": "123456789",                  # syncthing api-key to use (default auto-generated)
 255     }
 256 }
 257 ```
 258
 259 >**NOTE:** environment variables are supported by using `${MY_VAR}` syntax.
 260
 261
 262 ## Debugging
 263
 264 ### XDS server architecture
 265
 266 The server part is written in *Go* and web app / dashboard (client part) in
 267 *Angular2*.
 268
 269 ```
 270 |
 271 +-- bin/                where xds-server binary file will be built
 272 |
 273 +-- agent-config.json.in      example of config.json file
 274 |
 275 +-- glide.yaml          Go package dependency file
 276 |
 277 +-- lib/                sources of server part (Go)
 278 |
 279 +-- main.go             main entry point of of Web server (Go)
 280 |
 281 +-- Makefile            makefile including
 282 |
 283 +-- README.md           this readme
 284 |
 285 +-- scripts/            hold various scripts used for installation or startup
 286 |
 287 +-- tools/              temporary directory to hold development tools (like glide)
 288 |
 289 +-- vendor/             temporary directory to hold Go dependencies packages
 290 |
 291 +-- webapp/             source client dashboard (Angular2 app)
 292 ```
 293
 294 Visual Studio Code launcher settings can be found into `.vscode/launch.json`.
 295
 296
 297 ## TODO:
 298
 299 - replace makefile by build.go to make Windows build support easier
 300 - add more tests
 301 - add more documentation
 302 - add authentication / login (oauth) + HTTPS
 303 - enable syncthing user/password + HTTPS