feat(nautobot-target-proxy): Mechanical move of nautobot-target-proxy in to understack repo

Author: nicholaskuechler

python/nautobot_target_proxy/Dockerfile

@@ -0,0 +1,19 @@
+FROM python:3.12.13-alpine AS builder
+RUN pip install --upgrade poetry poetry-plugin-export
+COPY pyproject.toml poetry.lock /
+RUN poetry export --only main -o /tmp/requirements.txt --without-hashes
+
+# App
+FROM python:3.12.13-alpine AS app
+
+RUN pip3 install -U pip setuptools wheel
+
+# Copy Python dependencies from the builder stage
+COPY --from=builder /tmp/requirements.txt /tmp/requirements.txt
+
+# Install Poetry dependencies
+RUN pip3 install -r /tmp/requirements.txt
+
+COPY src /src
+WORKDIR /src
+EXPOSE 8000

python/nautobot_target_proxy/README.md

@@ -0,0 +1 @@
+A FastAPI application to query Nautobots GraphQL API to scrape targets for use with Prometheus `http_sd_config`.

python/nautobot_target_proxy/poetry.lock

@@ -0,0 +1,50 @@
+[tool.poetry]
+name = "Nautobot API Scraper"
+description = "Simple API to scrape targets from Nautobot for use with other systems"
+version = "0.0.1"
+authors = ["Project Undercloud Developers"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+
+# App requirements
+requests = "2.32.5"
+fastapi = {version = "0.123.10", extras = ["standard"]}
+
+# test depends
+coverage = { version = "*", optional = true }
+
+[tool.poetry.extras]
+test = ["coverage"]
+
+[tool.ruff]
+line-length = 80
+target-version = "py312"
+fix = true
+
+[tool.ruff.lint]
+select = [
+  "E",       # pycodestyle (error)
+  "F",       # pyflakes
+  "B",       # flake8-bugbear
+  "I",       # isort
+  "UP",      # pyupgrade
+  "ASYNC",   # flake8-async
+  "ISC",     # flake8-implicit-str-concat
+  "PTH",     # flake8-use-pathlib
+  "RUF100",  # Unused noqa comments
+  "PGH004"   # blanket noqa comments
+]
+
+ignore = [
+  "ISC001",  # avoid formatter issues
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"

python/nautobot_target_proxy/pyproject.toml

@@ -0,0 +1,66 @@
+"""
+An API to obtain data from Nautobot, and format it for use in various external
+systems
+"""
+
+# Standard Library
+
+# Third Party
+from fastapi import FastAPI
+from fastapi import Request
+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
+
+app = FastAPI()
+
+
+@app.exception_handler(Exception)
+async def validation_exception_handler(request: Request, exc: Exception):
+    """
+    Generic catchall for exception handling
+    """
+    return JSONResponse(
+        status_code=500,
+        content={
+            "error": True,
+            "path": str(request.url),
+            "detail": f"Exception message is {exc!r}.",
+        },
+    )
+
+
+@app.get("/targets/oob")
+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.
+    """
+    response = query_nautobot_graphql(OOB_TARGET_QUERY).json()
+    res = []
+    for interface in response["data"]["interfaces"]:
+        for device in interface["ip_addresses"]:
+            urn = interface["device"].get("cpf_urn")
+            # Only return devices which contain a urn.
+            if not urn:
+                continue
+            device_name = interface["device"]["name"]
+            device_uuid = interface["device"]["id"]
+            location = interface["device"]["location"]["name"]
+            rack = interface["device"]["rack"]["name"]
+            res.append(
+                {
+                    "targets": [device["host"]],
+                    "labels": {
+                        "device_name": device_name,
+                        "uuid": device_uuid,
+                        "location": location,
+                        "rack": rack,
+                        "urn": urn,
+                    },
+                }
+            )
+    return res

python/nautobot_target_proxy/src/app.py

@@ -0,0 +1,24 @@
+# Standard Library
+import os
+
+# Third Party
+import requests
+
+
+def query_nautobot_graphql(query):
+    nautobot_token = os.environ.get("NAUTOBOT_TOKEN")
+    if not nautobot_token:
+        raise RuntimeError("A Nautobot Token is required")
+    nautobot_url = os.environ.get("NAUTOBOT_URL")
+    if not nautobot_url:
+        raise RuntimeError("A Nautobot URL is required")
+    headers = {
+        "Authorization": f"Token {nautobot_token}",
+        "Content-Type": "application/json",
+        "Accept": "application/json",
+    }
+    res = requests.post(
+        f"{nautobot_url}/api/graphql/", headers=headers, json={"query": query}
+    )
+    res.raise_for_status()
+    return res

python/nautobot_target_proxy/src/helpers/graphql.py

@@ -0,0 +1,20 @@
+OOB_TARGET_QUERY = """
+{
+  interfaces(mgmt_only: true, name: ["iDRAC", "iLO"]) {
+    device {
+      name
+      rack {
+        name
+      }
+      id
+      cpf_urn
+      location {
+        name
+      }
+    }
+    ip_addresses {
+      host
+    }
+  }
+}
+"""

python/nautobot_target_proxy/src/helpers/queries.py

@@ -0,0 +1,23 @@
+# Third Party
+from pydantic import BaseModel
+
+
+class TargetResponse(BaseModel):
+    labels: dict
+    targets: list
+
+    model_config = {
+        "json_schema_extra": {
+            "examples": [
+                [
+                    {
+                        "labels": {
+                            "location": "<datacenter>",
+                            "name": "<dns_name>",
+                        },
+                        "targets": ["<host>"],
+                    }
+                ]
+            ]
+        }
+    }