docs: migrate docs to GitHub repository

.github/workflows/pull-request.yaml

@@ -32,6 +32,9 @@ jobs:
           fi
 
       # DOCKER BUILD & PUSH
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
       - name: Login to Quay.io
@@ -56,6 +59,7 @@ jobs:
           provenance: false # https://issues.redhat.com/browse/PROJQUAY-5013 quay doesn't support it
           build-args: |
             VERSION='${{ steps.auto_version.outputs.version }}'
+          platforms: linux/amd64,linux/arm64
 
       # HELM
       - name: Get Helm chart version
@@ -66,12 +70,11 @@ jobs:
       - name: Update Helm chart version
         uses: mikefarah/yq@master
         with:
-          cmd: | 
+          cmd: |
             BASEDIR=charts/csi-wekafsplugin
             DRIVER_VERSION="$(echo ${{ steps.version.outputs.version }} | sed 's/^v//1')"
             CHART_VERSION="${{ steps.helm_version.outputs.helm_version }}"
             APP_VERSION="${{ steps.version.outputs.version }}"
-
             yq -i '.version = "'$CHART_VERSION'"' $BASEDIR/Chart.yaml
             yq -i '.appVersion = "'$APP_VERSION'"' $BASEDIR/Chart.yaml
             yq -i '.sources[0] = "https://github.com/weka/csi-wekafs/tree/v$CHART_VERSION/charts/csi-wekafsplugin"' $BASEDIR/Chart.yaml
@@ -88,7 +91,7 @@ jobs:
           options: -v ${{ github.workspace }}:/data
           run: |
             cd /data
-            helm-docs -s file -c charts -o ../../README.md -t ../README.md.gotmpl 
+            helm-docs -s file -c charts -o ../../README.md -t ../README.md.gotmpl
             helm-docs -s file -c charts
 
       - name: Set up Helm
@@ -142,7 +145,7 @@ jobs:
           S3_BUCKET_NAME=${{ secrets.S3_BUCKET_NAME }}
           URL="https://$S3_BUCKET_NAME.s3.$AWS_REGION.amazonaws.com"
           echo "filename=$FILENAME" >> $GITHUB_OUTPUT
-          echo "url=$URL" >> $GITHUB_OUTPUT          
+          echo "url=$URL" >> $GITHUB_OUTPUT
 
       - name: Install AWS CLI
         id: install-aws-cli
@@ -157,7 +160,7 @@ jobs:
           export AWS_SECRET_ACCESS_KEY="${{ secrets.AWS_SECRET_ACCESS_KEY}}"
           export AWS_REGION="${{ secrets.AWS_REGION }}"
           aws s3 cp ${{ steps.helm-package.outputs.filename }} "s3://${{ vars.AWS_BUCKET }}/"
-          echo "link=https://${{ vars.AWS_BUCKET }}.s3.${AWS_REGION}.amazonaws.com/${{ steps.helm-package.outputs.filename }}" >> $GITHUB_OUTPUT 
+          echo "link=https://${{ vars.AWS_BUCKET }}.s3.${AWS_REGION}.amazonaws.com/${{ steps.helm-package.outputs.filename }}" >> $GITHUB_OUTPUT
         if: steps.helm-test.outputs.passed == 'true'
 
       - uses: rtCamp/action-slack-notify@v2

.github/workflows/push-dev.yaml

@@ -37,14 +37,19 @@ jobs:
           fi
 
       # DOCKER BUILD & PUSH
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
+
       - name: Login to Quay.io
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
           registry: quay.io
+
       - name: Build and push
         uses: docker/build-push-action@v6
         with:
@@ -61,13 +66,15 @@ jobs:
           provenance: false # https://issues.redhat.com/browse/PROJQUAY-5013 quay doesn't support it
           build-args: |
             VERSION='${{ steps.auto_version.outputs.version }}'
+          platforms: linux/amd64,linux/arm64
 
       # HELM
       - name: Get Helm chart version
         id: helm_version
         run: |
           out="$(echo "${{ steps.auto_version.outputs.version }}" | sed 's/^v//1')"
           echo "helm_version=$out" >> $GITHUB_OUTPUT
+
       - name: Update Helm chart version
         uses: mikefarah/yq@master
         with:

.github/workflows/release.yaml

@@ -133,7 +133,11 @@ jobs:
           cat changelog1 > charts/csi-wekafsplugin/CHANGELOG.md
           mv CHANGELOG.md RELEASE.md
 
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
       - uses: docker/setup-buildx-action@v3
+
       - uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
@@ -152,6 +156,7 @@ jobs:
             revision='${{ steps.set_version.outputs.version }}'
           build-args: |
             VERSION='${{ steps.set_version.outputs.version }}'
+          platforms: linux/amd64,linux/arm64
 
       - name: helm-docs
         uses: addnab/docker-run-action@v3

README.md

@@ -1,7 +1,7 @@
 # CSI WekaFS Driver
 Helm chart for Deployment of WekaIO Container Storage Interface (CSI) plugin for WekaFS - the world fastest filesystem
 
