219 lines
19 KiB
Markdown
219 lines
19 KiB
Markdown
|
|
# OpenEBS Jiva
|
|
|
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
|
|
|
|
|
|
OpenEBS Jiva helm chart for Kubernetes. This chart bootstraps OpenEBS jiva operators and csi driver deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager
|
|
|
|
**Homepage:** <http://www.openebs.io/>
|
|
|
|
## Maintainers
|
|
|
|
| Name | Email | Url |
|
|
| ---- | ------ | --- |
|
|
| prateekpandey14 | prateek.pandey@mayadata.io | |
|
|
| shubham14bajpai | shubham.bajpai@mayadata.io | |
|
|
|
|
## Get Repo Info
|
|
|
|
```console
|
|
helm repo add openebs-jiva https://openebs.github.io/jiva-operator
|
|
helm repo update
|
|
```
|
|
|
|
_See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation._
|
|
|
|
## Install Chart
|
|
|
|
Please visit the [link](https://openebs.github.io/jiva-operator) for install instructions via helm3.
|
|
|
|
```console
|
|
# Helm
|
|
helm install [RELEASE_NAME] openebs-jiva/jiva --namespace [NAMESPACE] --create-namespace
|
|
```
|
|
|
|
_See [configuration](#configuration) below._
|
|
|
|
_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
|
|
|
|
|
|
## Dependencies
|
|
|
|
By default this chart installs additional, dependent charts:
|
|
|
|
| Repository | Name | Version |
|
|
|------------|------|---------|
|
|
| https://openebs.github.io/dynamic-localpv-provisioner | localpv-provisioner | 3.4.1 |
|
|
|
|
**Note:** Find detailed Dynamic LocalPV Provisioner Helm chart configuration options [here](https://github.com/openebs/dynamic-localpv-provisioner/blob/develop/deploy/helm/charts/README.md).
|
|
|
|
To disable the dependency during installation, set `openebsLocalpv.enabled` to `false`.
|
|
|
|
```console
|
|
helm install <your-relase-name> openebs-jiva/jiva --namespace <namespace> --create-namespace --set openebsLocalpv.enabled=false
|
|
```
|
|
|
|
For more details on dependency see [Jiva chart readme](https://github.com/openebs/jiva-operator/blob/master/deploy/helm/charts/README.md).
|
|
|
|
_See [helm dependency](https://helm.sh/docs/helm/helm_dependency/) for command documentation._
|
|
|
|
## Uninstall Chart
|
|
|
|
```console
|
|
# Helm
|
|
helm uninstall [RELEASE_NAME] --namespace [NAMESPACE]
|
|
```
|
|
|
|
This removes all the Kubernetes components associated with the chart and deletes the release.
|
|
|
|
_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
|
|
|
|
## Upgrading Chart
|
|
|
|
```console
|
|
# Helm
|
|
helm upgrade [RELEASE_NAME] [CHART] --install --namespace [NAMESPACE]
|
|
```
|
|
|
|
## Configuration
|
|
|
|
The following table lists the configurable parameters of the OpenEBS Jiva chart and their default values.
|
|
You can modify different parameters by specifying the desired value in the helm install command by using the `--set` and/or the `--set-string` flag(s). You can modify the parameters of the [Dynamic LocalPV Provisioner chart](https://openebs.github.io/dynamic-localpv-provisioner) by adding `localpv-provisioner` before the desired parameter in the helm install command.
|
|
|
|
In the following sample command we modify `csiNode.nodeSelector` from the Jiva chart to only use the NodeSelector label `openebs.io/data-plane=true` to schedule the openebs-jiva-csi-node DaemonSet pods, and we also modify `hostpathClass.basePath` from the localpv-provisioner chart to change the BasePath directory to '/data' used by the openebs-hostpath StorageClass.
|
|
|
|
```console
|
|
helm install openebs-jiva openebs-jiva/jiva -n openebs --create-namespace \
|
|
--set-string csiNode.nodeSelector."openebs\.io/data-plane"=true \
|
|
--set-string localpv-provisioner.hostpathClass.basePath="/data"
|
|
```
|
|
|
|
The Dynamic LocalPV Provisioner helm chart (this is a dependency for the Jiva helm chart) includes the [Node Disk Manager (NDM)](https://openebs.github.io/node-disk-manager/) helm chart. This NDM helm chart is disabled by default. You can enable the NDM chart during installation using flags as shown below:
|
|
|
|
```console
|
|
helm install openebs-jiva openebs-jiva/jiva -n openebs --create-namespace \
|
|
--set localpv-provisioner.openebsNDM.enabled=true \
|
|
--set localpv-provisioner.deviceClass.enabled=true
|
|
```
|
|
|
|
If you have already installed Jiva without NDM, and would like to enable it after installation, use the following command:
|
|
|
|
```console
|
|
helm upgrade openebs-jiva openebs-jiva/jiva -n openebs \
|
|
--set localpv-provisioner.openebsNDM.enabled=true \
|
|
--set localpv-provisioner.deviceClass.enabled=true
|
|
```
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|----------------------|---------------------------------------------------------|-------------|
|
|
| csiController.annotations | object | `{}` | CSI controller annotations |
|
|
| csiController.attacher.image.pullPolicy | string | `"IfNotPresent"` | CSI attacher image pull policy |
|
|
| csiController.attacher.image.registry | string | `"registry.k8s.io/"` | CSI attacher image registry |
|
|
| csiController.attacher.image.repository | string | `"sig-storage/csi-attacher"` | CSI attacher image repo |
|
|
| csiController.attacher.image.tag | string | `"v4.3.0"` | CSI attacher image tag |
|
|
| csiController.attacher.logLevel | string | _unspecified_ | Override CSI attacher container log level (1 = least verbose, 5 = most verbose) |
|
|
| csiController.attacher.name | string | `"csi-attacher"` | CSI attacher container name|
|
|
| csiController.componentName | string | `""` | CSI controller component name |
|
|
| csiController.livenessprobe.image.pullPolicy | string | `"IfNotPresent"` | CSI livenessprobe image pull policy |
|
|
| csiController.livenessprobe.image.registry | string | `"registry.k8s.io/"` | CSI livenessprobe image registry |
|
|
| csiController.livenessprobe.image.repository | string | `"sig-storage/livenessprobe"` | CSI livenessprobe image repo |
|
|
| csiController.livenessprobe.image.tag | string | `"v2.10.0"` | CSI livenessprobe image tag |
|
|
| csiController.livenessprobe.name | string | `"liveness-probe"` | CSI livenessprobe container name|
|
|
| csiController.logLevel | string | `"5"` | Default log level for all CSI controller containers (1 = least verbose, 5 = most verbose) unless overridden for a specific container |
|
|
| csiController.nodeSelector | object | `{}` | CSI controller pod node selector |
|
|
| csiController.podAnnotations | object | `{}` | CSI controller pod annotations |
|
|
| csiController.provisioner.image.pullPolicy | string | `"IfNotPresent"` | CSI provisioner image pull policy |
|
|
| csiController.provisioner.image.registry | string | `"registry.k8s.io/"` | CSI provisioner image pull registry |
|
|
| csiController.provisioner.image.repository | string | `"sig-storage/csi-provisioner"` | CSI provisioner image pull repository |
|
|
| csiController.provisioner.image.tag | string | `"v3.5.0"` | CSI provisioner image tag |
|
|
| csiController.provisioner.logLevel | string | _unspecified_ | Override CSI provisioner container log level (1 = least verbose, 5 = most verbose) |
|
|
| csiController.provisioner.name | string | `"csi-provisioner"` | CSI provisioner container name |
|
|
| csiController.resizer.image.pullPolicy | string | `"IfNotPresent"` | CSI resizer image pull policy |
|
|
| csiController.resizer.image.registry | string | `"registry.k8s.io/"` | CSI resizer image registry |
|
|
| csiController.resizer.image.repository | string | `"sig-storage/csi-resizer"` | CSI resizer image repository|
|
|
| csiController.resizer.image.tag | string | `"v1.8.0"` | CSI resizer image tag |
|
|
| csiController.resizer.logLevel | string | _unspecified_ | Override CSI resizer container log level (1 = least verbose, 5 = most verbose) |
|
|
| csiController.resizer.name | string | `"csi-resizer"` | CSI resizer container name |
|
|
| csiController.resources | object | `{}` | CSI controller container resources |
|
|
| csiController.securityContext | object | `{}` | CSI controller security context |
|
|
| csiController.tolerations | list | `[]` | CSI controller pod tolerations |
|
|
| csiNode.annotations | object | `{}` | CSI Node annotations |
|
|
| csiNode.componentName | string | `"openebs-jiva-csi-node"` | CSI Node component name |
|
|
| csiNode.driverRegistrar.image.pullPolicy | string | `"IfNotPresent"` | CSI Node driver registrar image pull policy|
|
|
| csiNode.driverRegistrar.image.registry | string | `"registry.k8s.io/"` | CSI Node driver registrar image registry |
|
|
| csiNode.driverRegistrar.image.repository | string | `"sig-storage/csi-node-driver-registrar"` | CSI Node driver registrar image repository |
|
|
| csiNode.driverRegistrar.image.tag | string | `"v2.8.0"` | CSI Node driver registrar image tag|
|
|
| csiNode.driverRegistrar.name | string | `"csi-node-driver-registrar"` | CSI Node driver registrar container name |
|
|
| csiNode.driverRegistrar.logLevel | string | _unspecified_ | Override CSI node driver registrar container log level (1 = least verbose, 5 = most verbose) |
|
|
| csiNode.kubeletDir | string | `"/var/lib/kubelet/"` | Kubelet root dir |
|
|
| csiNode.labels | object | `{}` | CSI Node pod labels |
|
|
| csiNode.logLevel | string | `"5"` | Default log level for all CSI node pod containers (1 = least verbose, 5 = most verbose) unless overridden for a specific container |
|
|
| csiNode.nodeSelector | object | `{}` | CSI Node pod nodeSelector |
|
|
| csiNode.podAnnotations | object | `{}` | CSI Node pod annotations |
|
|
| csiNode.resources | object | `{}` | CSI Node pod resources |
|
|
| csiNode.securityContext | object | `{}` | CSI Node pod security context |
|
|
| csiNode.tolerations | list | `[]` | CSI Node pod tolerations |
|
|
| csiNode.updateStrategy.type | string | `"RollingUpdate"` | CSI Node daemonset update strategy |
|
|
| csiNode.livenessprobe.image.pullPolicy | string | `"IfNotPresent"` | CSI livenessprobe image pull policy |
|
|
| csiNode.livenessprobe.image.registry | string | `"registry.k8s.io/"` | CSI livenessprobe image registry |
|
|
| csiNode.livenessprobe.image.repository | string | `"sig-storage/livenessprobe"` | CSI livenessprobe image repo |
|
|
| csiNode.livenessprobe.image.tag | string | `"v2.10.0"` | CSI livenessprobe image tag |
|
|
| csiNode.livenessprobe.name | string | `"liveness-probe"` | CSI livenessprobe container name|
|
|
| defaultPolicy.name | string | `"openebs-jiva-default-policy"` | Default jiva volume policy |
|
|
| defaultPolicy.enabled | bool | `true` | Enable default jiva volume policy |
|
|
| defaultPolicy.replicaSC | string | `"openebs-hostpath"` | StorageClass used for creating the PVC for the replica STS |
|
|
| defaultPolicy.replicas | string | `"3"` | The desired replication factor for the jiva volumes |
|
|
| storageClass.name | string | `"openebs-jiva-csi-default"` | Default jiva csi StorageClass |
|
|
| storageClass.enabled | bool | `true` | Enable default jiva csi StorageClass |
|
|
| storageClass.allowVolumeExpansion | bool | `true` | Enable volume expansion for the Volumes |
|
|
| storageClass.reclaimPolicy | string | `"Delete"` | Reclaim Policy for the StorageClass |
|
|
| storageClass.isDefaultClass | bool | `false` | Make jiva csi StorageClass as the default StorageClass |
|
|
| jivaOperator.annotations | object | `{}` | Jiva operator annotations |
|
|
| jivaOperator.componentName | string | `"jiva-operator"` | Jiva operator component name |
|
|
| jivaOperator.controller.image.registry | `nil` | Jiva volume controller container image registry |
|
|
| jivaOperator.controller.image.repository | `openebs/jiva` | Jiva volume controller container image repository |
|
|
| jivaOperator.controller.image.tag | `"3.5.0"` | Jiva volume controller container image tag |
|
|
| jivaOperator.exporter.image.registry | `nil` | Jiva volume metrics exporter container image registry |
|
|
| jivaOperator.exporter.image.repository | `openebs/m-exporter` | Jiva volume metrics exporter container image repository |
|
|
| jivaOperator.exporter.image.tag | `"3.5.0"` | Jiva volume metrics exporter container image tag |
|
|
| jivaOperator.image.pullPolicy | string | `"IfNotPresent"` | Jiva operator image pull policy |
|
|
| jivaOperator.image.registry | string | `nil` | Jiva operator image registry |
|
|
| jivaOperator.image.repository | string | `"openebs/jiva-operator"` | Jiva operator image repository |
|
|
| jivaOperator.image.tag | string | `"3.5.0"` | Jiva operator image tag |
|
|
| jivaOperator.nodeSelector | object | `{}` | Jiva operator pod nodeSelector|
|
|
| jivaOperator.podAnnotations | object | `{}` | Jiva operator pod annotations |
|
|
| jivaOperator.replica.image.registry | `nil` | Jiva volume replica container image registry |
|
|
| jivaOperator.replica.image.repository | `openebs/jiva` | Jiva volume replica container image repository |
|
|
| jivaOperator.replica.image.tag | `"3.5.0"` | Jiva volume replica container image tag |
|
|
| jivaOperator.resources | object | `{}` | Jiva operator pod resources |
|
|
| jivaOperator.securityContext | object | `{}` | Jiva operator security context |
|
|
| jivaOperator.tolerations | list | `[]` | Jiva operator pod tolerations |
|
|
| jivaCSIPlugin.image.pullPolicy | string | `"IfNotPresent"` | Jiva CSI driver image pull policy |
|
|
| jivaCSIPlugin.image.registry | string | `nil` | Jiva CSI driver image registry |
|
|
| jivaCSIPlugin.image.repository | string | `"openebs/jiva-csi"` | Jiva CSI driver image repository |
|
|
| jivaCSIPlugin.image.tag | string | `"3.5.0"` | Jiva CSI driver image tag |
|
|
| jivaCSIPlugin.name | string | `"jiva-csi-plugin"` | Jiva CSI driver container name |
|
|
| jivaCSIPlugin.remount | string | `"true"` | Jiva CSI driver remount feature, enabled by default |
|
|
| rbac.create | bool | `true` | Enable RBAC |
|
|
| rbac.pspEnabled | bool | `false` | Enable PodSecurityPolicy |
|
|
| release.version | string | `"3.5.0"` | Openebs Jiva release version |
|
|
| serviceAccount.annotations | object | `{}` | Service Account annotations |
|
|
| serviceAccount.csiController.create | bool | `true` | Enable CSI Controller ServiceAccount |
|
|
| serviceAccount.csiController.name | string | `"openebs-jiva-csi-controller-sa"` | CSI Controller ServiceAccount name |
|
|
| serviceAccount.csiNode.create | bool | `true` | Enable CSI Node ServiceAccount |
|
|
| serviceAccount.csiNode.name | string | `"openebs-jiva-csi-node-sa"` | CSI Node ServiceAccount name |
|
|
| serviceAccount.jivaOperator.create | bool | `true` | Enable Jiva Operator Node ServiceAccount |
|
|
| serviceAccount.jivaOperator.name | string | `"openebs-jiva-operator"` | Jiva Operator ServiceAccount name |
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
|
|
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
|
|
|
|
```bash
|
|
helm install <your-relase-name> -f values.yaml openebs-jiva/jiva
|
|
```
|
|
|
|
> **Tip**: You can use the default [values.yaml](values.yaml)
|