Skip to content

Commit ff34379

Browse files
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.
2 parents be69d4a + 2602034 commit ff34379

4 files changed

Lines changed: 14 additions & 8 deletions

File tree

content/en/docs/v1/install/providers/hetzner.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,9 +344,9 @@ The final stage of deploying a Cozystack cluster on Hetzner is to install Cozyst
344344
values:
345345
bundles:
346346
disabledPackages:
347-
- metallb
347+
- cozystack.metallb
348348
enabledPackages:
349-
- hetzner-robotlb
349+
- cozystack.hetzner-robotlb
350350
publishing:
351351
host: "example.org"
352352
apiServerEndpoint: "https://api.example.org:443"

content/en/docs/v1/operations/configuration/components.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,14 @@ Bundles have optional components that need to be explicitly enabled (included) i
4141
Regular bundle components can, on the other hand, be disabled (excluded) from the installation, when you don't need them.
4242
4343
Use `bundles.enabledPackages` and `bundles.disabledPackages` in the Platform Package values.
44+
Every entry in those lists is a fully-qualified Package name — the same name you see with
45+
`kubectl get package`. All platform packages live under the `cozystack.` prefix (for example,
46+
`cozystack.metallb`, `cozystack.hetzner-robotlb`, `cozystack.nfs-driver`). Run
47+
`kubectl get package` to see the exact names available on your cluster before editing
48+
the Platform Package.
49+
4450
For example, [installing Cozystack in Hetzner]({{% ref "/docs/v1/install/providers/hetzner" %}})
45-
requires swapping default load balancer, MetalLB, with one made specifically for Hetzner, called RobotLB:
51+
requires swapping the default load balancer, MetalLB, with one made specifically for Hetzner, called RobotLB:
4652

4753
```yaml
4854
apiVersion: cozystack.io/v1alpha1
@@ -56,9 +62,9 @@ spec:
5662
values:
5763
bundles:
5864
disabledPackages:
59-
- metallb
65+
- cozystack.metallb
6066
enabledPackages:
61-
- hetzner-robotlb
67+
- cozystack.hetzner-robotlb
6268
# rest of the config
6369
```
6470

content/en/docs/v1/storage/nfs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ aliases:
99

1010
## Enable NFS driver
1111

12-
Add `nfs-driver` to `bundles.enabledPackages` in the [Platform Package]({{% ref "/docs/v1/operations/configuration/platform-package" %}}):
12+
Add `cozystack.nfs-driver` to `bundles.enabledPackages` in the [Platform Package]({{% ref "/docs/v1/operations/configuration/platform-package" %}}):
1313

1414
```bash
1515
kubectl patch packages.cozystack.io cozystack.cozystack-platform --type=json \
16-
-p '[{"op": "add", "path": "/spec/components/platform/values/bundles/enabledPackages/-", "value": "nfs-driver"}]'
16+
-p '[{"op": "add", "path": "/spec/components/platform/values/bundles/enabledPackages/-", "value": "cozystack.nfs-driver"}]'
1717
```
1818

1919
Wait a minute for the platform chart to reconcile, then verify the HelmRelease has been created:

content/en/docs/v1/virtualization/gpu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Follow these steps:
3636

3737
```bash
3838
kubectl patch packages.cozystack.io cozystack.cozystack-platform --type=json \
39-
-p '[{"op": "add", "path": "/spec/components/platform/values/bundles/enabledPackages/-", "value": "gpu-operator"}]'
39+
-p '[{"op": "add", "path": "/spec/components/platform/values/bundles/enabledPackages/-", "value": "cozystack.gpu-operator"}]'
4040
```
4141

4242
This will deploy the components (operands).

0 commit comments

Comments
 (0)