From ab5b7220bfe552ed6d5f5925197794d036d21f86 Mon Sep 17 00:00:00 2001 From: Gerasimos Tzakis Date: Wed, 28 Aug 2024 16:08:39 +0300 Subject: [PATCH] fix: enable probes for celery --- charts/nautobot/README.md | 152 ++++++++++++++++---------------- charts/nautobot/values.yaml | 7 +- docs/configuration/reference.md | 152 ++++++++++++++++---------------- 3 files changed, 158 insertions(+), 153 deletions(-) diff --git a/charts/nautobot/README.md b/charts/nautobot/README.md index 887e8e5a..b1243635 100644 --- a/charts/nautobot/README.md +++ b/charts/nautobot/README.md @@ -147,13 +147,13 @@ See [Uninstall](https://docs.nautobot.com/projects/helm-charts/en/stable/operati | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celeryBeat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L741) | object | `{}` | DEPRECATED see [`workers.beat`](#workers.beat) and []`celery`](#celery-values) | +| [celeryBeat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L746) | object | `{}` | DEPRECATED see [`workers.beat`](#workers.beat) and []`celery`](#celery-values) | ## CeleryWorker Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celeryWorker](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L738) | object | `{}` | DEPRECATED see [`workers.default`](#workers.default) and [`celery`](#celery-values) | +| [celeryWorker](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L743) | object | `{}` | DEPRECATED see [`workers.default`](#workers.default) and [`celery`](#celery-values) | ## CommonAnnotations Values @@ -165,19 +165,19 @@ See [Uninstall](https://docs.nautobot.com/projects/helm-charts/en/stable/operati | Key | Type | Default | Description | |-----|------|---------|-------------| -| [ingress.annotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L776) | object | `{}` | Ingress annotations defined as key:value pairs, see the documentation for your specific Ingress provider for more details | -| [ingress.apiVersion](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L763) | string | `nil` | Override API Version (automatically detected if not set) | -| [ingress.backendProtocol](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L779) | string | `"https"` | The backend protocol to for the Ingress to communicate with the Nautobot containers, valid values: http, and https | -| [ingress.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L757) | bool | `false` | Enable Ingress resource creation | -| [ingress.extraHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L789) | list | `[]` | The list of additional hostnames to be covered with this ingress record. Most likely the hostname above will be enough, but in the event more hosts are needed, this is an array | -| [ingress.extraPaths](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L801) | list | `[]` | Any additional arbitrary paths that may need to be added to the ingress under the main host. For example: The ALB ingress controller requires a special rule for handling SSL redirection. | -| [ingress.extraTls](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L813) | list | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls)] The tls configuration for additional hostnames to be covered with this ingress record. | -| [ingress.hostname](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L766) | string | `"nautobot.local"` | Ingress Hostname | -| [ingress.ingressClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L769) | string | `""` | Ingress Class Name | -| [ingress.path](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L773) | string | `"/"` | The Path to Nautobot. You may need to set this to '/*' in order to use this with ALB ingress controllers. | -| [ingress.pathType](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L760) | string | `"Prefix"` | Ingress resource pathType valid values `ImplementationSpecific`, `Exact`, or `Prefix` | -| [ingress.secretName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L785) | string | `"nautobot-tls"` | The name of the secret to use for the TLS certificate | -| [ingress.tls](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L782) | bool | `false` | Enable TLS configuration for the hostname defined at `ingress.hostname` parameter | +| [ingress.annotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L781) | object | `{}` | Ingress annotations defined as key:value pairs, see the documentation for your specific Ingress provider for more details | +| [ingress.apiVersion](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L768) | string | `nil` | Override API Version (automatically detected if not set) | +| [ingress.backendProtocol](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L784) | string | `"https"` | The backend protocol to for the Ingress to communicate with the Nautobot containers, valid values: http, and https | +| [ingress.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L762) | bool | `false` | Enable Ingress resource creation | +| [ingress.extraHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L794) | list | `[]` | The list of additional hostnames to be covered with this ingress record. Most likely the hostname above will be enough, but in the event more hosts are needed, this is an array | +| [ingress.extraPaths](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L806) | list | `[]` | Any additional arbitrary paths that may need to be added to the ingress under the main host. For example: The ALB ingress controller requires a special rule for handling SSL redirection. | +| [ingress.extraTls](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L818) | list | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls)] The tls configuration for additional hostnames to be covered with this ingress record. | +| [ingress.hostname](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L771) | string | `"nautobot.local"` | Ingress Hostname | +| [ingress.ingressClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L774) | string | `""` | Ingress Class Name | +| [ingress.path](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L778) | string | `"/"` | The Path to Nautobot. You may need to set this to '/*' in order to use this with ALB ingress controllers. | +| [ingress.pathType](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L765) | string | `"Prefix"` | Ingress resource pathType valid values `ImplementationSpecific`, `Exact`, or `Prefix` | +| [ingress.secretName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L790) | string | `"nautobot-tls"` | The name of the secret to use for the TLS certificate | +| [ingress.tls](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L787) | bool | `false` | Enable TLS configuration for the hostname defined at `ingress.hostname` parameter | ## InitJob Values @@ -193,47 +193,47 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th | Key | Type | Default | Description | |-----|------|---------|-------------| -| [mariadb.auth.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1081) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB database name | -| [mariadb.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1085) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB user password | -| [mariadb.auth.rootPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1087) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB root user password | -| [mariadb.auth.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1083) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB username | -| [mariadb.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1078) | bool | `false` | Enable deployment of the [Bitnami mariadb](https://github.com/bitnami/charts/tree/master/bitnami/mariadb) chart, all other `redis.*` parameters will be passed directly to that chart | +| [mariadb.auth.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1086) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB database name | +| [mariadb.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1090) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB user password | +| [mariadb.auth.rootPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1092) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB root user password | +| [mariadb.auth.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1088) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB username | +| [mariadb.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1083) | bool | `false` | Enable deployment of the [Bitnami mariadb](https://github.com/bitnami/charts/tree/master/bitnami/mariadb) chart, all other `redis.*` parameters will be passed directly to that chart | ## Metrics Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [metrics.capacityMetrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L958) | bool | `false` | Enable serviceMonitor for [Nautobot Capacity Metrics](https://github.com/nautobot/nautobot-plugin-capacity-metrics) (Requires custom image) | -| [metrics.capacityMetrics.interval](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L962) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"5m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape interval for Nautobot Capacity Metrics serviceMonitor | -| [metrics.capacityMetrics.labels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L966) | map[string]string | `{}` | Additional labels for the for Nautobot Capacity Metrics serviceMonitor Object | -| [metrics.capacityMetrics.nautobot](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L960) | string | `"default"` | The nautobot deployment to collect capacity metrics from | -| [metrics.capacityMetrics.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L964) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"1m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape timeout for Nautobot Capacity Metrics serviceMonitor | -| [metrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L822) | bool | `false` | Enable and configure a Prometheus [serviceMonitor](https://prometheus-operator.dev/docs/operator/design/#servicemonitor) (requires the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator)) | -| [metrics.nginxExporter.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L844) | [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] NGINX Exporter Container Security Context | -| [metrics.nginxExporter.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L847) | bool | `true` | Enable the SecurityContext for the nginx exporter container | -| [metrics.nginxExporter.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L835) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/) valid values: `Always`, `Never`, or `IfNotPresent` | -| [metrics.nginxExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L837) | []string | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments | -| [metrics.nginxExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L829) | string | `"docker.io"` | NGINX Exporter image registry | -| [metrics.nginxExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L831) | string | `"nginx/nginx-prometheus-exporter"` | NGINX Exporter image name | -| [metrics.nginxExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L833) | string | `"1.3.0"` | NGINX Exporter image tag | -| [metrics.nginxExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L866) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] NGINX Exporter liveness probe | -| [metrics.nginxExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L879) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] NGINX Exporter readiness probe | -| [metrics.nginxExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L856) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] NGINX Exporter resource requests and limits | -| [metrics.prometheusRule](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L979) | object | See values.yaml | Enable and configure Prometheus Rules. | -| [metrics.prometheusRule.rules](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L984) | [][PrometheusRule](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Rule) | See [alerting rules documentation](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) | Configure additional rules for the chart. | -| [metrics.serviceMonitor.interval](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L971) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"1m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape interval | -| [metrics.serviceMonitor.labels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L975) | map[string]string | `{}` | Additional labels for the serviceMonitor Object | -| [metrics.serviceMonitor.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L973) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"30s"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape timeout | -| [metrics.uwsgiExporter.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L910) | [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] NGINX Exporter Container Security Context | -| [metrics.uwsgiExporter.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L913) | bool | `true` | Enable the SecurityContext for the uwsgi exporter container | -| [metrics.uwsgiExporter.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L901) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/) valid values: `Always`, `Never`, or `IfNotPresent` | -| [metrics.uwsgiExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L903) | list | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments | -| [metrics.uwsgiExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L895) | string | `"docker.io"` | uWSGI Exporter image registry | -| [metrics.uwsgiExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L897) | string | `"timonwong/uwsgi-exporter"` | uWSGI Exporter image name | -| [metrics.uwsgiExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L899) | string | `"v1.3.0"` | uWSGI Exporter image tag | -| [metrics.uwsgiExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L932) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] uWSGI Exporter liveness probe | -| [metrics.uwsgiExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L945) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] uWSGI Exporter readiness probe | -| [metrics.uwsgiExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L922) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] uWSGI Exporter resource requests and limits | +| [metrics.capacityMetrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L963) | bool | `false` | Enable serviceMonitor for [Nautobot Capacity Metrics](https://github.com/nautobot/nautobot-plugin-capacity-metrics) (Requires custom image) | +| [metrics.capacityMetrics.interval](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L967) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"5m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape interval for Nautobot Capacity Metrics serviceMonitor | +| [metrics.capacityMetrics.labels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L971) | map[string]string | `{}` | Additional labels for the for Nautobot Capacity Metrics serviceMonitor Object | +| [metrics.capacityMetrics.nautobot](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L965) | string | `"default"` | The nautobot deployment to collect capacity metrics from | +| [metrics.capacityMetrics.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L969) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"1m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape timeout for Nautobot Capacity Metrics serviceMonitor | +| [metrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L827) | bool | `false` | Enable and configure a Prometheus [serviceMonitor](https://prometheus-operator.dev/docs/operator/design/#servicemonitor) (requires the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator)) | +| [metrics.nginxExporter.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L849) | [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] NGINX Exporter Container Security Context | +| [metrics.nginxExporter.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L852) | bool | `true` | Enable the SecurityContext for the nginx exporter container | +| [metrics.nginxExporter.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L840) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/) valid values: `Always`, `Never`, or `IfNotPresent` | +| [metrics.nginxExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L842) | []string | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments | +| [metrics.nginxExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L834) | string | `"docker.io"` | NGINX Exporter image registry | +| [metrics.nginxExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L836) | string | `"nginx/nginx-prometheus-exporter"` | NGINX Exporter image name | +| [metrics.nginxExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L838) | string | `"1.3.0"` | NGINX Exporter image tag | +| [metrics.nginxExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L871) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] NGINX Exporter liveness probe | +| [metrics.nginxExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L884) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] NGINX Exporter readiness probe | +| [metrics.nginxExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L861) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] NGINX Exporter resource requests and limits | +| [metrics.prometheusRule](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L984) | object | See values.yaml | Enable and configure Prometheus Rules. | +| [metrics.prometheusRule.rules](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L989) | [][PrometheusRule](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Rule) | See [alerting rules documentation](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) | Configure additional rules for the chart. | +| [metrics.serviceMonitor.interval](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L976) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"1m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape interval | +| [metrics.serviceMonitor.labels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L980) | map[string]string | `{}` | Additional labels for the serviceMonitor Object | +| [metrics.serviceMonitor.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L978) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"30s"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape timeout | +| [metrics.uwsgiExporter.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L915) | [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] NGINX Exporter Container Security Context | +| [metrics.uwsgiExporter.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L918) | bool | `true` | Enable the SecurityContext for the uwsgi exporter container | +| [metrics.uwsgiExporter.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L906) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/) valid values: `Always`, `Never`, or `IfNotPresent` | +| [metrics.uwsgiExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L908) | list | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments | +| [metrics.uwsgiExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L900) | string | `"docker.io"` | uWSGI Exporter image registry | +| [metrics.uwsgiExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L902) | string | `"timonwong/uwsgi-exporter"` | uWSGI Exporter image name | +| [metrics.uwsgiExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L904) | string | `"v1.3.0"` | uWSGI Exporter image tag | +| [metrics.uwsgiExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L937) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] uWSGI Exporter liveness probe | +| [metrics.uwsgiExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L950) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] uWSGI Exporter readiness probe | +| [metrics.uwsgiExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L927) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] uWSGI Exporter resource requests and limits | ## Nautobot Values @@ -363,10 +363,10 @@ The `postgresql.*` values configure the upstream chart from Bitnami. Please see | Key | Type | Default | Description | |-----|------|---------|-------------| -| [postgresql.auth.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1004) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL database name | -| [postgresql.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1006) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL user password | -| [postgresql.auth.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1002) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL username | -| [postgresql.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L997) | bool | `true` | Enable deployment of the [Bitnami postgresql](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) chart, all other `postgresql.*` parameters will be passed directly to that chart | +| [postgresql.auth.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1009) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL database name | +| [postgresql.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1011) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL user password | +| [postgresql.auth.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1007) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL username | +| [postgresql.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1002) | bool | `true` | Enable deployment of the [Bitnami postgresql](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) chart, all other `postgresql.*` parameters will be passed directly to that chart | ## Postgresqlha Values @@ -374,24 +374,24 @@ The `postgresqlha.*` values configure the upstream chart from Bitnami. Please s | Key | Type | Default | Description | |-----|------|---------|-------------| -| [postgresqlha.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1130) | bool | `false` | Enable deployment of the [Bitnami postgresql-ha](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha) chart, all other `postgresql-ha.*` parameters will be passed directly to that chart | -| [postgresqlha.pgpool.adminPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1176) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Pgpool Admin password | -| [postgresqlha.pgpool.pdb.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1190) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Enable a Pod Distribution Budget for Pgpool | -| [postgresqlha.pgpool.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1180) | int | `2` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] The number of replicas to deploy | -| [postgresqlha.pgpool.srCheckDatabase](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1178) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Name of the database to perform streaming replication checks | -| [postgresqlha.pgpool.updateStrategy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1183) | object | See values.yaml | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Strategy used to replace old Pgpool Pods by new ones | -| [postgresqlha.postgresql.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1135) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL database name | -| [postgresqlha.postgresql.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1143) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL user password | -| [postgresqlha.postgresql.pdb.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1146) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] Enable a Pod Distribution Budget for Postgres | -| [postgresqlha.postgresql.postgresPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1137) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL postgres user password | -| [postgresqlha.postgresql.repmgrPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1139) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL Repmgr password | -| [postgresqlha.postgresql.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1141) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL username | +| [postgresqlha.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1135) | bool | `false` | Enable deployment of the [Bitnami postgresql-ha](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha) chart, all other `postgresql-ha.*` parameters will be passed directly to that chart | +| [postgresqlha.pgpool.adminPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1181) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Pgpool Admin password | +| [postgresqlha.pgpool.pdb.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1195) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Enable a Pod Distribution Budget for Pgpool | +| [postgresqlha.pgpool.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1185) | int | `2` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] The number of replicas to deploy | +| [postgresqlha.pgpool.srCheckDatabase](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1183) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Name of the database to perform streaming replication checks | +| [postgresqlha.pgpool.updateStrategy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1188) | object | See values.yaml | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Strategy used to replace old Pgpool Pods by new ones | +| [postgresqlha.postgresql.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1140) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL database name | +| [postgresqlha.postgresql.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1148) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL user password | +| [postgresqlha.postgresql.pdb.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1151) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] Enable a Pod Distribution Budget for Postgres | +| [postgresqlha.postgresql.postgresPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1142) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL postgres user password | +| [postgresqlha.postgresql.repmgrPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1144) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL Repmgr password | +| [postgresqlha.postgresql.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1146) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL username | ## Rabbitmq Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [rabbitmq.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1204) | bool | `false` | Enable deployment of the [Bitnami RabbitMQ](https://github.com/bitnami/charts/tree/main/bitnami/rabbitmq) chart, all other `rabbitmq.*` parameters will be passed directly to that chart | +| [rabbitmq.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1209) | bool | `false` | Enable deployment of the [Bitnami RabbitMQ](https://github.com/bitnami/charts/tree/main/bitnami/rabbitmq) chart, all other `rabbitmq.*` parameters will be passed directly to that chart | ## Redis Values @@ -399,10 +399,10 @@ The `redis.*` values configure the upstream chart from Bitnami. Please see the | Key | Type | Default | Description | |-----|------|---------|-------------| -| [redis.architecture](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1022) | string | `"standalone"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Redis Architecture valid values: `standalone` or `replication` | -| [redis.auth.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1025) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Enable password authentication | -| [redis.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1027) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Redis password | -| [redis.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1020) | bool | `true` | Enable deployment of the [Bitnami redis](https://github.com/bitnami/charts/tree/master/bitnami/redis) chart, all other `redis.*` parameters will be passed directly to that chart | +| [redis.architecture](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1027) | string | `"standalone"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Redis Architecture valid values: `standalone` or `replication` | +| [redis.auth.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1030) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Enable password authentication | +| [redis.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1032) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Redis password | +| [redis.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1025) | bool | `true` | Enable deployment of the [Bitnami redis](https://github.com/bitnami/charts/tree/master/bitnami/redis) chart, all other `redis.*` parameters will be passed directly to that chart | ## Service Values @@ -425,10 +425,10 @@ The `redis.*` values configure the upstream chart from Bitnami. Please see the | Key | Type | Default | Description | |-----|------|---------|-------------| -| [serviceAccount.annotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L751) | object | `{}` | Service account annotations | -| [serviceAccount.automountServiceAccountToken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L753) | bool | `false` | Auto Mount Service account token | -| [serviceAccount.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L746) | bool | `true` | Enable creation of a Kubernetes Service Account for Nautobot | -| [serviceAccount.name](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L749) | string | `$release_name` | Name of the Kubernetes Service Account for Nautobot | +| [serviceAccount.annotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L756) | object | `{}` | Service account annotations | +| [serviceAccount.automountServiceAccountToken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L758) | bool | `false` | Auto Mount Service account token | +| [serviceAccount.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L751) | bool | `true` | Enable creation of a Kubernetes Service Account for Nautobot | +| [serviceAccount.name](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L754) | string | `$release_name` | Name of the Kubernetes Service Account for Nautobot | ## Workers Values diff --git a/charts/nautobot/values.yaml b/charts/nautobot/values.yaml index 4cbf792f..8041d34a 100644 --- a/charts/nautobot/values.yaml +++ b/charts/nautobot/values.yaml @@ -726,9 +726,14 @@ workers: - "--loglevel" - "$(NAUTOBOT_LOG_LEVEL)" livenessProbe: + exec: + command: + - "bash" + - "-c" + - "[ $(find $NAUTOBOT_CELERY_BEAT_HEARTBEAT_FILE -mmin -0.1 | wc -l) -eq 1 ] || false" initialDelaySeconds: 30 readinessProbe: - initialDelaySeconds: 30 + enabled: false resources: requests: cpu: "5m" diff --git a/docs/configuration/reference.md b/docs/configuration/reference.md index 1224f7ce..f32163b6 100644 --- a/docs/configuration/reference.md +++ b/docs/configuration/reference.md @@ -53,13 +53,13 @@ hide: | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celeryBeat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L741) | object | `{}` | DEPRECATED see [`workers.beat`](#workers.beat) and []`celery`](#celery-values) | +| [celeryBeat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L746) | object | `{}` | DEPRECATED see [`workers.beat`](#workers.beat) and []`celery`](#celery-values) | ## CeleryWorker Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celeryWorker](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L738) | object | `{}` | DEPRECATED see [`workers.default`](#workers.default) and [`celery`](#celery-values) | +| [celeryWorker](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L743) | object | `{}` | DEPRECATED see [`workers.default`](#workers.default) and [`celery`](#celery-values) | ## CommonAnnotations Values @@ -71,19 +71,19 @@ hide: | Key | Type | Default | Description | |-----|------|---------|-------------| -| [ingress.annotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L776) | object | `{}` | Ingress annotations defined as key:value pairs, see the documentation for your specific Ingress provider for more details | -| [ingress.apiVersion](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L763) | string | `nil` | Override API Version (automatically detected if not set) | -| [ingress.backendProtocol](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L779) | string | `"https"` | The backend protocol to for the Ingress to communicate with the Nautobot containers, valid values: http, and https | -| [ingress.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L757) | bool | `false` | Enable Ingress resource creation | -| [ingress.extraHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L789) | list | `[]` | The list of additional hostnames to be covered with this ingress record. Most likely the hostname above will be enough, but in the event more hosts are needed, this is an array | -| [ingress.extraPaths](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L801) | list | `[]` | Any additional arbitrary paths that may need to be added to the ingress under the main host. For example: The ALB ingress controller requires a special rule for handling SSL redirection. | -| [ingress.extraTls](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L813) | list | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls)] The tls configuration for additional hostnames to be covered with this ingress record. | -| [ingress.hostname](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L766) | string | `"nautobot.local"` | Ingress Hostname | -| [ingress.ingressClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L769) | string | `""` | Ingress Class Name | -| [ingress.path](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L773) | string | `"/"` | The Path to Nautobot. You may need to set this to '/*' in order to use this with ALB ingress controllers. | -| [ingress.pathType](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L760) | string | `"Prefix"` | Ingress resource pathType valid values `ImplementationSpecific`, `Exact`, or `Prefix` | -| [ingress.secretName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L785) | string | `"nautobot-tls"` | The name of the secret to use for the TLS certificate | -| [ingress.tls](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L782) | bool | `false` | Enable TLS configuration for the hostname defined at `ingress.hostname` parameter | +| [ingress.annotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L781) | object | `{}` | Ingress annotations defined as key:value pairs, see the documentation for your specific Ingress provider for more details | +| [ingress.apiVersion](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L768) | string | `nil` | Override API Version (automatically detected if not set) | +| [ingress.backendProtocol](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L784) | string | `"https"` | The backend protocol to for the Ingress to communicate with the Nautobot containers, valid values: http, and https | +| [ingress.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L762) | bool | `false` | Enable Ingress resource creation | +| [ingress.extraHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L794) | list | `[]` | The list of additional hostnames to be covered with this ingress record. Most likely the hostname above will be enough, but in the event more hosts are needed, this is an array | +| [ingress.extraPaths](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L806) | list | `[]` | Any additional arbitrary paths that may need to be added to the ingress under the main host. For example: The ALB ingress controller requires a special rule for handling SSL redirection. | +| [ingress.extraTls](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L818) | list | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls)] The tls configuration for additional hostnames to be covered with this ingress record. | +| [ingress.hostname](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L771) | string | `"nautobot.local"` | Ingress Hostname | +| [ingress.ingressClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L774) | string | `""` | Ingress Class Name | +| [ingress.path](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L778) | string | `"/"` | The Path to Nautobot. You may need to set this to '/*' in order to use this with ALB ingress controllers. | +| [ingress.pathType](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L765) | string | `"Prefix"` | Ingress resource pathType valid values `ImplementationSpecific`, `Exact`, or `Prefix` | +| [ingress.secretName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L790) | string | `"nautobot-tls"` | The name of the secret to use for the TLS certificate | +| [ingress.tls](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L787) | bool | `false` | Enable TLS configuration for the hostname defined at `ingress.hostname` parameter | ## InitJob Values @@ -99,47 +99,47 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th | Key | Type | Default | Description | |-----|------|---------|-------------| -| [mariadb.auth.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1081) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB database name | -| [mariadb.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1085) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB user password | -| [mariadb.auth.rootPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1087) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB root user password | -| [mariadb.auth.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1083) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB username | -| [mariadb.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1078) | bool | `false` | Enable deployment of the [Bitnami mariadb](https://github.com/bitnami/charts/tree/master/bitnami/mariadb) chart, all other `redis.*` parameters will be passed directly to that chart | +| [mariadb.auth.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1086) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB database name | +| [mariadb.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1090) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB user password | +| [mariadb.auth.rootPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1092) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB root user password | +| [mariadb.auth.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1088) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/mariadb#mariadb-common-parameters)] MariaDB username | +| [mariadb.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1083) | bool | `false` | Enable deployment of the [Bitnami mariadb](https://github.com/bitnami/charts/tree/master/bitnami/mariadb) chart, all other `redis.*` parameters will be passed directly to that chart | ## Metrics Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [metrics.capacityMetrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L958) | bool | `false` | Enable serviceMonitor for [Nautobot Capacity Metrics](https://github.com/nautobot/nautobot-plugin-capacity-metrics) (Requires custom image) | -| [metrics.capacityMetrics.interval](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L962) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"5m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape interval for Nautobot Capacity Metrics serviceMonitor | -| [metrics.capacityMetrics.labels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L966) | map[string]string | `{}` | Additional labels for the for Nautobot Capacity Metrics serviceMonitor Object | -| [metrics.capacityMetrics.nautobot](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L960) | string | `"default"` | The nautobot deployment to collect capacity metrics from | -| [metrics.capacityMetrics.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L964) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"1m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape timeout for Nautobot Capacity Metrics serviceMonitor | -| [metrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L822) | bool | `false` | Enable and configure a Prometheus [serviceMonitor](https://prometheus-operator.dev/docs/operator/design/#servicemonitor) (requires the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator)) | -| [metrics.nginxExporter.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L844) | [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] NGINX Exporter Container Security Context | -| [metrics.nginxExporter.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L847) | bool | `true` | Enable the SecurityContext for the nginx exporter container | -| [metrics.nginxExporter.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L835) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/) valid values: `Always`, `Never`, or `IfNotPresent` | -| [metrics.nginxExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L837) | []string | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments | -| [metrics.nginxExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L829) | string | `"docker.io"` | NGINX Exporter image registry | -| [metrics.nginxExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L831) | string | `"nginx/nginx-prometheus-exporter"` | NGINX Exporter image name | -| [metrics.nginxExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L833) | string | `"1.3.0"` | NGINX Exporter image tag | -| [metrics.nginxExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L866) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] NGINX Exporter liveness probe | -| [metrics.nginxExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L879) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] NGINX Exporter readiness probe | -| [metrics.nginxExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L856) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] NGINX Exporter resource requests and limits | -| [metrics.prometheusRule](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L979) | object | See values.yaml | Enable and configure Prometheus Rules. | -| [metrics.prometheusRule.rules](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L984) | [][PrometheusRule](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Rule) | See [alerting rules documentation](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) | Configure additional rules for the chart. | -| [metrics.serviceMonitor.interval](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L971) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"1m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape interval | -| [metrics.serviceMonitor.labels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L975) | map[string]string | `{}` | Additional labels for the serviceMonitor Object | -| [metrics.serviceMonitor.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L973) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"30s"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape timeout | -| [metrics.uwsgiExporter.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L910) | [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] NGINX Exporter Container Security Context | -| [metrics.uwsgiExporter.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L913) | bool | `true` | Enable the SecurityContext for the uwsgi exporter container | -| [metrics.uwsgiExporter.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L901) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/) valid values: `Always`, `Never`, or `IfNotPresent` | -| [metrics.uwsgiExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L903) | list | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments | -| [metrics.uwsgiExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L895) | string | `"docker.io"` | uWSGI Exporter image registry | -| [metrics.uwsgiExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L897) | string | `"timonwong/uwsgi-exporter"` | uWSGI Exporter image name | -| [metrics.uwsgiExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L899) | string | `"v1.3.0"` | uWSGI Exporter image tag | -| [metrics.uwsgiExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L932) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] uWSGI Exporter liveness probe | -| [metrics.uwsgiExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L945) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] uWSGI Exporter readiness probe | -| [metrics.uwsgiExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L922) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] uWSGI Exporter resource requests and limits | +| [metrics.capacityMetrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L963) | bool | `false` | Enable serviceMonitor for [Nautobot Capacity Metrics](https://github.com/nautobot/nautobot-plugin-capacity-metrics) (Requires custom image) | +| [metrics.capacityMetrics.interval](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L967) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"5m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape interval for Nautobot Capacity Metrics serviceMonitor | +| [metrics.capacityMetrics.labels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L971) | map[string]string | `{}` | Additional labels for the for Nautobot Capacity Metrics serviceMonitor Object | +| [metrics.capacityMetrics.nautobot](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L965) | string | `"default"` | The nautobot deployment to collect capacity metrics from | +| [metrics.capacityMetrics.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L969) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"1m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape timeout for Nautobot Capacity Metrics serviceMonitor | +| [metrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L827) | bool | `false` | Enable and configure a Prometheus [serviceMonitor](https://prometheus-operator.dev/docs/operator/design/#servicemonitor) (requires the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator)) | +| [metrics.nginxExporter.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L849) | [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] NGINX Exporter Container Security Context | +| [metrics.nginxExporter.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L852) | bool | `true` | Enable the SecurityContext for the nginx exporter container | +| [metrics.nginxExporter.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L840) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/) valid values: `Always`, `Never`, or `IfNotPresent` | +| [metrics.nginxExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L842) | []string | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments | +| [metrics.nginxExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L834) | string | `"docker.io"` | NGINX Exporter image registry | +| [metrics.nginxExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L836) | string | `"nginx/nginx-prometheus-exporter"` | NGINX Exporter image name | +| [metrics.nginxExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L838) | string | `"1.3.0"` | NGINX Exporter image tag | +| [metrics.nginxExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L871) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] NGINX Exporter liveness probe | +| [metrics.nginxExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L884) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] NGINX Exporter readiness probe | +| [metrics.nginxExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L861) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] NGINX Exporter resource requests and limits | +| [metrics.prometheusRule](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L984) | object | See values.yaml | Enable and configure Prometheus Rules. | +| [metrics.prometheusRule.rules](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L989) | [][PrometheusRule](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Rule) | See [alerting rules documentation](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) | Configure additional rules for the chart. | +| [metrics.serviceMonitor.interval](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L976) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"1m"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape interval | +| [metrics.serviceMonitor.labels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L980) | map[string]string | `{}` | Additional labels for the serviceMonitor Object | +| [metrics.serviceMonitor.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L978) | [Duration](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.Duration) | `"30s"` | [[ref](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)] Prometheus scrape timeout | +| [metrics.uwsgiExporter.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L915) | [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] NGINX Exporter Container Security Context | +| [metrics.uwsgiExporter.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L918) | bool | `true` | Enable the SecurityContext for the uwsgi exporter container | +| [metrics.uwsgiExporter.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L906) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/) valid values: `Always`, `Never`, or `IfNotPresent` | +| [metrics.uwsgiExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L908) | list | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments | +| [metrics.uwsgiExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L900) | string | `"docker.io"` | uWSGI Exporter image registry | +| [metrics.uwsgiExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L902) | string | `"timonwong/uwsgi-exporter"` | uWSGI Exporter image name | +| [metrics.uwsgiExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L904) | string | `"v1.3.0"` | uWSGI Exporter image tag | +| [metrics.uwsgiExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L937) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] uWSGI Exporter liveness probe | +| [metrics.uwsgiExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L950) | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] uWSGI Exporter readiness probe | +| [metrics.uwsgiExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L927) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] uWSGI Exporter resource requests and limits | ## Nautobot Values @@ -269,10 +269,10 @@ The `postgresql.*` values configure the upstream chart from Bitnami. Please see | Key | Type | Default | Description | |-----|------|---------|-------------| -| [postgresql.auth.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1004) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL database name | -| [postgresql.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1006) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL user password | -| [postgresql.auth.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1002) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL username | -| [postgresql.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L997) | bool | `true` | Enable deployment of the [Bitnami postgresql](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) chart, all other `postgresql.*` parameters will be passed directly to that chart | +| [postgresql.auth.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1009) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL database name | +| [postgresql.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1011) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL user password | +| [postgresql.auth.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1007) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#postgresql-parameters)] PostgreSQL username | +| [postgresql.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1002) | bool | `true` | Enable deployment of the [Bitnami postgresql](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) chart, all other `postgresql.*` parameters will be passed directly to that chart | ## Postgresqlha Values @@ -280,24 +280,24 @@ The `postgresqlha.*` values configure the upstream chart from Bitnami. Please s | Key | Type | Default | Description | |-----|------|---------|-------------| -| [postgresqlha.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1130) | bool | `false` | Enable deployment of the [Bitnami postgresql-ha](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha) chart, all other `postgresql-ha.*` parameters will be passed directly to that chart | -| [postgresqlha.pgpool.adminPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1176) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Pgpool Admin password | -| [postgresqlha.pgpool.pdb.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1190) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Enable a Pod Distribution Budget for Pgpool | -| [postgresqlha.pgpool.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1180) | int | `2` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] The number of replicas to deploy | -| [postgresqlha.pgpool.srCheckDatabase](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1178) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Name of the database to perform streaming replication checks | -| [postgresqlha.pgpool.updateStrategy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1183) | object | See values.yaml | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Strategy used to replace old Pgpool Pods by new ones | -| [postgresqlha.postgresql.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1135) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL database name | -| [postgresqlha.postgresql.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1143) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL user password | -| [postgresqlha.postgresql.pdb.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1146) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] Enable a Pod Distribution Budget for Postgres | -| [postgresqlha.postgresql.postgresPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1137) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL postgres user password | -| [postgresqlha.postgresql.repmgrPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1139) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL Repmgr password | -| [postgresqlha.postgresql.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1141) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL username | +| [postgresqlha.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1135) | bool | `false` | Enable deployment of the [Bitnami postgresql-ha](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha) chart, all other `postgresql-ha.*` parameters will be passed directly to that chart | +| [postgresqlha.pgpool.adminPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1181) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Pgpool Admin password | +| [postgresqlha.pgpool.pdb.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1195) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Enable a Pod Distribution Budget for Pgpool | +| [postgresqlha.pgpool.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1185) | int | `2` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] The number of replicas to deploy | +| [postgresqlha.pgpool.srCheckDatabase](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1183) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Name of the database to perform streaming replication checks | +| [postgresqlha.pgpool.updateStrategy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1188) | object | See values.yaml | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#pgpool-parameters)] Strategy used to replace old Pgpool Pods by new ones | +| [postgresqlha.postgresql.database](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1140) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL database name | +| [postgresqlha.postgresql.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1148) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL user password | +| [postgresqlha.postgresql.pdb.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1151) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] Enable a Pod Distribution Budget for Postgres | +| [postgresqlha.postgresql.postgresPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1142) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL postgres user password | +| [postgresqlha.postgresql.repmgrPassword](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1144) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL Repmgr password | +| [postgresqlha.postgresql.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1146) | string | `"nautobot"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/postgresql-ha#postgresql-with-repmgr-parameters)] PostgreSQL username | ## Rabbitmq Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [rabbitmq.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1204) | bool | `false` | Enable deployment of the [Bitnami RabbitMQ](https://github.com/bitnami/charts/tree/main/bitnami/rabbitmq) chart, all other `rabbitmq.*` parameters will be passed directly to that chart | +| [rabbitmq.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1209) | bool | `false` | Enable deployment of the [Bitnami RabbitMQ](https://github.com/bitnami/charts/tree/main/bitnami/rabbitmq) chart, all other `rabbitmq.*` parameters will be passed directly to that chart | ## Redis Values @@ -305,10 +305,10 @@ The `redis.*` values configure the upstream chart from Bitnami. Please see the | Key | Type | Default | Description | |-----|------|---------|-------------| -| [redis.architecture](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1022) | string | `"standalone"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Redis Architecture valid values: `standalone` or `replication` | -| [redis.auth.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1025) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Enable password authentication | -| [redis.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1027) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Redis password | -| [redis.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1020) | bool | `true` | Enable deployment of the [Bitnami redis](https://github.com/bitnami/charts/tree/master/bitnami/redis) chart, all other `redis.*` parameters will be passed directly to that chart | +| [redis.architecture](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1027) | string | `"standalone"` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Redis Architecture valid values: `standalone` or `replication` | +| [redis.auth.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1030) | bool | `true` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Enable password authentication | +| [redis.auth.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1032) | string | `""` | [[ref](https://github.com/bitnami/charts/tree/master/bitnami/redis#redis-common-configuration-parameters)] Redis password | +| [redis.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1025) | bool | `true` | Enable deployment of the [Bitnami redis](https://github.com/bitnami/charts/tree/master/bitnami/redis) chart, all other `redis.*` parameters will be passed directly to that chart | ## Service Values @@ -331,10 +331,10 @@ The `redis.*` values configure the upstream chart from Bitnami. Please see the | Key | Type | Default | Description | |-----|------|---------|-------------| -| [serviceAccount.annotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L751) | object | `{}` | Service account annotations | -| [serviceAccount.automountServiceAccountToken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L753) | bool | `false` | Auto Mount Service account token | -| [serviceAccount.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L746) | bool | `true` | Enable creation of a Kubernetes Service Account for Nautobot | -| [serviceAccount.name](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L749) | string | `$release_name` | Name of the Kubernetes Service Account for Nautobot | +| [serviceAccount.annotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L756) | object | `{}` | Service account annotations | +| [serviceAccount.automountServiceAccountToken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L758) | bool | `false` | Auto Mount Service account token | +| [serviceAccount.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L751) | bool | `true` | Enable creation of a Kubernetes Service Account for Nautobot | +| [serviceAccount.name](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L754) | string | `$release_name` | Name of the Kubernetes Service Account for Nautobot | ## Workers Values