diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/part-2/0_Abstract.md | 45 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server.md | 34 | ||||
| -rw-r--r-- | docs/part-2/2_xds-agent.md | 29 | ||||
| -rw-r--r-- | docs/part-2/3_xds-cli.md | 6 | ||||
| -rw-r--r-- | docs/part-2/4_xds-gdb.md | 6 |
5 files changed, 63 insertions, 57 deletions
diff --git a/docs/part-2/0_Abstract.md b/docs/part-2/0_Abstract.md index 45f5f40..aa7ddc4 100644 --- a/docs/part-2/0_Abstract.md +++ b/docs/part-2/0_Abstract.md @@ -4,3 +4,48 @@ This 2nd part is the "technical" documentation of all XDS pieces/tools that allows for example to fine tune XDS configuration or rebuild all XDS tools from scratch. + +## Prerequisites + +To build xds binaries you need to install first [Go](https://golang.org/doc/install) version 1.8.1 or higher and some other tools. To build `xds-server` and `xds-agent` +you also need to install in addition `nodejs`. + +**Ubuntu:** + +```bash +# Install various tools +sudo apt-get install git make npm curl git zip unzip + +# Install Go +source /etc/os-release +wget -O- "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x52B59B1571A79DBC054901C0F6BC817356A3D45E" | sudo apt-key add - +sudo bash -c "cat >> /etc/apt/sources.list.d/golang.list <<EOF +deb http://ppa.launchpad.net/longsleep/golang-backports/ubuntu ${VERSION_CODENAME} main +EOF" +sudo apt-get update +sudo apt-get install golang-go + +# Install nodejs LTS version and angular-cli (only mandatory for xds-server and xds-agent) +sudo npm install --global n @angular/cli +sudo n lts +``` + +**openSUSE:** + +```bash +# Install various tools +sudo zypper install git make npm curl zip unzip + +# Install Go +# ( the value 'DISTRO' can be set to {openSUSE_Leap_42.2, openSUSE_Leap_42.3, openSUSE_Tumbleweed} ) +source /etc/os-release; export DISTRO="openSUSE_Leap_$VERSION" +sudo zypper ar http://download.opensuse.org/repositories/devel:/languages:/go/${DISTRO}/devel:languages:go.repo +sudo zypper --gpg-auto-import-keys ref +sudo zypper install go1.9 + +# Install nodejs LTS version and angular-cli (only mandatory for xds-server and xds-agent) +sudo npm install --global n @angular/cli +sudo n lts +``` + +Don't forget to open new user session after installing these packages. diff --git a/docs/part-2/1_xds-server.md b/docs/part-2/1_xds-server.md index b4022b2..2c31b1e 100644 --- a/docs/part-2/1_xds-server.md +++ b/docs/part-2/1_xds-server.md @@ -401,29 +401,9 @@ See also [xds-agent documentation](2_xds-agent.html) for more details. ### Dependencies -- Install and setup [Go](https://golang.org/doc/install) version 1.8.1 or higher to compile this tool. -- Install [npm](https://www.npmjs.com/) -- Install [nodejs](https://nodejs.org/en/) - -Ubuntu: - -```bash - sudo apt-get install golang npm curl git zip unzip - sudo npm install --global n @angular/cli # Angular Command Line Interface - # Install LTS version of nodejs - sudo n lts -``` - -openSUSE: - -```bash - sudo zypper install go npm git curl zip unzip - sudo npm install --global n @angular/cli # Angular Command Line Interface - # Install LTS version of nodejs - sudo n lts -``` - -Don't forget to open new user session after installing the packages. +Install [Go](https://golang.org/doc/install), [npm](https://www.npmjs.com/), +[nodejs](https://nodejs.org/en/) and some other tools. +Refer to [Prerequisites chapter](./0_Abstract.html#prerequisites) for more details. ### Building @@ -434,12 +414,16 @@ Create a GOPATH variable(must be a full path): ```bash export GOPATH=$(realpath ~/workspace_go) ``` +SEB Rework GOPATH inscrutions + Clone this repo into your `$GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds` and use delivered Makefile: ```bash - mkdir -p $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds - cd $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds +export GOPATH=${GOPATH}:${ROOTDIR} + + mkdir -p $ROOTDIR/src/gerrit.automotivelinux.org/gerrit/src/xds + cd $ROOTDIR/src/gerrit.automotivelinux.org/gerrit/src/xds git clone https://gerrit.automotivelinux.org/gerrit/src/xds/xds-server # or git clone ssh://YOUR_USERNAME@gerrit.automotivelinux.org:29418/src/xds/xds-server cd xds-server diff --git a/docs/part-2/2_xds-agent.md b/docs/part-2/2_xds-agent.md index 7d08a16..ce03ae7 100644 --- a/docs/part-2/2_xds-agent.md +++ b/docs/part-2/2_xds-agent.md @@ -71,32 +71,9 @@ You can now use XDS dashboard and check that connection with `xds-agent` is up. ### Dependencies -Install and setup [Go](https://golang.org/doc/install) version 1.8.1 or higher to compile this tool. - ->**Note:** for Ubuntu, you can use a PPA, see [https://github.com/golang/go/wiki/Ubuntu](https://github.com/golang/go/wiki/Ubuntu) - -Install [npm](https://www.npmjs.com/), [nodejs](https://nodejs.org/en/) and -some other tools - -Ubuntu: - -```bash - sudo apt-get install golang npm curl git zip unzip - sudo npm install --global n @angular/cli # Angular Command Line Interface - # Install LTS version of nodejs - sudo n lts -``` - -openSUSE: - -```bash - sudo zypper install go npm git curl zip unzip - sudo npm install --global n @angular/cli # Angular Command Line Interface - # Install LTS version of nodejs - sudo n lts -``` - -Don't forget to open new user session after installing the packages. +Install [Go](https://golang.org/doc/install), [npm](https://www.npmjs.com/), +[nodejs](https://nodejs.org/en/) and some other tools. +Refer to [Prerequisites chapter](./0_Abstract.html#prerequisites) for more details. ### Building diff --git a/docs/part-2/3_xds-cli.md b/docs/part-2/3_xds-cli.md index 3820b22..a4ccca5 100644 --- a/docs/part-2/3_xds-cli.md +++ b/docs/part-2/3_xds-cli.md @@ -165,10 +165,10 @@ xds-cli misc sts ## How to build -### Prerequisites +### Dependencies - You must install and setup [Go](https://golang.org/doc/install) version 1.8.1 or - higher to compile this tool. +Install [Go](https://golang.org/doc/install) and some other tools. +Refer to [Prerequisites chapter](./0_Abstract.html#prerequisites) for more details. ### Building diff --git a/docs/part-2/4_xds-gdb.md b/docs/part-2/4_xds-gdb.md index 8bb47aa..6185ce9 100644 --- a/docs/part-2/4_xds-gdb.md +++ b/docs/part-2/4_xds-gdb.md @@ -94,10 +94,10 @@ Example of gdb init file where we define project and sdk ID: ## How to build xds-gdb from scratch -### Prerequisites +### Dependencies - You must install and setup [Go](https://golang.org/doc/install) version 1.8.1 or - higher to compile this tool. +Install [Go](https://golang.org/doc/install) and some other tools. +Refer to [Prerequisites chapter](./0_Abstract.html#prerequisites) for more details. ### Building |