Initial rally commits

.devcontainer/devcontainer.json

@@ -1,7 +1,7 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/javascript-node
 {
-  "name": "ns8-kickstart",
+  "name": "ns8-rally",
   "image": "mcr.microsoft.com/devcontainers/javascript-node:0-18-bullseye",
   // Configure tool-specific properties.
   "customizations": {

.github/workflows/clean-registry.yml

@@ -15,5 +15,5 @@ jobs:
     steps:
       - uses: NethServer/ns8-github-actions/.github/actions/delete-image@v1
         with:
-          images: "kickstart"
+          images: "rally"
           delete_image_token: ${{ secrets.IMAGES_CLEANUP_TOKEN }}

README.md

@@ -1,48 +1,20 @@
-# ns8-kickstart
+# ns8-rally
 
-This is a template module for [NethServer 8](https://github.com/NethServer/ns8-core).
-To start a new module from it:
-
-1. Click on [Use this template](https://github.com/NethServer/ns8-kickstart/generate).
-   Name your repo with `ns8-` prefix (e.g. `ns8-mymodule`). 
-   Do not end your module name with a number, like ~~`ns8-baaad2`~~!
-
-1. Clone the repository, enter the cloned directory and
-   [configure your GIT identity](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#_your_identity)
-
-1. Rename some references inside the repo:
-   ```
-   modulename=$(basename $(pwd) | sed 's/^ns8-//') &&
-   git mv imageroot/systemd/user/kickstart.service imageroot/systemd/user/${modulename}.service &&
-   git mv imageroot/systemd/user/kickstart-app.service imageroot/systemd/user/${modulename}-app.service && 
-   git mv tests/kickstart.robot tests/${modulename}.robot &&
-   sed -i "s/kickstart/${modulename}/g" $(find .github/ * -type f) &&
-   git commit -a -m "Repository initialization"
-   ```
-
-1. Edit this `README.md` file, by replacing this section with your module
-   description
-
-1. Adjust `.github/workflows` to your needs. `clean-registry.yml` might
-   need the proper list of image names to work correctly. Unused workflows
-   can be disabled from the GitHub Actions interface.
-
-1. Commit and push your local changes
 
 ## Install
 
 Instantiate the module with:
 
-    add-module ghcr.io/nethserver/kickstart:latest 1
+    add-module ghcr.io/geniusdynamics/rally:latest 1
 
 The output of the command will return the instance name.
 Output example:
 
-    {"module_id": "kickstart1", "image_name": "kickstart", "image_url": "ghcr.io/nethserver/kickstart:latest"}
+    {"module_id": "rally1", "image_name": "rally", "image_url": "ghcr.io/nethserver/rally:latest"}
 
 ## Configure
 
-Let's assume that the mattermost instance is named `kickstart1`.
+Let's assume that the rally instance is named `rally1`.
 
 Launch `configure-module`, by setting the following parameters:
 - `host`: a fully qualified domain name for the application
@@ -53,37 +25,37 @@ Launch `configure-module`, by setting the following parameters:
 Example:
 
 ```
-api-cli run configure-module --agent module/kickstart1 --data - <<EOF
+api-cli run configure-module --agent module/rally1 --data - <<EOF
 {
-  "host": "kickstart.domain.com",
+  "host": "rally.domain.com",
   "http2https": true,
   "lets_encrypt": false
 }
 EOF
 ```
 
 The above command will:
-- start and configure the kickstart instance
+- start and configure the rally instance
 - configure a virtual host for trafik to access the instance
 
 ## Get the configuration
 You can retrieve the configuration with
 
 ```
-api-cli run get-configuration --agent module/kickstart1
+api-cli run get-configuration --agent module/rally1
 ```
 
 ## Uninstall
 
 To uninstall the instance:
 
-    remove-module --no-preserve kickstart1
+    remove-module --no-preserve rally1
 
 ## Update
 
 To Update the instance:
 
-    api-cli run update-module --data '{"module_url":"ghcr.io/nethserver/kickstart:latest","instances":["kickstart1"],"force":true}'
+    api-cli run update-module --data '{"module_url":"ghcr.io/nethserver/rally:latest","instances":["rally1"],"force":true}'
 
 ## Smarthost setting discovery
 
@@ -92,14 +64,14 @@ Some configuration settings, like the smarthost setup, are not part of the
 Redis keys.  To ensure the module is always up-to-date with the
 centralized [smarthost
 setup](https://nethserver.github.io/ns8-core/core/smarthost/) every time
-kickstart starts, the command `bin/discover-smarthost` runs and refreshes
+rally starts, the command `bin/discover-smarthost` runs and refreshes
 the `state/smarthost.env` file with fresh values from Redis.
 
-Furthermore if smarthost setup is changed when kickstart is already
+Furthermore if smarthost setup is changed when rally is already
 running, the event handler `events/smarthost-changed/10reload_services`
 restarts the main module service.
 
-See also the `systemd/user/kickstart.service` file.
+See also the `systemd/user/rally.service` file.
 
 This setting discovery is just an example to understand how the module is
 expected to work: it can be rewritten or discarded completely.
@@ -108,34 +80,34 @@ expected to work: it can be rewritten or discarded completely.
 
 some CLI are needed to debug
 
-- The module runs under an agent that initiate a lot of environment variables (in /home/kickstart1/.config/state), it could be nice to verify them
+- The module runs under an agent that initiate a lot of environment variables (in /home/rally1/.config/state), it could be nice to verify them
 on the root terminal
 
-    `runagent -m kickstart1 env`
+    `runagent -m rally1 env`
 
 - you can become runagent for testing scripts and initiate all environment variables
 
-    `runagent -m kickstart1`
+    `runagent -m rally1`
 
  the path become : 
 ```
     echo $PATH
-    /home/kickstart1/.config/bin:/usr/local/agent/pyenv/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/usr/
+    /home/rally1/.config/bin:/usr/local/agent/pyenv/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/usr/
 ```
 
 - if you want to debug a container or see environment inside
- `runagent -m kickstart1`
+ `runagent -m rally1`
  ```
 podman ps
 CONTAINER ID  IMAGE                                      COMMAND               CREATED        STATUS        PORTS                    NAMES
 d292c6ff28e9  localhost/podman-pause:4.6.1-1702418000                          9 minutes ago  Up 9 minutes  127.0.0.1:20015->80/tcp  80b8de25945f-infra
 d8df02bf6f4a  docker.io/library/postgres:15.5-alpine3.19          --character-set-s...  9 minutes ago  Up 9 minutes  127.0.0.1:20015->80/tcp  postgresql-app
-9e58e5bd676f  docker.io/library/nginx:stable-alpine3.17  nginx -g daemon o...  9 minutes ago  Up 9 minutes  127.0.0.1:20015->80/tcp  kickstart-app
+9e58e5bd676f  docker.io/library/nginx:stable-alpine3.17  nginx -g daemon o...  9 minutes ago  Up 9 minutes  127.0.0.1:20015->80/tcp  rally-app
 ```
 
 you can see what environment variable is inside the container
 ```
-podman exec  kickstart-app env
+podman exec  rally-app env
 TERM=xterm
 container=podman
 NGINX_VERSION=1.24.0
@@ -150,15 +122,15 @@ HOME=/root
 you can run a shell inside the container
 
 ```
-podman exec -ti   kickstart-app sh
+podman exec -ti   rally-app sh
 / # 
 ```
 ## Testing
 
 Test the module using the `test-module.sh` script:
 
 
-    ./test-module.sh <NODE_ADDR> ghcr.io/nethserver/kickstart:latest
+    ./test-module.sh <NODE_ADDR> ghcr.io/nethserver/rally:latest
 
 The tests are made using [Robot Framework](https://robotframework.org/)
 

build-images.sh

@@ -11,24 +11,24 @@ set -e
 # Prepare variables for later use
 images=()
 # The image will be pushed to GitHub container registry
-repobase="${REPOBASE:-ghcr.io/nethserver}"
+repobase="${REPOBASE:-ghcr.io/geniusdynamics}"
 # Configure the image name
-reponame="kickstart"
+reponame="rally"
 
 # Create a new empty container image
 container=$(buildah from scratch)
 
-# Reuse existing nodebuilder-kickstart container, to speed up builds
-if ! buildah containers --format "{{.ContainerName}}" | grep -q nodebuilder-kickstart; then
+# Reuse existing nodebuilder-rally container, to speed up builds
+if ! buildah containers --format "{{.ContainerName}}" | grep -q nodebuilder-rally; then
     echo "Pulling NodeJS runtime..."
-    buildah from --name nodebuilder-kickstart -v "${PWD}:/usr/src:Z" docker.io/library/node:lts
+    buildah from --name nodebuilder-rally -v "${PWD}:/usr/src:Z" docker.io/library/node:lts
 fi
 
 echo "Build static UI files with node..."
 buildah run \
     --workingdir=/usr/src/ui \
     --env="NODE_OPTIONS=--openssl-legacy-provider" \
-    nodebuilder-kickstart \
+    nodebuilder-rally \
     sh -c "yarn install && yarn build"
 
 # Add imageroot directory to the container image
@@ -45,7 +45,7 @@ buildah config --entrypoint=/ \
     --label="org.nethserver.authorizations=traefik@node:routeadm" \
     --label="org.nethserver.tcp-ports-demand=1" \
     --label="org.nethserver.rootfull=0" \
-    --label="org.nethserver.images=docker.io/postgres:15.5-alpine3.19 docker.io/nginx:stable-alpine3.17" \
+    --label="org.nethserver.images=docker.io/postgres:15.5-alpine3.19 docker.io/lukevella/rallly:3.8.0" \
     "${container}"
 # Commit the image
 buildah commit "${container}" "${repobase}/${reponame}"

imageroot/actions/configure-module/10configure_environment_vars

@@ -13,21 +13,19 @@ import agent
 # If parsing fails, output everything to stderr
 data = json.load(sys.stdin)
 
-#This is specific to you module, so you need to change it accordingly.
-# we read a json stdin {"vars1":true, "var2":"foo", "vars3": 3} and we writ it to .config/state/environment
-# Upper case to set environment variable and minor case to read from stdin
-
-# this values must exists in the json stdin
-# agent.set_env("MAIL_SERVER", data["mail_server"])
-# agent.set_env("LDAP_DOMAIN", data["ldap_domain"])
-
-# you can add default values for the following variables
-# agent.set_env("MAIL_DOMAIN",data.get("mail_domain",""))
-# agent.set_env("WOWORKERSCOUNT",data.get("workers_count",3))
-# agent.set_env("AUXILIARYACCOUNT",data.get("auxiliary_account",True))
-# agent.set_env("ACTIVESYNC",data.get("activesync",False))
-
-
+# rally domain settings
+host = data.get("host", "")
+NEXT_PUBLIC_BASE_URL = "https://"+host
+
+# Testing SMTP Settings on Enviroment
+rdb = agent.redis_connect(use_replica=True)
+smtp_settings = agent.get_smarthost_settings(rdb)
+agent.set_env("SMTP_HOST", smtp_settings['host'])
+agent.set_env("SMTP_PORT", smtp_settings['port'])
+agent.set_env("SMTP_USER", smtp_settings['username'])
+agent.set_env("SMTP_PWD", smtp_settings['password'])
+agent.set_env("SMTP_SECURE", smtp_settings['encrypt_smtp'])
+agent.set_env("SUPPORT_EMAIL", smtp_settings['username'])
 # Make sure everything is saved inside the environment file
 # just before starting systemd unit
-#agent.dump_env()
+agent.dump_env()

imageroot/actions/configure-module/80start_services

@@ -13,5 +13,5 @@ exec 1>&2
 
 touch smarthost.env
 
-systemctl --user enable kickstart.service
-systemctl --user restart kickstart.service
+systemctl --user enable rally.service
+systemctl --user restart rally.service

imageroot/actions/configure-module/validate-input.json

@@ -1,11 +1,11 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Configure kickstart",
-    "$id": "http://nethserver.org/json-schema/task/input/kickstart/configure-module",
-    "description": "Configure kickstart",
+    "title": "Configure rally",
+    "$id": "http://nethserver.org/json-schema/task/input/rally/configure-module",
+    "description": "Configure rally",
     "examples": [
         {
-            "host": "kickstart.domain.org",
+            "host": "rally.domain.org",
             "http2https": true,
             "lets_encrypt": true
         }
@@ -19,7 +19,7 @@
     "properties": {
         "host": {
             "type": "string",
-            "description": "Host name for the application, like 'kickstart.domain.org'",
+            "description": "Host name for the application, like 'rally.domain.org'",
             "format": "hostname",
             "pattern": "\\."
         },

imageroot/actions/create-module/20configure

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+
+#
+# Copyright (C) 2023 Nethesis S.r.l.
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+import os
+import json
+import sys
+# agent is a NethServer library which provides function to communicate with the agent
+import agent
+import secrets
+
+data = json.load(sys.stdin)
+
+# Setup default values
+random_key = secrets.token_hex(32)
+SECRET_PASSWORD = data.get("SECRET_PASSWORD",random_key)
+
+# Talk with agent using file descriptor.
+
+agent.set_env("SECRET_PASSWORD", SECRET_PASSWORD)
+
+# Make sure everything is saved inside the environment file
+# just before starting systemd unit
+agent.dump_env()

imageroot/actions/get-configuration/20read

@@ -19,8 +19,9 @@ config = {}
 
 # Read current configuration from the environment file
 config["host"] = os.getenv("TRAEFIK_HOST","")
+config["NEXT_PUBLIC_BASE_URL"] = os.getenv("NEXT_PUBLIC_BASE_URL","")
 config["http2https"] = os.getenv("TRAEFIK_HTTP2HTTPS") == "True"
 config["lets_encrypt"] = os.getenv("TRAEFIK_LETS_ENCRYPT") == "True"
-
+config["SECRET_PASSWORD"] = os.getenv("SECRET_PASSWORD","")
 # Dump the configuration to stdout
 json.dump(config, fp=sys.stdout)

imageroot/actions/get-configuration/validate-output.json

@@ -1,11 +1,11 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Get kickstart settings",
-    "$id": "http://nethserver.org/json-schema/task/input/kickstart/get-configuration",
-    "description": "Get kickstart settings",
+    "title": "Get rally settings",
+    "$id": "http://nethserver.org/json-schema/task/input/rally/get-configuration",
+    "description": "Get rally settings",
     "examples": [
         {
-            "host": "kickstart.domain.org",
+            "host": "rally.domain.org",
             "http2https": true,
             "lets_encrypt": true
         }
@@ -19,7 +19,7 @@
     "properties": {
         "host": {
             "type": "string",
-            "description": "Host name for the application, like 'kickstart.domain.org'",
+            "description": "Host name for the application, like 'rally.domain.org'",
             "format": "idn-hostname"
         },
         "lets_encrypt": {

imageroot/actions/restore-module/40restore_database

@@ -9,9 +9,9 @@ set -e -o pipefail
 exec 1>&2 # Redirect any output to the journal (stderr)
 
 mkdir -vp restore
-cat - >restore/kickstart_restore.sh <<'EOS'
+cat - >restore/rally_restore.sh <<'EOS'
 # Read dump file from standard input:
-pg_restore --no-owner --no-privileges -U postgres -d kickstart
+pg_restore --no-owner --no-privileges -U postgres -d rally
 ec=$?
 docker_temp_server_stop
 exit $ec
@@ -29,9 +29,9 @@ podman run \
     --replace --name=restore_db \
     --env POSTGRES_USER=postgres \
     --env POSTGRES_PASSWORD=Nethesis,1234 \
-    --env POSTGRES_DB=kickstart \
+    --env POSTGRES_DB=rally \
     --env TZ=UTC \
-    "${POSTGRES_IMAGE}" < kickstart.pg_dump
+    "${POSTGRES_IMAGE}" < rally.pg_dump
 
 # If the restore is successful, clean up:
-rm -rfv restore/ kickstart.pg_dump
+rm -rfv restore/ rally.pg_dump

imageroot/bin/module-cleanup-state

@@ -5,4 +5,4 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 #
 
-rm -vf kickstart.pg_dump
+rm -vf rally.pg_dump