Refactored and documented values.yaml

Author: wtripp180901

.github/workflows/publish-helm-chart.yml

@@ -1,45 +1,27 @@
-name: Release Charts
-
+name: Publish charts
+# Run the tasks on every push
 on: push
-
 jobs:
-  release:
-    # depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions
-    # see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token
-    permissions:
-      contents: write
+  publish_charts:
+    name: Build and push Helm charts
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - name: Check out the repository
+        uses: actions/checkout@v2
         with:
+          # This is important for the semver action to work correctly
+          # when determining the number of commits since the last tag
           fetch-depth: 0
           submodules: true
 
       - name: Get SemVer version for current commit
         id: semver
         uses: stackhpc/github-actions/semver@master
 
-      - name: Configure Git
-        run: |
-          git config user.name "$GITHUB_ACTOR"
-          git config user.email "[email protected]"
-
-      - name: Install Helm
-        uses: azure/setup-helm@v3
-        env:
-          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-
-      - name: "Package Chart"
-        run: |
-          mkdir -p .cr-release-packages
-          helm package slurm-cluster-chart --version ${{ steps.semver.outputs.version }} --destination .cr-release-packages
-
-      - name: Run chart-releaser
-        uses: helm/[email protected]
+      - name: Publish Helm charts
+        uses: stackhpc/github-actions/helm-publish@master
         with:
-          charts_dir: .
-          skip_packaging: True
-        env:
-          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-          
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: ${{ steps.semver.outputs.version }}
+          app-version: ${{ steps.semver.outputs.short-sha }}
+          

slurm-cluster-chart/templates/mysql-deployment.yaml

@@ -34,7 +34,7 @@ spec:
               value: "yes"
             - name: MYSQL_USER
               value: "slurm"
-          image: {{ .Values.sqlImage }}
+          image: {{ .Values.mySQL.image }}
           name: mysql
           ports:
             - containerPort: 3306

slurm-cluster-chart/templates/var-lib-mysql-persistentvolumeclaim.yaml

@@ -11,4 +11,4 @@ spec:
     - ReadWriteOnce
   resources:
     requests:
-      storage: {{ .Values.databaseStorage }}
+      storage: {{ .Values.mySQL.storage }}

slurm-cluster-chart/values.yaml

@@ -8,22 +8,27 @@ nfs:
   mountPath: /home
   claimName: rook-nfs-pv-claim
 
-sqlImage: mariadb:10.10
-
-databaseStorage: 100Mi
-
+# Values for Slurm's database container
+mySQL:
+  #Database image to be used
+  image: mariadb:10.10
+  #Storage requested by the var-lib-mysql volume backing the database
+  storage: 100Mi
+
+# Configmap resource names
 configmaps:
   slurmConf: slurm-conf-configmap
   slurmdbdConf: slurmdbd-conf-configmap
   sshdConfig: sshd-config-configmap
 
-# If let undefined, assumes you have run publish-keys.sh to publish your public key prior to deployment
+# Public key used for ssh access to the login node
+# If let undefined, assumes you have run the provided publish-keys.sh script to publish your public key prior to deployment
 sshPublicKey:
 
+# Secret resource names
 secrets:
-  databaseAuth: database-auth-secret
   mungeKey: munge-key-secret
 
-#OOD username is rocky
 openOnDemand:
+  #Password for default Open OnDemand user 'rocky'
   password: password