Merge pull request #1309 from rina23q/improvement/1232/doc-update-thin-edge

Improve installation guide of thin-edge

1 files changed, 48 insertions, 20 deletions

diff --git a/docs/src/howto-guides/002_installation.md b/docs/src/howto-guides/002_installation.md
index d69974c5..8c9ea23d 100644
--- a/docs/src/howto-guides/002_installation.md
+++ b/docs/src/howto-guides/002_installation.md
@@ -10,13 +10,56 @@ curl -fsSL https://raw.githubusercontent.com/thin-edge/thin-edge.io/main/get-thi
 
 You can execute that command on your device and it will do all required steps for an initial setup.
 
-If you prefer to have a little more control over the installation or the script did not work for you, please go on with the following steps.
+> Note: If you want to get a specific version, add `<version>` at the end like below. 
+> `<version>` is consist of 3 digits, e.g. `0.7.3`.
+> ```shell
+> curl -fsSL https://raw.githubusercontent.com/thin-edge/thin-edge.io/main/get-thin-edge_io.sh | sudo sh -s <version>
+> ```
+
+If you prefer to have a little more control over the installation or the script did not work for you,
+please go on with the [manual installation steps](#manual-installation-steps).
+
+## Upgrade thin-edge.io with get-thin-edge_io.sh script
+
+If you already have `thin-edge.io` on your device, to upgrade `thin-edge.io`,
+the easiest way is to use the same script as the installation. Follow the steps below.
+there is no need to remove old version.
+
+> Note: To successfully upgrade `thin-edge.io` all thin-edge.io components **must be stopped**. The components are:
+> `tedge-mapper-c8y`, `tedge-mapper-az`, `tedge-mapper-collectd`, `tedge-agent`, `c8y-log-plugin`, `c8y-configuration-plugin`.
+>
+> To stop `tedge-mapper-c8y`, `tedge-agent`, `tedge-mapper-az`, you can simply run the commands below.
+> 
+> ```shell
+> sudo tedge disconnect c8y
+> sudo tedge disconnect az
+> ```
+> 
+> To stop each component one by one, this is an example how to stop them with `systemctl`:
+> 
+> ```shell
+> systemctl stop tedge-mapper-c8y
+> systemctl stop tedge-agent
+> systemctl stop c8y-log-plugin
+> ```
 
-## Manual installation steps
+Then, run `get-thin-edge_io.sh` script as below to upgrade to the latest version.
+
+```shell
+curl -fsSL https://raw.githubusercontent.com/thin-edge/thin-edge.io/main/get-thin-edge_io.sh | sudo sh -s
+```
+
+> Note: If you want to upgrade to a specific version, add `<version>` at the end like below.
+> `<version>` is consist of 3 digits, e.g. `0.7.3`.
+> ```shell
+> curl -fsSL https://raw.githubusercontent.com/thin-edge/thin-edge.io/main/get-thin-edge_io.sh | sudo sh -s <version>
+> ```
+
+## thin-edge.io manual installation
 
 To install thin edge package it is required to use `curl` to download the package and `dpkg` to install it.
 
-## Dependency installation
+### Dependency installation
 
 thin-edge.io has single dependency and it is `mosquitto` used for communication southbound and northbound e.g. southbound, devices can publish measurements; northbound, gateway may relay messages to cloud.
 `mosquitto` can be installed with your package manager. For apt the command may look as following:
@@ -31,22 +74,7 @@ apt install mosquitto
 sudo apt install mosquitto
 ```
 
-## `thin-edge.io` installation
-
-When all dependencies are in place you can proceed with installation of `thin-edge.io cli` and `thin-edge.io mapper` service.
-
-### Upgrading `thin-edge.io`
-
-If you already have `thin-edge.io` on your device to upgrade `thin-edge.io` follow the steps below, there is no need to remove old version.
-
-> Note: To successfully upgrade `thin-edge.io` all thin-edge.io components should be stopped, eg: `tedge-mapper` and `tedge-agent`:
->
-> ```shell
-> systemctl stop tedge-mapper-c8y
-> systemctl stop tedge-agent
-> ```
-
-### Package download
+### thin-edge.io package download
 
 thin-edge.io package is in thin-edge.io repository on GitHub: [thin-edge.io](https://github.com/thin-edge/thin-edge.io/releases).
 
@@ -73,7 +101,7 @@ and for `mapper`:
 curl -LJO https://github.com/thin-edge/thin-edge.io/releases/download/0.5.0/tedge_mapper_0.5.0_armhf.deb
 ```
 
-### Package installation
+### thin-edge.io package installation
 
 Now, we have downloaded the package we can proceed to installation. First we will install cli tool `tedge`.