diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 65d41ff2..24cf1bd2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -33,7 +33,7 @@ repos: - "docs/" - repo: "https://github.com/streetsidesoftware/cspell-cli" - rev: "v8.7.0" + rev: "v8.8.2" hooks: - id: "cspell" diff --git a/charts/nautobot/Chart.lock b/charts/nautobot/Chart.lock index 4a53a0be..e1cd4c2e 100644 --- a/charts/nautobot/Chart.lock +++ b/charts/nautobot/Chart.lock @@ -16,6 +16,6 @@ dependencies: version: 12.15.0 - name: common repository: oci://registry-1.docker.io/bitnamicharts - version: 2.19.1 -digest: sha256:71657c3a97bd7d14cc7bf6ef8f861808c13ddc5dc53320503f7d2652d87448e6 -generated: "2024-04-24T14:31:40.391068+02:00" + version: 2.19.2 +digest: sha256:cf14954d4eece195f0719a1b919964d2d70dd39ac8c0ae2e6d4629c94499fe44 +generated: "2024-05-13T13:03:35.824684885+03:00" diff --git a/charts/nautobot/Chart.yaml b/charts/nautobot/Chart.yaml index 95f7b8a7..c36fe71e 100644 --- a/charts/nautobot/Chart.yaml +++ b/charts/nautobot/Chart.yaml @@ -6,7 +6,7 @@ annotations: artifacthub.io/prerelease: "false" artifacthub.io/images: | - name: nautobot - image: ghcr.io/nautobot/nautobot:2.2.2-py3.11 + image: ghcr.io/nautobot/nautobot:2.2.5-py3.11 artifacthub.io/links: | - name: Nautobot Documentation url: https://docs.nautobot.com/ @@ -31,22 +31,20 @@ annotations: url: https://raw.githubusercontent.com/nautobot/nautobot/develop/nautobot/docs/media/ss_plugin_chatops.png artifacthub.io/changes: | - kind: added - description: Added #379 Option to define harakiri uwsgi timeout + description: Added #391 option for persistent volume claim for media files - kind: fixed - description: Fixed #381 DB and Redis secrets - - kind: fixed - description: Fixed #374 Correct secret keys for Django passwords + description: Fixed #398 documentation to include Persistent volume changes - kind: changed - description: Upgraded Nautobot from 2.1.9 to 2.2.2 + description: Upgraded Nautobot from 2.2.2 to 2.2.5 - kind: changed - description: Upgraded Bitnami Common subchart from 2.13.3 to 2.19.1 + description: Upgraded nginx-prometheus-exporter image from 0.11.0 to 1.1.0 - kind: changed - description: Upgraded RabbitMQ subchart from 12.5.4 to 12.15.0 + description: Upgraded Bitnami Common subchart from 2.19.1 to 2.19.2 - kind: changed - description: Upgraded Redis subchart from 18.4.0 to 18.19.4 + description: Upgraded dependency mkdocs-material from 9.5.18 to 9.5.22 apiVersion: "v2" -appVersion: "2.2.2" -version: "2.1.1" +appVersion: "2.2.5" +version: "2.1.2" dependencies: - condition: "redis.enabled" name: "redis" diff --git a/charts/nautobot/README.md b/charts/nautobot/README.md index 44dcf56a..9b6b892d 100644 --- a/charts/nautobot/README.md +++ b/charts/nautobot/README.md @@ -1,6 +1,6 @@ # nautobot -![Version: 2.1.1](https://img.shields.io/badge/Version-2.1.1-informational?style=flat-square) ![AppVersion: 2.2.2](https://img.shields.io/badge/AppVersion-2.2.2-informational?style=flat-square) +![Version: 2.1.2](https://img.shields.io/badge/Version-2.1.2-informational?style=flat-square) ![AppVersion: 2.2.5](https://img.shields.io/badge/AppVersion-2.2.5-informational?style=flat-square) Nautobot is a Network Source of Truth and Network Automation Platform. @@ -102,58 +102,58 @@ See [Uninstall](https://docs.nautobot.com/projects/helm-charts/en/stable/operati | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celery.affinity](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L610) | [Affinity](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)] Affinity for Nautobot Celery Worker pods assignment | -| [celery.args](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L583) | []string | `[]` | Override default Nautobot Celery Worker container args (useful when using custom images) | -| [celery.autoscaling](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L661) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)] Define a horizontal pod autoscaler | -| [celery.autoscaling.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L663) | bool | `false` | Add an horizontal pod autoscaler for the Celery Worker (beta) | -| [celery.command](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L572) | []string | See values.yaml | Override default Nautobot Celery Worker container command (useful when using custom images) | -| [celery.concurrency](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L493) | int | `0` | [[ref](https://docs.nautobot.com/projects/core/en/stable/administration/celery-queues/#concurrency-setting)]Concurrency Setting (0: use the default which is the number of CPUs available on your system)[2](#notes) | -| [celery.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L560) | [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)] Nautobot Celery Worker Container Security Context | -| [celery.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L563) | bool | `true` | Enable the Worker Celery Container security context | -| [celery.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L490) | bool | `true` | Enables the default Celery Worker for Nautobot | -| [celery.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L625) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the Nautobot Celery Worker pods | -| [celery.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L632) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for Nautobot Celery Worker pods | -| [celery.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L634) | []string | `[]` | List of names of existing Secrets containing extra env vars for Nautobot Celery Worker pods | -| [celery.extraVolumeMounts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L638) | [][VolumeMount](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1) | `[]` | List of additional volumeMounts for the Nautobot Celery Worker containers | -| [celery.extraVolumes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L636) | [][Volume](https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/volume/#Volume) | `[]` | List of additional volumes for the Nautobot Celery Worker pod | -| [celery.hostAliases](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L585) | [][HostAlias](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#hostname-and-name-resolution) | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/)] Nautobot Celery Worker pods host aliases | -| [celery.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L651) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | [[ref](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)] Add additional init containers to the Nautobot Celery Worker pods | -| [celery.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L623) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the Nautobot Celery Worker container(s) to automate configuration before or after startup | -| [celery.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L501) | [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)] Nautobot Celery Worker liveness probe | -| [celery.metricsPort](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L688) | int | `8080` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#celery_worker_prometheus_ports)] Ports for Prometheus metric HTTP server running on the celery worker(s) if `nautobot.metrics` is `true` | -| [celery.nodeAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L597) | object | See values.yaml | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity)] Nautobot Celery Worker Node Affinity preset | -| [celery.nodeAffinityPreset.key](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L601) | string | `""` | Node label key to match. Ignored if `nautobot.affinity` is set | -| [celery.nodeAffinityPreset.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L599) | string | `""` | Nautobot Celery Worker Node affinity preset type. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | -| [celery.nodeAffinityPreset.values](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L603) | list | `[]` | Node label values to match. Ignored if `nautobot.affinity` is set | -| [celery.nodeSelector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L612) | [NodeSelector](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/user-guide/node-selection/)] Node labels for Nautobot Celery Worker pods assignment | -| [celery.pdb](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L553) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)] Nautobot Pod Distribution Budget | -| [celery.podAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L591) | `soft`, `hard` | `""` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Celery Worker Pod affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | -| [celery.podAnnotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L589) | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations for Nautobot Celery Worker pods | -| [celery.podAntiAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L593) | `soft`, `hard` | `"soft"` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Celery Worker Pod anti-affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | -| [celery.podLabels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L587) | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)] Extra labels for Nautobot Celery Worker pods | -| [celery.podSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L544) | [PodSecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] Nautobot Celery Worker Pods Security Context | -| [celery.podSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L546) | bool | `true` | Enable the Worker Pod security context | -| [celery.priorityClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L621) | string | `""` | Nautobot Celery Worker pods' priorityClassName | -| [celery.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L519) | [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)] Nautobot Celery Worker readiness probe | -| [celery.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L495) | int | `2` | Number of Nautobot Celery Workers replicas to deploy | -| [celery.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L534) | [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/)] Nautobot Celery Worker resource requests and limits | -| [celery.revisionHistoryLimit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L497) | int | `3` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#clean-up-policy)] Number of old ReplicaSets to retain | -| [celery.sidecars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L640) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | Add additional sidecar containers to the Nautobot Celery Worker pods | -| [celery.terminationGracePeriodSeconds](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L515) | int | `30` | [[ref](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/)] Termination Grace Period Seconds | -| [celery.tolerations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L614) | [][Toleration](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `[]` | [[ref](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)] Tolerations for Nautobot Celery Worker pods assignment | -| [celery.updateStrategy.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L618) | `Recreate`, `RollingUpdate` | `"RollingUpdate"` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies)] Nautobot Celery Worker Deployment strategy type | +| [celery.affinity](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L627) | [Affinity](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)] Affinity for Nautobot Celery Worker pods assignment | +| [celery.args](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L600) | []string | `[]` | Override default Nautobot Celery Worker container args (useful when using custom images) | +| [celery.autoscaling](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L678) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)] Define a horizontal pod autoscaler | +| [celery.autoscaling.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L680) | bool | `false` | Add an horizontal pod autoscaler for the Celery Worker (beta) | +| [celery.command](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L589) | []string | See values.yaml | Override default Nautobot Celery Worker container command (useful when using custom images) | +| [celery.concurrency](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L510) | int | `0` | [[ref](https://docs.nautobot.com/projects/core/en/stable/administration/celery-queues/#concurrency-setting)]Concurrency Setting (0: use the default which is the number of CPUs available on your system)[2](#notes) | +| [celery.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L577) | [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)] Nautobot Celery Worker Container Security Context | +| [celery.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L580) | bool | `true` | Enable the Worker Celery Container security context | +| [celery.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L507) | bool | `true` | Enables the default Celery Worker for Nautobot | +| [celery.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L642) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the Nautobot Celery Worker pods | +| [celery.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L649) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for Nautobot Celery Worker pods | +| [celery.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L651) | []string | `[]` | List of names of existing Secrets containing extra env vars for Nautobot Celery Worker pods | +| [celery.extraVolumeMounts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L655) | [][VolumeMount](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1) | `[]` | List of additional volumeMounts for the Nautobot Celery Worker containers | +| [celery.extraVolumes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L653) | [][Volume](https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/volume/#Volume) | `[]` | List of additional volumes for the Nautobot Celery Worker pod | +| [celery.hostAliases](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L602) | [][HostAlias](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#hostname-and-name-resolution) | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/)] Nautobot Celery Worker pods host aliases | +| [celery.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L668) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | [[ref](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)] Add additional init containers to the Nautobot Celery Worker pods | +| [celery.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L640) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the Nautobot Celery Worker container(s) to automate configuration before or after startup | +| [celery.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L518) | [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)] Nautobot Celery Worker liveness probe | +| [celery.metricsPort](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L705) | int | `8080` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#celery_worker_prometheus_ports)] Ports for Prometheus metric HTTP server running on the celery worker(s) if `nautobot.metrics` is `true` | +| [celery.nodeAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L614) | object | See values.yaml | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity)] Nautobot Celery Worker Node Affinity preset | +| [celery.nodeAffinityPreset.key](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L618) | string | `""` | Node label key to match. Ignored if `nautobot.affinity` is set | +| [celery.nodeAffinityPreset.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L616) | string | `""` | Nautobot Celery Worker Node affinity preset type. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | +| [celery.nodeAffinityPreset.values](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L620) | list | `[]` | Node label values to match. Ignored if `nautobot.affinity` is set | +| [celery.nodeSelector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L629) | [NodeSelector](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/user-guide/node-selection/)] Node labels for Nautobot Celery Worker pods assignment | +| [celery.pdb](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L570) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)] Nautobot Pod Distribution Budget | +| [celery.podAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L608) | `soft`, `hard` | `""` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Celery Worker Pod affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | +| [celery.podAnnotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L606) | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations for Nautobot Celery Worker pods | +| [celery.podAntiAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L610) | `soft`, `hard` | `"soft"` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Celery Worker Pod anti-affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | +| [celery.podLabels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L604) | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)] Extra labels for Nautobot Celery Worker pods | +| [celery.podSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L561) | [PodSecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] Nautobot Celery Worker Pods Security Context | +| [celery.podSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L563) | bool | `true` | Enable the Worker Pod security context | +| [celery.priorityClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L638) | string | `""` | Nautobot Celery Worker pods' priorityClassName | +| [celery.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L536) | [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)] Nautobot Celery Worker readiness probe | +| [celery.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L512) | int | `2` | Number of Nautobot Celery Workers replicas to deploy | +| [celery.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L551) | [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/)] Nautobot Celery Worker resource requests and limits | +| [celery.revisionHistoryLimit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L514) | int | `3` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#clean-up-policy)] Number of old ReplicaSets to retain | +| [celery.sidecars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L657) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | Add additional sidecar containers to the Nautobot Celery Worker pods | +| [celery.terminationGracePeriodSeconds](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L532) | int | `30` | [[ref](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/)] Termination Grace Period Seconds | +| [celery.tolerations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L631) | [][Toleration](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `[]` | [[ref](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)] Tolerations for Nautobot Celery Worker pods assignment | +| [celery.updateStrategy.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L635) | `Recreate`, `RollingUpdate` | `"RollingUpdate"` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies)] Nautobot Celery Worker Deployment strategy type | ## CeleryBeat Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celeryBeat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L724) | object | `{}` | DEPRECATED see [`workers.beat`](#workers.beat) and []`celery`](#celery-values) | +| [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) | ## CeleryWorker Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celeryWorker](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L721) | object | `{}` | DEPRECATED see [`workers.default`](#workers.default) and [`celery`](#celery-values) | +| [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) | ## CommonAnnotations Values @@ -165,27 +165,27 @@ 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#L759) | 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#L746) | string | `nil` | Override API Version (automatically detected if not set) | -| [ingress.backendProtocol](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L762) | 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#L740) | bool | `false` | Enable Ingress resource creation | -| [ingress.extraHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L772) | 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#L784) | 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#L796) | 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#L749) | string | `"nautobot.local"` | Ingress Hostname | -| [ingress.ingressClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L752) | string | `""` | Ingress Class Name | -| [ingress.path](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L756) | 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#L743) | 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#L768) | 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#L765) | 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#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 | ## InitJob Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [initJob](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L451) | object | See values.yaml | Override values for the nautobot-init job if nautobot.singleInit is true | -| [initJob.installHook](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L453) | `post-install`, `pre-install` | `"pre-install"` | [[ref](https://helm.sh/docs/topics/charts_hooks/#the-available-hooks)] Which helm hook should be used during the installation phase. | -| [initJob.upgradeHook](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L455) | `post-upgrade`, `pre-upgrade` | `"pre-upgrade"` | [[ref](https://helm.sh/docs/topics/charts_hooks/#the-available-hooks)] Which helm hook should be used during the upgrade phase. | +| [initJob](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L468) | object | See values.yaml | Override values for the nautobot-init job if nautobot.singleInit is true | +| [initJob.installHook](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L470) | `post-install`, `pre-install` | `"pre-install"` | [[ref](https://helm.sh/docs/topics/charts_hooks/#the-available-hooks)] Which helm hook should be used during the installation phase. | +| [initJob.upgradeHook](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L472) | `post-upgrade`, `pre-upgrade` | `"pre-upgrade"` | [[ref](https://helm.sh/docs/topics/charts_hooks/#the-available-hooks)] Which helm hook should be used during the upgrade phase. | ## Mariadb Values @@ -193,79 +193,79 @@ 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#L1064) | 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#L1068) | 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#L1070) | 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#L1066) | 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#L1061) | 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#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 | ## Metrics Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [metrics.capacityMetrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L941) | 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#L945) | [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#L949) | 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#L943) | 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#L947) | [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#L805) | 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#L827) | [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#L830) | 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#L818) | 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#L820) | []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#L812) | string | `"docker.io"` | NGINX Exporter image registry | -| [metrics.nginxExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L814) | 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#L816) | string | `"0.11.0"` | NGINX Exporter image tag | -| [metrics.nginxExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L849) | [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#L862) | [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#L839) | [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#L962) | object | See values.yaml | Enable and configure Prometheus Rules. | -| [metrics.prometheusRule.rules](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L967) | [][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#L954) | [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#L958) | map[string]string | `{}` | Additional labels for the serviceMonitor Object | -| [metrics.serviceMonitor.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L956) | [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#L893) | [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#L896) | 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#L884) | 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#L886) | 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#L878) | string | `"docker.io"` | uWSGI Exporter image registry | -| [metrics.uwsgiExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L880) | string | `"timonwong/uwsgi-exporter"` | uWSGI Exporter image name | -| [metrics.uwsgiExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L882) | string | `"v1.3.0"` | uWSGI Exporter image tag | -| [metrics.uwsgiExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L915) | [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#L928) | [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#L905) | [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#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.1.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 | ## Nautobot Values | Key | Type | Default | Description | |-----|------|---------|-------------| | [nautobot.affinity](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L163) | [Affinity](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)] Affinity for Nautobot pods assignment | -| [nautobot.allowedHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L350) | string | `"*"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#allowed_hosts)] Space separated list of Nautobot allowed hosts (NAUTOBOT_ALLOWED_HOSTS)[1](#notes) | +| [nautobot.allowedHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L367) | string | `"*"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#allowed_hosts)] Space separated list of Nautobot allowed hosts (NAUTOBOT_ALLOWED_HOSTS)[1](#notes) | | [nautobot.args](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L136) | []string | `[]` | Override default Nautobot container args (useful when using custom images) | | [nautobot.autoscaling](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L214) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)] Define a horizontal pod autoscaler | | [nautobot.autoscaling.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L216) | bool | `false` | Add an horizontal pod autoscaler for Nautobot (beta) | | [nautobot.command](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L130) | []string | `["nautobot-server","start","--ini","/opt/nautobot/uwsgi.ini"]` | Override default Nautobot container command (useful when using custom images) | -| [nautobot.config](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L345) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/)] Replace the entire `nautobot_config.py` file with this value[1](#notes) | +| [nautobot.config](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L362) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/)] Replace the entire `nautobot_config.py` file with this value[1](#notes) | | [nautobot.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L118) | [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)] Nautobot Container Security Context | | [nautobot.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L121) | bool | `true` | Enable the Nautobot container security context | -| [nautobot.db.engine](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L355) | string | `"django.db.backends.postgresql"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot database engine, valid values: `django.db.backends.postgresql`, `django_prometheus.db.backends.postgresql` (metrics enabled), `django.db.backends.mysql`, and `django_prometheus.db.backends.mysql` (metrics enabled) (NAUTOBOT_DB_ENGINE)[1](#notes) | -| [nautobot.db.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L357) | string | `""` | Name of existing secret to use for Database passwords[1](#notes) | -| [nautobot.db.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L359) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | -| [nautobot.db.host](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L361) | string | `"postgres"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database hostname, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_HOST)[1](#notes) | -| [nautobot.db.name](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L363) | string | `"nautobot"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database name, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_NAME)[1](#notes) | -| [nautobot.db.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L365) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database password, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_PASSWORD)[1](#notes) | -| [nautobot.db.port](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L367) | int | `5432` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database port, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_PORT)[1](#notes) | -| [nautobot.db.timeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L369) | int | `300` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot database timeout (NAUTOBOT_DB_TIMEOUT)[1](#notes) | -| [nautobot.db.user](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L371) | string | `"nautobot"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database username, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_USER)[1](#notes) | -| [nautobot.debug](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L347) | bool | `false` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#debug)] Enable Nautobot Debug (NAUTOBOT_DEBUG)[1](#notes) | -| [nautobot.django.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L400) | string | `""` | Name of existing secret to use for NAUTOBOT_SECRET_KEY[1](#notes) | -| [nautobot.django.existingSecretSecretKeyKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L402) | string | `""` | SecretKey key to be retrieved from existing secret[1](#notes) | -| [nautobot.django.secretKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L404) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#secret_key)] Nautobot Secret Key (NAUTOBOT_SECRET_KEY), takes priority over nautobot.secretKey[1](#notes) | +| [nautobot.db.engine](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L372) | string | `"django.db.backends.postgresql"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot database engine, valid values: `django.db.backends.postgresql`, `django_prometheus.db.backends.postgresql` (metrics enabled), `django.db.backends.mysql`, and `django_prometheus.db.backends.mysql` (metrics enabled) (NAUTOBOT_DB_ENGINE)[1](#notes) | +| [nautobot.db.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L374) | string | `""` | Name of existing secret to use for Database passwords[1](#notes) | +| [nautobot.db.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L376) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | +| [nautobot.db.host](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L378) | string | `"postgres"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database hostname, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_HOST)[1](#notes) | +| [nautobot.db.name](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L380) | string | `"nautobot"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database name, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_NAME)[1](#notes) | +| [nautobot.db.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L382) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database password, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_PASSWORD)[1](#notes) | +| [nautobot.db.port](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L384) | int | `5432` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database port, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_PORT)[1](#notes) | +| [nautobot.db.timeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L386) | int | `300` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot database timeout (NAUTOBOT_DB_TIMEOUT)[1](#notes) | +| [nautobot.db.user](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L388) | string | `"nautobot"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database username, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_USER)[1](#notes) | +| [nautobot.debug](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L364) | bool | `false` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#debug)] Enable Nautobot Debug (NAUTOBOT_DEBUG)[1](#notes) | +| [nautobot.django.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L417) | string | `""` | Name of existing secret to use for NAUTOBOT_SECRET_KEY[1](#notes) | +| [nautobot.django.existingSecretSecretKeyKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L419) | string | `""` | SecretKey key to be retrieved from existing secret[1](#notes) | +| [nautobot.django.secretKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L421) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#secret_key)] Nautobot Secret Key (NAUTOBOT_SECRET_KEY), takes priority over nautobot.secretKey[1](#notes) | | [nautobot.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L36) | bool | `true` | Enable the default Nautobot deployment | | [nautobot.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L178) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the Nautobot server pods | | [nautobot.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L185) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for Nautobot server pods | | [nautobot.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L187) | []string | `[]` | List of names of existing Secrets containing extra env vars for Nautobot server pods | -| [nautobot.extraVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L443) | []map[name,value]string | `[]` | An array of environment variable objects (`name` and `value` are required) to add to ALL Nautobot and Nautobot Worker related deployments[1](#notes) | +| [nautobot.extraVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L460) | []map[name,value]string | `[]` | An array of environment variable objects (`name` and `value` are required) to add to ALL Nautobot and Nautobot Worker related deployments[1](#notes) | | [nautobot.extraVolumeMounts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L191) | [][VolumeMount](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1) | `[]` | List of additional volumeMounts for the Nautobot containers | | [nautobot.extraVolumes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L189) | [][Volume](https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/volume/#Volume) | `[]` | List of additional volumes for the Nautobot server pod | | [nautobot.hostAliases](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L138) | [][HostAlias](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#hostname-and-name-resolution) | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/)] Nautobot pods host aliases | @@ -273,34 +273,39 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th | [nautobot.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L48) | []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 | | [nautobot.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L40) | string | `"ghcr.io"` | Nautobot image registry, common to all deployments | | [nautobot.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L42) | string | `"nautobot/nautobot"` | Nautobot image name, common to all deployments | -| [nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L44) | string | `"2.2.2-py3.11"` | Nautobot image tag, common to all deployments | +| [nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L44) | string | `"2.2.5-py3.11"` | Nautobot image tag, common to all deployments | | [nautobot.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L204) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | [[ref](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)] Add additional init containers to the Nautobot server pods | | [nautobot.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L176) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the Nautobot container(s) to automate configuration before or after startup | | [nautobot.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L60) | [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)] Nautobot liveness probe | | [nautobot.livenessProbe.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L62) | bool | `true` | Enable the Nautobot Liveness Probe | -| [nautobot.logLevel](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L374) | `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG` | `"INFO"` | Log Level used for Celery logging, valid values: `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG`[1](#notes) | -| [nautobot.metrics](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L376) | bool | `true` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#metrics_enabled)] Enable Prometheus metrics endpoint (NAUTOBOT_METRICS_ENABLED)[1](#notes) | -| [nautobot.nginx.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L282) | [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 Container Security Context | -| [nautobot.nginx.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L284) | bool | `true` | Enable the nginx container security context | -| [nautobot.nginx.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L260) | bool | `false` | Enable an nginx sidecar to proxy Nautobot traffic (can be useful for large deployments) | -| [nautobot.nginx.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L295) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the NGINX containers | -| [nautobot.nginx.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L302) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for the NGINX containers | -| [nautobot.nginx.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L304) | []string | `[]` | List of names of existing Secrets containing extra env vars for the NGINX containers | -| [nautobot.nginx.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L270) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/), common to all deployments valid values: `Always`, `Never`, or `IfNotPresent` | -| [nautobot.nginx.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L272) | []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 | -| [nautobot.nginx.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L264) | string | `"docker.io"` | NGINX image registry | -| [nautobot.nginx.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L266) | string | `"nginxinc/nginx-unprivileged"` | NGINX image name | -| [nautobot.nginx.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L268) | string | `"1.26"` | NGINX image tag | -| [nautobot.nginx.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L278) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the NGINX container(s) to automate configuration before or after startup | -| [nautobot.nginx.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L308) | [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 liveness probe | -| [nautobot.nginx.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L320) | [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 readiness probe | -| [nautobot.nginx.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L333) | [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 resource requests and limits | +| [nautobot.logLevel](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L391) | `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG` | `"INFO"` | Log Level used for Celery logging, valid values: `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG`[1](#notes) | +| [nautobot.metrics](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L393) | bool | `true` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#metrics_enabled)] Enable Prometheus metrics endpoint (NAUTOBOT_METRICS_ENABLED)[1](#notes) | +| [nautobot.nginx.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L299) | [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 Container Security Context | +| [nautobot.nginx.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L301) | bool | `true` | Enable the nginx container security context | +| [nautobot.nginx.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L277) | bool | `false` | Enable an nginx sidecar to proxy Nautobot traffic (can be useful for large deployments) | +| [nautobot.nginx.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L312) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the NGINX containers | +| [nautobot.nginx.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L319) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for the NGINX containers | +| [nautobot.nginx.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L321) | []string | `[]` | List of names of existing Secrets containing extra env vars for the NGINX containers | +| [nautobot.nginx.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L287) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/), common to all deployments valid values: `Always`, `Never`, or `IfNotPresent` | +| [nautobot.nginx.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L289) | []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 | +| [nautobot.nginx.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L281) | string | `"docker.io"` | NGINX image registry | +| [nautobot.nginx.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L283) | string | `"nginxinc/nginx-unprivileged"` | NGINX image name | +| [nautobot.nginx.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L285) | string | `"1.26"` | NGINX image tag | +| [nautobot.nginx.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L295) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the NGINX container(s) to automate configuration before or after startup | +| [nautobot.nginx.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L325) | [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 liveness probe | +| [nautobot.nginx.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L337) | [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 readiness probe | +| [nautobot.nginx.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L350) | [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 resource requests and limits | | [nautobot.nodeAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L150) | object | See values.yaml | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity)] Nautobot Node Affinity preset | | [nautobot.nodeAffinityPreset.key](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L154) | string | `""` | Node label key to match. Ignored if `nautobot.affinity` is set | | [nautobot.nodeAffinityPreset.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L152) | `soft`, `hard` | `""` | Nautobot Node affinity preset type. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | | [nautobot.nodeAffinityPreset.values](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L156) | []string | `[]` | Node label values to match. Ignored if `nautobot.affinity` is set | | [nautobot.nodeSelector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L165) | [NodeSelector](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/user-guide/node-selection/)] Node labels for Nautobot pods assignment | | [nautobot.pdb](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L111) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)] Nautobot Pod Distribution Budget | +| [nautobot.persistenceMediaFiles.accessMode](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L264) | string | `"ReadWriteOnce"` | - [Kubernetes Volumes AccessMode](https://kubernetes.io/docs/concepts/storage/storage-classes/) | +| [nautobot.persistenceMediaFiles.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L260) | bool | `false` | - Enable PVC and the relevant volumes | +| [nautobot.persistenceMediaFiles.selector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L268) | object | `{}` | - [Kubernetes PVC Selectors](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#selector) to specify volume for Persistent Volume Claim | +| [nautobot.persistenceMediaFiles.size](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L266) | string | `"1Gi"` | - Persistent storage size request | +| [nautobot.persistenceMediaFiles.storageClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L262) | string | `""` | - [Kubernetes StorageClass Name](https://kubernetes.io/docs/concepts/storage/storage-classes/), for the creation of Persistent Volume Claim | | [nautobot.persistenceStaticFiles.accessMode](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L247) | string | `"ReadWriteOnce"` | - [Kubernetes Volumes AccessMode](https://kubernetes.io/docs/concepts/storage/storage-classes/) | | [nautobot.persistenceStaticFiles.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L243) | bool | `false` | - Enable PVC and the relevant volumes | | [nautobot.persistenceStaticFiles.selector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L251) | object | `{}` | - [Kubernetes PVC Selectors](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#selector) to specify volume for Persistent Volume Claim | @@ -314,43 +319,43 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th | [nautobot.podSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L104) | bool | `true` | Enable the Nautobot Pod security context | | [nautobot.priorityClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L174) | string | `""` | Nautobot pods' priorityClassName | | [nautobot.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L79) | [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)] Nautobot readiness probe | -| [nautobot.redis.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L381) | string | `""` | Name of existing secret to use for Redis passwords[1](#notes) | -| [nautobot.redis.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L383) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | -| [nautobot.redis.host](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L385) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis hostname, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_HOST)[1](#notes) | -| [nautobot.redis.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L387) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis password, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_PASSWORD)[1](#notes) | -| [nautobot.redis.port](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L389) | int | `6379` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis port, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_PORT)[1](#notes) | -| [nautobot.redis.ssl](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L391) | bool | `false` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis ssl enabled, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_SSL)[1](#notes) | -| [nautobot.redis.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L393) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis username, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_USERNAME)[1](#notes) | +| [nautobot.redis.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L398) | string | `""` | Name of existing secret to use for Redis passwords[1](#notes) | +| [nautobot.redis.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L400) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | +| [nautobot.redis.host](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L402) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis hostname, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_HOST)[1](#notes) | +| [nautobot.redis.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L404) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis password, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_PASSWORD)[1](#notes) | +| [nautobot.redis.port](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L406) | int | `6379` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis port, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_PORT)[1](#notes) | +| [nautobot.redis.ssl](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L408) | bool | `false` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis ssl enabled, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_SSL)[1](#notes) | +| [nautobot.redis.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L410) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis username, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_USERNAME)[1](#notes) | | [nautobot.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L54) | int | `2` | Number of Nautobot server replicas to deploy | | [nautobot.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L92) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | (ResourceRequirements) [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] Nautobot resource requests and limits | | [nautobot.revisionHistoryLimit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L56) | int | `3` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#clean-up-policy)] Number of old ReplicaSets to retain | -| [nautobot.secretKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L396) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#secret_key)] Nautobot Secret Key (NAUTOBOT_SECRET_KEY)[1](#notes) | +| [nautobot.secretKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L413) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#secret_key)] Nautobot Secret Key (NAUTOBOT_SECRET_KEY)[1](#notes) | | [nautobot.sidecars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L193) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | Add additional sidecar containers to the Nautobot server pods | -| [nautobot.singleInit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L425) | bool | `false` | [[ref](https://docs.nautobot.com/projects/helm-charts/en/stable/advanced-features/init-hook)] Run the Nautobot initialization tasks as a helm hook instead of an initContainer[1](#notes) | -| [nautobot.superUser.apitoken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L416) | string | `""` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_api_token)] Configure an API key for the super user if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_API_TOKEN)[1](#notes) | -| [nautobot.superUser.email](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L418) | string | `"admin@example.com"` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_email)] Configure an email address for the super user if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_EMAIL)[1](#notes) | -| [nautobot.superUser.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L414) | bool | `true` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_create_superuser)] Create a new super user account in Nautobot once deployed (NAUTOBOT_CREATE_SUPERUSER)[1](#notes) | -| [nautobot.superUser.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L408) | string | `""` | Name of existing secret to use for superuser password and API token[1](#notes) | -| [nautobot.superUser.existingSecretApiTokenKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L412) | string | `""` | API Token key to be retrieved from existing secret[1](#notes) | -| [nautobot.superUser.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L410) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | -| [nautobot.superUser.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L422) | string | `""` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_password)] Password to use for the super user to be created if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_NAME), if unset a random password will be generated[1](#notes) | -| [nautobot.superUser.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L420) | string | `"admin"` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_name)] User name to use for the super user to be created if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_NAME)[1](#notes) | +| [nautobot.singleInit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L442) | bool | `false` | [[ref](https://docs.nautobot.com/projects/helm-charts/en/stable/advanced-features/init-hook)] Run the Nautobot initialization tasks as a helm hook instead of an initContainer[1](#notes) | +| [nautobot.superUser.apitoken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L433) | string | `""` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_api_token)] Configure an API key for the super user if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_API_TOKEN)[1](#notes) | +| [nautobot.superUser.email](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L435) | string | `"admin@example.com"` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_email)] Configure an email address for the super user if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_EMAIL)[1](#notes) | +| [nautobot.superUser.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L431) | bool | `true` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_create_superuser)] Create a new super user account in Nautobot once deployed (NAUTOBOT_CREATE_SUPERUSER)[1](#notes) | +| [nautobot.superUser.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L425) | string | `""` | Name of existing secret to use for superuser password and API token[1](#notes) | +| [nautobot.superUser.existingSecretApiTokenKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L429) | string | `""` | API Token key to be retrieved from existing secret[1](#notes) | +| [nautobot.superUser.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L427) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | +| [nautobot.superUser.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L439) | string | `""` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_password)] Password to use for the super user to be created if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_NAME), if unset a random password will be generated[1](#notes) | +| [nautobot.superUser.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L437) | string | `"admin"` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_name)] User name to use for the super user to be created if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_NAME)[1](#notes) | | [nautobot.terminationGracePeriodSeconds](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L75) | int | `30` | [[ref](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/)] Termination Grace Period Seconds | | [nautobot.tolerations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L167) | [][Toleration](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `[]` | [[ref](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)] Tolerations for Nautobot pods assignment | -| [nautobot.uWSGIini](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L428) | string | `""` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html)] Replace the entire `uwsgi.ini` file with this value[1](#notes) | +| [nautobot.uWSGIini](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L445) | string | `""` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html)] Replace the entire `uwsgi.ini` file with this value[1](#notes) | | [nautobot.updateStrategy.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L171) | `Recreate`, `RollingUpdate` | `"RollingUpdate"` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies)] Nautobot Deployment strategy type | -| [nautobot.uwsgi.bufferSize](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L438) | int | `4096` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#buffer-size)] Set the max size of a request (request-body excluded), this generally maps to the size of request headers. By default it is 4k. If you receive a bigger request (for example with big cookies or query string) you may need to increase it. It is a security measure too, so adapt to your app needs instead of maxing it out.[1](#notes) | -| [nautobot.uwsgi.harakiri](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L440) | int | `0` | [[ref]](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#harakiri) Set the harakiri timeout value. If the value is 0 then the timeout is not set. | -| [nautobot.uwsgi.listen](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L432) | int | `128` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#listen)] Set the uWSGI socket listen queue size.[1](#notes) | -| [nautobot.uwsgi.processes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L434) | int | `3` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#processes)] Spawn the specified number of workers/processes[1](#notes) | -| [nautobot.uwsgi.threads](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L436) | int | `2` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#threads)] Run each worker in prethreaded mode with the specified number of threads[1](#notes) | +| [nautobot.uwsgi.bufferSize](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L455) | int | `4096` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#buffer-size)] Set the max size of a request (request-body excluded), this generally maps to the size of request headers. By default it is 4k. If you receive a bigger request (for example with big cookies or query string) you may need to increase it. It is a security measure too, so adapt to your app needs instead of maxing it out.[1](#notes) | +| [nautobot.uwsgi.harakiri](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L457) | int | `0` | [[ref]](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#harakiri) Set the harakiri timeout value. If the value is 0 then the timeout is not set. | +| [nautobot.uwsgi.listen](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L449) | int | `128` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#listen)] Set the uWSGI socket listen queue size.[1](#notes) | +| [nautobot.uwsgi.processes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L451) | int | `3` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#processes)] Spawn the specified number of workers/processes[1](#notes) | +| [nautobot.uwsgi.threads](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L453) | int | `2` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#threads)] Run each worker in prethreaded mode with the specified number of threads[1](#notes) | ## Nautobots Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [nautobots](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L460) | map[name]nautobot | See values.yaml | Additional Nautobot deployments, map key is the name of the deployment and the additional keys `enabled`, `ingressPaths`, `initNautobot` are required for each Nautobot deployment, all other keys for each Nautobot will override the defaults provided by the root `.Values.nautobot`. | -| [nautobots.default](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L463) | nautobot | See values.yaml | Values for the Default Nautobot deployment see values.yaml `.nautobot` for assumed defaults | +| [nautobots](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L477) | map[name]nautobot | See values.yaml | Additional Nautobot deployments, map key is the name of the deployment and the additional keys `enabled`, `ingressPaths`, `initNautobot` are required for each Nautobot deployment, all other keys for each Nautobot will override the defaults provided by the root `.Values.nautobot`. | +| [nautobots.default](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L480) | nautobot | See values.yaml | Values for the Default Nautobot deployment see values.yaml `.nautobot` for assumed defaults | ## Postgresql Values @@ -358,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#L987) | 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#L989) | 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#L985) | 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#L980) | 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#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 | ## Postgresqlha Values @@ -369,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#L1113) | 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#L1159) | 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#L1173) | 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#L1163) | 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#L1161) | 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#L1166) | 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#L1118) | 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#L1126) | 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#L1129) | 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#L1120) | 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#L1122) | 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#L1124) | 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#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 | ## Rabbitmq Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [rabbitmq.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1187) | 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#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 | ## Redis Values @@ -394,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#L1005) | 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#L1008) | 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#L1010) | 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#L1003) | 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#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 | ## Service Values @@ -420,19 +425,19 @@ 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#L734) | object | `{}` | Service account annotations | -| [serviceAccount.automountServiceAccountToken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L736) | bool | `false` | Auto Mount Service account token | -| [serviceAccount.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L729) | 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#L732) | 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#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 | ## Workers Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [workers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L692) | map[name]celery | See values.yaml | Additional Celery Worker deployments, map key is the name of the deployment and the additional key `enabled` is required for each Worker deployment, all other keys for each Worker will override the defaults provided by the root `.Values.celery`. | -| [workers.beat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L701) | celery | See values.yaml | Values for the Celery Beat deployment see values.yaml `.celery` for assumed defaults | -| [workers.default](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L695) | celery | See values.yaml | Values for the Default Celery Worker deployment see values.yaml `.celery` for assumed defaults | -| [workers.default.taskQueues](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L698) | string | `"default"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/administration/celery-queues/)] a comma separated list of Celery Queues to listen on. | +| [workers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L709) | map[name]celery | See values.yaml | Additional Celery Worker deployments, map key is the name of the deployment and the additional key `enabled` is required for each Worker deployment, all other keys for each Worker will override the defaults provided by the root `.Values.celery`. | +| [workers.beat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L718) | celery | See values.yaml | Values for the Celery Beat deployment see values.yaml `.celery` for assumed defaults | +| [workers.default](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L712) | celery | See values.yaml | Values for the Default Celery Worker deployment see values.yaml `.celery` for assumed defaults | +| [workers.default.taskQueues](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L715) | string | `"default"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/administration/celery-queues/)] a comma separated list of Celery Queues to listen on. | ## Notes diff --git a/charts/nautobot/charts/common-2.19.1.tgz b/charts/nautobot/charts/common-2.19.1.tgz deleted file mode 100644 index 2aec1c88..00000000 Binary files a/charts/nautobot/charts/common-2.19.1.tgz and /dev/null differ diff --git a/charts/nautobot/charts/common-2.19.2.tgz b/charts/nautobot/charts/common-2.19.2.tgz new file mode 100644 index 00000000..e5a625dc Binary files /dev/null and b/charts/nautobot/charts/common-2.19.2.tgz differ diff --git a/charts/nautobot/templates/nautobot-deployment.yaml b/charts/nautobot/templates/nautobot-deployment.yaml index 94bbf0fe..d500f026 100644 --- a/charts/nautobot/templates/nautobot-deployment.yaml +++ b/charts/nautobot/templates/nautobot-deployment.yaml @@ -286,6 +286,8 @@ spec: volumeMounts: - name: "nautobot-static" mountPath: "/opt/nautobot/static" + - name: "nautobot-media" + mountPath: "/opt/nautobot/media" - name: "git-repos" mountPath: "/opt/nautobot/git" - name: "nautobot-config" @@ -420,6 +422,13 @@ spec: {{- else }} emptyDir: {} {{- end }} + - name: "nautobot-media" + {{- if $nautobot.persistenceMediaFiles.enabled }} + persistentVolumeClaim: + claimName: {{ include "common.names.fullname" $ }}-media + {{- else }} + emptyDir: {} + {{- end }} - name: "git-repos" emptyDir: {} - name: "nautobot-config" diff --git a/charts/nautobot/templates/pvc-media.yaml b/charts/nautobot/templates/pvc-media.yaml new file mode 100644 index 00000000..1e5c68d8 --- /dev/null +++ b/charts/nautobot/templates/pvc-media.yaml @@ -0,0 +1,35 @@ +{{- if .Values.nautobot.enabled -}} +{{- if .Values.nautobot.persistenceMediaFiles.enabled -}} +--- +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: {{ include "common.names.fullname" $ }}-media + namespace: {{ .Release.Namespace | quote }} + labels: {{- include "common.labels.standard" $ | nindent 4 }} + app.kubernetes.io/component: nautobot-media-pvc + {{- if .Values.commonLabels }} + {{- include "common.tplvalues.render" ( dict "value" $.Values.commonLabels "context" $ ) | nindent 4 }} + {{- end }} + {{- if .Values.commonAnnotations }} + annotations: {{- include "common.tplvalues.render" ( dict "value" $.Values.commonAnnotations "context" $ ) | nindent 4 }} + {{- end }} +spec: + {{- if .Values.nautobot.persistenceMediaFiles.storageClassName }} + {{- if (eq "-" .Values.nautobot.persistenceMediaFiles.storageClassName) }} + storageClassName: "" + {{- else }} + storageClassName: {{ .Values.nautobot.persistenceMediaFiles.storageClassName | quote }} + {{- end }} + {{- end }} + accessModes: + - {{ .Values.nautobot.persistenceMediaFiles.accessMode | quote }} + resources: + requests: + storage: {{ .Values.nautobot.persistenceMediaFiles.size | quote }} + {{- with .Values.nautobot.persistenceMediaFiles.selector }} + selector: + {{- toYaml . | nindent 4 }} + {{- end }} +{{ end -}} +{{ end -}} diff --git a/charts/nautobot/values.schema.json b/charts/nautobot/values.schema.json index ae0af678..f76855ea 100644 --- a/charts/nautobot/values.schema.json +++ b/charts/nautobot/values.schema.json @@ -99,6 +99,35 @@ ], "title": "Persistence" }, + "persistenceMediaFiles": { + "type": "object", + "additionalProperties": false, + "properties": { + "enabled": { + "type": "boolean" + }, + "storageClassName": { + "type": "string" + }, + "accessMode": { + "type": "string" + }, + "size": { + "type": "string" + }, + "selector": { + "type": "object" + } + }, + "required": [ + "accessMode", + "enabled", + "selector", + "size", + "storageClassName" + ], + "title": "Persistence" + }, "command": { "type": "array", "items": { diff --git a/charts/nautobot/values.yaml b/charts/nautobot/values.yaml index 85f066be..f34f7371 100644 --- a/charts/nautobot/values.yaml +++ b/charts/nautobot/values.yaml @@ -41,7 +41,7 @@ nautobot: # -- Nautobot image name, common to all deployments repository: "nautobot/nautobot" # -- Nautobot image tag, common to all deployments - tag: "2.2.2-py3.11" + tag: "2.2.5-py3.11" # -- [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/), common to all deployments valid values: `Always`, `Never`, or `IfNotPresent` pullPolicy: "Always" # -- ([]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 @@ -254,6 +254,23 @@ nautobot: # matchLabel: # nautobot-storage: static + # Add a Persistent Volume Claim for Nautobot media files + persistenceMediaFiles: + # --- Enable PVC and the relevant volumes + enabled: false + # --- [Kubernetes StorageClass Name](https://kubernetes.io/docs/concepts/storage/storage-classes/), for the creation of Persistent Volume Claim + storageClassName: "" + # --- [Kubernetes Volumes AccessMode](https://kubernetes.io/docs/concepts/storage/storage-classes/) + accessMode: "ReadWriteOnce" + # --- Persistent storage size request + size: "1Gi" + # --- [Kubernetes PVC Selectors](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#selector) to specify volume for Persistent Volume Claim + selector: {} + # e.g. + # selector: + # matchLabel: + # nautobot-storage: media + # Nautobot NGINX configuration nginx: # -- Enable an nginx sidecar to proxy Nautobot traffic (can be useful for large deployments) @@ -813,7 +830,7 @@ metrics: # -- NGINX Exporter image name repository: "nginx/nginx-prometheus-exporter" # -- NGINX Exporter image tag - tag: "0.11.0" + tag: "1.1.0" # -- [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/) valid values: `Always`, `Never`, or `IfNotPresent` pullPolicy: "Always" # -- ([]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 diff --git a/docs/advanced-features/index.md b/docs/advanced-features/index.md index c04b6d68..8f832ba3 100644 --- a/docs/advanced-features/index.md +++ b/docs/advanced-features/index.md @@ -14,7 +14,7 @@ With [Kubernetes](https://kubernetes.io/), public clouds, and the [dependency su * [Ingress](ingress/) * [MySQL Support](mysql/) * [Nautobot as a Subchart](nautobot-as-subchart/) -* [Persistent Volume for Static Files](persistence/) +* [Persistent Volumes for Files](persistence/) * [PostgreSQL High Availability](postgresql-ha/) * [PostgreSQL TLS](postgresql-tls/) * [Prometheus Operator Metrics](prometheus-metrics/) diff --git a/docs/advanced-features/persistence.md b/docs/advanced-features/persistence.md index c50309a8..024e34c6 100644 --- a/docs/advanced-features/persistence.md +++ b/docs/advanced-features/persistence.md @@ -1,21 +1,34 @@ -# Persistence for Static files +# Persistence for Static and Media files -The recommended way to store static files is to use an external shared storage such as [using S3 for Django storage](https://docs.nautobot.com/projects/core/en/stable/user-guide/administration/guides/s3-django-storage/). That said, it is also possible to leverage Kubernetes Persistent Volumes, following the below setting a Persistent Volume Claim is created and mounted it at the `/opt/nautobot/static` path of the Pods. +The recommended way to store static and media files is to use an external shared storage such as [using S3 for Django storage](https://docs.nautobot.com/projects/core/en/stable/user-guide/administration/guides/s3-django-storage/). + +That said, it is also possible to leverage Kubernetes Persistent Volumes, following the below setting a Persistent Volume Claim is created and mounted it at the `/opt/nautobot/static` path of the Pods. + +```yaml +nautobot: + persistenceStaticFiles: + enabled: true + storageClass: "your-storage-class" + accessMode: "ReadWriteMany" + size: "1Gi" +``` + +There is also a setting for Media files mounted at `/opt/nautobot/media` of Nautobot's Pods, similar to the static one, as shown below. ```yaml nautobot: - persistence: + persistenceMediaFiles: enabled: true storageClass: "your-storage-class" accessMode: "ReadWriteMany" size: "1Gi" ``` -Unfortunately, if the underlying storage solution does not support the `ReadWriteMany` option, you have to use node affinity in order for the Pods of the deployment to be scheduled on the same node as the Persistent Volume. Below there is an example using Node labels as selector to create the PVC and schedule the Pods in the same node. +Unfortunately, if the underlying storage solution does not support the `ReadWriteMany` option, you have to use node affinity in order for the Pods of the deployment to be scheduled on the same node as the Persistent Volumes. Below there is an example using Node labels as selector to create the PVC for static files and schedule the Pods in the same node. ```yaml nautobot: - persistence: + persistenceStaticFiles: enabled: true storageClass: "your-storage-class" size: "1Gi" diff --git a/docs/configuration/reference.md b/docs/configuration/reference.md index 2b5f7f63..88be52ab 100644 --- a/docs/configuration/reference.md +++ b/docs/configuration/reference.md @@ -8,58 +8,58 @@ hide: | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celery.affinity](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L610) | [Affinity](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)] Affinity for Nautobot Celery Worker pods assignment | -| [celery.args](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L583) | []string | `[]` | Override default Nautobot Celery Worker container args (useful when using custom images) | -| [celery.autoscaling](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L661) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)] Define a horizontal pod autoscaler | -| [celery.autoscaling.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L663) | bool | `false` | Add an horizontal pod autoscaler for the Celery Worker (beta) | -| [celery.command](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L572) | []string | See values.yaml | Override default Nautobot Celery Worker container command (useful when using custom images) | -| [celery.concurrency](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L493) | int | `0` | [[ref](https://docs.nautobot.com/projects/core/en/stable/administration/celery-queues/#concurrency-setting)]Concurrency Setting (0: use the default which is the number of CPUs available on your system)[2](#notes) | -| [celery.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L560) | [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)] Nautobot Celery Worker Container Security Context | -| [celery.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L563) | bool | `true` | Enable the Worker Celery Container security context | -| [celery.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L490) | bool | `true` | Enables the default Celery Worker for Nautobot | -| [celery.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L625) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the Nautobot Celery Worker pods | -| [celery.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L632) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for Nautobot Celery Worker pods | -| [celery.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L634) | []string | `[]` | List of names of existing Secrets containing extra env vars for Nautobot Celery Worker pods | -| [celery.extraVolumeMounts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L638) | [][VolumeMount](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1) | `[]` | List of additional volumeMounts for the Nautobot Celery Worker containers | -| [celery.extraVolumes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L636) | [][Volume](https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/volume/#Volume) | `[]` | List of additional volumes for the Nautobot Celery Worker pod | -| [celery.hostAliases](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L585) | [][HostAlias](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#hostname-and-name-resolution) | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/)] Nautobot Celery Worker pods host aliases | -| [celery.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L651) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | [[ref](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)] Add additional init containers to the Nautobot Celery Worker pods | -| [celery.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L623) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the Nautobot Celery Worker container(s) to automate configuration before or after startup | -| [celery.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L501) | [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)] Nautobot Celery Worker liveness probe | -| [celery.metricsPort](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L688) | int | `8080` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#celery_worker_prometheus_ports)] Ports for Prometheus metric HTTP server running on the celery worker(s) if `nautobot.metrics` is `true` | -| [celery.nodeAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L597) | object | See values.yaml | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity)] Nautobot Celery Worker Node Affinity preset | -| [celery.nodeAffinityPreset.key](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L601) | string | `""` | Node label key to match. Ignored if `nautobot.affinity` is set | -| [celery.nodeAffinityPreset.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L599) | string | `""` | Nautobot Celery Worker Node affinity preset type. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | -| [celery.nodeAffinityPreset.values](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L603) | list | `[]` | Node label values to match. Ignored if `nautobot.affinity` is set | -| [celery.nodeSelector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L612) | [NodeSelector](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/user-guide/node-selection/)] Node labels for Nautobot Celery Worker pods assignment | -| [celery.pdb](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L553) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)] Nautobot Pod Distribution Budget | -| [celery.podAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L591) | `soft`, `hard` | `""` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Celery Worker Pod affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | -| [celery.podAnnotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L589) | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations for Nautobot Celery Worker pods | -| [celery.podAntiAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L593) | `soft`, `hard` | `"soft"` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Celery Worker Pod anti-affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | -| [celery.podLabels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L587) | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)] Extra labels for Nautobot Celery Worker pods | -| [celery.podSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L544) | [PodSecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] Nautobot Celery Worker Pods Security Context | -| [celery.podSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L546) | bool | `true` | Enable the Worker Pod security context | -| [celery.priorityClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L621) | string | `""` | Nautobot Celery Worker pods' priorityClassName | -| [celery.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L519) | [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)] Nautobot Celery Worker readiness probe | -| [celery.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L495) | int | `2` | Number of Nautobot Celery Workers replicas to deploy | -| [celery.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L534) | [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/)] Nautobot Celery Worker resource requests and limits | -| [celery.revisionHistoryLimit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L497) | int | `3` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#clean-up-policy)] Number of old ReplicaSets to retain | -| [celery.sidecars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L640) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | Add additional sidecar containers to the Nautobot Celery Worker pods | -| [celery.terminationGracePeriodSeconds](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L515) | int | `30` | [[ref](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/)] Termination Grace Period Seconds | -| [celery.tolerations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L614) | [][Toleration](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `[]` | [[ref](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)] Tolerations for Nautobot Celery Worker pods assignment | -| [celery.updateStrategy.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L618) | `Recreate`, `RollingUpdate` | `"RollingUpdate"` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies)] Nautobot Celery Worker Deployment strategy type | +| [celery.affinity](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L627) | [Affinity](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)] Affinity for Nautobot Celery Worker pods assignment | +| [celery.args](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L600) | []string | `[]` | Override default Nautobot Celery Worker container args (useful when using custom images) | +| [celery.autoscaling](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L678) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)] Define a horizontal pod autoscaler | +| [celery.autoscaling.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L680) | bool | `false` | Add an horizontal pod autoscaler for the Celery Worker (beta) | +| [celery.command](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L589) | []string | See values.yaml | Override default Nautobot Celery Worker container command (useful when using custom images) | +| [celery.concurrency](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L510) | int | `0` | [[ref](https://docs.nautobot.com/projects/core/en/stable/administration/celery-queues/#concurrency-setting)]Concurrency Setting (0: use the default which is the number of CPUs available on your system)[2](#notes) | +| [celery.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L577) | [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)] Nautobot Celery Worker Container Security Context | +| [celery.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L580) | bool | `true` | Enable the Worker Celery Container security context | +| [celery.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L507) | bool | `true` | Enables the default Celery Worker for Nautobot | +| [celery.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L642) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the Nautobot Celery Worker pods | +| [celery.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L649) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for Nautobot Celery Worker pods | +| [celery.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L651) | []string | `[]` | List of names of existing Secrets containing extra env vars for Nautobot Celery Worker pods | +| [celery.extraVolumeMounts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L655) | [][VolumeMount](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1) | `[]` | List of additional volumeMounts for the Nautobot Celery Worker containers | +| [celery.extraVolumes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L653) | [][Volume](https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/volume/#Volume) | `[]` | List of additional volumes for the Nautobot Celery Worker pod | +| [celery.hostAliases](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L602) | [][HostAlias](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#hostname-and-name-resolution) | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/)] Nautobot Celery Worker pods host aliases | +| [celery.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L668) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | [[ref](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)] Add additional init containers to the Nautobot Celery Worker pods | +| [celery.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L640) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the Nautobot Celery Worker container(s) to automate configuration before or after startup | +| [celery.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L518) | [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)] Nautobot Celery Worker liveness probe | +| [celery.metricsPort](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L705) | int | `8080` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#celery_worker_prometheus_ports)] Ports for Prometheus metric HTTP server running on the celery worker(s) if `nautobot.metrics` is `true` | +| [celery.nodeAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L614) | object | See values.yaml | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity)] Nautobot Celery Worker Node Affinity preset | +| [celery.nodeAffinityPreset.key](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L618) | string | `""` | Node label key to match. Ignored if `nautobot.affinity` is set | +| [celery.nodeAffinityPreset.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L616) | string | `""` | Nautobot Celery Worker Node affinity preset type. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | +| [celery.nodeAffinityPreset.values](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L620) | list | `[]` | Node label values to match. Ignored if `nautobot.affinity` is set | +| [celery.nodeSelector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L629) | [NodeSelector](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/user-guide/node-selection/)] Node labels for Nautobot Celery Worker pods assignment | +| [celery.pdb](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L570) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)] Nautobot Pod Distribution Budget | +| [celery.podAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L608) | `soft`, `hard` | `""` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Celery Worker Pod affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | +| [celery.podAnnotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L606) | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations for Nautobot Celery Worker pods | +| [celery.podAntiAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L610) | `soft`, `hard` | `"soft"` | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity)] Nautobot Celery Worker Pod anti-affinity preset. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | +| [celery.podLabels](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L604) | map[string]string | `{}` | [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)] Extra labels for Nautobot Celery Worker pods | +| [celery.podSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L561) | [PodSecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)] Nautobot Celery Worker Pods Security Context | +| [celery.podSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L563) | bool | `true` | Enable the Worker Pod security context | +| [celery.priorityClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L638) | string | `""` | Nautobot Celery Worker pods' priorityClassName | +| [celery.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L536) | [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)] Nautobot Celery Worker readiness probe | +| [celery.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L512) | int | `2` | Number of Nautobot Celery Workers replicas to deploy | +| [celery.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L551) | [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/)] Nautobot Celery Worker resource requests and limits | +| [celery.revisionHistoryLimit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L514) | int | `3` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#clean-up-policy)] Number of old ReplicaSets to retain | +| [celery.sidecars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L657) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | Add additional sidecar containers to the Nautobot Celery Worker pods | +| [celery.terminationGracePeriodSeconds](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L532) | int | `30` | [[ref](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/)] Termination Grace Period Seconds | +| [celery.tolerations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L631) | [][Toleration](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `[]` | [[ref](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)] Tolerations for Nautobot Celery Worker pods assignment | +| [celery.updateStrategy.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L635) | `Recreate`, `RollingUpdate` | `"RollingUpdate"` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies)] Nautobot Celery Worker Deployment strategy type | ## CeleryBeat Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celeryBeat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L724) | object | `{}` | DEPRECATED see [`workers.beat`](#workers.beat) and []`celery`](#celery-values) | +| [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) | ## CeleryWorker Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [celeryWorker](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L721) | object | `{}` | DEPRECATED see [`workers.default`](#workers.default) and [`celery`](#celery-values) | +| [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) | ## CommonAnnotations Values @@ -71,27 +71,27 @@ hide: | Key | Type | Default | Description | |-----|------|---------|-------------| -| [ingress.annotations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L759) | 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#L746) | string | `nil` | Override API Version (automatically detected if not set) | -| [ingress.backendProtocol](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L762) | 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#L740) | bool | `false` | Enable Ingress resource creation | -| [ingress.extraHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L772) | 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#L784) | 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#L796) | 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#L749) | string | `"nautobot.local"` | Ingress Hostname | -| [ingress.ingressClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L752) | string | `""` | Ingress Class Name | -| [ingress.path](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L756) | 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#L743) | 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#L768) | 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#L765) | 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#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 | ## InitJob Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [initJob](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L451) | object | See values.yaml | Override values for the nautobot-init job if nautobot.singleInit is true | -| [initJob.installHook](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L453) | `post-install`, `pre-install` | `"pre-install"` | [[ref](https://helm.sh/docs/topics/charts_hooks/#the-available-hooks)] Which helm hook should be used during the installation phase. | -| [initJob.upgradeHook](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L455) | `post-upgrade`, `pre-upgrade` | `"pre-upgrade"` | [[ref](https://helm.sh/docs/topics/charts_hooks/#the-available-hooks)] Which helm hook should be used during the upgrade phase. | +| [initJob](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L468) | object | See values.yaml | Override values for the nautobot-init job if nautobot.singleInit is true | +| [initJob.installHook](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L470) | `post-install`, `pre-install` | `"pre-install"` | [[ref](https://helm.sh/docs/topics/charts_hooks/#the-available-hooks)] Which helm hook should be used during the installation phase. | +| [initJob.upgradeHook](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L472) | `post-upgrade`, `pre-upgrade` | `"pre-upgrade"` | [[ref](https://helm.sh/docs/topics/charts_hooks/#the-available-hooks)] Which helm hook should be used during the upgrade phase. | ## Mariadb Values @@ -99,79 +99,79 @@ 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#L1064) | 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#L1068) | 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#L1070) | 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#L1066) | 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#L1061) | 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#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 | ## Metrics Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [metrics.capacityMetrics.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L941) | 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#L945) | [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#L949) | 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#L943) | 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#L947) | [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#L805) | 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#L827) | [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#L830) | 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#L818) | 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#L820) | []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#L812) | string | `"docker.io"` | NGINX Exporter image registry | -| [metrics.nginxExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L814) | 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#L816) | string | `"0.11.0"` | NGINX Exporter image tag | -| [metrics.nginxExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L849) | [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#L862) | [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#L839) | [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#L962) | object | See values.yaml | Enable and configure Prometheus Rules. | -| [metrics.prometheusRule.rules](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L967) | [][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#L954) | [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#L958) | map[string]string | `{}` | Additional labels for the serviceMonitor Object | -| [metrics.serviceMonitor.scrapeTimeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L956) | [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#L893) | [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#L896) | 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#L884) | 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#L886) | 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#L878) | string | `"docker.io"` | uWSGI Exporter image registry | -| [metrics.uwsgiExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L880) | string | `"timonwong/uwsgi-exporter"` | uWSGI Exporter image name | -| [metrics.uwsgiExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L882) | string | `"v1.3.0"` | uWSGI Exporter image tag | -| [metrics.uwsgiExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L915) | [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#L928) | [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#L905) | [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#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.1.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 | ## Nautobot Values | Key | Type | Default | Description | |-----|------|---------|-------------| | [nautobot.affinity](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L163) | [Affinity](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)] Affinity for Nautobot pods assignment | -| [nautobot.allowedHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L350) | string | `"*"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#allowed_hosts)] Space separated list of Nautobot allowed hosts (NAUTOBOT_ALLOWED_HOSTS)[1](#notes) | +| [nautobot.allowedHosts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L367) | string | `"*"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#allowed_hosts)] Space separated list of Nautobot allowed hosts (NAUTOBOT_ALLOWED_HOSTS)[1](#notes) | | [nautobot.args](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L136) | []string | `[]` | Override default Nautobot container args (useful when using custom images) | | [nautobot.autoscaling](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L214) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)] Define a horizontal pod autoscaler | | [nautobot.autoscaling.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L216) | bool | `false` | Add an horizontal pod autoscaler for Nautobot (beta) | | [nautobot.command](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L130) | []string | `["nautobot-server","start","--ini","/opt/nautobot/uwsgi.ini"]` | Override default Nautobot container command (useful when using custom images) | -| [nautobot.config](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L345) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/)] Replace the entire `nautobot_config.py` file with this value[1](#notes) | +| [nautobot.config](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L362) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/)] Replace the entire `nautobot_config.py` file with this value[1](#notes) | | [nautobot.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L118) | [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)] Nautobot Container Security Context | | [nautobot.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L121) | bool | `true` | Enable the Nautobot container security context | -| [nautobot.db.engine](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L355) | string | `"django.db.backends.postgresql"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot database engine, valid values: `django.db.backends.postgresql`, `django_prometheus.db.backends.postgresql` (metrics enabled), `django.db.backends.mysql`, and `django_prometheus.db.backends.mysql` (metrics enabled) (NAUTOBOT_DB_ENGINE)[1](#notes) | -| [nautobot.db.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L357) | string | `""` | Name of existing secret to use for Database passwords[1](#notes) | -| [nautobot.db.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L359) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | -| [nautobot.db.host](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L361) | string | `"postgres"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database hostname, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_HOST)[1](#notes) | -| [nautobot.db.name](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L363) | string | `"nautobot"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database name, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_NAME)[1](#notes) | -| [nautobot.db.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L365) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database password, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_PASSWORD)[1](#notes) | -| [nautobot.db.port](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L367) | int | `5432` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database port, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_PORT)[1](#notes) | -| [nautobot.db.timeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L369) | int | `300` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot database timeout (NAUTOBOT_DB_TIMEOUT)[1](#notes) | -| [nautobot.db.user](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L371) | string | `"nautobot"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database username, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_USER)[1](#notes) | -| [nautobot.debug](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L347) | bool | `false` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#debug)] Enable Nautobot Debug (NAUTOBOT_DEBUG)[1](#notes) | -| [nautobot.django.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L400) | string | `""` | Name of existing secret to use for NAUTOBOT_SECRET_KEY[1](#notes) | -| [nautobot.django.existingSecretSecretKeyKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L402) | string | `""` | SecretKey key to be retrieved from existing secret[1](#notes) | -| [nautobot.django.secretKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L404) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#secret_key)] Nautobot Secret Key (NAUTOBOT_SECRET_KEY), takes priority over nautobot.secretKey[1](#notes) | +| [nautobot.db.engine](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L372) | string | `"django.db.backends.postgresql"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot database engine, valid values: `django.db.backends.postgresql`, `django_prometheus.db.backends.postgresql` (metrics enabled), `django.db.backends.mysql`, and `django_prometheus.db.backends.mysql` (metrics enabled) (NAUTOBOT_DB_ENGINE)[1](#notes) | +| [nautobot.db.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L374) | string | `""` | Name of existing secret to use for Database passwords[1](#notes) | +| [nautobot.db.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L376) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | +| [nautobot.db.host](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L378) | string | `"postgres"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database hostname, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_HOST)[1](#notes) | +| [nautobot.db.name](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L380) | string | `"nautobot"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database name, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_NAME)[1](#notes) | +| [nautobot.db.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L382) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database password, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_PASSWORD)[1](#notes) | +| [nautobot.db.port](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L384) | int | `5432` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database port, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_PORT)[1](#notes) | +| [nautobot.db.timeout](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L386) | int | `300` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot database timeout (NAUTOBOT_DB_TIMEOUT)[1](#notes) | +| [nautobot.db.user](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L388) | string | `"nautobot"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#databases)] Nautobot external database username, ignored if `postgresql.enabled` is `true` (NAUTOBOT_DB_USER)[1](#notes) | +| [nautobot.debug](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L364) | bool | `false` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#debug)] Enable Nautobot Debug (NAUTOBOT_DEBUG)[1](#notes) | +| [nautobot.django.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L417) | string | `""` | Name of existing secret to use for NAUTOBOT_SECRET_KEY[1](#notes) | +| [nautobot.django.existingSecretSecretKeyKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L419) | string | `""` | SecretKey key to be retrieved from existing secret[1](#notes) | +| [nautobot.django.secretKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L421) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#secret_key)] Nautobot Secret Key (NAUTOBOT_SECRET_KEY), takes priority over nautobot.secretKey[1](#notes) | | [nautobot.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L36) | bool | `true` | Enable the default Nautobot deployment | | [nautobot.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L178) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the Nautobot server pods | | [nautobot.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L185) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for Nautobot server pods | | [nautobot.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L187) | []string | `[]` | List of names of existing Secrets containing extra env vars for Nautobot server pods | -| [nautobot.extraVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L443) | []map[name,value]string | `[]` | An array of environment variable objects (`name` and `value` are required) to add to ALL Nautobot and Nautobot Worker related deployments[1](#notes) | +| [nautobot.extraVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L460) | []map[name,value]string | `[]` | An array of environment variable objects (`name` and `value` are required) to add to ALL Nautobot and Nautobot Worker related deployments[1](#notes) | | [nautobot.extraVolumeMounts](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L191) | [][VolumeMount](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1) | `[]` | List of additional volumeMounts for the Nautobot containers | | [nautobot.extraVolumes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L189) | [][Volume](https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/volume/#Volume) | `[]` | List of additional volumes for the Nautobot server pod | | [nautobot.hostAliases](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L138) | [][HostAlias](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#hostname-and-name-resolution) | `[]` | [[ref](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/)] Nautobot pods host aliases | @@ -179,34 +179,39 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th | [nautobot.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L48) | []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 | | [nautobot.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L40) | string | `"ghcr.io"` | Nautobot image registry, common to all deployments | | [nautobot.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L42) | string | `"nautobot/nautobot"` | Nautobot image name, common to all deployments | -| [nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L44) | string | `"2.2.2-py3.11"` | Nautobot image tag, common to all deployments | +| [nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L44) | string | `"2.2.5-py3.11"` | Nautobot image tag, common to all deployments | | [nautobot.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L204) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | [[ref](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)] Add additional init containers to the Nautobot server pods | | [nautobot.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L176) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the Nautobot container(s) to automate configuration before or after startup | | [nautobot.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L60) | [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)] Nautobot liveness probe | | [nautobot.livenessProbe.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L62) | bool | `true` | Enable the Nautobot Liveness Probe | -| [nautobot.logLevel](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L374) | `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG` | `"INFO"` | Log Level used for Celery logging, valid values: `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG`[1](#notes) | -| [nautobot.metrics](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L376) | bool | `true` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#metrics_enabled)] Enable Prometheus metrics endpoint (NAUTOBOT_METRICS_ENABLED)[1](#notes) | -| [nautobot.nginx.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L282) | [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 Container Security Context | -| [nautobot.nginx.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L284) | bool | `true` | Enable the nginx container security context | -| [nautobot.nginx.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L260) | bool | `false` | Enable an nginx sidecar to proxy Nautobot traffic (can be useful for large deployments) | -| [nautobot.nginx.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L295) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the NGINX containers | -| [nautobot.nginx.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L302) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for the NGINX containers | -| [nautobot.nginx.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L304) | []string | `[]` | List of names of existing Secrets containing extra env vars for the NGINX containers | -| [nautobot.nginx.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L270) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/), common to all deployments valid values: `Always`, `Never`, or `IfNotPresent` | -| [nautobot.nginx.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L272) | []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 | -| [nautobot.nginx.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L264) | string | `"docker.io"` | NGINX image registry | -| [nautobot.nginx.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L266) | string | `"nginxinc/nginx-unprivileged"` | NGINX image name | -| [nautobot.nginx.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L268) | string | `"1.26"` | NGINX image tag | -| [nautobot.nginx.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L278) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the NGINX container(s) to automate configuration before or after startup | -| [nautobot.nginx.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L308) | [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 liveness probe | -| [nautobot.nginx.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L320) | [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 readiness probe | -| [nautobot.nginx.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L333) | [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 resource requests and limits | +| [nautobot.logLevel](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L391) | `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG` | `"INFO"` | Log Level used for Celery logging, valid values: `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG`[1](#notes) | +| [nautobot.metrics](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L393) | bool | `true` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/optional-settings/#metrics_enabled)] Enable Prometheus metrics endpoint (NAUTOBOT_METRICS_ENABLED)[1](#notes) | +| [nautobot.nginx.containerSecurityContext](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L299) | [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 Container Security Context | +| [nautobot.nginx.containerSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L301) | bool | `true` | Enable the nginx container security context | +| [nautobot.nginx.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L277) | bool | `false` | Enable an nginx sidecar to proxy Nautobot traffic (can be useful for large deployments) | +| [nautobot.nginx.extraEnvVars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L312) | [][EnvVar](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables) | `[]` | Extra Env Vars to set only on the NGINX containers | +| [nautobot.nginx.extraEnvVarsCM](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L319) | []string | `[]` | List of names of existing ConfigMaps containing extra env vars for the NGINX containers | +| [nautobot.nginx.extraEnvVarsSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L321) | []string | `[]` | List of names of existing Secrets containing extra env vars for the NGINX containers | +| [nautobot.nginx.image.pullPolicy](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L287) | string | `"Always"` | [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/), common to all deployments valid values: `Always`, `Never`, or `IfNotPresent` | +| [nautobot.nginx.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L289) | []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 | +| [nautobot.nginx.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L281) | string | `"docker.io"` | NGINX image registry | +| [nautobot.nginx.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L283) | string | `"nginxinc/nginx-unprivileged"` | NGINX image name | +| [nautobot.nginx.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L285) | string | `"1.26"` | NGINX image tag | +| [nautobot.nginx.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L295) | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the NGINX container(s) to automate configuration before or after startup | +| [nautobot.nginx.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L325) | [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 liveness probe | +| [nautobot.nginx.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L337) | [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 readiness probe | +| [nautobot.nginx.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L350) | [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 resource requests and limits | | [nautobot.nodeAffinityPreset](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L150) | object | See values.yaml | [[ref](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity)] Nautobot Node Affinity preset | | [nautobot.nodeAffinityPreset.key](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L154) | string | `""` | Node label key to match. Ignored if `nautobot.affinity` is set | | [nautobot.nodeAffinityPreset.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L152) | `soft`, `hard` | `""` | Nautobot Node affinity preset type. Ignored if `nautobot.affinity` is set. Valid values: `soft` or `hard` | | [nautobot.nodeAffinityPreset.values](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L156) | []string | `[]` | Node label values to match. Ignored if `nautobot.affinity` is set | | [nautobot.nodeSelector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L165) | [NodeSelector](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `{}` | [[ref](https://kubernetes.io/docs/user-guide/node-selection/)] Node labels for Nautobot pods assignment | | [nautobot.pdb](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L111) | object | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)] Nautobot Pod Distribution Budget | +| [nautobot.persistenceMediaFiles.accessMode](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L264) | string | `"ReadWriteOnce"` | - [Kubernetes Volumes AccessMode](https://kubernetes.io/docs/concepts/storage/storage-classes/) | +| [nautobot.persistenceMediaFiles.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L260) | bool | `false` | - Enable PVC and the relevant volumes | +| [nautobot.persistenceMediaFiles.selector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L268) | object | `{}` | - [Kubernetes PVC Selectors](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#selector) to specify volume for Persistent Volume Claim | +| [nautobot.persistenceMediaFiles.size](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L266) | string | `"1Gi"` | - Persistent storage size request | +| [nautobot.persistenceMediaFiles.storageClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L262) | string | `""` | - [Kubernetes StorageClass Name](https://kubernetes.io/docs/concepts/storage/storage-classes/), for the creation of Persistent Volume Claim | | [nautobot.persistenceStaticFiles.accessMode](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L247) | string | `"ReadWriteOnce"` | - [Kubernetes Volumes AccessMode](https://kubernetes.io/docs/concepts/storage/storage-classes/) | | [nautobot.persistenceStaticFiles.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L243) | bool | `false` | - Enable PVC and the relevant volumes | | [nautobot.persistenceStaticFiles.selector](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L251) | object | `{}` | - [Kubernetes PVC Selectors](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#selector) to specify volume for Persistent Volume Claim | @@ -220,43 +225,43 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th | [nautobot.podSecurityContext.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L104) | bool | `true` | Enable the Nautobot Pod security context | | [nautobot.priorityClassName](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L174) | string | `""` | Nautobot pods' priorityClassName | | [nautobot.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L79) | [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)] Nautobot readiness probe | -| [nautobot.redis.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L381) | string | `""` | Name of existing secret to use for Redis passwords[1](#notes) | -| [nautobot.redis.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L383) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | -| [nautobot.redis.host](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L385) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis hostname, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_HOST)[1](#notes) | -| [nautobot.redis.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L387) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis password, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_PASSWORD)[1](#notes) | -| [nautobot.redis.port](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L389) | int | `6379` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis port, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_PORT)[1](#notes) | -| [nautobot.redis.ssl](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L391) | bool | `false` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis ssl enabled, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_SSL)[1](#notes) | -| [nautobot.redis.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L393) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis username, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_USERNAME)[1](#notes) | +| [nautobot.redis.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L398) | string | `""` | Name of existing secret to use for Redis passwords[1](#notes) | +| [nautobot.redis.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L400) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | +| [nautobot.redis.host](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L402) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis hostname, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_HOST)[1](#notes) | +| [nautobot.redis.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L404) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis password, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_PASSWORD)[1](#notes) | +| [nautobot.redis.port](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L406) | int | `6379` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis port, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_PORT)[1](#notes) | +| [nautobot.redis.ssl](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L408) | bool | `false` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis ssl enabled, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_SSL)[1](#notes) | +| [nautobot.redis.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L410) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#rq_queues)] Nautobot external Redis username, ignored if `redis.enabled` is `true` (NAUTOBOT_REDIS_USERNAME)[1](#notes) | | [nautobot.replicaCount](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L54) | int | `2` | Number of Nautobot server replicas to deploy | | [nautobot.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L92) | [ResourceRequirements](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) | See values.yaml | (ResourceRequirements) [[ref](http://kubernetes.io/docs/user-guide/compute-resources/)] Nautobot resource requests and limits | | [nautobot.revisionHistoryLimit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L56) | int | `3` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#clean-up-policy)] Number of old ReplicaSets to retain | -| [nautobot.secretKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L396) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#secret_key)] Nautobot Secret Key (NAUTOBOT_SECRET_KEY)[1](#notes) | +| [nautobot.secretKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L413) | string | `""` | [[ref](https://docs.nautobot.com/projects/core/en/stable/configuration/required-settings/#secret_key)] Nautobot Secret Key (NAUTOBOT_SECRET_KEY)[1](#notes) | | [nautobot.sidecars](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L193) | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | Add additional sidecar containers to the Nautobot server pods | -| [nautobot.singleInit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L425) | bool | `false` | [[ref](https://docs.nautobot.com/projects/helm-charts/en/stable/advanced-features/init-hook)] Run the Nautobot initialization tasks as a helm hook instead of an initContainer[1](#notes) | -| [nautobot.superUser.apitoken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L416) | string | `""` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_api_token)] Configure an API key for the super user if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_API_TOKEN)[1](#notes) | -| [nautobot.superUser.email](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L418) | string | `"admin@example.com"` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_email)] Configure an email address for the super user if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_EMAIL)[1](#notes) | -| [nautobot.superUser.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L414) | bool | `true` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_create_superuser)] Create a new super user account in Nautobot once deployed (NAUTOBOT_CREATE_SUPERUSER)[1](#notes) | -| [nautobot.superUser.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L408) | string | `""` | Name of existing secret to use for superuser password and API token[1](#notes) | -| [nautobot.superUser.existingSecretApiTokenKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L412) | string | `""` | API Token key to be retrieved from existing secret[1](#notes) | -| [nautobot.superUser.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L410) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | -| [nautobot.superUser.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L422) | string | `""` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_password)] Password to use for the super user to be created if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_NAME), if unset a random password will be generated[1](#notes) | -| [nautobot.superUser.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L420) | string | `"admin"` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_name)] User name to use for the super user to be created if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_NAME)[1](#notes) | +| [nautobot.singleInit](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L442) | bool | `false` | [[ref](https://docs.nautobot.com/projects/helm-charts/en/stable/advanced-features/init-hook)] Run the Nautobot initialization tasks as a helm hook instead of an initContainer[1](#notes) | +| [nautobot.superUser.apitoken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L433) | string | `""` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_api_token)] Configure an API key for the super user if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_API_TOKEN)[1](#notes) | +| [nautobot.superUser.email](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L435) | string | `"admin@example.com"` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_email)] Configure an email address for the super user if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_EMAIL)[1](#notes) | +| [nautobot.superUser.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L431) | bool | `true` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_create_superuser)] Create a new super user account in Nautobot once deployed (NAUTOBOT_CREATE_SUPERUSER)[1](#notes) | +| [nautobot.superUser.existingSecret](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L425) | string | `""` | Name of existing secret to use for superuser password and API token[1](#notes) | +| [nautobot.superUser.existingSecretApiTokenKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L429) | string | `""` | API Token key to be retrieved from existing secret[1](#notes) | +| [nautobot.superUser.existingSecretPasswordKey](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L427) | string | `""` | Password key to be retrieved from existing secret[1](#notes) | +| [nautobot.superUser.password](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L439) | string | `""` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_password)] Password to use for the super user to be created if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_NAME), if unset a random password will be generated[1](#notes) | +| [nautobot.superUser.username](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L437) | string | `"admin"` | [[ref](https://nautobot.readthedocs.io/en/stable/docker/#nautobot_superuser_name)] User name to use for the super user to be created if `nautobot.superUser.enabled` is `true` (NAUTOBOT_SUPERUSER_NAME)[1](#notes) | | [nautobot.terminationGracePeriodSeconds](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L75) | int | `30` | [[ref](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/)] Termination Grace Period Seconds | | [nautobot.tolerations](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L167) | [][Toleration](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) | `[]` | [[ref](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)] Tolerations for Nautobot pods assignment | -| [nautobot.uWSGIini](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L428) | string | `""` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html)] Replace the entire `uwsgi.ini` file with this value[1](#notes) | +| [nautobot.uWSGIini](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L445) | string | `""` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html)] Replace the entire `uwsgi.ini` file with this value[1](#notes) | | [nautobot.updateStrategy.type](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L171) | `Recreate`, `RollingUpdate` | `"RollingUpdate"` | [[ref](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies)] Nautobot Deployment strategy type | -| [nautobot.uwsgi.bufferSize](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L438) | int | `4096` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#buffer-size)] Set the max size of a request (request-body excluded), this generally maps to the size of request headers. By default it is 4k. If you receive a bigger request (for example with big cookies or query string) you may need to increase it. It is a security measure too, so adapt to your app needs instead of maxing it out.[1](#notes) | -| [nautobot.uwsgi.harakiri](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L440) | int | `0` | [[ref]](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#harakiri) Set the harakiri timeout value. If the value is 0 then the timeout is not set. | -| [nautobot.uwsgi.listen](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L432) | int | `128` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#listen)] Set the uWSGI socket listen queue size.[1](#notes) | -| [nautobot.uwsgi.processes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L434) | int | `3` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#processes)] Spawn the specified number of workers/processes[1](#notes) | -| [nautobot.uwsgi.threads](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L436) | int | `2` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#threads)] Run each worker in prethreaded mode with the specified number of threads[1](#notes) | +| [nautobot.uwsgi.bufferSize](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L455) | int | `4096` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#buffer-size)] Set the max size of a request (request-body excluded), this generally maps to the size of request headers. By default it is 4k. If you receive a bigger request (for example with big cookies or query string) you may need to increase it. It is a security measure too, so adapt to your app needs instead of maxing it out.[1](#notes) | +| [nautobot.uwsgi.harakiri](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L457) | int | `0` | [[ref]](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#harakiri) Set the harakiri timeout value. If the value is 0 then the timeout is not set. | +| [nautobot.uwsgi.listen](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L449) | int | `128` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#listen)] Set the uWSGI socket listen queue size.[1](#notes) | +| [nautobot.uwsgi.processes](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L451) | int | `3` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#processes)] Spawn the specified number of workers/processes[1](#notes) | +| [nautobot.uwsgi.threads](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L453) | int | `2` | [[ref](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#threads)] Run each worker in prethreaded mode with the specified number of threads[1](#notes) | ## Nautobots Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [nautobots](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L460) | map[name]nautobot | See values.yaml | Additional Nautobot deployments, map key is the name of the deployment and the additional keys `enabled`, `ingressPaths`, `initNautobot` are required for each Nautobot deployment, all other keys for each Nautobot will override the defaults provided by the root `.Values.nautobot`. | -| [nautobots.default](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L463) | nautobot | See values.yaml | Values for the Default Nautobot deployment see values.yaml `.nautobot` for assumed defaults | +| [nautobots](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L477) | map[name]nautobot | See values.yaml | Additional Nautobot deployments, map key is the name of the deployment and the additional keys `enabled`, `ingressPaths`, `initNautobot` are required for each Nautobot deployment, all other keys for each Nautobot will override the defaults provided by the root `.Values.nautobot`. | +| [nautobots.default](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L480) | nautobot | See values.yaml | Values for the Default Nautobot deployment see values.yaml `.nautobot` for assumed defaults | ## Postgresql Values @@ -264,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#L987) | 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#L989) | 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#L985) | 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#L980) | 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#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 | ## Postgresqlha Values @@ -275,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#L1113) | 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#L1159) | 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#L1173) | 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#L1163) | 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#L1161) | 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#L1166) | 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#L1118) | 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#L1126) | 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#L1129) | 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#L1120) | 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#L1122) | 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#L1124) | 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#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 | ## Rabbitmq Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [rabbitmq.enabled](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L1187) | 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#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 | ## Redis Values @@ -300,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#L1005) | 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#L1008) | 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#L1010) | 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#L1003) | 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#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 | ## Service Values @@ -326,19 +331,19 @@ 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#L734) | object | `{}` | Service account annotations | -| [serviceAccount.automountServiceAccountToken](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L736) | bool | `false` | Auto Mount Service account token | -| [serviceAccount.create](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L729) | 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#L732) | 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#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 | ## Workers Values | Key | Type | Default | Description | |-----|------|---------|-------------| -| [workers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L692) | map[name]celery | See values.yaml | Additional Celery Worker deployments, map key is the name of the deployment and the additional key `enabled` is required for each Worker deployment, all other keys for each Worker will override the defaults provided by the root `.Values.celery`. | -| [workers.beat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L701) | celery | See values.yaml | Values for the Celery Beat deployment see values.yaml `.celery` for assumed defaults | -| [workers.default](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L695) | celery | See values.yaml | Values for the Default Celery Worker deployment see values.yaml `.celery` for assumed defaults | -| [workers.default.taskQueues](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L698) | string | `"default"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/administration/celery-queues/)] a comma separated list of Celery Queues to listen on. | +| [workers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L709) | map[name]celery | See values.yaml | Additional Celery Worker deployments, map key is the name of the deployment and the additional key `enabled` is required for each Worker deployment, all other keys for each Worker will override the defaults provided by the root `.Values.celery`. | +| [workers.beat](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L718) | celery | See values.yaml | Values for the Celery Beat deployment see values.yaml `.celery` for assumed defaults | +| [workers.default](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L712) | celery | See values.yaml | Values for the Default Celery Worker deployment see values.yaml `.celery` for assumed defaults | +| [workers.default.taskQueues](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L715) | string | `"default"` | [[ref](https://docs.nautobot.com/projects/core/en/stable/administration/celery-queues/)] a comma separated list of Celery Queues to listen on. | ## Notes diff --git a/docs/release-notes/version-2.x.md b/docs/release-notes/version-2.x.md index d3942a0e..668191b5 100644 --- a/docs/release-notes/version-2.x.md +++ b/docs/release-notes/version-2.x.md @@ -3,6 +3,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## 2.1.2 - 2024-05-31 + +### Added + +* [#391](https://github.com/nautobot/helm-charts/pull/391) Add persistent volume option for media files + +### Fixed + +* [#398](https://github.com/nautobot/helm-charts/pull/398) Docs Update: Persistent volumes for static & media files + +### Changed + +* Upgraded Nautobot from 2.2.2 to 2.2.5 +* Upgraded nginx-prometheus-exporter image from 0.11.0 to 1.1.0 +* Upgraded Bitnami Common subchart from 2.19.1 to 2.19.2 +* Upgraded dependency mkdocs-material from 9.5.18 to 9.5.22 + ## 2.1.1 - 2024-04-25 ### Added diff --git a/docs/requirements.txt b/docs/requirements.txt index 96517629..6405dfe9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ mkdocs==1.6.0 -mkdocs-material==9.5.19 +mkdocs-material==9.5.22 mkdocs-version-annotations==1.0.0 diff --git a/mkdocs.yml b/mkdocs.yml index dc9f0e06..5bc357a9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -83,7 +83,7 @@ nav: - Ingress: "advanced-features/ingress.md" - MySQL Support: "advanced-features/mysql.md" - Nautobot as a Subchart: "advanced-features/nautobot-as-subchart.md" - - Persistent Volume for Static Files: "advanced-features/persistence.md" + - Persistent Volumes for Files: "advanced-features/persistence.md" - PostgreSQL High Availability: "advanced-features/postgresql-ha.md" - PostgreSQL TLS: "advanced-features/postgresql-tls.md" - Prometheus Operator Metrics: "advanced-features/prometheus-metrics.md" diff --git a/pyproject.toml b/pyproject.toml index 681ec36d..6649795f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,7 +11,7 @@ invoke = "*" # Rendering docs to HTML mkdocs = "~1.6.0" # Material for MkDocs theme -mkdocs-material = "9.5.19" +mkdocs-material = "9.5.22" # Render custom markdown for version added/changed/remove notes mkdocs-version-annotations = "1.0.0"