-![Version: 2.5.1-SNAPSHOT.41.bddf9ed](https://img.shields.io/badge/Version-2.5.1--SNAPSHOT.41.bddf9ed-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.5.1-SNAPSHOT.41.bddf9ed](https://img.shields.io/badge/AppVersion-v2.5.1--SNAPSHOT.41.bddf9ed-informational?style=flat-square)
+![Version: 2.5.1-SNAPSHOT.44.0a35d77](https://img.shields.io/badge/Version-2.5.1--SNAPSHOT.44.0a35d77-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.5.1-SNAPSHOT.44.0a35d77](https://img.shields.io/badge/AppVersion-v2.5.1--SNAPSHOT.44.0a35d77-informational?style=flat-square)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/csi-wekafs)](https://artifacthub.io/packages/search?repo=csi-wekafs)
 
@@ -18,6 +18,7 @@ https://github.com/weka/csi-wekafs
 - Kubernetes cluster of version 1.20 or later is recommended. Minimum version is 1.17
 - Access to terminal with `kubectl` installed
 - Weka system pre-configured and Weka client installed and registered in cluster for each Kubernetes node
+- Both AMD64 and ARM64 platforms are supported
 
 ## Deployment
 - [Helm public repo](https://artifacthub.io/packages/helm/csi-wekafs/csi-wekafsplugin) (recommended)
@@ -28,9 +29,6 @@ https://github.com/weka/csi-wekafs
 - [SELinux Support & Installation Notes](selinux/README.md)
 - [Using Weka CSI Plugin with NFS transport](docs/NFS.md)
 
-## Additional Documentation
-- [Official Weka CSI Plugin documentation](https://docs.weka.io/appendices/weka-csi-plugin)
-
 ## Building the binaries
 If you want to build the driver yourself, you can do so with the following command from the root directory:
 
@@ -44,7 +42,7 @@ make build
 |-----|------|---------|-------------|
 | dynamicProvisionPath | string | `"csi-volumes"` | Directory in root of file system where dynamic volumes are provisioned |
 | csiDriverName | string | `"csi.weka.io"` | Name of the driver (and provisioner) |
-| csiDriverVersion | string | `"2.5.1-SNAPSHOT.41.bddf9ed"` | CSI driver version |
+| csiDriverVersion | string | `"2.5.1-SNAPSHOT.44.0a35d77"` | CSI driver version |
 | images.livenessprobesidecar | string | `"registry.k8s.io/sig-storage/livenessprobe:v2.14.0"` | CSI liveness probe sidecar image URL |
 | images.attachersidecar | string | `"registry.k8s.io/sig-storage/csi-attacher:v4.7.0"` | CSI attacher sidecar image URL |
 | images.provisionersidecar | string | `"registry.k8s.io/sig-storage/csi-provisioner:v5.1.0"` | CSI provisioner sidecar image URL |
@@ -53,7 +51,7 @@ make build
 | images.snapshottersidecar | string | `"registry.k8s.io/sig-storage/csi-snapshotter:v8.1.0"` | CSI snapshotter sidecar image URL |
 | images.nodeinfo | string | `"quay.io/weka.io/csi-wekafs"` | CSI nodeinfo sidecar image URL, used for reading node metadata |
 | images.csidriver | string | `"quay.io/weka.io/csi-wekafs"` | CSI driver main image URL |
-| images.csidriverTag | string | `"2.5.1-SNAPSHOT.41.bddf9ed"` | CSI driver tag |
+| images.csidriverTag | string | `"2.5.1-SNAPSHOT.44.0a35d77"` | CSI driver tag |
 | imagePullSecret | string | `""` | image pull secret required for image download. Must have permissions to access all images above.    Should be used in case of private registry that requires authentication |
 | globalPluginTolerations | list | `[{"effect":"NoSchedule","key":"node-role.kubernetes.io/master","operator":"Exists"}]` | Tolerations for all CSI driver components |
 | controllerPluginTolerations | list | `[{"effect":"NoSchedule","key":"node-role.kubernetes.io/master","operator":"Exists"}]` | Tolerations for CSI controller component only (by default same as global) |

README.md.gotmpl

@@ -14,6 +14,7 @@
 - Kubernetes cluster of version 1.20 or later is recommended. Minimum version is 1.17
 - Access to terminal with `kubectl` installed
 - Weka system pre-configured and Weka client installed and registered in cluster for each Kubernetes node
+- Both AMD64 and ARM64 platforms are supported
 
 ## Deployment
 - [Helm public repo](https://artifacthub.io/packages/helm/csi-wekafs/csi-wekafsplugin) (recommended)

charts/csi-wekafsplugin/Chart.yaml

@@ -10,8 +10,8 @@ sources:
 home: https://github.com/weka/csi-wekafs
 icon: https://weka.github.io/csi-wekafs/logo.png
 type: application
-version: 2.5.1-SNAPSHOT.41.bddf9ed
-appVersion: v2.5.1-SNAPSHOT.41.bddf9ed
+version: 2.5.1-SNAPSHOT.44.0a35d77
+appVersion: v2.5.1-SNAPSHOT.44.0a35d77
 keywords: [storage, filesystem, HPC]
 annotations:
   artifacthub.io/category: "storage"

charts/csi-wekafsplugin/README.md

@@ -3,7 +3,7 @@ Helm chart for Deployment of WekaIO Container Storage Interface (CSI) plugin for
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/csi-wekafs)](https://artifacthub.io/packages/search?repo=csi-wekafs)
-![Version: 2.5.1-SNAPSHOT.41.bddf9ed](https://img.shields.io/badge/Version-2.5.1--SNAPSHOT.41.bddf9ed-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.5.1-SNAPSHOT.41.bddf9ed](https://img.shields.io/badge/AppVersion-v2.5.1--SNAPSHOT.41.bddf9ed-informational?style=flat-square)
+![Version: 2.5.1-SNAPSHOT.44.0a35d77](https://img.shields.io/badge/Version-2.5.1--SNAPSHOT.44.0a35d77-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.5.1-SNAPSHOT.44.0a35d77](https://img.shields.io/badge/AppVersion-v2.5.1--SNAPSHOT.44.0a35d77-informational?style=flat-square)
 
 ## Homepage
 https://github.com/weka/csi-wekafs
@@ -36,23 +36,19 @@ helm install csi-wekafsplugin csi-wekafs/csi-wekafsplugin --namespace csi-wekafs
 >
 > However, for sake of more convenient migration, a `legacySecretName` parameter can be set that will
 > bind existing legacy volumes to a Weka cluster API and allow volume expansion.
->
-> For further information, refer [Official Weka CSI Plugin documentation](https://docs.weka.io/appendices/weka-csi-plugin)
+
 
 ## Usage
 - [Deploy an Example application](https://github.com/weka/csi-wekafs/blob/master/docs/usage.md)
 - [SELinux Support & Installation Notes](https://github.com/weka/csi-wekafs/blob/master/selinux/README.md)
 
-## Additional Documentation
-- [Official Weka CSI Plugin documentation](https://docs.weka.io/appendices/weka-csi-plugin)
-
 ## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | dynamicProvisionPath | string | `"csi-volumes"` | Directory in root of file system where dynamic volumes are provisioned |
 | csiDriverName | string | `"csi.weka.io"` | Name of the driver (and provisioner) |
-| csiDriverVersion | string | `"2.5.1-SNAPSHOT.41.bddf9ed"` | CSI driver version |
+| csiDriverVersion | string | `"2.5.1-SNAPSHOT.44.0a35d77"` | CSI driver version |
 | images.livenessprobesidecar | string | `"registry.k8s.io/sig-storage/livenessprobe:v2.14.0"` | CSI liveness probe sidecar image URL |
 | images.attachersidecar | string | `"registry.k8s.io/sig-storage/csi-attacher:v4.7.0"` | CSI attacher sidecar image URL |
 | images.provisionersidecar | string | `"registry.k8s.io/sig-storage/csi-provisioner:v5.1.0"` | CSI provisioner sidecar image URL |
@@ -61,7 +57,7 @@ helm install csi-wekafsplugin csi-wekafs/csi-wekafsplugin --namespace csi-wekafs
 | images.snapshottersidecar | string | `"registry.k8s.io/sig-storage/csi-snapshotter:v8.1.0"` | CSI snapshotter sidecar image URL |
 | images.nodeinfo | string | `"quay.io/weka.io/csi-wekafs"` | CSI nodeinfo sidecar image URL, used for reading node metadata |
 | images.csidriver | string | `"quay.io/weka.io/csi-wekafs"` | CSI driver main image URL |
-| images.csidriverTag | string | `"2.5.1-SNAPSHOT.41.bddf9ed"` | CSI driver tag |
+| images.csidriverTag | string | `"2.5.1-SNAPSHOT.44.0a35d77"` | CSI driver tag |
 | imagePullSecret | string | `""` | image pull secret required for image download. Must have permissions to access all images above.    Should be used in case of private registry that requires authentication |
 | globalPluginTolerations | list | `[{"effect":"NoSchedule","key":"node-role.kubernetes.io/master","operator":"Exists"}]` | Tolerations for all CSI driver components |
 | controllerPluginTolerations | list | `[{"effect":"NoSchedule","key":"node-role.kubernetes.io/master","operator":"Exists"}]` | Tolerations for CSI controller component only (by default same as global) |

charts/csi-wekafsplugin/values.yaml

@@ -5,7 +5,7 @@ dynamicProvisionPath: "csi-volumes"
 # -- Name of the driver (and provisioner)
 csiDriverName: "csi.weka.io"
 # -- CSI driver version
-csiDriverVersion: &csiDriverVersion 2.5.1-SNAPSHOT.41.bddf9ed
+csiDriverVersion: &csiDriverVersion 2.5.1-SNAPSHOT.44.0a35d77
 images:
   # -- CSI liveness probe sidecar image URL
   livenessprobesidecar: registry.k8s.io/sig-storage/livenessprobe:v2.14.0