Convert documentation and charts to reference github versus gitlab (#4)

* add helm action
* Fix demo charts to point to github
* Update paths to github packages
* Fix up README and remove namespace values
* Add minimal post-deployment notes to our charts

Signed-off-by: Eric Van Hensbergen <[email protected]>

Author: ericvh

.github/workflows/helm.yml

@@ -0,0 +1,46 @@
+# release.yaml
+name: Release Charts
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+
+      # Optional step if GPG signing is used
+      - name: Prepare GPG key
+        run: |
+          gpg_dir=.cr-gpg
+          mkdir "$gpg_dir"
+          keyring="$gpg_dir/secring.gpg"
+          base64 -d <<< "$GPG_KEYRING_BASE64" > "$keyring"
+          passphrase_file="$gpg_dir/passphrase"
+          echo "$GPG_PASSPHRASE" > "$passphrase_file"
+          echo "CR_PASSPHRASE_FILE=$passphrase_file" >> "$GITHUB_ENV"
+          echo "CR_KEYRING=$keyring" >> "$GITHUB_ENV"
+          echo "sign: true" > cr.yaml
+          echo "key: Smarter Project" >> cr.yaml
+        env:
+          GPG_KEYRING_BASE64: "${{ secrets.GPG_KEYRING_BASE64 }}"
+          GPG_PASSPHRASE: "${{ secrets.GPG_PASSPHRASE }}"
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        with:
+          config: cr.yaml
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+

charts/demo/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 name: smarter-demo
 description: smarter edge demo deployment chart
-
+home: https://getsmarter.io
 # A chart can be either an 'application' or a 'library' chart.
 #
 # Application charts are a collection of templates that can be packaged into versioned archives
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: 0.1.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
@@ -32,24 +32,23 @@ dependencies:
     repository: https://fluent.github.io/helm-charts
     alias: fluent-bit
   - name: smarter-gstreamer
-    version: 0.0.1
-    repository: https://smarter-project.github.io/documentation/charts
+    version: 0.0.2
+    repository: https://smarter-project.github.io/gstreamer
   - name: smarter-pulseaudio
-    version: 0.0.1
-    repository: https://fluent.github.io/helm-charts/documentation/charts
+    version: 0.0.2
+    repository: https://smarter-project.github.io/pulseaudio
   - name: smarter-image-detector
-    version: 0.0.1
-    repository: https://fluent.github.io/helm-charts/documentation/charts
+    version: 0.0.2
+    repository: https://smarter-project.github.io/image-detector
   - name: smarter-audio-client
-    version: 0.0.1
-    repository: https://fluent.github.io/helm-charts/documentation/charts
-  - name: smarter-admission-controller
-    version: 0.0.1
-    repository: https://fluent.github.io/helm-charts/documentation/charts
-
+    version: 0.0.2
+    repository: https://smarter-project.github.io/audio-client
+  - name: smarter-inference
+    version: 0.0.2
+    repository: https://smarter-project.github.io/smarter-inference
+icon: https://gitlab.com/uploads/-/system/group/avatar/59012546/ARM1636_Project_Logo_ST2_RGB_V1.png
 sources:
-  - https://gitlab.com/smarter-project/documentation
-
+  - https://github.com/smarter-project/documentation
 annotations:
   artifacthub.io/changes: |
     - Initial release
@@ -59,5 +58,5 @@ annotations:
       email: [email protected]
   artifacthub.io/prerelease: "false"
   artifacthub.io/signKey: |
-    fingerprint: 9696F0D196A59098A4CAD15188FFD5FB4A5FFF98
-    url: https://keybase.io/ericvh/pgp_keys.asc
+    fingerprint: 71EDA4E3D652DC73EB09E3A5387D298C169CF24E
+    url: https://smarter-project.github.io/documentation/pgp_keys.asc

charts/demo/README.md

@@ -7,8 +7,7 @@ For more information on smarter go to https://getsmarter.io
 ## TL;DR
 
 ```console
-helm repo add smarter https://smarter-project.gitlab.io/documentation/charts
-helm install --set domain=example.com demo smarter/demo
+helm install --set domain=example.com demo charts/demo
 ```
 
 # Overview

charts/demo/templates/NOTES.txt

@@ -0,0 +1,11 @@
+Your SMARTER edge demo applications have been provisioned.  
+If you edge-nodes are labeled correctly with the node 
+4selectors as defined in values.yaml then the smarter edge demo daemonsets
+will be automatically deployed to your edge nodes and forward data to your 
+cloud instance to be visualized in grafana.
+
+If you haven't already done so, provision your cloud side infrastructure to 
+be able to receive data from your edgem nodes.
+
+For more details and instructions go to https://getsmarter.io
+

charts/demo/values.yaml

@@ -3,7 +3,7 @@
 # Declare variables to be passed into your templates.
 
 global:
-  domain: d.getsmarter.io
+  domain: example.com
 
 fluent-bit:
   fluentd:

charts/smarter-cloud/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: smarter-cloud
-description: smarter cloud deploymnent chart
+description: smarter cloud deployment chart
 
 home: https://gitlab.com/smarter-project/documentation
 
@@ -17,14 +17,13 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: 0.1.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
 appVersion: "2.0.0"
-logo: https://gitlab.com/uploads/-/system/group/avatar/6339043/ARM1636_Project_Logo_ST2_RGB_V1.png
 kubeVersion: ">=1.18.0-0"
 
 dependencies:
@@ -59,5 +58,5 @@ annotations:
       email: [email protected]
   artifacthub.io/prerelease: "false"
   artifacthub.io/signKey: |
-    fingerprint: 9696F0D196A59098A4CAD15188FFD5FB4A5FFF98
-    url: https://keybase.io/ericvh/pgp_keys.asc
+    fingerprint: 71EDA4E3D652DC73EB09E3A5387D298C169CF24E
+    url: https://smarter-project.github.io/documentation/pgp_keys.asc

charts/smarter-cloud/README.md

@@ -13,8 +13,7 @@ For more information on smarter go to https://getsmarter.io
 ## TL;DR
 
 ```console
-helm repo add smarter https://smarter-project.gitlab.io/documentation/charts
-helm install --set domain=example.com --set [email protected] my-smarter-cloud smarter-cloud
+helm install --set domain=example.com --set [email protected] smarter-cloud charts/smarter-cloud
 ```
 
 # Overview

charts/smarter-cloud/templates/NOTES.txt

@@ -0,0 +1,6 @@
+Your SMARTER cloud instance has been deployed.  Next deploy an edge server and edge nodes to connect to it.
+For more details and instructions go to https://getsmarter.io
+
+If you deployed your instance correctly, you should be able to log into grafana at
+https://grafana.{{ .Values.domain }} with the username admin and the password {{ .Values.prometheus.grafana.adminPassword }}
+

charts/smarter-cloud/values.yaml

@@ -2,8 +2,6 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
-namespace: smarter-cloud
-
 domain: example.com
 
 cert-manager:

charts/smarter-edge/Chart.yaml

@@ -1,8 +1,8 @@
 apiVersion: v2
 name: smarter-edge
-description: smarter edge deploymnent chart
+description: smarter edge deployment chart
 
-home: https://gitlab.com/smarter-project/documentation
+home: https://getsmarter.io
 
 # A chart can be either an 'application' or a 'library' chart.
 #
@@ -17,7 +17,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.0.2
+version: 0.0.3
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
@@ -30,17 +30,17 @@ kubeVersion: ">=1.18.0-0"
 dependencies:
   - name: smarter-cni
     version: 0.0.2
-    repository: https://smarter-project.gitlab.io/documentation/charts
+    repository: https://smarter-project.github.io/smarter-cni
   - name: smarter-dns
     version: 0.0.2
-    repository: https://smarter-project.gitlab.io/documentation/charts
+    repository: https://smarter-project.github.io/smarter-dns
   - name: smarter-device-manager
-    version: 0.0.3
-    repository: https://smarter-project.gitlab.io/documentation/charts
+    version: 0.0.7
+    repository: https://smarter-project.github.io/smarter-device-manager
 
 icon: https://gitlab.com/uploads/-/system/group/avatar/59012546/ARM1636_Project_Logo_ST2_RGB_V1.png
 sources:
-  - https://gitlab.com/smarter-project/documentation
+  - https://github.com/smarter-project/documentation
 
 annotations:
   artifacthub.io/changes: |
@@ -51,5 +51,5 @@ annotations:
       email: [email protected]
   artifacthub.io/prerelease: "false"
   artifacthub.io/signKey: |
-    fingerprint: 9696F0D196A59098A4CAD15188FFD5FB4A5FFF98
-    url: https://keybase.io/ericvh/pgp_keys.asc
+    fingerprint: 71EDA4E3D652DC73EB09E3A5387D298C169CF24E
+    url: https://smarter-project.github.io/documentation/pgp_keys.asc