Merge pull request #490 from nautobot/develop

Release v2.4.2

.pre-commit-config.yaml

@@ -33,7 +33,7 @@ repos:
           - "docs/"
 
   - repo: "https://github.com/streetsidesoftware/cspell-cli"
-    rev: "v8.16.0"
+    rev: "v8.16.1"
     hooks:
       - id: "cspell"
 

charts/nautobot/Chart.lock

@@ -16,6 +16,6 @@ dependencies:
   version: 12.15.0
 - name: common
   repository: oci://registry-1.docker.io/bitnamicharts
-  version: 2.27.2
-digest: sha256:b6b4ec626acd08bf14c9c66a37790067ee1077d33bf7522b482a70ceb98a3591
-generated: "2024-11-29T09:04:09.045379342+02:00"
+  version: 2.28.0
+digest: sha256:35606a5f81b4205c4d696f4e980a569de9a2102ad709c0cb7c8bb64d1b1c7d55
+generated: "2024-12-12T17:16:47.97397207+02:00"

charts/nautobot/Chart.yaml

@@ -6,7 +6,7 @@ annotations:
   artifacthub.io/prerelease: "false"
   artifacthub.io/images: |
     - name: nautobot
-      image: ghcr.io/nautobot/nautobot:2.3.12-py3.11
+      image: ghcr.io/nautobot/nautobot:2.3.13-py3.11
   artifacthub.io/links: |
     - name: Nautobot Documentation
       url: https://docs.nautobot.com/
@@ -30,13 +30,17 @@ annotations:
     - title: Chatops
       url: https://raw.githubusercontent.com/nautobot/nautobot/develop/nautobot/docs/media/ss_plugin_chatops.png
   artifacthub.io/changes: |
+    - kind: added
+      description: Add functionality for auto-deployments in configuration changes
     - kind: changed
-      description: Upgraded Nautobot from 2.3.11 to 2.3.12
+      description: Upgraded Nautobot from 2.3.12 to 2.3.13
     - kind: changed
-      description: Upgraded Bitnami common subchart from 2.27.0 to 2.27.2
+      description: Upgraded Nginx prometheus exporter from 1.3.0 to 1.4.0
+    - kind: changed
+      description: Upgraded Bitnami common subchart from 2.27.2 to 2.28.0
 apiVersion: "v2"
-appVersion: "2.3.12"
-version: "2.4.1"
+appVersion: "2.3.13"
+version: "2.4.2"
 dependencies:
   - condition: "redis.enabled"
     name: "redis"

charts/nautobot/README.md

@@ -1,6 +1,6 @@
 # nautobot
 
