Update Quick Start description for all HW platforms (#411)

Signed-off-by: Taras Drozdovskyi <[email protected]>
lf-edge · Oct 29, 2021 · 34c3da4 · 34c3da4
1 parent 2b179a7
commit 34c3da4
Show file tree

Hide file tree

Showing 6 changed files with 136 additions and 10 deletions.
diff --git a/docs/platforms/hikey960/hikey960.md b/docs/platforms/hikey960/hikey960.md
@@ -23,26 +23,55 @@ After starting Linux, you need to run the `nmtui` to configure the Wi-Fi.
 
 > login/password - linaro/linaro
 
-Docker installation:
+Everything is now ready to deploy Edge-Orchestration
+
+---
+
+## Quick start
+This section provides how to download and run pre-built Docker image without building the project.
+
+#### 1. Install docker
+
+- docker
+
 ```sh
 curl -sSL https://get.docker.com | sh
 sudo usermod -aG docker $USER
 newgrp docker
 ```
-Everything is now ready to deploy Edge-Orchestration
 
----
+#### 2. Download Docker image from [Docker Hub](https://hub.docker.com/r/lfedge/edge-home-orchestration-go/tags)
 
-## Quick start 
-This section provides how to download and run pre-built Docker image without building the project.
+To download the image, you must execute the command: `docker pull lfedge/edge-home-orchestration-go:{tag}`, where `{tag}` is a release name.
+```shell
+docker pull lfedge/edge-home-orchestration-go:latest
+```
+If it succeeds, you can see the Docker image as follows:
+```shell
+docker images
+
+REPOSITORY                            TAG           IMAGE ID            CREATED             SIZE
+lfedge/edge-home-orchestration-go     latest        740bcf622152        6 hours ago         161MB
+```
+
+#### 3. Run with Docker image
 
-> TBD
+How to run see [here](../x86_64_linux/x86_64_linux.md#how-to-work).
 
 ---
 
 ## How to build Edge-Orchestration
 
-Prerequisites: install the qemu packages
+Prerequisites: install the docker and qemu packages
+
+- Docker
+```sh
+curl -sSL https://get.docker.com | sh
+sudo usermod -aG docker $USER
+newgrp docker
+```
+- Qemu packages
+
 ```shell
 sudo apt-get install qemu binfmt-support qemu-user-static
 ```

diff --git a/docs/platforms/orange_pi3/orange_pi3.md b/docs/platforms/orange_pi3/orange_pi3.md
@@ -19,7 +19,33 @@ Insert the SD card into the Orange Pi 3 and turn on the power. Make configuratio
 ## Quick start
 This section provides how to download and run pre-built Docker image without building the project.
 
-> TBD
+#### 1. Install docker
+
+- docker
+```
+sudo update-alternatives --set iptables /usr/sbin/iptables-legacy
+sudo update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy
+curl -sSL https://get.docker.com | sh
+sudo usermod -aG docker $USER
+newgrp docker
+```
+#### 2. Download Docker image from [Docker Hub](https://hub.docker.com/r/lfedge/edge-home-orchestration-go/tags)
+
+To download the image, you must execute the command: `docker pull lfedge/edge-home-orchestration-go:{tag}`, where `{tag}` is a release name.
+```shell
+docker pull lfedge/edge-home-orchestration-go:latest
+```
+If it succeeds, you can see the Docker image as follows:
+```shell
+docker images
+
+REPOSITORY                            TAG           IMAGE ID            CREATED             SIZE
+lfedge/edge-home-orchestration-go     latest        740bcf622152        6 hours ago         161MB
+```
+
+#### 3. Run with Docker image
+
+How to run see [here](../x86_64_linux/x86_64_linux.md#how-to-work).
 
 ---
 

diff --git a/docs/platforms/raspberry_pi3/raspberry_pi3.md b/docs/platforms/raspberry_pi3/raspberry_pi3.md
@@ -19,7 +19,33 @@ Insert the SD card into the Raspberry pi 3 and turn on the power. Make configura
 ## Quick start
 This section provides how to download and run pre-built Docker image without building the project.
 
-> TBD
+#### 1. Install docker
+
+- docker
+
+```sh
+curl -sSL https://get.docker.com | sh
+sudo usermod -aG docker $USER
+newgrp docker
+```
+
+#### 2. Download Docker image from [Docker Hub](https://hub.docker.com/r/lfedge/edge-home-orchestration-go/tags)
+
+To download the image, you must execute the command: `docker pull lfedge/edge-home-orchestration-go:{tag}`, where `{tag}` is a release name.
+```shell
+docker pull lfedge/edge-home-orchestration-go:latest
+```
+If it succeeds, you can see the Docker image as follows:
+```shell
+docker images
+
+REPOSITORY                            TAG           IMAGE ID            CREATED             SIZE
+lfedge/edge-home-orchestration-go     latest        740bcf622152        6 hours ago         161MB
+```
+
+#### 3. Run with Docker image
+
+How to run see [here](../x86_64_linux/x86_64_linux.md#how-to-work).
 
 ---
 

diff --git a/docs/platforms/raspberry_pi3_cluster/raspberry_pi3_cluster.md b/docs/platforms/raspberry_pi3_cluster/raspberry_pi3_cluster.md
@@ -35,7 +35,33 @@ And you should [enable ssh](https://www.raspberrypi.org/documentation/remote-acc
 ## Quick start
 This section provides how to download and run pre-built Docker image without building the project.
 
-> TBD
+#### 1. Install docker
+
+- docker
+
+```sh
+curl -sSL https://get.docker.com | sh
+sudo usermod -aG docker $USER
+newgrp docker
+```
+
+#### 2. Download Docker image from [Docker Hub](https://hub.docker.com/r/lfedge/edge-home-orchestration-go/tags)
+
+To download the image, you must execute the command: `docker pull lfedge/edge-home-orchestration-go:{tag}`, where `{tag}` is a release name.
+```shell
+docker pull lfedge/edge-home-orchestration-go:latest
+```
+If it succeeds, you can see the Docker image as follows:
+```shell
+docker images
+
+REPOSITORY                            TAG           IMAGE ID            CREATED             SIZE
+lfedge/edge-home-orchestration-go     latest        740bcf622152        6 hours ago         161MB
+```
+
+#### 3. Run with Docker image
+
+How to run see [here](../x86_64_linux/x86_64_linux.md#how-to-work).
 
 ---
 

diff --git a/docs/platforms/x86_64_linux/x86_64_linux.md b/docs/platforms/x86_64_linux/x86_64_linux.md
@@ -9,6 +9,7 @@ This section provides how to download and run pre-built Docker image without bui
   - [How to install](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/)
 
 #### 2. Download Docker image from [Docker Hub](https://hub.docker.com/r/lfedge/edge-home-orchestration-go/tags)
+To download the image, you must execute the command: `docker pull lfedge/edge-home-orchestration-go:{tag}`, where `{tag}` is a release name.
 ```shell
 docker pull lfedge/edge-home-orchestration-go:latest
 ```

diff --git a/tools/manifest.yaml b/tools/manifest.yaml
@@ -0,0 +1,18 @@
+image: lfedge/edge-home-orchestration-go:latest
+manifests:
+  - image: lfedge/edge-home-orchestration-go:latest-amd64
+    platform:
+      architecture: amd64
+      os: linux
+  - image: lfedge/edge-home-orchestration-go:latest-i386
+    platform:
+      architecture: 386
+      os: linux
+  - image: lfedge/edge-home-orchestration-go:latest-arm64
+    platform:
+      architecture: arm64
+      os: linux
+  - image: lfedge/edge-home-orchestration-go:latest-arm32
+    platform:
+      architecture: arm
+      os: linux