From 94bcf90898e8b17811075eb693e0d96d753b8d8b Mon Sep 17 00:00:00 2001
From: Sebastien Douheret <sebastien.douheret@iot.bzh>
Date: Thu, 4 Oct 2018 11:57:13 +0200
Subject: Invert order of installation chapters

To make install process more understandable, document
first installation of xds-server part and then installation
of xds tools.

Bug: SPEC-1993

Change-Id: I5733c5d6885f45ff98cc9fee0d04362f76a86a4c
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
---
 docs/part-1/1-2_install-xds-server-vm.md | 84 ++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 docs/part-1/1-2_install-xds-server-vm.md

(limited to 'docs/part-1/1-2_install-xds-server-vm.md')

diff --git a/docs/part-1/1-2_install-xds-server-vm.md b/docs/part-1/1-2_install-xds-server-vm.md
new file mode 100644
index 0000000..32a8c20
--- /dev/null
+++ b/docs/part-1/1-2_install-xds-server-vm.md
@@ -0,0 +1,84 @@
+# Installation based on Virtual Machine appliance
+
+## Virtual Machine appliance 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, first remove the oldest xds appliance if needed.
+
+```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 controlvm ${VDS_VMNAME} poweroff
+[ -n ${VDS_VMNAME} ] && VBoxManage unregistervm ${VDS_VMNAME} --delete
+```
+
+## Create and start a new appliance
+
+Used provided script to create a new appliance or you can use VirtualBox GUI:
+
+```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}
+```
+
+Add share folder to appliance, **mandatory** to use **path-mapping sharing type for projects**:
+
+```bash
+# Create local share folder
+mkdir -p $HOME/xds-workspace
+
+#Add share folder to appliance
+vboxmanage sharedfolder add ${VDS_VMNAME} --name XDS-workspace --hostpath $HOME/xds-workspace
+```
+
+Start appliance
+
+```bash
+# Start XDS appliance
+[ -n ${VDS_VMNAME} ] && VBoxManage startvm ${VDS_VMNAME}
+```
+
+## Appliance settings
+
+This image exposes following network ports (NAT mode):
+
+- 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)
+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.html)
-- 
cgit 1.2.3-korg