Commit ff34379
authored
docs: prefix bundle package names with cozystack. in v1 examples (#482)
## What
Prefix every bundle package name in the v1 docs with `cozystack.` so
they match the real names `kubectl get package` returns, and add a short
note in the Components reference pointing at that command as the source
of truth.
Files touched:
- `content/en/docs/v1/operations/configuration/components.md` — fix the
Hetzner RobotLB swap example (`metallb` → `cozystack.metallb`,
`hetzner-robotlb` → `cozystack.hetzner-robotlb`) and extend the
surrounding prose with a one-paragraph explanation of the prefix
convention plus the `kubectl get package` pointer.
- `content/en/docs/v1/install/providers/hetzner.md` — fix the same
example in the Hetzner install guide.
- `content/en/docs/v1/storage/nfs.md` — `nfs-driver` →
`cozystack.nfs-driver` in the enable-NFS-driver `kubectl patch` example.
- `content/en/docs/v1/virtualization/gpu.md` — `gpu-operator` →
`cozystack.gpu-operator` in the enable-GPU-operator `kubectl patch`
example.
## Why
Multiple users have hit this in the community chat: they follow one of
the examples (most recently the Hetzner RobotLB swap), paste
`disabledPackages: [metallb]` into their Platform Package, and the entry
does nothing because no package named `metallb` exists — the real name
is `cozystack.metallb`. From a [recent
thread](https://t.me/cozystack_ru):
> в перечне Helm Releases или пакетов package.cozystack.io числится
cozystack.metallb, как будто бы игнорируется блок […]
> там название аналогично меняется, cozystack.hetzner-robotlb т.е.
добавляется префикс "cozystack." Это для всех пакетов теперь так
The `cozystack.` prefix is a deliberate design choice in v1.x — every
package the platform chart renders is `cozystack.<name>`, as enforced in
`packages/core/platform/templates/bundles/*.yaml` upstream. The docs
never caught up after the convention changed. This PR fixes the four
places where short names still appear.
## Verification
- `grep -rn 'enabledPackages\|disabledPackages' content/en/docs/v1/`
after the change shows only properly-prefixed names in examples (the
only remaining bare mentions are in prose, not in YAML).
- Every substitution was cross-checked against upstream
`packages/core/platform/templates/bundles/system.yaml` and `iaas.yaml`:
- `cozystack.metallb`, `cozystack.hetzner-robotlb` —
`bundles/system.yaml:156`
- `cozystack.nfs-driver` — `bundles/system.yaml:146`
- `cozystack.gpu-operator` — `bundles/iaas.yaml:11`
- `hugo` builds cleanly; all four touched pages render with the prefixed
names.
- The PR does not touch the `bundles.enabledPackages` /
`disabledPackages` field names themselves or the Platform Package YAML
path — only the package-name strings inside the list values.4 files changed
Lines changed: 14 additions & 8 deletions
File tree
- content/en/docs/v1
- install/providers
- operations/configuration
- storage
- virtualization
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
344 | 344 | | |
345 | 345 | | |
346 | 346 | | |
347 | | - | |
| 347 | + | |
348 | 348 | | |
349 | | - | |
| 349 | + | |
350 | 350 | | |
351 | 351 | | |
352 | 352 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
44 | 50 | | |
45 | | - | |
| 51 | + | |
46 | 52 | | |
47 | 53 | | |
48 | 54 | | |
| |||
56 | 62 | | |
57 | 63 | | |
58 | 64 | | |
59 | | - | |
| 65 | + | |
60 | 66 | | |
61 | | - | |
| 67 | + | |
62 | 68 | | |
63 | 69 | | |
64 | 70 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| |||
0 commit comments