From b83238ff17f8e27d7526e872a21583deaf4e79bf Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Fri, 5 Jan 2018 01:26:11 +0100 Subject: Bump v1.0.0 and various changes. - bump v1.0.0 - update download/public links - remove prompt in command shell output - update SDK install / remove --- README.md | 2 +- book.json | 4 +- docs/0-Doc-Revisions.md | 1 + docs/README.md | 2 +- docs/cover.jpg | Bin 294957 -> 289362 bytes docs/cover_small.jpg | Bin 18525 -> 18768 bytes docs/part-1/0_Abstract.md | 2 +- docs/part-1/1_install-client.md | 32 +++++------ docs/part-1/2_install-xds-server.md | 60 ++++++++++----------- docs/part-1/3_install-sdks.md | 102 ++++++++++++++++++++++++++---------- docs/part-2/1_xds-server.md | 27 +++++----- 11 files changed, 141 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index 857d712..d6706ee 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,4 @@ Resulting documentation is available : - online: [http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide) -- PDF file: [http://iot.bzh/download/public/2017/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/2017/XDS/docs/XDS_UsersGuide.pdf) +- PDF file: [http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf) diff --git a/book.json b/book.json index 4d15e08..156a120 100644 --- a/book.json +++ b/book.json @@ -5,8 +5,8 @@ "keywords": "AGL, XDS, cross, Development, Iotbzh", "author": "Sebastien Douheret", "website": "http://iot.bzh", - "published": "November 2017", - "version": "1.0.0-rc1", + "published": "January 2018", + "version": "1.0.0", "gitbook": "3.2.2", "root": "docs", diff --git a/docs/0-Doc-Revisions.md b/docs/0-Doc-Revisions.md index c0ca786..cdd8941 100644 --- a/docs/0-Doc-Revisions.md +++ b/docs/0-Doc-Revisions.md @@ -6,3 +6,4 @@ Document revisions | Sept 2017 | 0.1 | Initial release | S. Douheret [ Iot.bzh ] | | Oct 2017 | 0.2 | Various updates to match new behavior | S. Douheret [ Iot.bzh ] | | Nov 2017 | 1.0.0-rc1 | Updates to match v1.0.0-rc1 behavior | S. Douheret [ Iot.bzh ] | +| Jan 2018 | 1.0.0 | Add VM appliance and document new SDK management | S. Douheret, R. Le Martret [ Iot.bzh ] | diff --git a/docs/README.md b/docs/README.md index fca70e9..89b908c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ cross build applications. This documentation is available : - online: [http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide) -- PDF file: [http://iot.bzh/download/public/2017/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/2017/XDS/docs/XDS_UsersGuide.pdf) +- PDF file: [http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf)

diff --git a/docs/cover.jpg b/docs/cover.jpg index 1100177..e106be5 100644 Binary files a/docs/cover.jpg and b/docs/cover.jpg differ diff --git a/docs/cover_small.jpg b/docs/cover_small.jpg index c7d8c26..d75bddd 100644 Binary files a/docs/cover_small.jpg and b/docs/cover_small.jpg differ diff --git a/docs/part-1/0_Abstract.md b/docs/part-1/0_Abstract.md index 7badf42..8def883 100644 --- a/docs/part-1/0_Abstract.md +++ b/docs/part-1/0_Abstract.md @@ -8,7 +8,7 @@ for cross development with near-zero installation. This documentation is available : - online: [http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide) -- PDF file: [http://iot.bzh/download/public/2017/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/2017/XDS/docs/XDS_UsersGuide.pdf) +- PDF file: [http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf) The first goal of XDS is to provide a multi-platform cross development tool with near-zero installation. diff --git a/docs/part-1/1_install-client.md b/docs/part-1/1_install-client.md index 7d0299f..304b46a 100644 --- a/docs/part-1/1_install-client.md +++ b/docs/part-1/1_install-client.md @@ -25,31 +25,31 @@ optional and depends of what you want to do : ```bash # 'DISTRO' can be set to { xUbuntu_16.04, xUbuntu_16.10, xUbuntu_17.04, Debian_8.0, Debian_9.0 } -seb@laptop ~$ export DISTRO="xUbuntu_16.04" +export DISTRO="xUbuntu_16.04" -seb@laptop ~$ wget -O - http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Development/${DISTRO}/Release.key | sudo apt-key add - -seb@laptop ~$ sudo bash -c "cat >> /etc/apt/sources.list.d/AGL.list <> /etc/apt/sources.list.d/AGL.list <8000/tcp, 0.0.0.0:69->69/udp, 0.0.0.0:10809->10809/tcp, 0.0.0.0:2222->22/tcp agl-xds-seb@laptop-0-seb ``` @@ -62,7 +62,7 @@ to use for example with Path-Mapping folder type. ```bash # Create new XDS worker container and share extra '$HOME/my-workspace' directory -seb@laptop ~$ bash ./xds-docker-create-container.sh --volume /my-workspace:$HOME/my-workspace +bash ./xds-docker-create-container.sh --volume /my-workspace:$HOME/my-workspace ``` ### Check if xds-server is running @@ -75,7 +75,7 @@ web page that gives you some instructions: ```bash # if container 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 +xdg-open http://localhost:8000 ``` `xds-server` is now up and running, you can now install AGL SDKs, please refer @@ -99,7 +99,7 @@ inside and outside docker): | $USER_VOLUME | $USER_VOLUME | user path, see `--volume` option of `xds-docker-create-container.sh` script | -Please refer to [part 2 - xds-server](../part-2/1_xds-server.md) documentation +Please refer to [part 2 - xds-server](../part-2/1_xds-server.md#sdk-cross-toolchain-management) documentation for additional info. @@ -123,20 +123,20 @@ wget http://iot.bzh/download/public/XDS/appliance/xds-vm-debian9_latest.ova You must have one and one xds appliance only. -So, at first remove the oldest xds appliance. +So, first remove the oldest xds appliance if needed. ```bash -#Get the virtual machine name +# Get the virtual machine name VDS_VMNAME=$(VBoxManage list vms | grep xds-vm-debian | cut -d "\"" -f2) echo ${VDS_VMNAME} -#Remove old XDS appliance +# 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: +Used provided script to create a new appliance or you can use VirtualBox GUI: ```bash # Import image into VirtualBox @@ -152,7 +152,7 @@ echo ${VDS_VMNAME} ### Appliance settings -This container (ID=0) exposes following ports: +This image exposes following network ports (NAT mode): - 8000 : `xds-server` to serve XDS basic web page - 69 : TFTP @@ -167,7 +167,7 @@ To check if xds-server is correctly install and running, you can access the basi ```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 +xdg-open http://localhost:8000 ``` `xds-server` is now up and running, you can now install AGL SDKs, please refer @@ -183,27 +183,27 @@ installation ! ```bash # 'DISTRO' can be set to { xUbuntu_16.04, xUbuntu_16.10, xUbuntu_17.04, Debian_8.0, Debian_9.0} -seb@laptop ~$ export DISTRO="xUbuntu_16.04" +export DISTRO="xUbuntu_16.04" -seb@laptop ~$ wget -O - http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Development/${DISTRO}/Release.key | sudo apt-key add - -seb@laptop ~$ sudo bash -c "cat >> /etc/apt/sources.list.d/AGL.list <> /etc/apt/sources.list.d/AGL.list < -**Warning:** due to some limitation, you need for now to restart `xds-server` in -order to make new installed SDK visible/available. +SDK ID d65fe750-d3a7-38f5-83d8-3d3806054f8d successfully installed. + + +# Abort an installation that is in progress +xds-cli sdks abort -id d65fe750 + +# Install a SDK (using a local SDK package/file) +xds-cli sdks install --file $HOME/xds-workspace/sdks/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain-4.99.5.sh -```bash -seb@laptop ~$ ssh -p 2222 devel@localhost -devel@docker ~$ systemctl --user restart xds-server.service ``` - + +Installation based on a local SDK package is only supported when SDK file package +is located in `$HOME/xds-workspace/sdks` directory + + +## Install a new SDK from XDS Dashboard + +Open XDS-Dashboard in web-browser and select `SDKs` entry in left side menu. +Then switch to `SDKs MANAGEMENT` view : + +![](../part-1/pictures/xds-dashboard-sdks-mgt.png){:: style="margin:auto; display:flex"} + +Use filter boxes to find the SDK you want to install and then click on plus +icon (Actions column) to start installation. SDK download and installation +process may take several minutes and output of installation script (output of +`add` script mentioned in above chapter). + +![](../part-1/pictures/xds-dashboard-sdks-install.png){:: style="margin:auto; display:flex"} + +Note that you can abort installation by clicking on `CANCEL` button. + +## More info + +Please refer to [xds-server](../part-2/1_xds-server.md) chapter for more details +about SDKs management. diff --git a/docs/part-2/1_xds-server.md b/docs/part-2/1_xds-server.md index 6ecbdc9..3ed32c9 100644 --- a/docs/part-2/1_xds-server.md +++ b/docs/part-2/1_xds-server.md @@ -44,7 +44,7 @@ been integrated into AGL SDK docker container. Load the pre-build AGL SDK docker image including `xds-server`: ```bash -wget -O - http://iot.bzh/download/public/2017/XDS/docker/docker_agl_worker-xds-latest.tar.xz | docker load +wget -O - http://iot.bzh/download/public/XDS/docker/docker_agl_worker-xds-latest.tar.xz | docker load ``` ### List container @@ -235,19 +235,20 @@ Used `sdks` command of `xds-cli` tool to managed SDKs. xds-cli sdks ls -a List of available SDKs: - ID NAME STATUS VERSION ARCH - ec15afe0 AGL-release-eel-4.99.4-raspberrypi3 Not Installed 4.99.4 armv7vehf-neon-vfpv4 - 944d2d5a AGL-snapshots-master-latest-intel-corei7-64 Not Installed 4.99.3+snapshot corei7-64 - cf3a4365 AGL-release-dab-4.0.2-qemux86-64 Not Installed 4.0.2 corei7-64 - d65fe750 AGL-release-eel-latest-qemux86-64 Not Installed 4.99.3 corei7-64 - a0ae663d poky-agl-corei7-64-3.99.1+snapshot Installed 3.99.1+snapshot corei7-64 - 87f0400b AGL-release-dab-3.99.3-m3ulcb-nogfx Installed 3.99.3 aarch64 - 8c2f2841 AGL-release-dab-4.0.2-dragonboard-410c Not Installed 4.0.2 aarch64 +ID NAME STATUS VERSION ARCH +ec15afe0 AGL-release-eel-4.99.4-raspberrypi3 Not Installed 4.99.4 armv7vehf-neon-vfpv4 +944d2d5a AGL-snapshots-master-latest-intel-corei7-64 Not Installed 4.99.3+snapshot corei7-64 +cf3a4365 AGL-release-dab-4.0.2-qemux86-64 Not Installed 4.0.2 corei7-64 +d65fe750 AGL-release-eel-latest-qemux86-64 Not Installed 4.99.3 corei7-64 +a0ae663d poky-agl-corei7-64-3.99.1+snapshot Installed 3.99.1+snapshot corei7-64 +87f0400b AGL-release-dab-3.99.3-m3ulcb-nogfx Installed 3.99.3 aarch64 +8c2f2841 AGL-release-dab-4.0.2-dragonboard-410c Not Installed 4.0.2 aarch64 ... # Install a SDK (downloaded + install) xds-cli sdks install d65fe750 -Installation of 'AGL-release-eel-latest-qemux86-64' SDK (id d65fe750-d3a7-38f5-83d8-3d3806054f8d) successfully started. + +Installation of 'AGL-release-eel-latest-qemux86-64' SDK successfully started. Downloading poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain-4.99.5.sh ... --2018-01-02 11:22:23-- https://download.automotivelinux.org/AGL/release/eel/latest/qemux86-64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain-4.99.5.sh Resolving download.automotivelinux.org (download.automotivelinux.org)... 199.19.213.77 @@ -259,7 +260,6 @@ Saving to: ‘/tmp/tmp.wuQzLdImCS/poky-agl-glibc-x86_64-agl-demo-platform-crosss 0K .......... .......... .......... .......... .......... 0% 82,7K 2h11m 50K .......... .......... .......... .......... .......... 0% 89,1K 2h6m 100K .......... .......... .......... .......... .......... 0% 82,0K 2h8m - 150K .......... .......... .......... .......... .......... 0% 66,7K 2h16m ... 50300K .......... .......... .......... .......... .......... 99% 2,15M 0s 650350K .......... .......... .......... ....... 100% 4,04M=10m35s @@ -275,6 +275,8 @@ SDK has been successfully set up and is ready to be used. Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. $ . /xdt/sdk/poky-agl/4.99.5/corei7-64/environment-setup-corei7-64-agl-linux +SDK ID d65fe750-d3a7-38f5-83d8-3d3806054f8d successfully installed. + # Abort an installation that is in progress xds-cli sdks abort -id d65fe750 @@ -330,7 +332,8 @@ SDK ID d65fe750-d3a7-38f5-83d8-3d3806054f8d successfully deleted. #### Un-install a SDK from XDS Dashboard Open XDS-Dashboard in web-browser and select `SDKs` entry in left side menu. -If needed, switch to `BASIC SDKS VIEW` view : +If needed, switch to `BASIC SDKS VIEW` view and click on trash icon located +in the top-right corner of SDK card. ### XDS server REST API and Web application -- cgit 1.2.3-korg