ccluster-py 0.0.1__tar.gz

ccluster_py-0.0.1/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: ccluster-py
+Version: 0.0.1
+Summary: Pydantic models for the ccluster.nvidia.com API and its Helm chart catalog
+License-Expression: Apache-2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Clustering
+Classifier: Typing :: Typed
+Requires-Dist: pydantic>=2.11
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/NVIDIA/ccluster
+Project-URL: Source, https://github.com/NVIDIA/ccluster/tree/main/python
+Project-URL: Changelog, https://github.com/NVIDIA/ccluster/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# ccluster (Python)
+
+Pydantic v2 models for the `ccluster.nvidia.com/v1alpha1` API and for the typed values of
+every chart in the catalog. The package is **generated**: nothing in `ccluster/v1alpha1/`
+or `ccluster/catalogs/cluster_base/` is written by hand.
+
+```bash
+uv add ccluster-py --path ../python   # or: pip install ./python; released: pip install ccluster-py
+```
+
+```python
+from ccluster import catalogs
+from ccluster.catalogs.cluster_base import gpu_operator, keda
+from ccluster.v1alpha1 import CCLComponentSet, CCLComponentSetSpec, ObjectMeta
+
+cs = CCLComponentSet(
+    metadata=ObjectMeta(name="local-base", namespace="ccluster-quickstart"),
+    spec=CCLComponentSetSpec(
+        components=[
+            catalogs.component("keda", "ccluster-local", keda.CHART, "keda"),
+            catalogs.component(
+                "gpu-operator", "ccluster-local", gpu_operator.CHART, "gpu-operator",
+                gpu_operator.Values(
+                    gpu_operator=gpu_operator.ChartValues(
+                        driver=gpu_operator.Toggle(enabled=False),
+                    ),
+                ),
+            ),
+        ]
+    ),
+)
+print(cs.model_dump(by_alias=True, exclude_none=True))   # kubectl apply -f this
+```
+
+Field names are snake_case with the wire name as the alias, so always dump with
+`by_alias=True, exclude_none=True`. `exclude_none` is what keeps an unset optional out of
+the values Helm sees while an explicit `False` stays in — the same distinction the Go
+catalog makes with pointer fields.
+
+## What is generated from what
+
+| Python | Source | Via |
+| --- | --- | --- |
+| `ccluster/v1alpha1/*.py` | `config/crd/bases/*.yaml` (the CRD `openAPIV3Schema`) | `hack/pyschema` → JSON Schema → datamodel-code-generator |
+| `ccluster/catalogs/cluster_base/<chart>/values.py` | `catalogs/cluster_base/<chart>/component.go` (`Values` and friends) | `hack/pyschema` (invopop/jsonschema reflection) → datamodel-code-generator |
+| every `__init__.py` under those two | the same | `hack/pyschema` |
+
+Three things are deliberately added on the way from the CRD: `apiVersion` and `kind` get
+defaults, `metadata` becomes a small `ObjectMeta` (name, namespace, labels, annotations)
+instead of an opaque dict, and a component's `values` is typed `dict[str, Any]` rather than
+"anything". Everything else, including every validation constraint and doc comment, is the
+CRD's.
+
+`ccluster/__init__.py`, `ccluster/catalogs/__init__.py` (`entry`, `component`) and `tests/`
+are hand-written.
+
+## Regenerating
+
+```bash
+make python-generate     # from the repository root; needs Go and uv
+make python-test
+```
+
+CI regenerates and fails on any diff, so edit the Go types or the CRD markers, regenerate,
+and commit the result. Adding a chart to `catalogs/` means adding it to the table in
+`hack/pyschema/main.go` too.

ccluster_py-0.0.1/README.md

