add annotations to deployments (#432)

* add annotations to deployments

* update readme and reference docs

charts/nautobot/templates/celery-deployment.yaml

@@ -12,8 +12,8 @@ metadata:
     {{- 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 }}
+  {{- if (or $celery.annotations $.Values.commonAnnotations) }}
+  annotations: {{- include "common.tplvalues.render" ( dict "value" (merge $celery.annotations $.Values.commonAnnotations) "context" $ ) | nindent 4 }}
   {{- end }}
 spec:
   {{- if not $celery.autoscaling.enabled }}

charts/nautobot/templates/nautobot-deployment.yaml

@@ -12,8 +12,8 @@ metadata:
     {{- 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 }}
+  {{- if (or $nautobot.annotations $.Values.commonAnnotations) }}
+  annotations: {{- include "common.tplvalues.render" ( dict "value" (merge $nautobot.annotations $.Values.commonAnnotations) "context" $ ) | nindent 4 }}
   {{- end }}
 spec:
   {{- if not $nautobot.autoscaling.enabled }}

charts/nautobot/values.schema.json

@@ -247,6 +247,19 @@
           "type": "string",
           "pattern": "^(soft|hard|)$"
         },
+        "annotations": {
+          "additionalProperties": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
+          "type": [
+            "object",
+            "null"
+          ]
+        },
         "podAnnotations": {
           "additionalProperties": {
             "type": [

charts/nautobot/values.yaml

@@ -136,6 +136,8 @@ nautobot:
   args: []
   # -- ([]HostAlias) [[ref](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/)] Nautobot pods host aliases
   hostAliases: []
+  # -- (map[string]string) [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations to be applied to Nautobot deployment resource
+  annotations: {}
   # -- (map[string]string) [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)] Extra labels for Nautobot pods
   podLabels: {}
   # -- (map[string]string) [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations for Nautobot pods
@@ -600,6 +602,8 @@ celery:
   args: []
   # -- ([]HostAlias) [[ref](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/)] Nautobot Celery Worker pods host aliases
   hostAliases: []
+  # -- (map[string]string) [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations to be applied to Nautobot Celery Worker deployment resource
+  annotations: {}
   # -- (map[string]string) [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)] Extra labels for Nautobot Celery Worker pods
   podLabels: {}
   # -- (map[string]string) [[ref](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)] Annotations for Nautobot Celery Worker pods