Fix documentation for k3s/k8s usage of yaml files

Signed-off-by: Alexandre Peixoto Ferreira <alexandre.ferreira@arm.com>

.github/workflows/docker-buildx.yml

@@ -1,104 +0,0 @@
-name: Docker Image BuildX CI and Publish
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-on:
-  schedule:
-    - cron: '19 16 * * *'
-  push:
-    branches: [ "main" ]
-    # Publish semver tags as releases.
-    tags: [ 'v*.*.*' ]
-  pull_request:
-    branches: [ "main" ]
-  workflow_dispatch:
-  
-env:
-  # Use docker.io for Docker Hub if empty
-  REGISTRY: ghcr.io
-  # github.repository as <account>/<repo>
-  IMAGE_NAME: ${{ github.repository }}
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-      # This is used to complete the identity challenge
-      # with sigstore/fulcio when running outside of PRs.
-      id-token: write
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      # Install the cosign tool except on PR
-      # https://github.com/sigstore/cosign-installer
-      - name: Install cosign
-        if: github.event_name != 'pull_request'
-        uses: sigstore/cosign-installer@f3c664df7af409cb4873aa5068053ba9d61a57b6 #v2.6.0
-        with:
-          cosign-release: 'v1.13.1'
-
-      -
-        # Add support for more platforms with QEMU (optional)
-        # https://github.com/docker/setup-qemu-action
-        name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-
-      # Login against a Docker registry except on PR
-      # https://github.com/docker/login-action
-      - name: Log into registry ${{ env.REGISTRY }}
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@28218f9b04b4f3f62068d7b6ce6ca5b26e35336c
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-      # Extract metadata (tags, labels) for Docker
-      # https://github.com/docker/metadata-action
-      - name: Extract Docker metadata
-        id: meta
-        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
-        with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
- 
-      # Workaround: https://github.com/docker/build-push-action/issues/461
-      - name: Setup Docker buildx
-        uses: docker/setup-buildx-action@v2.2.1
-        with:
-          platforms: linux/amd64,linux/arm64,linux/arm/v7
-      # Build and push Docker image with Buildx (don't push on PR)
-      # https://github.com/docker/build-push-action
-      - name: Build and push Docker image
-        id: build-and-push
-        uses: docker/build-push-action@v3
-        with:
-          platforms: linux/amd64,linux/arm64,linux/arm/v7
-          context: .
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-      #- name: Build
-      #  run: |
-      #    docker build --platform "linux/amd64,linux/arm64" --push . --file Dockerfile --tag ${{ steps.meta.outputs.tags }} --tag ${{ steps.meta.outputs.labels }} # will run buil
-
-      # Sign the resulting Docker image digest except on PRs.
-      # This will only write to the public Rekor transparency log when the Docker
-      # repository is public to avoid leaking data.  If you would like to publish
-      # transparency data even for private images, pass --force to cosign below.
-      # https://github.com/sigstore/cosign
-      - name: Sign the published Docker image
-        if: ${{ github.event_name != 'pull_request' }}
-        env:
-          COSIGN_EXPERIMENTAL: "true"
-        # This step uses the identity token to provision an ephemeral certificate
-        # against the sigstore community Fulcio instance.
-        run: echo "${{ steps.meta.outputs.tags }}" | xargs -I {} cosign sign {}@${{ steps.build-and-push.outputs.digest }}

.github/workflows/helm.yml

@@ -1,46 +0,0 @@
-# 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 "$GITHUB_ACTOR@users.noreply.github.com"
-
-      # 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/chart-releaser-action@v1.4.1
-        with:
-          config: cr.yaml
-        env:
-          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-

.github/workflows/smarter-org-docker-buildx.yml

@@ -0,0 +1,21 @@
+name: Docker Image BuildX CI and Publish
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  schedule:
+    - cron: "19 16 * * *"
+  push:
+    branches: ["main"]
+    # Publish semver tags as releases.
+    tags: ["v*.*.*"]
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+jobs:
+  build:
+    uses: smarter-project/reusable-workflows/.github/workflows/smarter-org-docker-buildx.yml@main

.github/workflows/smarter-org-helm.yml

@@ -0,0 +1,14 @@
+# release.yaml
+name: Release Charts
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    uses: smarter-project/reusable-workflows/.github/workflows/smarter-org-helm.yml@main
+    secrets:
+      GPG_KEYRING_BASE64: ${{ secrets.GPG_KEYRING_BASE64 }}
+      GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

README.md

@@ -137,7 +137,7 @@ More than one smarter-device-manager can be used in a single node if required if
 
 ## Enabling Access
 
