add persistentVolume for static volumes

charts/nautobot/templates/job.yaml

@@ -109,7 +109,12 @@ spec:
             {{- end }}
       volumes:
         - name: "nautobot-static"
+        {{- if $.Values.nautobot.persistenceStaticFiles.enabled }}
+          persistentVolumeClaim:
+            claimName: {{ include "common.names.fullname" $ }}-static
+        {{- else }}
           emptyDir: {}
+        {{- end }}
         - name: "git-repos"
           emptyDir: {}
         - name: "nautobot-config"

charts/nautobot/templates/nautobot-deployment.yaml

@@ -350,7 +350,12 @@ spec:
       terminationGracePeriodSeconds: {{ $nautobot.terminationGracePeriodSeconds }}
       volumes:
         - name: "nautobot-static"
+        {{- if $nautobot.persistenceStaticFiles.enabled }}
+          persistentVolumeClaim:
+            claimName: {{ include "common.names.fullname" $ }}-static
+        {{- else }}
           emptyDir: {}
+        {{- end }}
         - name: "git-repos"
           emptyDir: {}
         - name: "nautobot-config"

charts/nautobot/templates/pvc-static.yaml

@@ -0,0 +1,35 @@
+{{- if .Values.nautobot.enabled -}}
+{{- if .Values.nautobot.persistenceStaticFiles.enabled -}}
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ include "common.names.fullname" $ }}-static
+  namespace: {{ .Release.Namespace | quote }}
+  labels: {{- include "common.labels.standard" $ | nindent 4 }}
+    app.kubernetes.io/component: nautobot-static-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.persistenceStaticFiles.storageClassName }}
+  {{- if (eq "-" .Values.nautobot.persistenceStaticFiles.storageClassName) }}
+  storageClassName: ""
+  {{- else }}
+  storageClassName: {{ .Values.nautobot.persistenceStaticFiles.storageClassName | quote }}
+  {{- end }}
+  {{- end }}
+  accessModes:
+  - {{ .Values.nautobot.persistenceStaticFiles.accessMode | quote }}
+  resources:
+    requests:
+      storage: {{ .Values.nautobot.persistenceStaticFiles.size | quote }}
+  {{- with .Values.nautobot.persistenceStaticFiles.selector }}
+  selector:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{ end -}}
+{{ end -}}

charts/nautobot/values.schema.json

@@ -70,6 +70,35 @@
             }
           }
         },
+        "persistenceStaticFiles": {
+          "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": {

charts/nautobot/values.yaml

@@ -1,7 +1,6 @@
 ---
 # -- (map[string]string) Annotations to be applied to ALL resources created by this chart
 commonAnnotations: {}
-
 # Nautobot UI front end service
 service:
   # -- (`ExternalName`, `ClusterIP`, `NodePort`, or `LoadBalancer`) [[ref](https://kubernetes.io/docs/concepts/services-networking/service/)] Kubernetes service type, valid values: `ExternalName`, `ClusterIP`, `NodePort`, or `LoadBalancer`
@@ -236,6 +235,23 @@ nautobot:
             value: 2
             periodSeconds: 15
 
+  # Add a Persistent Volume Claim for Nautobot static files
+  persistenceStaticFiles:
+    # --- 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: static
+
   # Nautobot NGINX configuration
   nginx:
     # -- Enable an nginx sidecar to proxy Nautobot traffic (can be useful for large deployments)

contrib/minikube.yaml

@@ -26,6 +26,7 @@ nautobot:
   resources:
     requests: null
     limits: null
+
   nginx:
     enabled: false
     resources:

docs/advanced-features/index.md

@@ -14,6 +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/)
 * [PostgreSQL High Availability](postgresql-ha/)
 * [PostgreSQL TLS](postgresql-tls/)
 * [Prometheus Operator Metrics](prometheus-metrics/)

docs/advanced-features/persistence.md

@@ -0,0 +1,29 @@
+# Persistence for Static 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.
+
+```yaml
+nautobot:
+  persistence:
+    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.
+
+```yaml
+nautobot:
+  persistence:
+    enabled: true
+    storageClass: "your-storage-class"
+    size: "1Gi"
+    selector:
+      matchLabel:
+        nautobot-storage: static
+
+  # Selector for the Pods of the deployment.
+  nodeSelector:
+    nautobot-storage: static
+```