github.com/openebs/node-disk-manager@v1.9.1-0.20230225014141-4531f06ffa1e/deploy/helm/charts/README.md (about) 1 ## Introduction 2 3 This chart bootstraps OpenEBS NDM deployment on a [Kubernetes](http://kubernetes.io) cluster using the 4 [Helm](https://helm.sh) package manager. 5 6 ## Installation 7 8 You can run OpenEBS NDM on any Kubernetes 1.17+ cluster in a matter of seconds. 9 10 Please visit the [link](https://openebs.github.io/node-disk-manager/) for install instructions via helm3. 11 12 ## Configuration 13 14 The following table lists the configurable parameters of the OpenEBS NDM chart and their default values. 15 16 | Parameter | Description | Default | 17 |-------------------------------------------------------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| 18 | `imagePullSecrets` | Provides image pull secrect | `""` | 19 | `ndm.enabled` | Enable Node Disk Manager | `true` | 20 | `ndm.image.registry` | Registry for Node Disk Manager image | `""` | 21 | `ndm.image.repository` | Image repository for Node Disk Manager | `openebs/node-disk-manager` | 22 | `ndm.image.pullPolicy` | Image pull policy for Node Disk Manager | `IfNotPresent` | 23 | `ndm.image.tag` | Image tag for Node Disk Manager | `2.1.0` | 24 | `ndm.sparse.path` | Directory where Sparse files are created | `/var/openebs/sparse` | 25 | `ndm.sparse.size` | Size of the sparse file in bytes | `10737418240` | 26 | `ndm.sparse.count` | Number of sparse files to be created | `0` | 27 | `ndm.updateStrategy.type` | Update strategy for NDM daemonset | `RollingUpdate` | 28 | `ndm.annotations` | Annotations for NDM daemonset metadata | `""` | 29 | `ndm.podAnnotations` | Annotations for NDM daemonset's pods metadata | `""` | 30 | `ndm.resources` | Resource and request and limit for containers | `""` | 31 | `ndm.podLabels` | Appends labels to the pods | `""` | 32 | `ndm.nodeSelector` | Nodeselector for daemonset pods | `""` | 33 | `ndm.tolerations` | NDM daemonset's pod toleration values | `""` | 34 | `ndm.securityContext` | Seurity context for container | `""` | 35 | `ndm.filters.enableOsDiskExcludeFilter` | Enable filters of OS disk exclude | `true` | 36 | `ndm.filters.osDiskExcludePaths` | Paths/Mountpoints to be excluded by OS Disk Filter | `/,/etc/hosts,/boot` | 37 | `ndm.filters.enableVendorFilter` | Enable filters of vendors | `true` | 38 | `ndm.filters.excludeVendors` | Exclude devices with specified vendor | `CLOUDBYT,OpenEBS` | 39 | `ndm.filters.enablePathFilter` | Enable filters of paths | `true` | 40 | `ndm.filters.includePaths` | Include devices with specified path patterns | `""` | 41 | `ndm.filters.excludePaths` | Exclude devices with specified path patterns | `loop,fd0,sr0,/dev/ram,/dev/dm-,/dev/md,/dev/rbd,/dev/zd` | 42 | `ndm.probes.enableSeachest` | Enable Seachest probe for NDM | `false` | 43 | `ndm.probes.enableUdevProbe` | Enable Udev probe for NDM | `true` | 44 | `ndm.probes.enableSmartProbe` | Enable Smart probe for NDM | `true` | 45 | `ndm.metaConfig.nodeLabelPattern` | Config for adding node labels as BD labels | `kubernetes.io*,beta.kubernetes.io*` | 46 | `ndm.metaConfig.deviceLabelTypes` | Config for adding device attributes as BD labels | `.spec.details.vendor,.spec.details.model,.spec.details.driveType,.spec.filesystem.fsType` | 47 | `ndmOperator.enabled` | Enable NDM Operator | `true` | 48 | `ndmOperator.replica` | Pod replica count for NDM operator | `1` | 49 | `ndmOperator.upgradeStrategy` | Update strategy NDM operator | `"Recreate"` | 50 | `ndmOperator.image.registry` | Registry for NDM operator image | `""` | 51 | `ndmOperator.image.repository` | Image repository for NDM operator | `openebs/node-disk-operator` | 52 | `ndmOperator.image.pullPolicy` | Image pull policy for NDM operator | `IfNotPresent` | 53 | `ndmOperator.image.tag` | Image tag for NDM operator | `2.1.0` | 54 | `ndmOperator.annotations` | Annotations for NDM operator metadata | `""` | 55 | `ndmOperator.podAnnotations` | Annotations for NDM operator's pods metadata | `""` | 56 | `ndmOperator.resources` | Resource and request and limit for containers | `""` | 57 | `ndmOperator.podLabels` | Appends labels to the pods | `""` | 58 | `ndmOperator.nodeSelector` | Nodeselector for operator pods | `""` | 59 | `ndmOperator.tolerations` | NDM operator's pod toleration values | `""` | 60 | `ndmOperator.securityContext` | Security context for container | `""` | 61 | `ndmExporter.enabled` | Enable NDM Exporters | `false` | 62 | `ndmExporter.image.registry` | Registry for NDM Exporters image | `""` | 63 | `ndmExporter.repository` | Image repository for NDM Exporters | `openebs/node-disk-exporter` | 64 | `ndmExporter.pullPolicy` | Image pull policy for NDM Exporters | `IfNotPresent` | 65 | `ndmExporter.tag` | Image tag for NDM Exporters | `2.1.0` | 66 | `ndmExporter.nodeExporter.metricsPort` | The TCP port number used for exposing NDM node exporter metrics | `9101` | 67 | `ndmExporter.nodeExporter.nodeExporter.nodeSelector` | Node selector for NDM node exporter pods | `9101` | 68 | `ndmExporter.nodeExporter.nodeExporter.tolerations` | NDM node exporter toleration values | `9101` | 69 | `ndmExporter.clusterExporter.metricsPort` | The TCP port number used for exposing NDM cluster exporter metrics | `9100` | 70 | `ndmExporter.clusterExporter.clusterExpoerter.nodeSelector` | Node selector for NDM cluster exporter pod | `9100` | 71 | `ndmExporter.clusterExporter.clusterExpoerter.tolerations` | NDM cluster exporter toleraion values | `9100` | 72 | `featureGates.APIService.enabled` | Enable the gRPC API service of NDM | `false` | 73 | `featureGates.UseOSDisk.enabled` | Enable feature-gate to use free space on OS disk | `false` | 74 | `featureGates.ChangeDetection.enabled` | Enable feature-gate to detect mountpoint/filesystem/size changes | `false` | 75 | `featureGates.PartitionTableUUID.enabled` | Enable feature-gate to use partition table UUID instead of creating partition | `true` | 76 | `helperPod.image.registry` | Registry for helper image | `""` | 77 | `helperPod.image.repository` | Image for helper pod | `openebs/linux-utils` | 78 | `helperPod.image.pullPolicy` | Pull policy for helper pod | `IfNotPresent` | 79 | `helperPod.image.tag` | Image tag for helper image | `3.4.0` | 80 | `varDirectoryPath.baseDir` | Directory to store debug info and so forth | `/var/openebs` | 81 | `serviceAccount.create` | Create a service account or not | `true` | 82 | `serviceAccount.name` | Name for the service account | `true` | 83 84 85 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. 86 87 Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, 88 89 ```bash 90 helm install <release-name> -f values.yaml ndm/openebs-ndm 91 ``` 92 93 > **Tip**: You can use the default [values.yaml](values.yaml)