@@ -0,0 +1,66 @@
+# ccluster (Python)
+
+Pydantic v2 models for the `ccluster.nvidia.com/v1alpha1` API and for the typed values of
+every chart in the catalog. The package is **generated**: nothing in `ccluster/v1alpha1/`
+or `ccluster/catalogs/cluster_base/` is written by hand.
+
+```bash
+uv add ccluster-py --path ../python   # or: pip install ./python; released: pip install ccluster-py
+```
+
+```python
+from ccluster import catalogs
+from ccluster.catalogs.cluster_base import gpu_operator, keda
+from ccluster.v1alpha1 import CCLComponentSet, CCLComponentSetSpec, ObjectMeta
+
+cs = CCLComponentSet(
+    metadata=ObjectMeta(name="local-base", namespace="ccluster-quickstart"),
+    spec=CCLComponentSetSpec(
+        components=[
+            catalogs.component("keda", "ccluster-local", keda.CHART, "keda"),
+            catalogs.component(
+                "gpu-operator", "ccluster-local", gpu_operator.CHART, "gpu-operator",
+                gpu_operator.Values(
+                    gpu_operator=gpu_operator.ChartValues(
+                        driver=gpu_operator.Toggle(enabled=False),
+                    ),
+                ),
+            ),
+        ]
+    ),
+)
+print(cs.model_dump(by_alias=True, exclude_none=True))   # kubectl apply -f this
+```
+
+Field names are snake_case with the wire name as the alias, so always dump with
+`by_alias=True, exclude_none=True`. `exclude_none` is what keeps an unset optional out of
+the values Helm sees while an explicit `False` stays in — the same distinction the Go
+catalog makes with pointer fields.
+
+## What is generated from what
+
+| Python | Source | Via |
+| --- | --- | --- |
+| `ccluster/v1alpha1/*.py` | `config/crd/bases/*.yaml` (the CRD `openAPIV3Schema`) | `hack/pyschema` → JSON Schema → datamodel-code-generator |
+| `ccluster/catalogs/cluster_base/<chart>/values.py` | `catalogs/cluster_base/<chart>/component.go` (`Values` and friends) | `hack/pyschema` (invopop/jsonschema reflection) → datamodel-code-generator |
+| every `__init__.py` under those two | the same | `hack/pyschema` |
+
+Three things are deliberately added on the way from the CRD: `apiVersion` and `kind` get
+defaults, `metadata` becomes a small `ObjectMeta` (name, namespace, labels, annotations)
+instead of an opaque dict, and a component's `values` is typed `dict[str, Any]` rather than
+"anything". Everything else, including every validation constraint and doc comment, is the
+CRD's.
+
+`ccluster/__init__.py`, `ccluster/catalogs/__init__.py` (`entry`, `component`) and `tests/`
+are hand-written.
+
+## Regenerating
+
+```bash
+make python-generate     # from the repository root; needs Go and uv
+make python-test
+```
+
+CI regenerates and fails on any diff, so edit the Go types or the CRD markers, regenerate,
+and commit the result. Adding a chart to `catalogs/` means adding it to the table in
+`hack/pyschema/main.go` too.

ccluster_py-0.0.1/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["uv_build>=0.11,<0.12"]
+build-backend = "uv_build"
+
+[project]
+name = "ccluster-py"
+version = "0.0.1"
+description = "Pydantic models for the ccluster.nvidia.com API and its Helm chart catalog"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = ["pydantic>=2.11"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: System :: Clustering",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/NVIDIA/ccluster"
+Source = "https://github.com/NVIDIA/ccluster/tree/main/python"
+Changelog = "https://github.com/NVIDIA/ccluster/blob/main/CHANGELOG.md"
+
+[tool.uv.build-backend]
+module-name = "ccluster"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "pyyaml>=6",
+]

