[bitnami/grafana-operator] Make ingress host optional (#9922)

* [bitnami/grafana-operator] Make ingress host optional

Signed-off-by: Ronan LE BRUN <ronan.lebrun@gmail.com>

* Update README.md with readme-generator-for-helm

Signed-off-by: Bitnami Containers <containers@bitnami.com>

Co-authored-by: Bitnami Containers <containers@bitnami.com>
This commit is contained in:
Ronan LE BRUN
2022-04-26 09:46:26 +02:00
committed by GitHub
parent d13421db89
commit a123207427
4 changed files with 80 additions and 78 deletions

View File

@@ -24,4 +24,4 @@ name: grafana-operator
sources:
- https://github.com/grafana-operator/grafana-operator
- https://github.com/bitnami/bitnami-docker-grafana-operator
version: 2.3.7
version: 2.4.0

View File

@@ -106,7 +106,7 @@ For more information, refer to the [documentation on the differences between the
| `operator.updateStrategy.type` | Set up update strategy for Grafana Operator installation. | `Recreate` |
| `operator.image.registry` | Grafana Operator image registry | `docker.io` |
| `operator.image.repository` | Grafana Operator image name | `bitnami/grafana-operator` |
| `operator.image.tag` | Grafana Operator image tag | `4.2.0-debian-10-r38` |
| `operator.image.tag` | Grafana Operator image tag | `4.2.0-debian-10-r54` |
| `operator.image.pullPolicy` | Grafana Operator image pull policy | `IfNotPresent` |
| `operator.image.pullSecrets` | Grafana Operator image pull secrets | `[]` |
| `operator.leaderElect` | Enables or disables the operator leader Election. | `true` |
@@ -181,81 +181,81 @@ For more information, refer to the [documentation on the differences between the
### Grafana parameters
| Name | Description | Value |
| ----------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------ |
| `grafana.enabled` | Enabled the deployment of the Grafana CRD object into the cluster | `true` |
| `grafana.image.registry` | Grafana image registry | `docker.io` |
| `grafana.image.repository` | Grafana image name | `bitnami/grafana` |
| `grafana.image.tag` | Grafana image tag | `8.4.5-debian-10-r1` |
| `grafana.image.pullSecrets` | Grafana image pull secrets | `[]` |
| `grafana.serviceAccount` | Additional service account configuration | `{}` |
| `grafana.podSecurityContext.enabled` | Enable pods security context | `true` |
| `grafana.podSecurityContext.runAsUser` | User ID for the pods | `1001` |
| `grafana.podSecurityContext.runAsGroup` | User ID for the pods | `0` |
| `grafana.podSecurityContext.runAsNonRoot` | Grafana Operator must run as nonRoot | `true` |
| `grafana.podSecurityContext.fsGroup` | Group ID for the pods | `1001` |
| `grafana.podSecurityContext.supplementalGroups` | Which group IDs containers add | `[]` |
| `grafana.containerSecurityContext.enabled` | Enable containers security context | `true` |
| `grafana.containerSecurityContext.runAsUser` | User ID for the containers | `1001` |
| `grafana.containerSecurityContext.runAsGroup` | Group ID for the containers | `0` |
| `grafana.containerSecurityContext.privileged` | Decide if the container runs privileged. | `false` |
| `grafana.containerSecurityContext.runAsNonRoot` | Force the container to run as non-root | `true` |
| `grafana.containerSecurityContext.allowPrivilegeEscalation` | Don't allow privilege escalation for the containers | `false` |
| `grafana.resources.limits` | The resources limits for the container | `{}` |
| `grafana.resources.requests` | The requested resources for the container | `{}` |
| `grafana.replicaCount` | Specify the amount of replicas running | `1` |
| `grafana.skipCreateAdminAccount` | Prevent the operator from creating an admin secret | `false` |
| `grafana.podAffinityPreset` | Pod affinity preset | `""` |
| `grafana.podAntiAffinityPreset` | Pod anti-affinity preset | `soft` |
| `grafana.nodeAffinityPreset.type` | Set nodeAffinity preset type | `""` |
| `grafana.nodeAffinityPreset.key` | Set nodeAffinity preset key | `""` |
| `grafana.nodeAffinityPreset.values` | Set nodeAffinity preset values | `[]` |
| `grafana.affinity` | Affinity for controller pod assignment | `{}` |
| `grafana.nodeSelector` | Node labels for controller pod assignment | `{}` |
| `grafana.tolerations` | Tolerations for controller pod assignment | `[]` |
| `grafana.envFrom` | Extra environment variable to pass to the running container | `[]` |
| `grafana.client.timeout` | The timeout in seconds for the Grafana Rest API on that instance | `5` |
| `grafana.client.preferService` | If the API should be used via Ingress or via the internal service | `true` |
| `grafana.labels` | Add additional labels to the grafana deployment, service and ingress resources | `{}` |
| `grafana.service.type` | Kubernetes Service type | `ClusterIP` |
| `grafana.service.annotations` | Additional custom annotations for Grafana service | `{}` |
| `grafana.service.extraPorts` | Extra ports to expose in the Grafana service | `[]` |
| `grafana.ingress.enabled` | If an ingress or OpenShift Route should be created | `false` |
| `grafana.ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `""` |
| `grafana.ingress.hostname` | The hostname under which the grafana instance should be reachable | `grafana.local` |
| `grafana.ingress.path` | The path for the ingress instance to forward to the grafana app | `/` |
| `grafana.ingress.pathType` | The pathType for the ingress instance to forward to the grafana app | `ImplementationSpecific` |
| `grafana.ingress.labels` | Additional Labels for the ingress resource | `{}` |
| `grafana.ingress.annotations` | Additional Annotations for the ingress resource | `{}` |
| `grafana.ingress.tls` | This enables tls support for the ingress resource | `false` |
| `grafana.ingress.tlsSecret` | The name for the secret to use for the tls termination | `grafana.local-tls` |
| `grafana.persistence.enabled` | Enable persistent storage for the grafana deployment | `false` |
| `grafana.persistence.storageClass` | Define the storageClass for the persistent storage if not defined default is used | `""` |
| `grafana.persistence.accessModes` | Define the accessModes for the persistent storage | `["ReadWriteOnce"]` |
| `grafana.persistence.annotations` | Add annotations to the persistent volume | `{}` |
| `grafana.persistence.size` | Define the size of the PersistentVolumeClaim to request for | `10Gi` |
| `grafana.config` | grafana.ini configuration for the instance for this to configure please look at upstream docs | `{}` |
| `grafana.configMaps` | Extra configMaps to mount into the grafana pod | `[]` |
| `grafana.secrets` | Extra secrets to mount into the grafana pod | `[]` |
| `grafana.jsonnetLibrarySelector` | Configuring the read for jsonnetLibraries to pull in. | `{}` |
| `grafana.dashboardLabelSelectors` | This selects dashboards on the label. | `{}` |
| `grafana.dashboardNamespaceSelector` | Watch for dashboards only in the Namespaces that have the specified namespace label | `{}` |
| `grafana.livenessProbe.enabled` | Enable livenessProbe | `true` |
| `grafana.livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `120` |
| `grafana.livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `grafana.livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `5` |
| `grafana.livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `6` |
| `grafana.livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `grafana.readinessProbe.enabled` | Enable readinessProbe | `true` |
| `grafana.readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `30` |
| `grafana.readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `grafana.readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `5` |
| `grafana.readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `6` |
| `grafana.readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `grafana.updateStrategy` | Set up update strategy for Grafana installation. | `{}` |
| `grafana.extraVolumes` | Optionally specify extra list of additional volumes for the grafana pod(s) | `[]` |
| `grafana.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for the grafana container(s) | `[]` |
| `grafana.sidecars` | Add additional sidecar containers to the grafana pod(s) | `[]` |
| Name | Description | Value |
| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------ |
| `grafana.enabled` | Enabled the deployment of the Grafana CRD object into the cluster | `true` |
| `grafana.image.registry` | Grafana image registry | `docker.io` |
| `grafana.image.repository` | Grafana image name | `bitnami/grafana` |
| `grafana.image.tag` | Grafana image tag | `8.4.6-debian-10-r6` |
| `grafana.image.pullSecrets` | Grafana image pull secrets | `[]` |
| `grafana.serviceAccount` | Additional service account configuration | `{}` |
| `grafana.podSecurityContext.enabled` | Enable pods security context | `true` |
| `grafana.podSecurityContext.runAsUser` | User ID for the pods | `1001` |
| `grafana.podSecurityContext.runAsGroup` | User ID for the pods | `0` |
| `grafana.podSecurityContext.runAsNonRoot` | Grafana Operator must run as nonRoot | `true` |
| `grafana.podSecurityContext.fsGroup` | Group ID for the pods | `1001` |
| `grafana.podSecurityContext.supplementalGroups` | Which group IDs containers add | `[]` |
| `grafana.containerSecurityContext.enabled` | Enable containers security context | `true` |
| `grafana.containerSecurityContext.runAsUser` | User ID for the containers | `1001` |
| `grafana.containerSecurityContext.runAsGroup` | Group ID for the containers | `0` |
| `grafana.containerSecurityContext.privileged` | Decide if the container runs privileged. | `false` |
| `grafana.containerSecurityContext.runAsNonRoot` | Force the container to run as non-root | `true` |
| `grafana.containerSecurityContext.allowPrivilegeEscalation` | Don't allow privilege escalation for the containers | `false` |
| `grafana.resources.limits` | The resources limits for the container | `{}` |
| `grafana.resources.requests` | The requested resources for the container | `{}` |
| `grafana.replicaCount` | Specify the amount of replicas running | `1` |
| `grafana.skipCreateAdminAccount` | Prevent the operator from creating an admin secret | `false` |
| `grafana.podAffinityPreset` | Pod affinity preset | `""` |
| `grafana.podAntiAffinityPreset` | Pod anti-affinity preset | `soft` |
| `grafana.nodeAffinityPreset.type` | Set nodeAffinity preset type | `""` |
| `grafana.nodeAffinityPreset.key` | Set nodeAffinity preset key | `""` |
| `grafana.nodeAffinityPreset.values` | Set nodeAffinity preset values | `[]` |
| `grafana.affinity` | Affinity for controller pod assignment | `{}` |
| `grafana.nodeSelector` | Node labels for controller pod assignment | `{}` |
| `grafana.tolerations` | Tolerations for controller pod assignment | `[]` |
| `grafana.envFrom` | Extra environment variable to pass to the running container | `[]` |
| `grafana.client.timeout` | The timeout in seconds for the Grafana Rest API on that instance | `5` |
| `grafana.client.preferService` | If the API should be used via Ingress or via the internal service | `true` |
| `grafana.labels` | Add additional labels to the grafana deployment, service and ingress resources | `{}` |
| `grafana.service.type` | Kubernetes Service type | `ClusterIP` |
| `grafana.service.annotations` | Additional custom annotations for Grafana service | `{}` |
| `grafana.service.extraPorts` | Extra ports to expose in the Grafana service | `[]` |
| `grafana.ingress.enabled` | If an ingress or OpenShift Route should be created | `false` |
| `grafana.ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `""` |
| `grafana.ingress.hostname` | The hostname under which the grafana instance should be reachable. If empty the parameter will not be set. | `grafana.local` |
| `grafana.ingress.path` | The path for the ingress instance to forward to the grafana app | `/` |
| `grafana.ingress.pathType` | The pathType for the ingress instance to forward to the grafana app | `ImplementationSpecific` |
| `grafana.ingress.labels` | Additional Labels for the ingress resource | `{}` |
| `grafana.ingress.annotations` | Additional Annotations for the ingress resource | `{}` |
| `grafana.ingress.tls` | This enables tls support for the ingress resource | `false` |
| `grafana.ingress.tlsSecret` | The name for the secret to use for the tls termination | `grafana.local-tls` |
| `grafana.persistence.enabled` | Enable persistent storage for the grafana deployment | `false` |
| `grafana.persistence.storageClass` | Define the storageClass for the persistent storage if not defined default is used | `""` |
| `grafana.persistence.accessModes` | Define the accessModes for the persistent storage | `["ReadWriteOnce"]` |
| `grafana.persistence.annotations` | Add annotations to the persistent volume | `{}` |
| `grafana.persistence.size` | Define the size of the PersistentVolumeClaim to request for | `10Gi` |
| `grafana.config` | grafana.ini configuration for the instance for this to configure please look at upstream docs | `{}` |
| `grafana.configMaps` | Extra configMaps to mount into the grafana pod | `[]` |
| `grafana.secrets` | Extra secrets to mount into the grafana pod | `[]` |
| `grafana.jsonnetLibrarySelector` | Configuring the read for jsonnetLibraries to pull in. | `{}` |
| `grafana.dashboardLabelSelectors` | This selects dashboards on the label. | `{}` |
| `grafana.dashboardNamespaceSelector` | Watch for dashboards only in the Namespaces that have the specified namespace label | `{}` |
| `grafana.livenessProbe.enabled` | Enable livenessProbe | `true` |
| `grafana.livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `120` |
| `grafana.livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
| `grafana.livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `5` |
| `grafana.livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `6` |
| `grafana.livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
| `grafana.readinessProbe.enabled` | Enable readinessProbe | `true` |
| `grafana.readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `30` |
| `grafana.readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
| `grafana.readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `5` |
| `grafana.readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `6` |
| `grafana.readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
| `grafana.updateStrategy` | Set up update strategy for Grafana installation. | `{}` |
| `grafana.extraVolumes` | Optionally specify extra list of additional volumes for the grafana pod(s) | `[]` |
| `grafana.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for the grafana container(s) | `[]` |
| `grafana.sidecars` | Add additional sidecar containers to the grafana pod(s) | `[]` |
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

View File

@@ -150,7 +150,9 @@ spec:
{{- if and .Values.grafana.ingress.ingressClassName (include "common.ingress.supportsIngressClassname" .) }}
ingressClassName: {{ .Values.grafana.ingress.ingressClassName | quote }}
{{- end }}
{{- if .Values.grafana.ingress.hostname }}
hostname: {{ include "common.tplvalues.render" (dict "value" .Values.grafana.ingress.hostname "context" $) }}
{{- end }}
tlsEnabled: {{ .Values.grafana.ingress.tls }}
tlsSecretName: {{ .Values.grafana.ingress.tlsSecret }}
{{- if or .Values.commonLabels .Values.grafana.ingress.labels }}

View File

@@ -566,7 +566,7 @@ grafana:
## ref: https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/
##
ingressClassName: ""
## @param grafana.ingress.hostname The hostname under which the grafana instance should be reachable
## @param grafana.ingress.hostname The hostname under which the grafana instance should be reachable. If empty the parameter will not be set.
##
hostname: grafana.local
## @param grafana.ingress.path The path for the ingress instance to forward to the grafana app