Skip to content

Commit 546281e

Browse files
docs: move the operator guides out of docs/ to where readers find them
Five documents in docs/ were operator-facing guides written alongside the feature PRs that added the code, and left in the source tree where no user looks. They now live on the website (cozystack/website), so delete them here and repoint every reference. Moved to the website: docs/oidc-tenant.md -> kubernetes/oidc-authentication docs/oidc-grafana.md -> operations/services/monitoring/oidc-authentication docs/gpu-vgpu.md -> virtualization/vgpu + operations/troubleshooting/gpu-operator-host-driver docs/vm-external-vlan.md -> networking/vm-external-vlan docs/hubble-observability.md -> networking/hubble docs/vm-external-vlan.md needed splitting rather than moving. Its "Staging the reference CNI plugins" section is a contract: hack/cni-plugins-staging-contract.bats greps six literal sentences out of it and asserts them against the multus Dockerfile, the daemonset manifest and the platform values. That half is package documentation, so it moves verbatim into a new packages/system/multus/README.md and the suite reads it there; the operator guide goes to the website. The bats messages now name the README, so a future failure points at the file that has to change. References repointed to https://cozystack.io/docs/v1.6/... in nine hand-maintained files (two values.yaml @PARAM blocks, four template comments, three test comments). The seven generated files -- both values.schema.json, both README.md, the kubernetes Go types and both cozyrds -- come from `make generate` with cozyvalues-gen v1.6.0, the version pinned in .github/workflows/pre-commit.yml; each changed exactly one line. Two changelog links in v1.6.0.md repointed as well. The wording is untouched: only the location of the documents it names has changed. Two pieces of process framing dropped on the way past, per the convention added in docs/agents/overview.md: system.yaml said GrafanaAdmin promotion was "out of scope for Phase 1" (it is simply not implemented), and the chainsaw suite pointed at "docs/oidc-tenant.md -> Phase 1". Assisted-By: Claude <[email protected]> Signed-off-by: Myasnikov Daniil <[email protected]>
1 parent 516be4a commit 546281e

26 files changed

Lines changed: 69 additions & 1342 deletions

File tree

‎api/apps/v1alpha1/kubernetes/types.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/changelogs/v1.6.0.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Two symmetric Phase 1 features let a tenant opt an individual workload into the
184184

185185
**Grafana.** Each `Monitoring` CR gains the same `spec.oidc.mode` selector. `System` wires a per-instance confidential Keycloak client with audience binding; authorization is app-side, with `spec.oidc.users: [{email, role: Admin|Editor|Viewer}]` reconciled into Grafana's Main Org. by a chart-owned post-install/post-upgrade Job that pre-provisions users, adds them to the org, PATCHes their role and prunes stale members. `CustomConfig` accepts a tenant-supplied `[auth.generic_oauth]` payload, either inline as a map (the chart merges the two contract-critical settings on top) or as a Secret with an `auth.ini` key — in which case `spec.oidc.users` is unsupported and the chart fails the render on that combination rather than silently ignoring it. The `admin_user`/`admin_password` Secret remains a documented break-glass path in every mode ([**@IvanHunters**](https://github.com/IvanHunters) in #3176).
186186

187-
Both are documented in-repo at [`docs/oidc-tenant.md`](../oidc-tenant.md) and [`docs/oidc-grafana.md`](../oidc-grafana.md).
187+
Both are documented at [OIDC authentication for kubectl](https://cozystack.io/docs/v1.6/kubernetes/oidc-authentication/) and [OIDC authentication for Grafana](https://cozystack.io/docs/v1.6/operations/services/monitoring/oidc-authentication/).
188188

189189
### SecurityGroup: Tenant-Managed Network Policy
190190

@@ -580,7 +580,7 @@ A sweep of platform components that previously ran without resource requests or
580580

581581
* **[docs] Route bugs, features, and proposals to the right repository**: Issue templates and contribution docs now direct reporters to the correct Cozystack repository ([**@myasnikovdaniil**](https://github.com/myasnikovdaniil) in #2854).
582582

583-
* **[vm-instance] Document attaching a VM to an external VLAN**: New `docs/vm-external-vlan.md` covering the Linux-bridge and bridge-type `NetworkAttachmentDefinition` path ([**@lexfrei**](https://github.com/lexfrei) in #3196).
583+
* **[vm-instance] Document attaching a VM to an external VLAN**: New guide on [attaching a VM to an external VLAN](https://cozystack.io/docs/v1.6/networking/vm-external-vlan/), covering the Linux-bridge and bridge-type `NetworkAttachmentDefinition` path ([**@lexfrei**](https://github.com/lexfrei) in #3196).
584584

585585
* **[harbor] Fix the SeaweedFS discovery key described as an annotation**: It is the `namespace.cozystack.io/seaweedfs` namespace **label** ([**@lexfrei**](https://github.com/lexfrei) in #3293).
586586

‎docs/gpu-vgpu.md‎

Lines changed: 0 additions & 396 deletions
This file was deleted.

‎docs/hubble-observability.md‎

Lines changed: 0 additions & 99 deletions
This file was deleted.

0 commit comments

Comments
 (0)