ccluster_py-0.0.1/pyproject.toml.orig

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["uv_build>=0.11,<0.12"]
+build-backend = "uv_build"
+
+[project]
+# Distribution name only: `ccluster` was already taken on PyPI. The import name is still
+# `ccluster` (src/ccluster).
+name = "ccluster-py"
+# Placeholder: the release version is the git tag, stamped in by `make python-build`.
+version = "0.0.1"
+description = "Pydantic models for the ccluster.nvidia.com API and its Helm chart catalog"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = [
+    "pydantic>=2.11",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: System :: Clustering",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/NVIDIA/ccluster"
+Source = "https://github.com/NVIDIA/ccluster/tree/main/python"
+Changelog = "https://github.com/NVIDIA/ccluster/blob/main/CHANGELOG.md"
+
+# uv_build derives the module name from the distribution name (ccluster_py); point it at the
+# real package instead.
+[tool.uv.build-backend]
+module-name = "ccluster"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "pyyaml>=6",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

ccluster_py-0.0.1/src/ccluster/__init__.py

@@ -0,0 +1,19 @@
+# Copyright 2026 NVIDIA CORPORATION & AFFILIATES.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Pydantic models for the ccluster.nvidia.com API and the catalog's chart values.
+
+Everything under ccluster.v1alpha1 and ccluster.catalogs.cluster_base is generated by
+`make python-generate` from the CRDs and the catalog's Go packages; see python/README.md.
+"""

ccluster_py-0.0.1/src/ccluster/catalogs/__init__.py

@@ -0,0 +1,65 @@
+# Copyright 2026 NVIDIA CORPORATION & AFFILIATES.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""The Helm chart catalog, as typed values.
+
+Each chart under ccluster.catalogs.cluster_base has a Values model and a CHART path,
+generated from the Go package beside the chart. entry() turns one of those into the
+ComponentEntry fields of a CCLComponentSet component, as catalogs.Entry does in Go.
+"""
+
+from typing import Any
+
+from pydantic import BaseModel
+
+from ccluster.v1alpha1 import ComponentSpec, LocalObjectReference
+
+__all__ = ["component", "entry"]
+
+
+def entry(chart: str, namespace: str, values: BaseModel | None) -> dict[str, Any]:
+    """Return the chart, namespace and values fields of a component.
+
+    values is dumped by alias with None fields left out, which is the shape Helm
+    expects and the shape the Go catalog produces. An empty result is dropped rather
+    than stored: the operator omits the Application's helm block when values is unset,
+    and an empty object would defeat that. The required values of a chart (only
+    teleport-kube-agent has any) are checked when its Values is constructed.
+    """
+    out: dict[str, Any] = {"chart": chart, "namespace": namespace}
+    if values is not None:
+        dumped = values.model_dump(by_alias=True, exclude_none=True)
+        if dumped:
+            out["values"] = dumped
+    return out
+
+
+def component(
+    name: str,
+    infra_plane: str,
+    chart: str,
+    namespace: str,
+    values: BaseModel | None = None,
+) -> ComponentSpec:
+    """Build one CCLComponentSet component from a chart's typed values.
+
+    chart is the module's CHART constant. The component's name and the infra plane it
+    is deployed to are the caller's, as is the namespace it installs into: none of
+    those are facts about the chart.
+    """
+    return ComponentSpec(
+        name=name,
+        infra_plane_ref=LocalObjectReference(name=infra_plane),
+        **entry(chart, namespace, values),
+    )

ccluster_py-0.0.1/src/ccluster/catalogs/cluster_base/__init__.py

@@ -0,0 +1,41 @@
+# Copyright 2026 NVIDIA CORPORATION & AFFILIATES.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Code generated by `make python-generate`. DO NOT EDIT.
+
+"""The cluster_base catalog: one subpackage per chart, each with a Values
+model and its CHART path."""
+
+from . import argo_rollouts, cert_manager, external_dns, final_stack, fluent_bit, gpu_operator, ingress_nginx, istio, keda, kube_prometheus_stack, longhorn, metrics_server, network_operator, opentelemetry_collector, prometheus_adapter, spire, spire_crds, teleport_kube_agent
+
+__all__ = [
+    "argo_rollouts",
+    "cert_manager",
+    "external_dns",
+    "final_stack",
+    "fluent_bit",
+    "gpu_operator",
+    "ingress_nginx",
+    "istio",
+    "keda",
+    "kube_prometheus_stack",
+    "longhorn",
+    "metrics_server",
+    "network_operator",
+    "opentelemetry_collector",
+    "prometheus_adapter",
+    "spire",
+    "spire_crds",
+    "teleport_kube_agent",
+]

ccluster_py-0.0.1/src/ccluster/catalogs/cluster_base/argo_rollouts/__init__.py

@@ -0,0 +1,37 @@
+# Copyright 2026 NVIDIA CORPORATION & AFFILIATES.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Code generated by `make python-generate`. DO NOT EDIT.
+
+"""Values of the catalogs/cluster_base/argo_rollouts chart, generated from its Go package."""
+
+from typing import Final
+
+from .values import (
+    ChartValues,
+    Controller,
+    Dashboard,
+    Values,
+)
+
+__all__ = [
+    "CHART",
+    "ChartValues",
+    "Controller",
+    "Dashboard",
+    "Values",
+]
+
+# CHART is the chart's directory, relative to the root of the catalog repository.
+CHART: Final = "catalogs/cluster_base/argo_rollouts"

ccluster_py-0.0.1/src/ccluster/catalogs/cluster_base/argo_rollouts/values.py

@@ -0,0 +1,79 @@
+# Copyright 2026 NVIDIA CORPORATION & AFFILIATES.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Code generated by `make python-generate`. DO NOT EDIT.
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class Controller(BaseModel):
+    """
+    Controller configures the rollouts controller.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    replicas: int | None = None
+    """
+    Replicas is the controller replica count. The chart ships 2.
+    """
+
+
+class Dashboard(BaseModel):
+    """
+    Dashboard configures the rollouts dashboard.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    enabled: bool | None = None
+    """
+    Enabled turns the dashboard on. The chart ships it off.
+    """
+
+
+class ChartValues(BaseModel):
+    """
+    ChartValues are the upstream argo-rollouts values worth setting per cluster.
+    Anything not set here comes from catalogs/cluster_base/argo_rollouts/values.yaml.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    controller: Controller | None = None
+    dashboard: Dashboard | None = None
+
+
+class Values(BaseModel):
+    """
+    Values is the top-level values document for catalogs/cluster_base/argo_rollouts.
+    Its single key is the upstream chart's alias, because this chart wraps it as a
+    dependency — which is the only reason the nesting exists.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    argo_rollouts: Annotated[ChartValues | None, Field(alias="argo-rollouts")] = None

ccluster_py-0.0.1/src/ccluster/catalogs/cluster_base/cert_manager/__init__.py

@@ -0,0 +1,37 @@
+# Copyright 2026 NVIDIA CORPORATION & AFFILIATES.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Code generated by `make python-generate`. DO NOT EDIT.
+
+"""Values of the catalogs/cluster_base/cert_manager chart, generated from its Go package."""
+
+from typing import Final
+
+from .values import (
+    ChartValues,
+    PrometheusValues,
+    Toggle,
+    Values,
+)
+
+__all__ = [
+    "CHART",
+    "ChartValues",
+    "PrometheusValues",
+    "Toggle",
+    "Values",
+]
+
+# CHART is the chart's directory, relative to the root of the catalog repository.
+CHART: Final = "catalogs/cluster_base/cert_manager"

ccluster_py-0.0.1/src/ccluster/catalogs/cluster_base/cert_manager/values.py

@@ -0,0 +1,85 @@
+# Copyright 2026 NVIDIA CORPORATION & AFFILIATES.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Code generated by `make python-generate`. DO NOT EDIT.
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class Toggle(BaseModel):
+    """
+    Toggle is a subchart's enable flag.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    enabled: bool | None = None
+    """
+    Enabled turns the feature on.
+    """
+
+
+class PrometheusValues(BaseModel):
+    """
+    PrometheusValues configures cert-manager's metrics scraping.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    enabled: bool | None = None
+    servicemonitor: Toggle | None = None
+    """
+    ServiceMonitor is spelled lower-case in this chart, unlike every other
+    chart in the catalog.
+    """
+
+
+class ChartValues(BaseModel):
+    """
+    ChartValues are the upstream cert-manager values worth setting per cluster.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    replica_count: Annotated[int | None, Field(alias="replicaCount")] = None
+    """
+    ReplicaCount is the controller replica count. The chart ships 2.
+    """
+    prometheus: PrometheusValues | None = None
+    """
+    Prometheus scraping is shipped off, because the ServiceMonitor CRD only
+    exists once kube-prometheus-stack is deployed. Enable it after that.
+    """
+
+
+class Values(BaseModel):
+    """
+    Values is the top-level values document for catalogs/cluster_base/cert_manager.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    cert_manager: Annotated[ChartValues | None, Field(alias="cert-manager")] = None

ccluster_py-0.0.1/src/ccluster/catalogs/cluster_base/external_dns/__init__.py

@@ -0,0 +1,39 @@
+# Copyright 2026 NVIDIA CORPORATION & AFFILIATES.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Code generated by `make python-generate`. DO NOT EDIT.
+
+"""Values of the catalogs/cluster_base/external_dns chart, generated from its Go package."""
+
+from typing import Final
+
+from .values import (
+    ChartValues,
+    Provider,
+    ServiceAccount,
+    Toggle,
+    Values,
+)
+
+__all__ = [
+    "CHART",
+    "ChartValues",
+    "Provider",
+    "ServiceAccount",
+    "Toggle",
+    "Values",
+]
+
+# CHART is the chart's directory, relative to the root of the catalog repository.
+CHART: Final = "catalogs/cluster_base/external_dns"