diff --git a/docs/README.md b/docs/README.md index dfc22775..dbbe6769 100644 --- a/docs/README.md +++ b/docs/README.md @@ -71,6 +71,7 @@ Following sections are Kubernetes specific. If you are Kubernetes user, use foll ## Installation +### Steps - pre-installed k8s platform under outscale cloud with 3 masters and 2 workers on vm with `tinav2.c2r4p3` type - prepare the machine from which you will run deploy the osc bsu csi plugin - Add CRD and a Snapshot Controller if you enable snapshots: @@ -113,7 +114,8 @@ kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snaps ## Check the pod is running kubectl get pods -o wide -A -n kube-system ``` - +### Chart Configuration +See [Helm Chart Configuration](helm.md) ## Examples Make sure you follow the [Prerequisites](README.md#Prerequisites) before the examples: * [Dynamic Provisioning](../examples/kubernetes/dynamic-provisioning) diff --git a/docs/helm.md b/docs/helm.md new file mode 100644 index 00000000..b8eb0e1a --- /dev/null +++ b/docs/helm.md @@ -0,0 +1,43 @@ +# Configuration + +The following table lists the configurable parameters of the chart and their default values. + +| Parameter | Description | Default | +| :----------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `replicaCount` | k8s replicas | `2` | +| `image.pullPolicy` | Container pull policy | `IfNotPresent` | +| `image.repository` | Container image to use | `outscale/osc-ebs-csi-driver` | +| `image.tag` | Container image tag to deploy | `v0.0.14beta` | +| `imagePullSecrets` | Specify image pull secrets | `[]` (does not add image pull secrets to deployed pods) | +| `verbosity` | Verbosity level of plugins | `2` | +| `timeout` | Timeout for sidecars | `60s` | +| `backoff.duration` | Initial duraction of backoff | `1` | +| `backoff.factor` | factor multiplied by Duration for each iteration | `1.9` | +| `backoff.steps` | remaining number of iterations in which the duration parameter may change | `20` | +| `sidecars.Image.repository` | side-cars image to use between
(`provisioner`, `attacher`, `snapshotter`, `livenessProbe`, `resizer`, `nodeDriverRegistrar`) | - `provisioner` = `k8s.gcr.io/sig-storage/csi-provisioner`
- `attacher` = `k8s.gcr.io/sig-storage/csi-attacher`
- `snapshotter` = `k8s.gcr.io/sig-storage/csi-snapshotter`
- `livenessProbe` = `k8s.gcr.io/sig-storage/livenessProbe`
- `resizer` = `k8s.gcr.io/sig-storage/csi-resizer`
- `nodeDriverRegistrar` = `k8s.gcr.io/sig-storage/csi-node-driver-registrar`
| +| `sidecars.Image.tag` | side-cars image tag to deploy between
(`provisioner`, `attacher`, `snapshotter`, `livenessProbe`, `resizer`, `nodeDriverRegistrar`) | - `provisioner` = `v2.1.1`
- `attacher` = `v3.1.0`
- `snapshotter` = `v3.0.3`
- `livenessProbe` = `v2.2.0`
- `resizer` = `v1.0.0`
- `nodeDriverRegistrar` = `v2.1.0`
| +| `nameOverride` | Override name of the app (instead of `osc-bsu-csi-driver`) | `""` | +| `fullnameOverride` | Override fullname of the app (not use right now) | `""` | +| `enableVolumeScheduling` | Enable schedule volume for dynamic volume provisioning | `false` | +| `enableVolumeResizing` | Enable volume resizing | `false` | +| `enableVolumeSnapshot` | Enable volume snapshot | `false` | +| `extraVolumeTags` | Add extra tags on volume | `{}` | +| `extraCreateMetadata` | Add pv/pvc metadata to plugin create requests as parameters | `false` | +| `k8sTagClusterId` | Id of the K8s cluster used for tagging (optionnal) | `""` | +| `region` | Region to use, otherwise it will be looked up via metadata | `""` | +| `maxBsuVolumes` | Maximum volume to attach to a node (see [Docs](https://docs.outscale.com/en/userguide/About-Volumes.html)) | `25` | +| `resources.limits.cpu` | Container requested CPU | `nil` | +| `resources.limits.memory` | Container requested memory | `nil` | +| `affinity` | affinity settings | `{}` | +| `podAnnotations` | Annotations for controller pod | `{}` | +| `podLabels` | Labels for controller pod | `{}` | +| `tolerations` | pod tolerations | `[]` | +| `tolerationAllTaints` | Not used | `true` | +| `nodeSelector` | node labels for pod assignment | `{}` | +| `node.podAnnotations` | Annotations for controller pod | `{}` | +| `node.podLabels` | Labels for controller pod | `{}` | +| `node.tolerationAllTaints` | Not used | `true` | +| `node.tolerations` | pod tolerations | `[]` | +| `serviceAccount.controller.annotations` | Annotations to add to the Controller ServiceAccount | `{}` | +| `serviceAccount.snapshot.annotations` | Annotations to add to the Snapshot ServiceAccount | `{}` | +| `csiDriver.fsGroupPolicy` | Policy of the FileSystem (see [Docs](https://kubernetes-csi.github.io/docs/support-fsgroup.html#supported-modes)) | `File` | diff --git a/osc-bsu-csi-driver/templates/controller.yaml b/osc-bsu-csi-driver/templates/controller.yaml index db49b8e7..20093316 100644 --- a/osc-bsu-csi-driver/templates/controller.yaml +++ b/osc-bsu-csi-driver/templates/controller.yaml @@ -17,6 +17,9 @@ spec: labels: app: ebs-csi-controller {{- include "aws-ebs-csi-driver.labels" . | nindent 8 }} + {{- if .Values.podLabels }} + {{ toYaml .Values.podLabels | nindent 8 }} + {{- end }} {{- if .Values.podAnnotations }} annotations: {{ toYaml .Values.podAnnotations | nindent 8 }} {{- end }} diff --git a/osc-bsu-csi-driver/templates/node.yaml b/osc-bsu-csi-driver/templates/node.yaml index 80531640..85683323 100644 --- a/osc-bsu-csi-driver/templates/node.yaml +++ b/osc-bsu-csi-driver/templates/node.yaml @@ -16,6 +16,9 @@ spec: labels: app: ebs-csi-node {{- include "aws-ebs-csi-driver.labels" . | nindent 8 }} + {{- if .Values.node.podLabels }} + {{ toYaml .Values.node.podLabels | nindent 8 }} + {{- end }} {{- if .Values.node.podAnnotations }} annotations: {{ toYaml .Values.node.podAnnotations | nindent 8 }} {{- end }} diff --git a/osc-bsu-csi-driver/values.yaml b/osc-bsu-csi-driver/values.yaml index 2e2391a4..a1adeefe 100644 --- a/osc-bsu-csi-driver/values.yaml +++ b/osc-bsu-csi-driver/values.yaml @@ -49,6 +49,7 @@ nameOverride: "" fullnameOverride: "" podAnnotations: {} +podLabels: {} # True if enable volume scheduling for dynamic volume provisioning enableVolumeScheduling: false @@ -103,6 +104,7 @@ maxBsuVolumes: "25" node: podAnnotations: {} + podLabels: {} tolerateAllTaints: true tolerations: []