feat(nautobot-target-proxy): Include nautobot-target-proxy chart in understack

Author: nicholaskuechler

charts/argocd-understack/templates/application-nautobot-target-proxy.yaml

@@ -0,0 +1,44 @@
+{{- if eq (include "understack.isEnabled" (list $.Values.site "nautobot_target_proxy")) "true" }}
+---
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+  name: {{ printf "%s-%s" $.Release.Name "nautobot-target-proxy" }}
+  finalizers:
+  - resources-finalizer.argocd.argoproj.io
+  annotations:
+    argocd.argoproj.io/compare-options: ServerSideDiff=true,IncludeMutationWebhook=true
+{{- include "understack.appLabelsBlock" $ | nindent 2 }}
+spec:
+  destination:
+    namespace: nautobot
+    server: {{ $.Values.cluster_server }}
+  project: understack
+  sources:
+    - ref: understack
+      path: charts/nautobot-target-proxy
+      repoURL: {{ include "understack.understack_url" $ }}
+      targetRevision: {{ include "understack.understack_ref" $ }}
+      helm:
+        releaseName: nautobot-target-proxy
+        valueFiles:
+          - $understack/charts/nautobot-target-proxy/values.yaml
+          - $deploy/{{ include "understack.deploy_path" $ }}/nautobot-target-proxy/values.yaml
+        ignoreMissingValueFiles: true
+    - ref: deploy
+      repoURL: {{ include "understack.deploy_url" $ }}
+      targetRevision: {{ include "understack.deploy_ref" $ }}
+      path: {{ include "understack.deploy_path" $ }}/nautobot-target-proxy
+  syncPolicy:
+    automated:
+      prune: true
+      selfHeal: true
+    managedNamespaceMetadata:
+      annotations:
+        argocd.argoproj.io/sync-options: Delete=false
+    syncOptions:
+    - CreateNamespace=true
+    - ServerSideApply=true
+    - RespectIgnoreDifferences=true
+    - ApplyOutOfSyncOnly=true
+{{- end }}

charts/argocd-understack/values.yaml

@@ -499,6 +499,12 @@ site:
     # @default -- false
     enabled: false
 
+  # -- Nautobot target proxy service
+  nautobot_target_proxy:
+    # -- Enable/disable deploying nautobot-target-proxy
+    # @default -- false
+    enabled: false
+
   # -- OpenEBS
   openebs:
     # -- Enable/disable deploying OpenEBS

charts/nautobot-target-proxy/README.md

@@ -6,7 +6,7 @@ Helm chart that deploys the `nautobot_target_proxy` FastAPI service.
 
 - Runs the proxy as a Kubernetes `Deployment`.
 - Exposes the app internally with a Kubernetes `Service`.
-- Starts the container with `uvicorn app:app --host 0.0.0.0 --port 8000`.
+- Starts the container with `uvicorn nautobot_target_proxy.app:app --host 0.0.0.0 --port 8000`.
 - Injects `NAUTOBOT_URL` directly from values.
 - Injects `UNDERSTACK_PARTITION` from the shared `cluster-data` ConfigMap.
 - Injects `NAUTOBOT_TOKEN` from a referenced Kubernetes Secret.

charts/nautobot-target-proxy/values.schema.json

@@ -128,7 +128,7 @@
         "type": "string"
       },
       "default": [
-        "app:app",
+        "nautobot_target_proxy.app:app",
         "--host",
         "0.0.0.0",
         "--port",

charts/nautobot-target-proxy/values.yaml

@@ -38,7 +38,7 @@ command:
   - uvicorn
 
 args:
-  - app:app
+  - nautobot_target_proxy.app:app
   - --host
   - 0.0.0.0
   - --port

containers/nautobot-target-proxy/Dockerfile

@@ -16,7 +16,8 @@ RUN pip3 install -U pip setuptools wheel
 COPY --from=builder /tmp/requirements.txt /tmp/requirements.txt
 RUN pip3 install -r /tmp/requirements.txt
 
-COPY python/nautobot_target_proxy/src /src
+COPY python/nautobot_target_proxy /app
+RUN pip3 install --no-deps /app
 
-WORKDIR /src
+WORKDIR /app
 EXPOSE 8000

python/nautobot_target_proxy/nautobot_target_proxy/__init__.py

@@ -0,0 +1,3 @@
+"""
+Installable package for the Nautobot target proxy service.
+"""

python/nautobot_target_proxy/src/app.py …arget_proxy/nautobot_target_proxy/app.pypython/nautobot_target_proxy/src/app.py renamed to python/nautobot_target_proxy/nautobot_target_proxy/app.py python/nautobot_target_proxy/src/app.py renamed to python/nautobot_target_proxy/nautobot_target_proxy/app.py

@@ -1,6 +1,6 @@
 """
 An API to obtain data from Nautobot, and format it for use in various external
-systems
+systems.
 """
 
 # Standard Library
@@ -12,9 +12,9 @@
 from fastapi.responses import JSONResponse
 
 # First Party
-from helpers.graphql import query_nautobot_graphql
-from helpers.queries import OOB_TARGET_QUERY
-from helpers.schemas import TargetResponse
+from nautobot_target_proxy.helpers.graphql import query_nautobot_graphql
+from nautobot_target_proxy.helpers.queries import OOB_TARGET_QUERY
+from nautobot_target_proxy.helpers.schemas import TargetResponse
 
 app = FastAPI()
 

python/nautobot_target_proxy/nautobot_target_proxy/helpers/__init__.py

@@ -0,0 +1,3 @@
+"""
+Helper utilities for the Nautobot target proxy service.
+"""