Back to Sealos

OpenEBS Jiva

deploy/base/openebs/v3.10.0/charts/openebs/charts/jiva/README.md

5.1.119.3 KB
Original Source

OpenEBS Jiva

OpenEBS Jiva helm chart for Kubernetes. This chart bootstraps OpenEBS jiva operators and csi driver deployment on a Kubernetes cluster using the Helm package manager

Homepage: http://www.openebs.io/

Maintainers

NameEmailUrl
prateekpandey14[email protected]
shubham14bajpai[email protected]

Get Repo Info

console
helm repo add openebs-jiva https://openebs.github.io/jiva-operator
helm repo update

See helm repo for command documentation.

Install Chart

Please visit the link for install instructions via helm3.

console
# Helm
helm install [RELEASE_NAME] openebs-jiva/jiva --namespace [NAMESPACE] --create-namespace

See configuration below.

See helm install for command documentation.

Dependencies

By default this chart installs additional, dependent charts:

RepositoryNameVersion
https://openebs.github.io/dynamic-localpv-provisionerlocalpv-provisioner3.5.0

Note: Find detailed Dynamic LocalPV Provisioner Helm chart configuration options here.

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.

See 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 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 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) 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
KeyTypeDefaultDescription
csiController.annotationsobject{}CSI controller annotations
csiController.attacher.image.pullPolicystring"IfNotPresent"CSI attacher image pull policy
csiController.attacher.image.registrystring"registry.k8s.io/"CSI attacher image registry
csiController.attacher.image.repositorystring"sig-storage/csi-attacher"CSI attacher image repo
csiController.attacher.image.tagstring"v4.3.0"CSI attacher image tag
csiController.attacher.logLevelstringunspecifiedOverride CSI attacher container log level (1 = least verbose, 5 = most verbose)
csiController.attacher.namestring"csi-attacher"CSI attacher container name
csiController.componentNamestring""CSI controller component name
csiController.livenessprobe.image.pullPolicystring"IfNotPresent"CSI livenessprobe image pull policy
csiController.livenessprobe.image.registrystring"registry.k8s.io/"CSI livenessprobe image registry
csiController.livenessprobe.image.repositorystring"sig-storage/livenessprobe"CSI livenessprobe image repo
csiController.livenessprobe.image.tagstring"v2.10.0"CSI livenessprobe image tag
csiController.livenessprobe.namestring"liveness-probe"CSI livenessprobe container name
csiController.logLevelstring"5"Default log level for all CSI controller containers (1 = least verbose, 5 = most verbose) unless overridden for a specific container
csiController.nodeSelectorobject{}CSI controller pod node selector
csiController.podAnnotationsobject{}CSI controller pod annotations
csiController.provisioner.image.pullPolicystring"IfNotPresent"CSI provisioner image pull policy
csiController.provisioner.image.registrystring"registry.k8s.io/"CSI provisioner image pull registry
csiController.provisioner.image.repositorystring"sig-storage/csi-provisioner"CSI provisioner image pull repository
csiController.provisioner.image.tagstring"v3.5.0"CSI provisioner image tag
csiController.provisioner.logLevelstringunspecifiedOverride CSI provisioner container log level (1 = least verbose, 5 = most verbose)
csiController.provisioner.namestring"csi-provisioner"CSI provisioner container name
csiController.resizer.image.pullPolicystring"IfNotPresent"CSI resizer image pull policy
csiController.resizer.image.registrystring"registry.k8s.io/"CSI resizer image registry
csiController.resizer.image.repositorystring"sig-storage/csi-resizer"CSI resizer image repository
csiController.resizer.image.tagstring"v1.8.0"CSI resizer image tag
csiController.resizer.logLevelstringunspecifiedOverride CSI resizer container log level (1 = least verbose, 5 = most verbose)
csiController.resizer.namestring"csi-resizer"CSI resizer container name
csiController.resourcesobject{}CSI controller container resources
csiController.securityContextobject{}CSI controller security context
csiController.tolerationslist[]CSI controller pod tolerations
csiNode.annotationsobject{}CSI Node annotations
csiNode.componentNamestring"openebs-jiva-csi-node"CSI Node component name
csiNode.driverRegistrar.image.pullPolicystring"IfNotPresent"CSI Node driver registrar image pull policy
csiNode.driverRegistrar.image.registrystring"registry.k8s.io/"CSI Node driver registrar image registry
csiNode.driverRegistrar.image.repositorystring"sig-storage/csi-node-driver-registrar"CSI Node driver registrar image repository
csiNode.driverRegistrar.image.tagstring"v2.8.0"CSI Node driver registrar image tag
csiNode.driverRegistrar.namestring"csi-node-driver-registrar"CSI Node driver registrar container name
csiNode.driverRegistrar.logLevelstringunspecifiedOverride CSI node driver registrar container log level (1 = least verbose, 5 = most verbose)
csiNode.kubeletDirstring"/var/lib/kubelet/"Kubelet root dir
csiNode.labelsobject{}CSI Node pod labels
csiNode.logLevelstring"5"Default log level for all CSI node pod containers (1 = least verbose, 5 = most verbose) unless overridden for a specific container
csiNode.nodeSelectorobject{}CSI Node pod nodeSelector
csiNode.podAnnotationsobject{}CSI Node pod annotations
csiNode.resourcesobject{}CSI Node pod resources
csiNode.securityContextobject{}CSI Node pod security context
csiNode.tolerationslist[]CSI Node pod tolerations
csiNode.updateStrategy.typestring"RollingUpdate"CSI Node daemonset update strategy
csiNode.livenessprobe.image.pullPolicystring"IfNotPresent"CSI livenessprobe image pull policy
csiNode.livenessprobe.image.registrystring"registry.k8s.io/"CSI livenessprobe image registry
csiNode.livenessprobe.image.repositorystring"sig-storage/livenessprobe"CSI livenessprobe image repo
csiNode.livenessprobe.image.tagstring"v2.10.0"CSI livenessprobe image tag
csiNode.livenessprobe.namestring"liveness-probe"CSI livenessprobe container name
defaultPolicy.namestring"openebs-jiva-default-policy"Default jiva volume policy
defaultPolicy.enabledbooltrueEnable default jiva volume policy
defaultPolicy.replicaSCstring"openebs-hostpath"StorageClass used for creating the PVC for the replica STS
defaultPolicy.replicasstring"3"The desired replication factor for the jiva volumes
storageClass.namestring"openebs-jiva-csi-default"Default jiva csi StorageClass
storageClass.enabledbooltrueEnable default jiva csi StorageClass
storageClass.allowVolumeExpansionbooltrueEnable volume expansion for the Volumes
storageClass.reclaimPolicystring"Delete"Reclaim Policy for the StorageClass
storageClass.isDefaultClassboolfalseMake jiva csi StorageClass as the default StorageClass
jivaOperator.annotationsobject{}Jiva operator annotations
jivaOperator.componentNamestring"jiva-operator"Jiva operator component name
jivaOperator.controller.image.registrynilJiva volume controller container image registry
jivaOperator.controller.image.repositoryopenebs/jivaJiva volume controller container image repository
jivaOperator.controller.image.tag"3.6.0"Jiva volume controller container image tag
jivaOperator.exporter.image.registrynilJiva volume metrics exporter container image registry
jivaOperator.exporter.image.repositoryopenebs/m-exporterJiva volume metrics exporter container image repository
jivaOperator.exporter.image.tag"3.6.0"Jiva volume metrics exporter container image tag
jivaOperator.image.pullPolicystring"IfNotPresent"Jiva operator image pull policy
jivaOperator.image.registrystringnilJiva operator image registry
jivaOperator.image.repositorystring"openebs/jiva-operator"Jiva operator image repository
jivaOperator.image.tagstring"3.6.0"Jiva operator image tag
jivaOperator.nodeSelectorobject{}Jiva operator pod nodeSelector
jivaOperator.podAnnotationsobject{}Jiva operator pod annotations
jivaOperator.replica.image.registrynilJiva volume replica container image registry
jivaOperator.replica.image.repositoryopenebs/jivaJiva volume replica container image repository
jivaOperator.replica.image.tag"3.6.0"Jiva volume replica container image tag
jivaOperator.resourcesobject{}Jiva operator pod resources
jivaOperator.securityContextobject{}Jiva operator security context
jivaOperator.tolerationslist[]Jiva operator pod tolerations
jivaCSIPlugin.image.pullPolicystring"IfNotPresent"Jiva CSI driver image pull policy
jivaCSIPlugin.image.registrystringnilJiva CSI driver image registry
jivaCSIPlugin.image.repositorystring"openebs/jiva-csi"Jiva CSI driver image repository
jivaCSIPlugin.image.tagstring"3.6.0"Jiva CSI driver image tag
jivaCSIPlugin.namestring"jiva-csi-plugin"Jiva CSI driver container name
jivaCSIPlugin.remountstring"true"Jiva CSI driver remount feature, enabled by default
rbac.createbooltrueEnable RBAC
rbac.pspEnabledboolfalseEnable PodSecurityPolicy
release.versionstring"3.6.0"Openebs Jiva release version
serviceAccount.annotationsobject{}Service Account annotations
serviceAccount.csiController.createbooltrueEnable CSI Controller ServiceAccount
serviceAccount.csiController.namestring"openebs-jiva-csi-controller-sa"CSI Controller ServiceAccount name
serviceAccount.csiNode.createbooltrueEnable CSI Node ServiceAccount
serviceAccount.csiNode.namestring"openebs-jiva-csi-node-sa"CSI Node ServiceAccount name
serviceAccount.jivaOperator.createbooltrueEnable Jiva Operator Node ServiceAccount
serviceAccount.jivaOperator.namestring"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