Merge pull request #11 from lilatomic/feature/crd-visualiser

Add a visualiser for Kubernetes CRDs

Author: lilatomic

.github/workflows/pants.yml

@@ -20,6 +20,10 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: "3.10"
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
       - name: Setup Python
         uses: actions/setup-python@v4
         with:

alpacloud/argocdkit/Dockerfile

@@ -27,5 +27,3 @@ FROM	python:3.13-slim
 COPY	--from=helm-installer /helm /usr/local/bin/helm
 COPY	alpacloud.argocdkit/__main__.pex /bin/alpacloud-argocdkit
 RUN	/bin/alpacloud-argocdkit gen-cfg
-
-COPY	alpacloud.argocdkit.test_resources/my_postrenderer.pex /bin/my_postrenderer

alpacloud/argocdkit/test_resources/BUILD

@@ -10,3 +10,9 @@ files(
 	name="k8s_objs",
 	sources=["**/*.yml", "**/*.yaml", "**/*.tpl", "**/*.json"],
 )
+
+docker_image(
+	name="docker",
+	repository="cmp",
+	image_tags=["latesttest"],
+)

alpacloud/argocdkit/test_resources/Dockerfile

@@ -0,0 +1,3 @@
+FROM ghcr.io/lilatomic/alpacloud/cmp:0.0.1
+
+COPY	alpacloud.argocdkit.test_resources/my_postrenderer.pex /bin/my_postrenderer

alpacloud/argocdkit/test_resources/integration/argocd-repo-server-deployment-patch.yaml

@@ -9,7 +9,7 @@ spec:
         - name: my-cmp
           command: [/var/run/argocd/argocd-cmp-server]
           args: [--loglevel, debug]
-          image: cmp:0.0.1
+          image: cmp:latesttest
           securityContext:
             runAsNonRoot: true
             runAsUser: 999

alpacloud/argocdkit/test_resources/integration/my-values.yaml

@@ -0,0 +1 @@
+replicaCount: 3

alpacloud/argocdkit/test_resources/integration/test-app.yaml

@@ -0,0 +1,27 @@
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+  name: guestbook
+  namespace: argocd
+spec:
+  destination:
+    namespace: aa-tgt
+    server: https://kubernetes.default.svc
+  project: default
+  sources:
+    - path: helm-guestbook
+      plugin:
+        env:
+          - name: foo
+            value: bar
+        name: helm-and-python-0.0.1
+        valueFiles:
+          - $values/alpacloud/argocdkit/test_resources/integration/my-values.yaml
+        parameters:
+          - array:
+              - /bin/my_postrenderer
+            name: postRenderers
+      repoURL: https://github.com/argoproj/argocd-example-apps.git
+    - repoURL: https://github.com/lilatomic/alpacloud.git
+      targetRevision: prod
+      ref: values

alpacloud/crdvis/BUILD

@@ -0,0 +1,31 @@
+python_sources()
+
+python_tests(
+	name="tests",
+	dependencies=["./test_resources:k8s_objs", "//:reqs1#pytest-asyncio"],
+)
+
+python_distribution(
+	name="alpacloud.crdvis",
+	repositories=["@alpacloud.crdvis"],
+	dependencies=[":crdvis"],
+	long_description_path="alpacloud/crdvis/readme.md",
+	provides=python_artifact(
+		name="alpacloud.crdvis",
+		version="0.1.0",
+		description="A visualiser for Kubernetes CRDs",
+		author="Daniel Goldman",
+		entry_points={"console_scripts": ["crdvis=alpacloud.crdvis:run_crdvis"]},
+		classifiers=[
+			"Development Status :: 3 - Alpha",
+			"Programming Language :: Python :: 3.10",
+			"Programming Language :: Python :: 3.11",
+			"Programming Language :: Python :: 3.12",
+			"Programming Language :: Python :: 3.13",
+			"Topic :: Utilities",
+			"Topic :: System :: Systems Administration",
+		],
+		license="Round Robin 2.0.0",
+		long_description_content_type="text/markdown",
+	),
+)

alpacloud/crdvis/__init__.py

@@ -0,0 +1,10 @@
+"""
+CRDVis package provides visualization tools for Kubernetes CRD resources.
+"""
+
+__version__ = "0.1.0"
+
+from . import models, vis
+from .vis import main as run_crdvis
+
+__all__ = ["models", "vis", "run_crdvis"]

alpacloud/crdvis/crd.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+import os
+import shutil
+import subprocess
+from urllib.parse import urlparse
+
+import requests
+import yaml
+
+from alpacloud.crdvis.models import CustomResourceDefinition
+
+
+class CRDReadError(Exception):
+	"""Exception raised when there is an error reading a CRD."""
+
+	pass
+
+
+def read_path(path: str) -> CustomResourceDefinition:
+	"""
+	Read a path-like object to fetch a CRD.
+
+	Raises:
+		CRDReadError: If there is an error reading the CRD.
+	"""
+	if path.startswith("http://") or path.startswith("https://"):
+		req = requests.Request("GET", path)
+
+		url = urlparse(req.url)
+		if url.netloc == "github.com":
+			req.params["raw"] = "true"
+
+		response = requests.Session().send(req.prepare(), timeout=30)
+
+		if not response.ok:
+			raise CRDReadError(f"Failed to fetch CRD from {path}: {response.status_code}")
+		content = response.text
+	elif path.startswith("file://") or os.path.exists(path):
+		disk_path = path.rsplit("://", 1)[-1]
+		if not os.path.exists(disk_path):
+			raise CRDReadError(f"File not found: {disk_path}")
+
+		with open(disk_path, "r", encoding="utf-8") as f:
+			content = f.read()
+
+	elif path.startswith("kubectl://"):
+		kubectl_crd = path.rsplit("://", 1)[-1]
+		kubectl_exe = shutil.which("kubectl")
+		if not kubectl_exe:
+			raise CRDReadError("kubectl is not installed.")
+
+		try:
+			content = subprocess.check_output([kubectl_exe, "get", "-o", "yaml", "crd", kubectl_crd], timeout=30).decode("utf-8")
+		except subprocess.SubprocessError as e:
+			try:
+				crds = subprocess.check_output([kubectl_exe, "get", "crd"], timeout=30)
+				if crds:
+					error_msg = f"crd is not available in cluster {kubectl_crd}"
+				else:
+					error_msg = f"Failed to fetch CRDs {kubectl_crd}: {e}"
+
+			except subprocess.SubprocessError as e:
+				error_msg = f"Failed to fetch CRDs {kubectl_crd}: {e}"
+			raise CRDReadError(error_msg)
+	else:
+		content = path
+
+	if not content:
+		raise CRDReadError("Empty content")
+	doc = yaml.safe_load(content)
+	return CustomResourceDefinition.model_validate(doc)