dev-api-and-codegen

Adds or modifies Kubernetes Custom Resource Definition (CRD) Go types in api/, Kubebuilder validation markers, RBAC annotations, Kustomize bases, and Helm chart templates, values, and CRD schemas; regenerates manifests, ClusterRoles, and DeepCopy methods via make manifests and make generate; and audits pre-PR repository parity across config/, helm/, VERSION, and docs/examples/ YAMLs. Use when changing WorkloadMixing API struct fields, updating CRD validation or RBAC permissions, editing Helm/Kustomize packaging templates, or verifying zero codegen and manifest drift before a pull request. Don't use for implementing Go controller reconciliation logic (use dev-controller-and-translator), Slurm Lua scripts (use dev-slurm-lua), or running unit/E2E test suites (use test-unit-and-lint or test-e2e-cluster).

Jump to install Review files

Repository: GoogleCloudPlatform/k8s-bridge
Last source activity: November 3, 2026 at 10:55
Detected SKILL.md language: English
Stars: 17
Forks: 7

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with an AI assistant

Copy this prompt into the AI assistant you're using.

Follow https://skillsmp.com/skill-install/prompt.md to install only the Agent Skill at https://github.com/GoogleCloudPlatform/k8s-bridge/tree/main/skills/dev-api-and-codegen.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/GoogleCloudPlatform/k8s-bridge --skill dev-api-and-codegen

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer

2 files

SKILL.md

Source instructions · Read-only preview

name: dev-api-and-codegen
description: Adds or modifies Kubernetes Custom Resource Definition (CRD) Go types in api/, Kubebuilder validation markers, RBAC annotations, Kustomize bases, and Helm chart templates, values, and CRD schemas; regenerates manifests, ClusterRoles, and DeepCopy methods via make manifests and make generate; and audits pre-PR repository parity across config/, helm/, VERSION, and docs/examples/ YAMLs. Use when changing WorkloadMixing API struct fields, updating CRD validation or RBAC permissions, editing Helm/Kustomize packaging templates, or verifying zero codegen and manifest drift before a pull request. Don't use for implementing Go controller reconciliation logic (use dev-controller-and-translator), Slurm Lua scripts (use dev-slurm-lua), or running unit/E2E test suites (use test-unit-and-lint or test-e2e-cluster).

# API, Codegen, Packaging, and Parity Audit Workflow (`dev-api-and-codegen`) ## 1. Preconditions & Inputs Before modifying API schemas, RBAC markers, or chart templates, or running a pre-PR parity audit, read [references/parity-checklist.md](references/parity-checklist.md) for the source-to-derived parity matrix. --- ## 2. Guardrails - **Do not hand-edit generated files, and sync manually paired artifacts:** Treat all generated outputs in [references/parity-checklist.md](references/parity-checklist.md) (plus `PROJECT`) as read-only outputs of `make manifests generate` and `make version-sync`, and manually sync all non-generated paired files in that table. - **Preserve API identity, status subresource, and immutable Deployment selector labels:** Do not alter `WorkloadMixing` group/version (`k8s-bridge.x-k8s.io/v1alpha1`), `Namespaced` scope, or `+kubebuilder:subresource:status`, and never add `app.kubernetes.io/component` or `app.kubernetes.io/version` to `.spec.selector.matchLabels` in `helm/templates/deployment.yaml` or `config/manager/manager.yaml`. --- ## 3. Step-by-Step Procedure ### Step 1: Edit `WorkloadMixing` Go Types or Controller `+kubebuilder:rbac` Markers 1. **CRD Schema & Validation:** Edit struct fields and Kubebuilder markers in `api/v1alpha1/workloadmixing_types.go` (keep paired validation and defaults in `internal/controller/slurmjob/translator.go` in sync; see [references/parity-checklist.md](references/parity-checklist.md)). 2. **Controller RBAC Permissions:** If controller permissions changed, update the `+kubebuilder:rbac` annotations above `Reconcile` in `internal/controller/*/*_controller.go`. ### Step 2: Run Code and Manifest Generation Regenerate CRDs, RBAC roles, `helm/crds/`, and DeepCopy methods: ```bash make manifests generate ``` ### Step 3: Synchronize Paired Artifacts & Audit Pre-PR Repository Parity Walk through every modified row in [references/parity-checklist.md](references/parity-checklist.md) and synchronize all derived/paired artifacts. --- ## 4. Verification Verify that version sync, code generation, formatting, static analysis, Kustomize/Helm rendering, and unit/`envtest` suites succeed with zero uncommitted drift: ```bash make version-sync manifests generate fmt vet lint kustomize git diff --exit-code ./bin/kustomize build config/default > /dev/null && ./bin/kustomize build config/samples > /dev/null helm lint ./helm && helm template k8s-bridge ./helm --namespace k8s-bridge-system > /dev/null make test ``` --- ## 5. Handoffs & Related Skills - **To implement controller reconciliation or `JobSet` translation for new CRD fields:** Read [skills/dev-controller-and-translator/SKILL.md](../dev-controller-and-translator/SKILL.md). - **To write unit or `envtest` tests for new API fields:** Read [skills/test-unit-and-lint/SKILL.md](../test-unit-and-lint/SKILL.md). - **To run the full-cluster Kind or GKE GPU E2E suite before merging:** Read [skills/test-e2e-cluster/SKILL.md](../test-e2e-cluster/SKILL.md).

View on GitHub

Back to search Back to installation

dev-controller-and-translator

Implements or modifies Go operator reconciliation loops in internal/controller/, Slurm REST polling and event deduplication, JobSet translation, ClientMap and JWT token management, and Prometheus metric instruments. Use when changing how Slurm jobs are polled, translated into JobSets, unheld, preempted, or torn down in Go source code. Don't use for Slurm Lua submission plugins (use dev-slurm-lua), CRD schema or Helm template changes (use dev-api-and-codegen), deploying or upgrading the operator chart in a cluster (use infra-deploy-stack), or writing unit/E2E test suites (use test-unit-and-lint or test-e2e-cluster).

2026-11-03

dev-slurm-lua

Implements, modifies, and tests the Slurm Lua plugins (hack/job_submit.lua and hack/cli_filter.lua) that validate CLI options, place jobs on bridged partitions into auto-hold, and protect k8s-bridge job constraints. Use when adding allowed Slurm CLI flags, changing job submission or modification interception rules in Lua, or testing plugin behavior with non-root users. Don't use for Go controller or JobSet translator changes (use dev-controller-and-translator) or cluster partition mapping configuration (use infra-configure-crs).

2026-11-03

infra-configure-crs

Configures, applies, and removes all workload-mixing Custom Resources (CRs) and Slurm partitions for CPU, GPU, priority, and GKE CCC workloads: Kueue CRs (ResourceFlavor, ClusterQueue, LocalQueue, WorkloadPriorityClass), GKE ComputeClass CRs, Slinky slurm Helm release (slurm-values.yaml and Lua plugins), WorkloadMixing CRs, non-root user verification, and job submission checks. Use when deploying, updating, or removing Slurm partitions, Kueue queues, priority classes, or typed/untyped GPU mappedResources. Don't use for creating cloud clusters or node pools (use infra-provision-cluster), installing and tearing down the base operators (use infra-deploy-stack), or diagnosing stuck workloads and cleaning up wedged state (use ops-diagnose-workload or ops-cleanup-state).

2026-11-03

View all from this repository

dev-api-and-codegen

Source facts

Install options

Install with an AI assistant

Review the source files

More from this repository

Install with an AI assistant

More from this repository