[bitnami/*] Standardize documentation (#19835)

Signed-off-by: Jota Martos <jotamartos@vmware.com>
This commit is contained in:
Juan José Martos
2023-10-20 08:18:30 +02:00
committed by GitHub
parent 3e0672c0ad
commit af5f7530c1
216 changed files with 14699 additions and 13690 deletions

View File

@@ -11,9 +11,11 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/node-exporter
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/node-exporter
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
## Introduction
This chart bootstraps [Node Exporter](https://github.com/bitnami/containers/tree/main/bitnami/node-exporter) on [Kubernetes](https://kubernetes.io) using the [Helm](https://helm.sh) package manager.
@@ -32,9 +34,11 @@ Looking to use Node Exporter in production? Try [VMware Application Catalog](htt
To install the chart with the release name `my-release`:
```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/node-exporter
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/node-exporter
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
The command deploys Node Exporter on the Kubernetes cluster in the default configuration. The [configuration](#configuration-and-installation-details) section lists the parameters that can be configured during installation.
## Uninstalling the Chart
@@ -75,117 +79,120 @@ The command removes all the Kubernetes components associated with the chart and
### Node Exporter parameters
| Name | Description | Value |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- |
| `hostAliases` | Deployment pod host aliases | `[]` |
| `rbac.create` | Whether to create and use RBAC resources or not | `true` |
| `rbac.pspEnabled` | Whether to create a PodSecurityPolicy and bound it with RBAC. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or later | `true` |
| `serviceAccount.create` | Specifies whether a ServiceAccount should be created | `true` |
| `serviceAccount.name` | Name of the service account to use. If not set and create is true, a name is generated using the fullname template. | `""` |
| `serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` |
| `serviceAccount.annotations` | Annotations for service account. Evaluated as a template. Only used if `create` is `true`. | `{}` |
| `image.registry` | Node Exporter image registry | `docker.io` |
| `image.repository` | Node Exporter image repository | `bitnami/node-exporter` |
| `image.tag` | Node Exporter image tag (immutable tags are recommended) | `1.6.1-debian-11-r78` |
| `image.digest` | Node Exporter image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `image.pullPolicy` | Node Exporter image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Specify docker-registry secret names as an array | `[]` |
| `containerPorts.metrics` | Node Exporter container port | `9100` |
| `sidecars` | Add additional sidecar containers to the Node exporter pod(s) | `[]` |
| `initContainers` | Add additional init containers to the Node exporter pod(s) | `[]` |
| `extraArgs` | Additional command line arguments to pass to node-exporter | `{}` |
| `command` | Override default container command (useful when using custom images) | `[]` |
| `args` | Override default container args (useful when using custom images) | `[]` |
| `lifecycleHooks` | for the Node exporter container(s) to automate configuration before or after startup | `{}` |
| `extraEnvVars` | Array with extra environment variables to add to Node exporter container | `[]` |
| `extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars for Node exporter container | `""` |
| `extraEnvVarsSecret` | Name of existing Secret containing extra env vars for Node exporter container | `""` |
| `extraVolumes` | Additional volumes to the node-exporter pods | `[]` |
| `extraVolumeMounts` | Additional volumeMounts to the node-exporter container | `[]` |
| `podSecurityContext.enabled` | Enabled Node exporter pods' Security Context | `true` |
| `podSecurityContext.fsGroup` | Set Node exporter pod's Security Context fsGroup | `1001` |
| `containerSecurityContext.enabled` | Enabled Node exporter containers' Security Context | `true` |
| `containerSecurityContext.runAsUser` | Set Node exporter containers' Security Context runAsUser | `1001` |
| `containerSecurityContext.runAsNonRoot` | Set Node exporter container's Security Context runAsNonRoot | `true` |
| `service.type` | Kubernetes service type | `ClusterIP` |
| `service.ports.metrics` | Node Exporter metrics service port | `9100` |
| `service.nodePorts.metrics` | Specify the nodePort value for the LoadBalancer and NodePort service types | `""` |
| `service.clusterIP` | Specific cluster IP when service type is cluster IP. Use `None` for headless service | `""` |
| `service.loadBalancerIP` | `loadBalancerIP` if service type is `LoadBalancer` | `""` |
| `service.loadBalancerSourceRanges` | Address that are allowed when service is `LoadBalancer` | `[]` |
| `service.externalTrafficPolicy` | Node exporter service external traffic policy | `Cluster` |
| `service.extraPorts` | Extra ports to expose (normally used with the `sidecar` value) | `[]` |
| `service.addPrometheusScrapeAnnotation` | Add the `prometheus.io/scrape: "true"` annotation to the service | `true` |
| `service.annotations` | Additional annotations for Node Exporter service | `{}` |
| `service.labels` | Additional labels for Node Exporter service | `{}` |
| `service.sessionAffinity` | Session Affinity for Kubernetes service, can be "None" or "ClientIP" | `None` |
| `service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` |
| `updateStrategy.type` | The update strategy type to apply to the DaemonSet | `RollingUpdate` |
| `updateStrategy.rollingUpdate.maxUnavailable` | Maximum number of pods that may be made unavailable | `1` |
| `hostNetwork` | Expose the service to the host network | `true` |
| `hostPID` | Allows visibility of processes on the host, potentially leaking information such as environment variables and configuration | `true` |
| `minReadySeconds` | `minReadySeconds` to avoid killing pods before we are ready | `0` |
| `priorityClassName` | Priority class assigned to the Pods | `""` |
| `terminationGracePeriodSeconds` | In seconds, time the given to the Node exporter pod needs to terminate gracefully | `""` |
| `resources.limits` | The resources limits for the container | `{}` |
| `resources.requests` | The requested resources for the container | `{}` |
| `podLabels` | Pod labels | `{}` |
| `podAnnotations` | Pod annotations | `{}` |
| `podAffinityPreset` | Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `podAntiAffinityPreset` | Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `soft` |
| `nodeAffinityPreset.type` | Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `nodeAffinityPreset.key` | Node label key to match Ignored if `affinity` is set. | `""` |
| `nodeAffinityPreset.values` | Node label values to match. Ignored if `affinity` is set. | `[]` |
| `affinity` | Affinity for pod assignment. Evaluated as a template. | `{}` |
| `nodeSelector` | Node labels for pod assignment. Evaluated as a template. | `{}` |
| `tolerations` | Tolerations for pod assignment. Evaluated as a template. | `[]` |
| `livenessProbe.enabled` | Enable livenessProbe | `true` |
| `livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `120` |
| `livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `5` |
| `livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `6` |
| `livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `readinessProbe.enabled` | Enable readinessProbe | `true` |
| `readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `30` |
| `readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `5` |
| `readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `6` |
| `readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `startupProbe.enabled` | Enable startupProbe | `false` |
| `startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `30` |
| `startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
| `startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `5` |
| `startupProbe.failureThreshold` | Failure threshold for startupProbe | `6` |
| `startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `customStartupProbe` | Custom liveness probe for the Node exporter container | `{}` |
| `customLivenessProbe` | Custom liveness probe for the Node exporter container | `{}` |
| `customReadinessProbe` | Custom readiness probe for the Node exporter container | `{}` |
| `serviceMonitor.enabled` | Creates a ServiceMonitor to monitor Node Exporter | `false` |
| `serviceMonitor.namespace` | Namespace in which Prometheus is running | `""` |
| `serviceMonitor.jobLabel` | The name of the label on the target service to use as the job name in prometheus. | `""` |
| `serviceMonitor.interval` | Scrape interval (use by default, falling back to Prometheus' default) | `""` |
| `serviceMonitor.scrapeTimeout` | Timeout after which the scrape is ended | `""` |
| `serviceMonitor.basicAuth` | Use basic auth for scraping | `{}` |
| `serviceMonitor.selector` | ServiceMonitor selector labels | `{}` |
| `serviceMonitor.relabelings` | RelabelConfigs to apply to samples before scraping | `[]` |
| `serviceMonitor.metricRelabelings` | MetricRelabelConfigs to apply to samples before ingestion | `[]` |
| `serviceMonitor.labels` | Extra labels for the ServiceMonitor | `{}` |
| `serviceMonitor.honorLabels` | honorLabels chooses the metric's labels on collisions with target labels | `false` |
| `serviceMonitor.attachMetadata` | Attaches node metadata to discovered targets | `{}` |
| `serviceMonitor.sampleLimit` | Per-scrape limit on number of scraped samples that will be accepted. | `""` |
| Name | Description | Value |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- |
| `hostAliases` | Deployment pod host aliases | `[]` |
| `rbac.create` | Whether to create and use RBAC resources or not | `true` |
| `rbac.pspEnabled` | Whether to create a PodSecurityPolicy and bound it with RBAC. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or later | `true` |
| `serviceAccount.create` | Specifies whether a ServiceAccount should be created | `true` |
| `serviceAccount.name` | Name of the service account to use. If not set and create is true, a name is generated using the fullname template. | `""` |
| `serviceAccount.automountServiceAccountToken` | Automount service account token for the server service account | `true` |
| `serviceAccount.annotations` | Annotations for service account. Evaluated as a template. Only used if `create` is `true`. | `{}` |
| `image.registry` | Node Exporter image registry | `REGISTRY_NAME` |
| `image.repository` | Node Exporter image repository | `REPOSITORY_NAME/node-exporter` |
| `image.tag` | Node Exporter image tag (immutable tags are recommended) | `1.6.1-debian-11-r78` |
| `image.digest` | Node Exporter image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `image.pullPolicy` | Node Exporter image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Specify docker-registry secret names as an array | `[]` |
| `containerPorts.metrics` | Node Exporter container port | `9100` |
| `sidecars` | Add additional sidecar containers to the Node exporter pod(s) | `[]` |
| `initContainers` | Add additional init containers to the Node exporter pod(s) | `[]` |
| `extraArgs` | Additional command line arguments to pass to node-exporter | `{}` |
| `command` | Override default container command (useful when using custom images) | `[]` |
| `args` | Override default container args (useful when using custom images) | `[]` |
| `lifecycleHooks` | for the Node exporter container(s) to automate configuration before or after startup | `{}` |
| `extraEnvVars` | Array with extra environment variables to add to Node exporter container | `[]` |
| `extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars for Node exporter container | `""` |
| `extraEnvVarsSecret` | Name of existing Secret containing extra env vars for Node exporter container | `""` |
| `extraVolumes` | Additional volumes to the node-exporter pods | `[]` |
| `extraVolumeMounts` | Additional volumeMounts to the node-exporter container | `[]` |
| `podSecurityContext.enabled` | Enabled Node exporter pods' Security Context | `true` |
| `podSecurityContext.fsGroup` | Set Node exporter pod's Security Context fsGroup | `1001` |
| `containerSecurityContext.enabled` | Enabled Node exporter containers' Security Context | `true` |
| `containerSecurityContext.runAsUser` | Set Node exporter containers' Security Context runAsUser | `1001` |
| `containerSecurityContext.runAsNonRoot` | Set Node exporter container's Security Context runAsNonRoot | `true` |
| `service.type` | Kubernetes service type | `ClusterIP` |
| `service.ports.metrics` | Node Exporter metrics service port | `9100` |
| `service.nodePorts.metrics` | Specify the nodePort value for the LoadBalancer and NodePort service types | `""` |
| `service.clusterIP` | Specific cluster IP when service type is cluster IP. Use `None` for headless service | `""` |
| `service.loadBalancerIP` | `loadBalancerIP` if service type is `LoadBalancer` | `""` |
| `service.loadBalancerSourceRanges` | Address that are allowed when service is `LoadBalancer` | `[]` |
| `service.externalTrafficPolicy` | Node exporter service external traffic policy | `Cluster` |
| `service.extraPorts` | Extra ports to expose (normally used with the `sidecar` value) | `[]` |
| `service.addPrometheusScrapeAnnotation` | Add the `prometheus.io/scrape: "true"` annotation to the service | `true` |
| `service.annotations` | Additional annotations for Node Exporter service | `{}` |
| `service.labels` | Additional labels for Node Exporter service | `{}` |
| `service.sessionAffinity` | Session Affinity for Kubernetes service, can be "None" or "ClientIP" | `None` |
| `service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` |
| `updateStrategy.type` | The update strategy type to apply to the DaemonSet | `RollingUpdate` |
| `updateStrategy.rollingUpdate.maxUnavailable` | Maximum number of pods that may be made unavailable | `1` |
| `hostNetwork` | Expose the service to the host network | `true` |
| `hostPID` | Allows visibility of processes on the host, potentially leaking information such as environment variables and configuration | `true` |
| `minReadySeconds` | `minReadySeconds` to avoid killing pods before we are ready | `0` |
| `priorityClassName` | Priority class assigned to the Pods | `""` |
| `terminationGracePeriodSeconds` | In seconds, time the given to the Node exporter pod needs to terminate gracefully | `""` |
| `resources.limits` | The resources limits for the container | `{}` |
| `resources.requests` | The requested resources for the container | `{}` |
| `podLabels` | Pod labels | `{}` |
| `podAnnotations` | Pod annotations | `{}` |
| `podAffinityPreset` | Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `podAntiAffinityPreset` | Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `soft` |
| `nodeAffinityPreset.type` | Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` |
| `nodeAffinityPreset.key` | Node label key to match Ignored if `affinity` is set. | `""` |
| `nodeAffinityPreset.values` | Node label values to match. Ignored if `affinity` is set. | `[]` |
| `affinity` | Affinity for pod assignment. Evaluated as a template. | `{}` |
| `nodeSelector` | Node labels for pod assignment. Evaluated as a template. | `{}` |
| `tolerations` | Tolerations for pod assignment. Evaluated as a template. | `[]` |
| `livenessProbe.enabled` | Enable livenessProbe | `true` |
| `livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `120` |
| `livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `5` |
| `livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `6` |
| `livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `readinessProbe.enabled` | Enable readinessProbe | `true` |
| `readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `30` |
| `readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `5` |
| `readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `6` |
| `readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `startupProbe.enabled` | Enable startupProbe | `false` |
| `startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `30` |
| `startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
| `startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `5` |
| `startupProbe.failureThreshold` | Failure threshold for startupProbe | `6` |
| `startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
| `customStartupProbe` | Custom liveness probe for the Node exporter container | `{}` |
| `customLivenessProbe` | Custom liveness probe for the Node exporter container | `{}` |
| `customReadinessProbe` | Custom readiness probe for the Node exporter container | `{}` |
| `serviceMonitor.enabled` | Creates a ServiceMonitor to monitor Node Exporter | `false` |
| `serviceMonitor.namespace` | Namespace in which Prometheus is running | `""` |
| `serviceMonitor.jobLabel` | The name of the label on the target service to use as the job name in prometheus. | `""` |
| `serviceMonitor.interval` | Scrape interval (use by default, falling back to Prometheus' default) | `""` |
| `serviceMonitor.scrapeTimeout` | Timeout after which the scrape is ended | `""` |
| `serviceMonitor.basicAuth` | Use basic auth for scraping | `{}` |
| `serviceMonitor.selector` | ServiceMonitor selector labels | `{}` |
| `serviceMonitor.relabelings` | RelabelConfigs to apply to samples before scraping | `[]` |
| `serviceMonitor.metricRelabelings` | MetricRelabelConfigs to apply to samples before ingestion | `[]` |
| `serviceMonitor.labels` | Extra labels for the ServiceMonitor | `{}` |
| `serviceMonitor.honorLabels` | honorLabels chooses the metric's labels on collisions with target labels | `false` |
| `serviceMonitor.attachMetadata` | Attaches node metadata to discovered targets | `{}` |
| `serviceMonitor.sampleLimit` | Per-scrape limit on number of scraped samples that will be accepted. | `""` |
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example the following command sets the `minReadySeconds` of the Node Exporter Pods to `120` seconds.
```console
helm install my-release --set minReadySeconds=120 oci://registry-1.docker.io/bitnamicharts/node-exporter
helm install my-release --set minReadySeconds=120 oci://REGISTRY_NAME/REPOSITORY_NAME/node-exporter
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
```console
helm install my-release -f values.yaml oci://registry-1.docker.io/bitnamicharts/node-exporter
helm install my-release -f values.yaml oci://REGISTRY_NAME/REPOSITORY_NAME/node-exporter
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
> **Tip**: You can use the default [values.yaml](values.yaml)
## Configuration and installation details
@@ -209,9 +216,11 @@ Find more information about how to deal with common errors related to Bitnami's
## Upgrading
```console
helm upgrade my-release oci://registry-1.docker.io/bitnamicharts/node-exporter
helm upgrade my-release oci://REGISTRY_NAME/REPOSITORY_NAME/node-exporter
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
### To 3.0.0
This major release renames several values in this chart and adds missing features, in order to be aligned with the rest of the assets in the Bitnami charts repository.