-![Version: 2.4.1](https://img.shields.io/badge/Version-2.4.1-informational?style=flat-square) ![AppVersion: 2.3.12](https://img.shields.io/badge/AppVersion-2.3.12-informational?style=flat-square)
+![Version: 2.4.2](https://img.shields.io/badge/Version-2.4.2-informational?style=flat-square) ![AppVersion: 2.3.13](https://img.shields.io/badge/AppVersion-2.3.13-informational?style=flat-square)
 
 Nautobot is a Network Source of Truth and Network Automation Platform.
 
@@ -222,7 +222,7 @@ The `mariadb.*` values configure the upstream chart from Bitnami.  Please see th
 | <a name="metrics.nginxExporter.image.pullSecrets">[metrics.nginxExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L858)</a> | []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 |
 | <a name="metrics.nginxExporter.image.registry">[metrics.nginxExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L850)</a> | string | `"docker.io"` | NGINX Exporter image registry |
 | <a name="metrics.nginxExporter.image.repository">[metrics.nginxExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L852)</a> | string | `"nginx/nginx-prometheus-exporter"` | NGINX Exporter image name |
-| <a name="metrics.nginxExporter.image.tag">[metrics.nginxExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L854)</a> | string | `"1.3.0"` | NGINX Exporter image tag |
+| <a name="metrics.nginxExporter.image.tag">[metrics.nginxExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L854)</a> | string | `"1.4.0"` | NGINX Exporter image tag |
 | <a name="metrics.nginxExporter.livenessProbe">[metrics.nginxExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L887)</a> | [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-startup-probes/#configure-probes)] NGINX Exporter liveness probe |
 | <a name="metrics.nginxExporter.readinessProbe">[metrics.nginxExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L900)</a> | [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-startup-probes/#configure-probes)] NGINX Exporter readiness probe |
 | <a name="metrics.nginxExporter.resources">[metrics.nginxExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L877)</a> | [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 |
@@ -281,7 +281,7 @@ The `mariadb.*` values configure the upstream chart from Bitnami.  Please see th
 | <a name="nautobot.image.pullSecrets">[nautobot.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L48)</a> | []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 |
 | <a name="nautobot.image.registry">[nautobot.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L40)</a> | string | `"ghcr.io"` | Nautobot image registry, common to all deployments |
 | <a name="nautobot.image.repository">[nautobot.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L42)</a> | string | `"nautobot/nautobot"` | Nautobot image name, common to all deployments |
-| <a name="nautobot.image.tag">[nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L44)</a> | string | `"2.3.12-py3.11"` | Nautobot image tag, common to all deployments |
+| <a name="nautobot.image.tag">[nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L44)</a> | string | `"2.3.13-py3.11"` | Nautobot image tag, common to all deployments |
 | <a name="nautobot.initContainers">[nautobot.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L219)</a> | [][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 |
 | <a name="nautobot.lifecycleHooks">[nautobot.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L191)</a> | [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 |
 | <a name="nautobot.livenessProbe">[nautobot.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L60)</a> | [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-startup-probes/#configure-probes)] Nautobot liveness probe |

charts/nautobot/templates/celery-deployment.yaml

@@ -1,3 +1,4 @@
+{{- $config_checksum := dict "checksum/config-env" (include "nautobot.configMap.env" . | sha256sum ) "checksum/config" (include "nautobot.configMap.config" . | sha256sum) }}
 {{- $workers := (include "nautobot.workers" .) | mustFromJson -}}
 {{- range $celeryName, $celery := $workers -}}
 {{- if $celery.enabled }}
@@ -29,7 +30,9 @@ spec:
   template:
     metadata:
       {{- if $celery.podAnnotations }}
-      annotations: {{- include "common.tplvalues.render" (dict "value" $celery.podAnnotations "context" $) | nindent 8 }}
+      annotations: {{- include "common.tplvalues.render" (dict "value" (merge $celery.podAnnotations $config_checksum) "context" $) | nindent 8 }}
+      {{- else }}
+      annotations: {{- include "common.tplvalues.render" ( dict "value" $config_checksum "context" $ ) | nindent 8 }}
       {{- end }}
       labels: {{- include "common.labels.standard" $ | nindent 8 }}
         app.kubernetes.io/component: nautobot-celery-{{ $celeryName }}

charts/nautobot/templates/nautobot-deployment.yaml

@@ -1,3 +1,4 @@
+{{- $config_checksum := dict "checksum/config-env" (include "nautobot.configMap.env" . | sha256sum ) "checksum/config" (include "nautobot.configMap.config" . | sha256sum) }}
 {{- $nautobots := (include "nautobot.nautobots" .) | mustFromJson -}}
 {{- range $nautobotName, $nautobot := $nautobots -}}
 {{- if $nautobot.enabled -}}
@@ -29,7 +30,9 @@ spec:
   template:
     metadata:
       {{- if $nautobot.podAnnotations }}
-      annotations: {{- include "common.tplvalues.render" (dict "value" $nautobot.podAnnotations "context" $) | nindent 8 }}
+      annotations: {{- include "common.tplvalues.render" (dict "value" (merge $nautobot.podAnnotations $config_checksum) "context" $) | nindent 8 }}
+      {{- else }}
+      annotations: {{- include "common.tplvalues.render" ( dict "value" $config_checksum "context" $ ) | nindent 8 }}
       {{- end }}
       labels: {{- include "common.labels.standard" $ | nindent 8 }}
         app.kubernetes.io/component: nautobot-{{ $nautobotName }}

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.3.12-py3.11"
+    tag: "2.3.13-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
@@ -851,7 +851,7 @@ metrics:
       # -- NGINX Exporter image name
       repository: "nginx/nginx-prometheus-exporter"
       # -- NGINX Exporter image tag
-      tag: "1.3.0"
+      tag: "1.4.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

docs/configuration/reference.md

@@ -128,7 +128,7 @@ The `mariadb.*` values configure the upstream chart from Bitnami.  Please see th
 | <a name="metrics.nginxExporter.image.pullSecrets">[metrics.nginxExporter.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L858)</a> | []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 |
 | <a name="metrics.nginxExporter.image.registry">[metrics.nginxExporter.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L850)</a> | string | `"docker.io"` | NGINX Exporter image registry |
 | <a name="metrics.nginxExporter.image.repository">[metrics.nginxExporter.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L852)</a> | string | `"nginx/nginx-prometheus-exporter"` | NGINX Exporter image name |
-| <a name="metrics.nginxExporter.image.tag">[metrics.nginxExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L854)</a> | string | `"1.3.0"` | NGINX Exporter image tag |
+| <a name="metrics.nginxExporter.image.tag">[metrics.nginxExporter.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L854)</a> | string | `"1.4.0"` | NGINX Exporter image tag |
 | <a name="metrics.nginxExporter.livenessProbe">[metrics.nginxExporter.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L887)</a> | [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-startup-probes/#configure-probes)] NGINX Exporter liveness probe |
 | <a name="metrics.nginxExporter.readinessProbe">[metrics.nginxExporter.readinessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L900)</a> | [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-startup-probes/#configure-probes)] NGINX Exporter readiness probe |
 | <a name="metrics.nginxExporter.resources">[metrics.nginxExporter.resources](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L877)</a> | [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 |
@@ -187,7 +187,7 @@ The `mariadb.*` values configure the upstream chart from Bitnami.  Please see th
 | <a name="nautobot.image.pullSecrets">[nautobot.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L48)</a> | []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 |
 | <a name="nautobot.image.registry">[nautobot.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L40)</a> | string | `"ghcr.io"` | Nautobot image registry, common to all deployments |
 | <a name="nautobot.image.repository">[nautobot.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L42)</a> | string | `"nautobot/nautobot"` | Nautobot image name, common to all deployments |
-| <a name="nautobot.image.tag">[nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L44)</a> | string | `"2.3.12-py3.11"` | Nautobot image tag, common to all deployments |
+| <a name="nautobot.image.tag">[nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L44)</a> | string | `"2.3.13-py3.11"` | Nautobot image tag, common to all deployments |
 | <a name="nautobot.initContainers">[nautobot.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L219)</a> | [][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 |
 | <a name="nautobot.lifecycleHooks">[nautobot.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L191)</a> | [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 |
 | <a name="nautobot.livenessProbe">[nautobot.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L60)</a> | [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-startup-probes/#configure-probes)] Nautobot liveness probe |

docs/release-notes/version-2.x.md

@@ -3,6 +3,18 @@
 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.4.2 - 2024-12-13
+
+## Added
+
+[#480](https://github.com/nautobot/helm-charts/pull/480) Add functionality for auto-deployments in configuration changes
+
+### Changed
+
+* Upgraded Nautobot from 2.3.12 to 2.3.13
+* Upgraded nginx-prometheus-exporter image from 1.3.0 to 1.4.0
+* Upgraded Bitnami common subchart from 2.27.2 to 2.28.0
+
 ## 2.4.1 - 2024-11-29
 
 ### Changed

docs/requirements.txt

@@ -1,3 +1,3 @@
 mkdocs==1.6.1
-mkdocs-material==9.5.46
+mkdocs-material==9.5.48
 mkdocs-version-annotations==1.0.0

pyproject.toml

@@ -11,7 +11,7 @@ invoke = "*"
 # Rendering docs to HTML
 mkdocs = "~1.6.0"
 # Material for MkDocs theme
-mkdocs-material = "9.5.46"
+mkdocs-material = "9.5.48"
 # Render custom markdown for version added/changed/remove notes
 mkdocs-version-annotations = "1.0.0"