feat(chart): Create initial Chart for csi-cloudscale

.github/workflows/release-chart.yml

@@ -0,0 +1,38 @@
+name: Release Charts
+
+on:
+  push:
+    branches:
+      - master
+
+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]"
+
+      - name: Install Helm
+        uses: azure/[email protected]
+        with:
+          version: v3.9.3
+
+      - name: Add repositories
+        run: |
+          for dir in $(ls -d charts/*/); do
+            helm dependency list $dir 2> /dev/null | tail +2 | head -n -1 | awk '{ print "helm repo add " $1 " " $3 }' | while read cmd; do $cmd; done
+          done
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        with:
+          config: cr.yaml
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.gitignore

@@ -1,5 +1,7 @@
 # IntelliJ IDEA / GoLand
 .idea
 *.iml
+values.yaml
+charts/csi-cloudscale/charts
 
 cmd/cloudscale-csi-plugin/cloudscale-csi-plugin

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## unreleased
 
+## v3.3.0 - 2022.09.22
+* Package as Helm chart.
+* Always set `CLOUDSCALE_MAX_CSI_VOLUMES_PER_NODE` in manifest.
+* Explicitly set `reclaimPolicy` and `volumeBindingMode` for storage classes to Kubernetes default values. 
+
 ## v3.2.1 - 2022.07.12
 * Ensure that the device has the expected size in NodeExpandVolume to avoid a race-condition that appeared in testing.
 * Minor changes to the integration test suite.

Makefile

@@ -12,6 +12,7 @@ LDFLAGS ?= -X github.com/cloudscale-ch/csi-cloudscale/driver.version=${VERSION}
 PKG ?= github.com/cloudscale-ch/csi-cloudscale/cmd/cloudscale-csi-plugin
 
 VERSION ?= $(shell cat VERSION)
+CHART_VERSION ?= $(shell awk '/^version:/ {print $$2}' charts/csi-cloudscale/Chart.yaml)
 DOCKER_REPO ?= quay.io/cloudscalech/cloudscale-csi-plugin
 
 all: check-unused test
@@ -30,13 +31,22 @@ bump-version:
 	@(echo ${NEW_VERSION} | grep -E "^v") || ( echo "NEW_VERSION must be a semver ('v' prefix is required)"; exit 1 )
 	@echo "Bumping VERSION from $(VERSION) to $(NEW_VERSION)"
 	@echo $(NEW_VERSION) > VERSION
-	@cp deploy/kubernetes/releases/csi-cloudscale-${VERSION}.yaml deploy/kubernetes/releases/csi-cloudscale-${NEW_VERSION}.yaml
-	@sed -i'' -e 's/${VERSION}/${NEW_VERSION}/g' deploy/kubernetes/releases/csi-cloudscale-${NEW_VERSION}.yaml
 	@sed -i'' -e 's/${VERSION}/${NEW_VERSION}/g' README.md
+	@sed -i'' -e 's/${VERSION}/${NEW_VERSION}/g' charts/csi-cloudscale/values.yaml
+	@sed -i'' -e 's/${VERSION:v%=%}/${NEW_VERSION:v%=%}/g' charts/csi-cloudscale/Chart.yaml
+	@helm template csi-cloudscale -n kube-system --set nameOverride=csi-cloudscale --set renderNamespace=true ./charts/csi-cloudscale > deploy/kubernetes/releases/csi-cloudscale-${NEW_VERSION}.yaml
 	$(eval NEW_DATE = $(shell date +%Y.%m.%d))
 	@sed -i'' -e 's/## unreleased/## ${NEW_VERSION} - ${NEW_DATE}/g' CHANGELOG.md
 	@ echo '## unreleased\n' | cat - CHANGELOG.md > temp && mv temp CHANGELOG.md
-	@rm README.md-e CHANGELOG.md-e deploy/kubernetes/releases/csi-cloudscale-${NEW_VERSION}.yaml-e
+	@rm README.md-e CHANGELOG.md-e charts/csi-cloudscale/Chart.yaml-e charts/csi-cloudscale/values.yaml-e
+
+.PHONY: bump-chart-version
+bump-chart-version:
+	@[ "${NEW_CHART_VERSION}" ] || ( echo "NEW_CHART_VERSION must be set (ex. make NEW_CHART_VERSION=v1.x.x bump-version)"; exit 1 )
+	@(echo ${NEW_CHART_VERSION} | grep -E "^v") || ( echo "NEW_CHART_VERSION must be a semver ('v' prefix is required)"; exit 1 )
+	@echo "Bumping CHART_VERSION from $(CHART_VERSION) to $(NEW_CHART_VERSION)"
+	@sed -i'' -e 's/${CHART_VERSION:v%=%}/${NEW_CHART_VERSION:v%=%}/g' charts/csi-cloudscale/Chart.yaml
+	@rm charts/csi-cloudscale/Chart.yaml-e
 
 .PHONY: compile
 compile:
@@ -84,3 +94,7 @@ vendor:
 clean:
 	@echo "==> Cleaning releases"
 	@GOOS=${OS} go clean -i -x ./...
+
+.PHONY: helm-template
+helm-template:
+	@helm template csi-cloudscale -n kube-system --set nameOverride=csi-cloudscale ./charts/csi-cloudscale

README.md

@@ -8,6 +8,17 @@ The cloudscale.ch CSI plugin is mostly tested on Kubernetes. Theoretically it
 should also work on other Container Orchestrators, such as Mesos or
 Cloud Foundry. Feel free to test it on other COs and give us a feedback.
 
+## TL;DR
+
+```shell
+# Add a cloudscale.ch API token as secret, replace the placeholder string starting with `a05...` with your own secret
+$ kubectl -n kube-system create secret generic cloudscale --from-literal=access-token=a05dd2f26b9b9ac2asdas__REPLACE_ME____123cb5d1ec17513e06da
+# Add repository
+$ helm repo add csi-cloudscale https://cloudscale-ch.github.io/csi-cloudscale
+# Install Driver
+$ helm install -n kube-system -g csi-cloudscale/csi-cloudscale
+```
+
 ## Volume parameters
 
 This plugin supports the following volume parameters (in case of kubernetes: parameters on the 
@@ -50,7 +61,7 @@ secret `my-pvc-luks-key`.
 ## Releases
 
 The cloudscale.ch CSI plugin follows [semantic versioning](https://semver.org/).
-The current version is: **`v3.2.1`**.
+The current version is: **`v3.3.0`**.
 
 * Bug fixes will be released as a `PATCH` update.
 * New features (such as CSI spec bumps) will be released as a `MINOR` update.
@@ -67,13 +78,13 @@ We recommend using the latest cloudscale.ch CSI driver compatible with your Kube
 |--------------------|----------------------------------|----------------------------------|
 | <= 1.16            |                                  | v1.3.1                           |
 | 1.17               | v1.3.1                           | v3.0.0                           |
-| 1.18               | v1.3.1                           | v3.2.1                           |
-| 1.19               | v1.3.1                           | v3.2.1                           |
-| 1.20               | v2.0.0                           | v3.2.1                           |
-| 1.21               | v2.0.0                           | v3.2.1                           |
-| 1.22               | v3.1.0                           | v3.2.1                           |
-| 1.23               | v3.1.0                           | v3.2.1                           |
-| 1.24               | v3.1.0                           | v3.2.1                           |
+| 1.18               | v1.3.1                           | v3.3.0                           |
+| 1.19               | v1.3.1                           | v3.3.0                           |
+| 1.20               | v2.0.0                           | v3.3.0                           |
+| 1.21               | v2.0.0                           | v3.3.0                           |
+| 1.22               | v3.1.0                           | v3.3.0                           |
+| 1.23               | v3.1.0                           | v3.3.0                           |
+| 1.24               | v3.1.0                           | v3.3.0                           |
 
 **Requirements:**
 
@@ -118,29 +129,68 @@ cloudscale            Opaque                                1         18h
 
 #### 2. Deploy the CSI plugin and sidecars:
 
-Before you continue, be sure to checkout to a [tagged
-release](https://github.com/cloudscale-ch/csi-cloudscale/releases). 
-Always use the [latest stable version](https://github.com/cloudscale-ch/csi-cloudscale/releases/latest) 
-For example, to use the latest stable version (`v3.2.1`) you can execute the following command:
+You can install the CSI plugin and sidecars using one of the following methods:
+ * Helm (requires a Helm installation)
+ * YAML Manifests (only kubectl required)
+
+
+#### 2a. Using Helm:
+
+Before you can install the csi-cloudscale chart, you need to add the helm repository:
 
 ```
-$ kubectl apply -f https://raw.githubusercontent.com/cloudscale-ch/csi-cloudscale/master/deploy/kubernetes/releases/csi-cloudscale-v3.2.1.yaml
+$ helm repo add csi-cloudscale  https://cloudscale-ch.github.io/csi-cloudscale
 ```
 
-There are also `dev` images available:
+Then install the latest stable version:
 
 ```
-$ kubectl apply -f https://raw.githubusercontent.com/cloudscale-ch/csi-cloudscale/master/deploy/kubernetes/releases/csi-cloudscale-dev.yaml
+$ helm install -n kube-system -g csi-cloudscale/csi-cloudscale
+```
+
+Advanced users can customize the installation by specifying custom values.
+The following table summarizes the most-frequently used parameters.
+For a complete list please refer to [values.yaml](./charts/csi-cloudscale/values.yaml)
+
+| Parameter                           | Default                      | Description                                                                                |
+|-------------------------------------|------------------------------|--------------------------------------------------------------------------------------------|
+| attacher.resources                  | `{}`                         | Resource limits and requests for the attacher side-car.                                    |
+| cloudscale.apiUrl                   | `https://api.cloudscale.ch/` | URL of the cloudscale.ch API. You can almost certainly use the default                     |
+| cloudscale.max_csi_volumes_per_node | `125`                        | Override [max. Number of CSI Volumes per Node](#Max.-Number-of-CSI-Volumes-per-Node)       |
+| cloudscale.token.existingSecret     | `cloudscale`                 | Name of the Kubernetes Secret which contains the cloudscale.ch API Token.                  |
+| controller.resources                | `{}`                         | Resource limits and requests for the controller container.                                 |
+| controller.serviceAccountName       | `null`                       | Override the controller service account name.                                              |
+| driverRegistrar.resources           | `{}`                         | Resource limits and requests for the driverRegistrar side-car.                             |
+| extraDeploy                         | `[]`                         | To deploy extra objects together with the driver.                                          |
+| nameOverride                        | `null`                       | Override the default `{{ .Release.Name }}-csi-cloudscale` name pattern with a custom name. |
+| node.resources                      | `{}`                         | Resource limits and requests for the node container.                                       |
+| node.serviceAccountName             | `null`                       | Override the controller node account name.                                                 |
+| node.tolerations                    | `[]`                         | Set tolerations on the node daemonSet.                                                     |
+| provisioner.resources               | `{}`                         | Resource limits and requests for the provisioner side-car.                                 |
+| resizer.resources                   | `{}`                         | Resource limits and requests for the resizer side-car.                                     |
+
+Note: if you want to test a debug/dev release, you can use the following command:
+
+```
+$ helm install -g -n kube-system --set controller.image.tag=dev --set node.image.tag=dev ./charts/csi-cloudscale
+```
+
+#### 2b. Using YAML Manifests:
+
+Before you continue, be sure to checkout to a [tagged
+release](https://github.com/cloudscale-ch/csi-cloudscale/releases). 
+Always use the [latest stable version](https://github.com/cloudscale-ch/csi-cloudscale/releases/latest) 
+For example, to use the latest stable version (`v3.3.0`) you can execute the following command:
+
+```
+$ kubectl apply -f https://raw.githubusercontent.com/cloudscale-ch/csi-cloudscale/master/deploy/kubernetes/releases/csi-cloudscale-v3.3.0.yaml
 ```
 
 The storage classes `cloudscale-volume-ssd` and `cloudscale-volume-bulk` will be created. The 
 storage class `cloudscale-volume-ssd` is set to **"default"** for dynamic provisioning. If you're 
 using multiple storage classes you might want to remove the annotation and re-deploy it. This is
 based on the [recommended mechanism](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/storage/container-storage-interface.md#recommended-mechanism-for-deploying-csi-drivers-on-kubernetes) of deploying CSI drivers on Kubernetes
 
-*Note that the deployment proposal to Kubernetes is still a work in progress and not all of the written
-features are implemented. When in doubt, open an issue or ask #sig-storage in [Kubernetes Slack](http://slack.k8s.io)*
-
 #### 3. Test and verify:
 
 Create a PersistentVolumeClaim. This makes sure a volume is created and provisioned on your behalf:
@@ -260,6 +310,8 @@ env:
    value: '10'
 ```
 
+Or use the `cloudscale.max_csi_volumes_per_node` value of the [Helm chart](#2a-using-helm).
+
 Note that there are currently the following hard-limits per Node:
  * 26 volumes (including root) for `virtio-blk` (`/dev/vdX`).
  * 128 volumes (including root) for `virtio-scsi` (`/dev/sdX`).
@@ -269,6 +321,26 @@ Note that there are currently the following hard-limits per Node:
 Requirements:
 
 * Go: min `v1.10.x`
+* Helm
+
+Build out the `charts/` directory from the `Chart.lock` file:
+
+```
+$ helm dependency build charts/csi-cloudscale
+```
+
+Install the chart from local sources:
+
+```
+$ helm install -n kube-system -g ./charts/csi-cloudscale
+```
+
+Useful commands to compare the generated helm chart to the static YAML manifests:
+
+```
+$ helm template csi-cloudscale --dry-run -n kube-system --set nameOverride=csi-cloudscale charts/csi-cloudscale | kubectl-slice -f - -o deploy/kubernetes/releases/generated
+$ kubectl-slice -f deploy/kubernetes/releases/csi-cloudscale-v6.0.0.yaml -o deploy/kubernetes/releases/v3
+```
 
 After making your changes, run the unit tests: 
 
@@ -303,6 +375,7 @@ To release a new version bump first the version:
 
 ```
 $ make NEW_VERSION=vX.Y.Z bump-version
+$ make NEW_CHART_VERSION=vX.Y.Z bump-chart-version
 ```
 
 Make sure everything looks good. Verify that the Kubernetes compatibility matrix is up-to-date.
@@ -316,15 +389,15 @@ $ git push origin
 
 After it's merged to master, [create a new Github
 release](https://github.com/cloudscale-ch/csi-cloudscale/releases/new) from
-master with the version `v3.2.1` and then publish a new docker build:
+master with the version `v3.3.0` and then publish a new docker build:
 
 ```
 $ git checkout master
 $ make publish
 ```
 
-This will create a binary with version `v3.2.1` and docker image pushed to
-`cloudscalech/cloudscale-csi-plugin:v3.2.1`
+This will create a binary with version `v3.3.0` and docker image pushed to
+`cloudscalech/cloudscale-csi-plugin:v3.3.0`
 
 ## Contributing
 

VERSION

@@ -1 +1 @@
-v3.2.1
+v3.3.0

charts/csi-cloudscale/Chart.lock

@@ -0,0 +1,6 @@
+dependencies:
+- name: common
+  repository: https://charts.bitnami.com/bitnami
+  version: 1.17.1
+digest: sha256:c9dc9bde4c38cea08319ae9f4583b58ae3494d9d5ccedfa53fcd8661df127d1f
+generated: "2022-08-18T13:40:45.580796+02:00"

charts/csi-cloudscale/Chart.yaml

@@ -0,0 +1,14 @@
+apiVersion: v2
+name: csi-cloudscale
+description: A Container Storage Interface Driver for cloudscale.ch volumes.
+type: application
+version: 1.0.0
+appVersion: "3.3.0"
+home: https://github.com/cloudscale-ch/csi-cloudscale
+sources:
+  - https://github.com/cloudscale-ch/csi-cloudscale.git
+dependencies:
+  - name: common
+    version: 1.17.1
+    repository: https://charts.bitnami.com/bitnami
+

charts/csi-cloudscale/templates/_helpers.tpl

@@ -0,0 +1,39 @@
+{{/* Get Driver Name */}}
+{{- define "csi-cloudscale.driver-name" -}}
+{{- if .Values.nameOverride -}}
+    {{ .Values.nameOverride }}
+{{- else -}}
+    {{ .Release.Name }}-csi-cloudscale
+{{- end -}}
+{{- end -}}
+
+{{/* Get API Token Name */}}
+{{- define "csi-cloudscale.api-token-name" -}}
+{{ required "cloudscale.token.existingSecret" .Values.cloudscale.token.existingSecret }}
+{{- end -}}
+
+{{/* Get Controller Service Account Name*/}}
+{{- define "csi-cloudscale.controller-service-account-name" -}}
+{{- if .Values.controller.serviceAccountName -}}
+    {{ .Values.controller.serviceAccountName }}
+{{- else -}}
+    {{ include "csi-cloudscale.driver-name" . }}-controller-sa
+{{- end -}}
+{{- end -}}
+
+{{/* Get Node Service Account Name*/}}
+{{- define "csi-cloudscale.node-service-account-name" -}}
+{{- if .Values.node.serviceAccountName -}}
+    {{ .Values.node.serviceAccountName }}
+{{- else -}}
+    {{ include "csi-cloudscale.driver-name" . }}-node-sa
+{{- end -}}
+{{- end -}}
+
+{{/* When renderNamespace is true, include a Namespace definition. This is for emitting old-school YAMLs  */}}
+{{- define "csi-cloudscale.namespace-in-yaml-manifest" -}}
+{{/* See: https://github.com/helm/helm/issues/5465#issuecomment-473942223 */}}
+{{- if .Values.renderNamespace -}}
+namespace: {{ .Release.Namespace }}
+{{- end -}}
+{{- end -}}

charts/csi-cloudscale/templates/csi_driver.yaml

@@ -0,0 +1,8 @@
+---
+apiVersion: storage.k8s.io/v1
+kind: CSIDriver
+metadata:
+  name: csi.cloudscale.ch
+spec:
+  attachRequired: true
+  podInfoOnMount: true