feat(nautobot-target-proxy): package, build, and test updates

nicholaskuechler · nicholaskuechler · commit 93ef7a2d5c6c · 2026-05-04T08:49:24.000-05:00
diff --git a/.yamllint.yaml b/.yamllint.yaml
@@ -5,6 +5,7 @@ ignore:
   - charts/argocd-understack/templates/
   - charts/nautobot-api-tokens/templates/
   - charts/nautobot-job-queues/templates/
+  - charts/nautobot-target-proxy/templates/
   - charts/site-workflows/templates/
   - charts/undersync/templates/
 
diff --git a/charts/argocd-understack/templates/application-nautobot-target-proxy.yaml b/charts/argocd-understack/templates/application-nautobot-target-proxy.yaml
@@ -15,20 +15,20 @@ spec:
     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
+  - helm:
+      releaseName: nautobot-target-proxy
+      ignoreMissingValueFiles: true
+      valueFiles:
+      - $understack/components/nautobot-target-proxy/values.yaml
+      - $deploy/{{ include "understack.deploy_path" $ }}/nautobot-target-proxy/values.yaml
+    path: charts/nautobot-target-proxy
+    ref: understack
+    repoURL: {{ include "understack.understack_url" $ }}
+    targetRevision: {{ include "understack.understack_ref" $ }}
+  - path: {{ include "understack.deploy_path" $ }}/nautobot-target-proxy
+    ref: deploy
+    repoURL: {{ include "understack.deploy_url" $ }}
+    targetRevision: {{ include "understack.deploy_ref" $ }}
   syncPolicy:
     automated:
       prune: true
diff --git a/charts/argocd-understack/values.yaml b/charts/argocd-understack/values.yaml
@@ -507,7 +507,7 @@ site:
 
   # -- Nautobot target proxy service
   nautobot_target_proxy:
-    # -- Enable/disable deploying nautobot-target-proxy
+    # -- Enable/disable deploying the nautobot-target-proxy Helm chart
     # @default -- false
     enabled: false
 
diff --git a/charts/nautobot-target-proxy/README.md b/charts/nautobot-target-proxy/README.md
@@ -8,6 +8,7 @@ Helm chart that deploys the `nautobot_target_proxy` FastAPI service.
 - Exposes the app internally with a Kubernetes `Service`.
 - Starts the container with `uvicorn nautobot_target_proxy.app:app --host 0.0.0.0 --port 8000`.
 - Injects `NAUTOBOT_URL` directly from values.
+- Injects `NAUTOBOT_LOCATION` directly from values.
 - Injects `UNDERSTACK_PARTITION` from the shared `cluster-data` ConfigMap.
 - Injects `NAUTOBOT_TOKEN` from a referenced Kubernetes Secret.
 - Uses TCP liveness and readiness probes on port `8000`.
