Merge pull request #36 from thin-edge/feat-bootstrap-improvements

feat: add bootstrapping options

Author: reubenmiller

.gitignore

@@ -9,3 +9,6 @@ src/tedge/bin/tedge
 tmp/
 /tedge-*
 binaries/zig-mosquitto/
+log.html
+output.xml
+report.html

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python3",
+    "robot.language-server.python": "${workspaceFolder}/.venv/bin/python3",
+    "robot.python.executable": "${workspaceFolder}/.venv/bin/python3",
+    "robot.pythonpath": [
+        "${workspaceFolder}/tests/RobotFramework/.venv/bin/python3"
+    ],
+    "python.envFile": "${workspaceFolder}/.env"
+}

README.md

@@ -44,7 +44,7 @@ wget -q -O - https://raw.githubusercontent.com/thin-edge/tedge-standalone/main/i
 curl -fsSL https://raw.githubusercontent.com/thin-edge/tedge-standalone/main/install.sh | sh -s -- --install-path /data
 ```
 
-Then, follow the instructions printed out on the console to bootstrap (configure) and then start the services. However if you are planning on using Cumulocity's basic authentication, then you need to run the following section before running the `bootstrap.sh` script.
+Then, follow the instructions printed out on the console to bootstrap (configure) and then start the services.
 
 ### Install without wget/curl
 
@@ -66,11 +66,24 @@ Before running the `bootstrap.sh` script, you will need to set the device's cred
 For example, if you installed thin-edge.io under `/data` then you can set the credentials using the following snippet:
 
 ```sh
-cat <<EOT > /data/tedge/credentials.toml
+./bootstrap.sh --device-user "{tenant}/device_{external_id}" --device-password "{password}" --c8y-url {CumulocityURL}
+
+# example
+./bootstrap.sh --device-user "t12345/device_tedge-abcdef" --device-password 'ex4amp!3' --c8y-url example.cumulocity.com
+```
+
+Alternative, you can set the `credentials.toml` under the installed directory, e.g. `/data/tedge/credentials.toml` (if you're using the default installation directory):
+
+```sh
 [c8y]
 username = "{tenant}/device_{external_id}"
 password = "{password}"
-EOT
+```
+
+For [go-c8y-cli](https://goc8ycli.netlify.app/) users, you can register a device and generate randomized credentials using the following command. The device's username (including tenant) and password will be printed out on the console, and then you can provide the values to the `bootstrap.sh` script. 
+
+```sh
+c8y deviceregistration register-basic --id tedge-abcdef
 ```
 
 ## Automatically starting services
@@ -103,7 +116,7 @@ Assuming you have already launched the custom `runsvdir` instance, the following
 Before running any of the command you need to load the environment variables using the following one-liner:
 
 ```sh
-set -a; . /data/tedge/env; set +a
+. /data/tedge/env
 ```
 
 ### Start services

docs/Luckfox.md

@@ -59,7 +59,7 @@ Install thin-edge.io standalone on a Luckfox Pico device using the following ste
 
     ```sh
     load_tedge_env() {
-        set -a; . /opt/tedge/env; set +a;
+        . /opt/tedge/env;
     }
     load_tedge_env
     ```

install.sh

@@ -36,7 +36,7 @@ EXAMPLE
     # Install under a custom location but install the non-upx'd versions
 
     $0 --install-path /home/etc --overwrite
-    # Install under a custom location and overrite any existing configuration files
+    # Install under a custom location and overwrite any existing configuration files
 
     $0 --file ./tedge-standalone-arm64.tar.gz --install-path /home/root
     # Install from a manually downloaded file and install under a custom path
@@ -183,11 +183,26 @@ main() {
     echo
     echo "Configure and start thin-edge.io using the following command:"
     echo
-    echo "    $INSTALL_PATH/tedge/bootstrap.sh"
+    echo Option 1: Register using Cumulocity Certificate Authority
+    echo
+    echo "    $INSTALL_PATH/tedge/bootstrap.sh --ca c8y --c8y-url 'example.cumulocity.com'"
+    echo
+    echo "    $INSTALL_PATH/tedge/bootstrap.sh --ca c8y --c8y-url 'example.cumulocity.com' --device-id tedge01"
+    echo
+    echo
+    echo Option 2: Register using Cumulocity self-signed certificate
+    echo
+    echo "    $INSTALL_PATH/tedge/bootstrap.sh --ca c8y --c8y-url 'example.cumulocity.com' --device-id tedge01"
+    echo
+    echo
+    echo "Option 3: Register using Cumulocity Basic Authorization Credentials (pre-registered)"
+    echo
+    echo "    $INSTALL_PATH/tedge/bootstrap.sh --c8y-url 'example.cumulocity.com' --device-user 't12345/device_tedge01' --device-password 'ex4ampl3['"
+    echo
     echo
     echo Import the shell environment using:
     echo
-    echo "    set -a; . '$INSTALL_PATH/tedge/env'; set +a"
+    echo "    . '$INSTALL_PATH/tedge/env'"
     echo
 }
 

justfile

@@ -4,3 +4,17 @@ PACKAGE := "tedge-standalone"
 # Build static binaries and create the tarball package
 build target target_name *args:
     ./scripts/build.sh --target {{target}} --target-name {{target_name}} --package {{PACKAGE}} {{args}}
+
+# Build artifacts to be used in system tests
+build-test:
+    just build aarch64-linux-musl arm64-noupx --skip-upx
+    just build aarch64-linux-musl arm64
+
+# Install python virtual environment
+venv:
+  [ -d .venv ] || python3 -m venv .venv
+  ./.venv/bin/pip3 install -r tests/requirements.txt
+
+# Run tests
+test *args='':
+  ./.venv/bin/python3 -m robot.run --outputdir output {{args}} tests

src/tedge/bin/tedgectl

@@ -5,10 +5,8 @@ export SVDIR="${SVDIR:-/run/services}"
 export RUNIT_SRCDIR="${RUNIT_SRCDIR:-@CONFIG_DIR@/services}"
 
 if [ -f @CONFIG_DIR@/env ]; then
-    set -a
     # shellcheck disable=SC1091
     . @CONFIG_DIR@/env
-    set +a
 fi
 
 manage_runit() {
@@ -20,9 +18,17 @@ manage_runit() {
             # Check if runit instance is active
             pgrep -f "runsvdir -P $SVDIR" >/dev/null 2>&1
             ;;
-        start) sv start "$name" ;;
-        stop) sv stop "$name" ;;
-        restart) sv restart "$name" ;;
+        start)
+            manage_runit enable "$name" ||:
+            sv start "$name" ||:
+            ;;
+        stop)
+            sv stop "$name" ||:
+            ;;
+        restart)
+            manage_runit enable "$name" ||:
+            sv restart "$name" ||:
+            ;;
         enable)
             if [ ! -d "$SVDIR/$name" ]; then
                 ln -s "$RUNIT_SRCDIR/$name" "$SVDIR/"