-A few examples of yaml files are provided that enable the smarter-device-manager to be deployed in a node. The file smarter-device-management-pod-<>.yaml deploys a single pod on a node; this setup is useful for testing. The file smarter-device-manager-<>.yaml provides a deamonSet configuration that enables pods to be deployed in any node that contains the "smarter-device-manager=enabled" label. The following command inserts the daemonSet in Kubernetes. k3s and k8s put the unix sockets for the device plugin in different directories on the node so the \*-k8s.yaml files should be used on Kubernetes and the \*-k3s.yaml should be used on k3s.
+A few examples of yaml files are provided that enable the smarter-device-manager to be deployed in a node. The file smarter-device-management-pod-<>.yaml deploys a single pod on a node; this setup is useful for testing. The file smarter-device-manager-<>.yaml provides a deamonSet configuration that enables pods to be deployed in any node that contains the "smarter-device-manager=enabled" label. The following command inserts the daemonSet in Kubernetes. Use the k8s for k8s/k3s/k0s unless using k3s version lower than 1.18. K3s smaller then 1.18 put the unix sockets for the device plugin in different directories on the node so the \*-k3s.yaml files should be used on k3s for those versions.
 
 ```
 kubectl apply -f smarter-device-manager.yaml

charts/smarter-device-manager/Chart.yaml

@@ -1,21 +1,17 @@
 apiVersion: v2
 name: smarter-device-manager
 description: smarter-device-manager chart for SMARTER edge devices
-home: https://gitlab.com/smarter-project/smarter-device-manager/helm
-version: 0.0.4
-appVersion: v1.20.11
+home: https://getsmarter.io
+version: 0.0.9
+appVersion: v1.20.12
 kubeVersion: ">=1.16.0-0"
 keywords:
   - kubernetes
   - device
   - hardware
 sources:
-  - https://gitlab.com/smarter-project/smarter-device-manager
-#dependencies:
-#  - name: smarter-common
-#    repository: https://gitlab.com/smarter-project/documentation
-#    version: 0.0.1
-
+  - https://github.com/smarter-project/smarter-device-manager
+icon: https://github.com/smarter-project/documentation/raw/main/ARM1636_Project_Logo_ST2_RGB_V1.png
 annotations:
   artifacthub.io/changes: |
     - Fix template
@@ -26,5 +22,5 @@ annotations:
       email: alexandref75@gmail.com
   artifacthub.io/prerelease: "false"
   artifacthub.io/signKey: |
-    fingerprint: 82AD709FEC4ECA4C84B093889BDC9DE410CFC23B
-    url: https://keybase.io/alexandref75/pgp_keys.asc
+    fingerprint: 71EDA4E3D652DC73EB09E3A5387D298C169CF24E
+    url: https://smarter-project.github.io/documentation/pgp_keys.asc

charts/smarter-device-manager/README.md

@@ -6,9 +6,10 @@ For more information check out https://getsmarter.io
 
 ## TL;DR
 
+Assumes that this repository was cloned.
+
 ```console
-helm repo add smarter https://smarter-project.gitlab.io/documentation/charts
-helm install my-smarter-device-manager smarter-device-manager --version 0.0.2
+helm install --nsmespace=smarter --create-namespace my-smarter-device-manager charts/smarter-device-manager
 ```
 
 ## Overview

charts/smarter-device-manager/values.yaml

@@ -4,7 +4,7 @@ application:
   appName: smarter-device-manager
 
 image:
-  repository: registry.gitlab.com/smarter-project/smarter-device-manager
+  repository: ghcr.io/smarter-project/smarter-device-manager
   # @default -- chart.appVersion
   tag: ""
   pullPolicy: IfNotPresent

compile.sh

@@ -36,7 +36,7 @@ function printHelp() {
 }
 
 BUILD_TAG=$(date -u "+%Y%m%d%H%M%S")
-REPOSITORY_NAME="registry.gitlab.com/smarter-project/smarter-device-manager/"
+REPOSITORY_NAME="ghcr.io/smarter-project/smarter-device-manager/"
 IMAGE_NAME="smarter-device-manager"
 DIRECTORY_TO_RUN=.
 

smarter-device-management-pod-k3s-test-xavier.yaml

@@ -15,7 +15,7 @@ spec:
   nodeName: smarter-jetson-xavier-4bcc2584
   containers:
   - name: smarter-device-manager
-    image: registry.gitlab.com/smarter-project/smarter-device-manager:v1.20.11
+    image: ghcr.io/smarter-project/smarter-device-manager:v1.20.11
     imagePullPolicy: IfNotPresent
     securityContext:
       allowPrivilegeEscalation: false

smarter-device-management-pod-k3s.yaml

@@ -15,7 +15,7 @@ spec:
   nodeName: <replace with node to run>
   containers:
   - name: smarter-device-manager
-    image: registry.gitlab.com/smarter-project/smarter-device-manager:v1.20.11
+    image: ghcr.io/smarter-project/smarter-device-manager:v1.20.11
     imagePullPolicy: IfNotPresent
     securityContext:
       allowPrivilegeEscalation: false

smarter-device-management-pod.yaml

@@ -15,7 +15,7 @@ spec:
   nodeName: <replace with node to run>
   containers:
   - name: smarter-device-manager
-    image: registry.gitlab.com/smarter-project/smarter-device-manager:v1.20.11
+    image: ghcr.io/smarter-project/smarter-device-manager:v1.20.11
     imagePullPolicy: IfNotPresent
     securityContext:
       allowPrivilegeEscalation: false

smarter-device-manager-ds-k3s.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/smarter-project/smarter-device-manager:v1.20.11
+        image: ghcr.io/smarter-project/smarter-device-manager:v1.20.11
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds-with-configmap-rpi-k3s.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/smarter-project/smarter-device-manager:v1.20.11
+        image: ghcr.io/smarter-project/smarter-device-manager:v1.20.11
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds-with-configmap-rpi.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/smarter-project/smarter-device-manager:v1.20.11
+        image: ghcr.io/smarter-project/smarter-device-manager:v1.20.11
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds-with-configmap-xavier-k3s.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/smarter-project/smarter-device-manager:v1.20.11
+        image: ghcr.io/smarter-project/smarter-device-manager:v1.20.11
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds-with-configmap-xavier.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/smarter-project/smarter-device-manager:v1.20.11
+        image: ghcr.io/smarter-project/smarter-device-manager:v1.20.11
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false

smarter-device-manager-ds.yaml

@@ -34,7 +34,7 @@ spec:
       dnsPolicy: ClusterFirstWithHostNet
       containers:
       - name: smarter-device-manager
-        image: registry.gitlab.com/smarter-project/smarter-device-manager:v1.20.11
+        image: ghcr.io/smarter-project/smarter-device-manager:v1.20.11
         imagePullPolicy: IfNotPresent
         securityContext:
           allowPrivilegeEscalation: false