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 ```
 101
 102 ### Manually Start XDS server
 103
 104 XDS server is started as a service by Systemd.
 105 ```bash
 106 /lib/systemd/system/xds-server.service
 107 ```
 108 This Systemd service starts a bash script `/usr/local/bin/xds-server-start.sh`
 109
 110 If you needed you can change default setting by defining specific environment variables in `/etc/default/xds-server`.
 111 For example to control log level, just set LOGLEVEL env variable knowing that supported *level* are: panic, fatal, error, warn, info, debug.
 112 ```bash
 113 echo 'LOGLEVEL=debug' | sudo tee --append /etc/default/xds-server > /dev/null
 114 sudo systemctl restart xds-server.service
 115 tail -f /tmp/xds-server/logs/xds-server.log
 116 ```
 117
 118 ### Install SDK cross-toolchain
 119
 120 `xds-server` uses cross-toolchain install into directory pointed by `sdkRootDir` setting (see configuration section below for more details).
 121 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.
 122
 123 Use provided `install-agl-sdks` script, for example to install SDK for ARM64 and Intel corei7-64:
 124
 125 ```bash
 126 # Install ARM64 SDK (automatic download)
 127 /usr/local/bin/xds-utils/install-agl-sdks.sh --arch aarch64
 128
 129 # Install Intel corei7-64 SDK (using an SDK tarball that has been built or downloaded manually)
 130 /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-
 131 3.99.1+snapshot.sh
 132
 133 ```
 134
 135 ### XDS Dashboard
 136
 137 `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**.
 138 ```bash
 139 xdg-open http://localhost:8000
 140 ```
 141
 142 Then follow instructions provided by this dashboard, knowing that the first time
 143 you need to download and start `xds-agent` on your local machine.
 144
 145 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).
 146
 147 See also `xds-agent` [README file](https://github.com/iotbzh/xds-agent) for more details.
 148
 149 ## Build xds-server from scratch
 150
 151 ### Dependencies
 152
 153 - Install and setup [Go](https://golang.org/doc/install) version 1.7 or
 154 higher to compile this tool.
 155 - Install [npm](https://www.npmjs.com/)
 156 - Install [gulp](http://gulpjs.com/)
 157
 158 Ubuntu:
 159
 160 ```bash
 161  sudo apt-get install golang npm curl git zip
 162  sudo npm install -g gulp-cli
 163 ```
 164
 165 openSUSE:
 166
 167 ```bash
 168  sudo zypper install go npm git curl zip
 169  sudo npm install -g gulp-cli
 170 ```
 171
 172 Don't forget to open new user session after installing the packages.
 173
 174 ### Building
 175
 176 #### Native build
 177
 178 Create a GOPATH variable(must be a full path):
 179 ```bash
 180  export GOPATH=$(realpath ~/workspace_go)
 181 ```
 182
 183 Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile:
 184 ```bash
 185  mkdir -p $GOPATH/src/github.com/iotbzh
 186  cd $GOPATH/src/github.com/iotbzh
 187  git clone https://github.com/iotbzh/xds-server.git
 188  cd xds-server
 189  make all
 190 ```
 191
 192 And to install `xds-server` (by default in `/usr/local/bin`):
 193 ```bash
 194  make install
 195 ```
 196
 197 >**NOTE:** Used `DESTDIR` to specify another install directory
 198 >```bash
 199 >make install DESTDIR=$HOME/opt/xds-server
 200 >```
 201
 202 #### XDS docker image
 203
 204 As an alternative to a pre-build image, you can rebuild the container from scratch.
 205 `xds-server` has been integrated as a flavour of AGL SDK docker image.
 206 So to rebuild docker image just execute following commands:
 207
 208 ```bash
 209 # Clone docker-worker-generator git repo
 210 git clone https://git.automotivelinux.org/AGL/docker-worker-generator
 211 # Start build that will create a docker image
 212 cd docker-worker-generator
 213 make build FLAVOUR=xds
 214 ```
 215
 216 ### Configuration
 217
 218 `xds-server` configuration is driven by a JSON config file (`config.json`).
 219
 220 Here is the logic to determine which `config.json` file will be used:
 221 1. from command line option: `--config myConfig.json`
 222 2. `$HOME/.xds/config.json` file
 223 3. `<current dir>/config.json` file
 224 4. `<xds-server executable dir>/config.json` file
 225
 226 Supported fields in configuration file are (all fields are optional and listed values are the default values):
 227 ```
 228 {
 229     "httpPort": 8000,                               # HTTP port of client webapp / dashboard
 230     "webAppDir": "webapp/dist",                     # location of client dashboard (default: webapp/dist)
 231     "shareRootDir": "${HOME}/.xds/projects",        # root directory where projects will be copied
 232     "logsDir": "/tmp/logs",                         # directory to store logs (eg. syncthing output)
 233     "sdkRootDir": "/xdt/sdk",                       # root directory where cross SDKs are installed
 234     "syncthing": {
 235         "binDir": "./bin",                          # syncthing binaries directory (default: executable directory)
 236         "home": "${HOME}/.xds/syncthing-config",    # syncthing home directory (usually .../syncthing-config)
 237         "gui-address": "http://localhost:8384",     # syncthing gui url (default http://localhost:8384)
 238         "gui-apikey": "123456789",                  # syncthing api-key to use (default auto-generated)
 239     }
 240 }
 241 ```
 242
 243 >**NOTE:** environment variables are supported by using `${MY_VAR}` syntax.
 244
 245
 246 ## Debugging
 247
 248 ### XDS server architecture
 249
 250 The server part is written in *Go* and web app / dashboard (client part) in
 251 *Angular2*.
 252
 253 ```
 254 |
 255 +-- bin/                where xds-server binary file will be built
 256 |
 257 +-- agent-config.json.in      example of config.json file
 258 |
 259 +-- glide.yaml          Go package dependency file
 260 |
 261 +-- lib/                sources of server part (Go)
 262 |
 263 +-- main.go             main entry point of of Web server (Go)
 264 |
 265 +-- Makefile            makefile including
 266 |
 267 +-- README.md           this readme
 268 |
 269 +-- scripts/            hold various scripts used for installation or startup
 270 |
 271 +-- tools/              temporary directory to hold development tools (like glide)
 272 |
 273 +-- vendor/             temporary directory to hold Go dependencies packages
 274 |
 275 +-- webapp/             source client dashboard (Angular2 app)
 276 ```
 277
 278 Visual Studio Code launcher settings can be found into `.vscode/launch.json`.
 279
 280
 281 ## TODO:
 282
 283 - replace makefile by build.go to make Windows build support easier
 284 - add more tests
 285 - add more documentation
 286 - add authentication / login (oauth) + HTTPS
 287 - enable syncthing user/password + HTTPS