diff options
author | Ronan Le Martret <ronan.lemartret@iot.bzh> | 2018-01-04 17:49:21 +0100 |
---|---|---|
committer | Ronan Le Martret <ronan.lemartret@iot.bzh> | 2018-01-04 17:49:21 +0100 |
commit | 814deb494598e26bc410e60e2a55a0b04f85c2bf (patch) | |
tree | 74e02572b31f7bdfa30e4f89c22105ac84aa7bff /docs/part-1 | |
parent | 75b88569a0ff0c1bd0a62a00bf3916393296561e (diff) |
Update Documentation for Virtual machine
Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh>
Diffstat (limited to 'docs/part-1')
-rw-r--r-- | docs/part-1/1_install-client.md | 6 | ||||
-rw-r--r-- | docs/part-1/2_install-xds-server.md | 70 | ||||
-rw-r--r-- | docs/part-1/3_install-sdks.md | 2 |
3 files changed, 73 insertions, 5 deletions
diff --git a/docs/part-1/1_install-client.md b/docs/part-1/1_install-client.md index a1c2a4e..7d0299f 100644 --- a/docs/part-1/1_install-client.md +++ b/docs/part-1/1_install-client.md @@ -4,7 +4,6 @@ on your machine (user / developer host) to be able to use XDS. You should establish the following chain: - Client (eg. `xds-cli` or XDS Dashboard) and `xds-agent` is running on your machine and `xds-server` is running on a remote server and/or in a container. Exchanges between these 3 tools are done though HTTP and Websocket protocols @@ -62,8 +61,9 @@ seb@laptop ~$ sudo zypper install agl-xds-gdb 1. Then unzip the tarball any where into your local disk (for example: `/opt/AGL/xds` or `C:\AGL\xds`). 1. Add binary to PATH: - - MacOs: create the .bash_profile `nano .bash_profile` and add `export PATH="/opt/AGL/xds/xds-agent:$PATH` - - Windows: change the system path via control panel or system settings or + + - MacOs: create the .bash_profile `nano .bash_profile` and add `export PATH="/opt/AGL/xds/xds-agent:$PATH` + - Windows: change the system path via control panel or system settings or `setx path "C:\AGK\xds\xds-agent;%path%"` - repeat the previous steps to install other tools depending of your needs: diff --git a/docs/part-1/2_install-xds-server.md b/docs/part-1/2_install-xds-server.md index 5460da8..c992f35 100644 --- a/docs/part-1/2_install-xds-server.md +++ b/docs/part-1/2_install-xds-server.md @@ -103,9 +103,75 @@ Please refer to [part 2 - xds-server](../part-2/1_xds-server.md) documentation for additional info. <!-- endnote --> -## Installation based on VirtualBox appliance +## Installation based on Virtual Machine appliance -_coming soon ..._ +### Prerequisites + +> VirtualBox is installed on the host machine + +please refer to [VirtualBox documentation](https://www.virtualbox.org/wiki/Downloads) for more details. + +### Get the appliance + +Load the pre-build AGL SDK appliance image including `xds-server`: + +```bash +wget http://iot.bzh/download/public/XDS/appliance/xds-vm-debian9_latest.ova +``` + +### Clean old appliance + +You must have one and one xds appliance only. + +So, at first remove the oldest xds appliance. + +```bash +#Get the virtual machine name +VDS_VMNAME=$(VBoxManage list vms | grep xds-vm-debian | cut -d "\"" -f2) +echo ${VDS_VMNAME} + +#Remove old XDS appliance +[ -n ${VDS_VMNAME} ] && VBoxManage unregistervm ${VDS_VMNAME} --delete +``` + +### Create and start a new appliance + +Use provided script to create a new appliance or you can use the UI of VirtualBox: + +```bash +# Import image into VirtualBox +VBoxManage import ./xds-vm-debian9_latest.ova + +# Check import result +VDS_VMNAME=$(VBoxManage list vms | grep xds-vm-debian | cut -d "\"" -f2) +echo ${VDS_VMNAME} + +# Start XDS appliance +[ -n ${VDS_VMNAME} ] && VBoxManage startvm ${VDS_VMNAME} +``` + +### Appliance settings + +This container (ID=0) exposes following ports: + +- 8000 : `xds-server` to serve XDS basic web page +- 69 : TFTP +- 2222 : ssh + +## Check if xds-server is running + +`xds-server` is automatically started as a service on container startup. + +To check if xds-server is correctly install and running, you can access the basic web page that gives you some instructions: + +```bash +# if container/appliance is running on your local host +# (else replace localhost by the name or the ip of the machine running the container) +seb@laptop ~$ xdg-open http://localhost:8000 +``` + +`xds-server` is now up and running, you can now install AGL SDKs, please refer +to next chapter named [Installing AGL SDKs](3_install-sdks.md#installing-agl-sdks) ## Native installation diff --git a/docs/part-1/3_install-sdks.md b/docs/part-1/3_install-sdks.md index 3ea342e..e1cdd07 100644 --- a/docs/part-1/3_install-sdks.md +++ b/docs/part-1/3_install-sdks.md @@ -39,8 +39,10 @@ devel@docker ~$ sudo /opt/AGL/xds/server/xds-utils/install-agl-sdks.sh --arch co <!-- warning --> **Warning:** due to some limitation, you need for now to restart `xds-server` in order to make new installed SDK visible/available. + ```bash seb@laptop ~$ ssh -p 2222 devel@localhost devel@docker ~$ systemctl --user restart xds-server.service ``` + <!-- endwarning --> |