@@ -23,6 +24,7 @@ Helm chart that deploys the `nautobot_target_proxy` FastAPI service.
 ```yaml
 nautobot:
   url: https://nautobot.example.com
+  location: dev
   clusterDataConfigMapRef:
     name: cluster-data
     key: UNDERSTACK_PARTITION
@@ -45,6 +47,7 @@ service:
 
 nautobot:
   url: https://nautobot.example.com
+  location: dev
   clusterDataConfigMapRef:
     name: cluster-data
     key: UNDERSTACK_PARTITION
diff --git a/charts/nautobot-target-proxy/ci/example.yaml b/charts/nautobot-target-proxy/ci/example.yaml
@@ -5,6 +5,7 @@ image:
 
 nautobot:
   url: https://nautobot.example.com
+  location: dev
   clusterDataConfigMapRef:
     name: cluster-data
     key: UNDERSTACK_PARTITION
diff --git a/charts/nautobot-target-proxy/templates/deployment.yaml b/charts/nautobot-target-proxy/templates/deployment.yaml
@@ -47,6 +47,8 @@ spec:
           env:
             - name: NAUTOBOT_URL
               value: {{ required "values.nautobot.url is required" .Values.nautobot.url | quote }}
+            - name: NAUTOBOT_LOCATION
+              value: {{ required "values.nautobot.location is required" .Values.nautobot.location | quote }}
             - name: UNDERSTACK_PARTITION
               valueFrom:
                 configMapKeyRef:
diff --git a/charts/nautobot-target-proxy/values.schema.json b/charts/nautobot-target-proxy/values.schema.json
@@ -144,6 +144,12 @@
           "minLength": 1,
           "description": "Base URL for the Nautobot instance queried by the proxy."
         },
+        "location": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Nautobot location name used to filter returned devices.",
+          "default": "dev"
+        },
         "clusterDataConfigMapRef": {
           "type": "object",
           "additionalProperties": false,
@@ -187,6 +193,7 @@
       },
       "required": [
         "url",
+        "location",
         "clusterDataConfigMapRef",
         "tokenSecretRef"
       ]
diff --git a/charts/nautobot-target-proxy/values.yaml b/charts/nautobot-target-proxy/values.yaml
@@ -46,7 +46,10 @@ args:
 
 nautobot:
   # -- Base URL for the Nautobot instance queried by the proxy.
-  url: ""
+  url: "http://nautobot-default.nautobot.svc.cluster.local"
+
+  # -- Nautobot location name used to filter returned devices.
+  location: "dev"
 
   clusterDataConfigMapRef:
     # -- ConfigMap name containing the UNDERSTACK_PARTITION key.
@@ -56,9 +59,9 @@ nautobot:
 
   tokenSecretRef:
     # -- Secret name containing the Nautobot API token.
-    name: ""
+    name: nautobot-target-proxy-token
     # -- Secret key containing the Nautobot API token.
-    key: NAUTOBOT_TOKEN
+    key: apitoken
 
 resources: {}
 
diff --git a/components/nautobot-target-proxy/kustomization.yaml b/components/nautobot-target-proxy/kustomization.yaml
@@ -0,0 +1,3 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources: []
diff --git a/components/nautobot-target-proxy/values.yaml b/components/nautobot-target-proxy/values.yaml
diff --git a/containers/nautobot-target-proxy/Dockerfile b/containers/nautobot-target-proxy/Dockerfile
@@ -1,23 +1,24 @@
-FROM python:3.12.13-alpine AS builder
+FROM python:3.12.13-slim AS builder
+ENV UV_PYTHON_DOWNLOADS=never
+ENV UV_COMPILE_BYTECODE=1
+ENV PATH="/app/.venv/bin:$PATH"
 
-RUN pip install --upgrade poetry poetry-plugin-export
-
-COPY python/nautobot_target_proxy/pyproject.toml \
-  python/nautobot_target_proxy/poetry.lock \
-  /tmp/nautobot_target_proxy/
-
-RUN cd /tmp/nautobot_target_proxy && \
-  poetry export --only main -o /tmp/requirements.txt --without-hashes
-
-FROM python:3.12.13-alpine AS prod
-
-RUN pip3 install -U pip setuptools wheel
+WORKDIR /app
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
 
-COPY --from=builder /tmp/requirements.txt /tmp/requirements.txt
-RUN pip3 install -r /tmp/requirements.txt
+COPY python/nautobot_target_proxy/pyproject.toml /app/pyproject.toml
+COPY python/nautobot_target_proxy/uv.lock /app/uv.lock
+RUN --mount=type=cache,target=/root/.cache/uv \
+  uv sync --locked --no-dev --no-install-project
 
 COPY python/nautobot_target_proxy /app
-RUN pip3 install --no-deps /app
+RUN --mount=type=cache,target=/root/.cache/uv \
+  uv sync --locked --no-dev
+
+FROM python:3.12.13-slim AS prod
+ENV PATH="/app/.venv/bin:$PATH"
 
 WORKDIR /app
+COPY --from=builder /app /app
+
 EXPOSE 8000
diff --git a/docs/deploy-guide/components/index.md b/docs/deploy-guide/components/index.md
@@ -91,6 +91,8 @@ enablement defaults, validation, and troubleshooting notes.
 | [nautobot](./nautobot.md) | global |
 | [nautobot-api-tokens](./nautobot-api-tokens.md) | global |
 | [nautobot-job-queues](./nautobot-job-queues.md) | global |
+| [nautobot-target-proxy](./nautobot-target-proxy.md) | site |
+| [nautobot-worker](./nautobot-worker.md) | site |
 | [nautobotop](./nautobotop.md) | global |
 | [openebs](./openebs.md) | global, site |
 | [openstack](./openstack.md) | site |
diff --git a/docs/deploy-guide/components/nautobot-target-proxy.md b/docs/deploy-guide/components/nautobot-target-proxy.md
@@ -0,0 +1,53 @@
+---
+charts:
+- nautobot-target-proxy
+deploy_overrides:
+  helm:
+    mode: values
+  kustomize:
+    mode: second_source
+---
+
+# nautobot-target-proxy
+
+FastAPI proxy service that fronts Nautobot target lookups for site deployments.
+
+## Deployment Scope
+
+- Cluster scope: site
+- Values key: `site.nautobot_target_proxy`
+- ArgoCD Application template: `charts/argocd-understack/templates/application-nautobot-target-proxy.yaml`
+
+## How ArgoCD Builds It
+
+{{ component_argocd_builds() }}
+
+## How to Enable
+
+Enable this component under the scope that matches your deployment model:
+
+```yaml title="$CLUSTER_NAME/deploy.yaml"
+site:
+  nautobot_target_proxy:
+    enabled: true
+```
+
+## Deployment Repo Content
+
+{{ secrets_disclaimer }}
+
+Required or commonly required items:
+
+- `values.yaml`: Provide deployment-specific overrides such as the Nautobot base URL, image settings, and any scheduling or resource changes for this environment.
+- `nautobot-token` Secret: Provide the key referenced by `nautobot.tokenSecretRef` so the proxy can authenticate to the Nautobot API.
+- `cluster-data` ConfigMap: Provide the key referenced by `nautobot.clusterDataConfigMapRef` so the proxy receives `UNDERSTACK_PARTITION`.
+
+Optional additions:
+
+- `dockerconfigjson-github-com` Secret: Provide `.dockerconfigjson` if this deployment pulls the proxy image from a private registry and reference it through `imagePullSecrets`.
+- `Deployment override manifest`: Add patches or extra manifests in the component overlay directory if this site needs pod-level changes that are clearer to manage as Kubernetes resources instead of Helm values alone.
+
+## Notes
+
+- The chart deploys the proxy in the `nautobot` namespace and exposes it with a ClusterIP Service on port `8000` by default.
+- The ArgoCD template consumes both `$CLUSTER_NAME/nautobot-target-proxy/values.yaml` and the matching component directory as its second source, so you can keep simple configuration in values and reserve the overlay for Kubernetes-native additions.
diff --git a/docs/deploy-guide/deploy-repo.md b/docs/deploy-guide/deploy-repo.md
@@ -58,7 +58,7 @@ understackctl deploy update my-site
 This creates `<component>/` directories with `kustomization.yaml` and
 `values.yaml` files for each enabled component.
 
-### component directories
+### Component directories
 
 Inside of the `manifests` directory you'll have child directories named after
 each component (using hyphens, e.g., `cert-manager`, `argo-workflows`). These
@@ -130,7 +130,7 @@ disabled components.
     (e.g., `cert-manager`, `argo-workflows`). The `understackctl` tool
     handles this conversion automatically.
 
-### inventory directory
+### Inventory directory
 
 This directory contains an Ansible inventory file along with Ansible
 group_vars that are used as data by Ansible executions within the cluster
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -189,6 +189,8 @@ nav:
       - deploy-guide/components/monitoring.md
       - deploy-guide/components/nautobot-api-tokens.md
       - deploy-guide/components/nautobot-job-queues.md
+      - deploy-guide/components/nautobot-worker.md
+      - deploy-guide/components/nautobot-target-proxy.md
       - deploy-guide/components/nautobot.md
       - deploy-guide/components/nautobotop.md
       - deploy-guide/components/nautobot-worker.md
diff --git a/python/nautobot_target_proxy/nautobot_target_proxy/app.py b/python/nautobot_target_proxy/nautobot_target_proxy/app.py
@@ -3,15 +3,12 @@
 systems.
 """
 
-# Standard Library
 import os
 
-# Third Party
 from fastapi import FastAPI
 from fastapi import Request
 from fastapi.responses import JSONResponse
 
-# First Party
 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
@@ -40,13 +37,13 @@ def get_oob_targets() -> list[TargetResponse]:
     Obtains a list of targets to monitor from Nautobot, and returns them in a
     format that can be read by the Prometheus `http_sd_config` method.
     """
-    understack_partition = os.environ.get("UNDERSTACK_PARTITION")
-    if not understack_partition:
-        raise RuntimeError("UNDERSTACK_PARTITION is required")
+    nautobot_location = os.environ.get("NAUTOBOT_LOCATION")
+    if not nautobot_location:
+        raise RuntimeError("NAUTOBOT_LOCATION is required")
 
     response = query_nautobot_graphql(
         OOB_TARGET_QUERY,
-        {"understackPartition": [understack_partition]},
+        {"location": [nautobot_location]},
     ).json()
     res = []
     for interface in response["data"]["interfaces"]:
diff --git a/python/nautobot_target_proxy/nautobot_target_proxy/helpers/graphql.py b/python/nautobot_target_proxy/nautobot_target_proxy/helpers/graphql.py
@@ -1,7 +1,5 @@
-# Standard Library
 import os
 
-# Third Party
 import requests
 
 
@@ -22,10 +20,12 @@ def query_nautobot_graphql(query, variables=None):
         "Content-Type": "application/json",
         "Accept": "application/json",
     }
+    payload = {"query": query, "variables": variables or {}}
+
     res = requests.post(
         f"{nautobot_url}/api/graphql/",
         headers=headers,
-        json={"query": query, "variables": variables or {}},
+        json=payload,
     )
     res.raise_for_status()
     return res
diff --git a/python/nautobot_target_proxy/nautobot_target_proxy/helpers/queries.py b/python/nautobot_target_proxy/nautobot_target_proxy/helpers/queries.py
@@ -1,9 +1,9 @@
 OOB_TARGET_QUERY = """
-query OobTargetQuery($understackPartition: [String]) {
+query OobTargetQuery($location: [String]) {
   interfaces(
     mgmt_only: true,
     name: ["iDRAC", "iLO"],
-    device: {location: {name: $understackPartition}}
+    location: $location
   ) {
     device {
       name
diff --git a/python/nautobot_target_proxy/poetry.lock b/python/nautobot_target_proxy/poetry.lock
diff --git a/python/nautobot_target_proxy/pyproject.toml b/python/nautobot_target_proxy/pyproject.toml
diff --git a/python/nautobot_target_proxy/tests/test_app.py b/python/nautobot_target_proxy/tests/test_app.py
diff --git a/python/nautobot_target_proxy/uv.lock b/python/nautobot_target_proxy/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+apiVersion: kustomize.config.k8s.io/v1beta1`
	`2`	`+kind: Kustomization`
	`3`	`+resources: []`