Skip to content

Commit fabb0cb

Browse files
sircthulhuclaude
andcommitted
fix(docs): update remaining stale references and DRY reuse-values warning
- Replace ConfigMap/paas-full references in backup-and-recovery, nfs, vpc, and development docs with Platform Package equivalents - Rename configmap.md to platform-package.md with URL aliases - Create reuse-values-warning shortcode to DRY the repeated warning in upgrade.md and telemetry.md - Add JSON Merge Patch array-replacement warning to install-cozystack section 5.3 for exposedServices Co-Authored-By: Claude <[email protected]> Signed-off-by: Kirill Ilin <[email protected]>
1 parent a080575 commit fabb0cb

9 files changed

Lines changed: 38 additions & 17 deletions

File tree

‎content/en/docs/v1/development.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ Provides everything needed for the initial bootstrap of cozystack: the installer
6262
Reads the configuration from the cluster, templates the manifests, and applies them
6363
back to the cluster.
6464

65-
It primarily reads the `cozystack` ConfigMap from `cozy-system` namespace, and templates
66-
manifests according to the specified options. This ConfigMap
67-
specifies the [bundle](/docs/bundles/) name and options, detailing which system components should be
65+
It reads the configuration from the `cozystack.cozystack-platform` [Package]({{% ref "/docs/v1/operations/configuration/platform-package" %}}) resource, and templates
66+
manifests according to the specified options. The Package resource
67+
specifies the [variant]({{% ref "/docs/v1/operations/configuration/bundles" %}}) and component settings, detailing which system components should be
6868
installed in the cluster.
6969

7070
{{% alert color="info" %}}

‎content/en/docs/v1/getting-started/install-cozystack.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ However, let's overview and explain each value:
6464
- `publishing.exposedServices` lists services to make accessible by users — here the dashboard (UI) and API.
6565
- `networking.*` are internal networking configurations for the underlying Kubernetes cluster.
6666

67-
You can learn more about this configuration file in the [Platform Package reference]({{% ref "/docs/v1/operations/configuration/configmap" %}}).
67+
You can learn more about this configuration file in the [Platform Package reference]({{% ref "/docs/v1/operations/configuration/platform-package" %}}).
6868

6969
{{% alert color="info" %}}
7070
Cozystack gathers anonymous usage statistics by default. Learn more about what data is collected and how to opt out in the [Telemetry Documentation]({{% ref "/docs/v1/operations/configuration/telemetry" %}}).
@@ -641,6 +641,10 @@ kubectl patch packages.cozystack.io cozystack.cozystack-platform --type=merge -p
641641
}'
642642
```
643643

644+
{{% alert color="warning" %}}
645+
JSON Merge Patch (`--type=merge`) replaces arrays wholesale. The patch above sets `exposedServices` to `["dashboard"]` only. To keep other services (e.g., `api`), include all of them: `["dashboard", "api"]`.
646+
{{% /alert %}}
647+
644648
Open `dashboard.example.org` to access the system dashboard, where `example.org` is your domain specified for `tenant-root`.
645649
There you will see a login window which expects an authentication token.
646650

‎content/en/docs/v1/kubernetes/backup-and-recovery.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This guide explains how to configure one‑off and scheduled backups and how to
1717

1818
The Velero add‑on is disabled by default. To enable it:
1919

20-
- For the **management cluster**, add `velero` to the `bundle-enable` option in the `cozystack` ConfigMap in the `cozy-system` namespace.
20+
- For the **management cluster**, add `velero` to `bundles.enabledPackages` in the [Platform Package]({{% ref "/docs/v1/operations/configuration/platform-package" %}}).
2121
- For **tenant clusters**, set `spec.addons.velero.enabled` to `true` in the `Kubernetes` resource.
2222

2323
## Prerequisites

‎content/en/docs/v1/networking/vpc.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ As the service evolves, it will provide more ways to isolate your workloads.
1919

2020
## Service details
2121

22-
To function, the service requires kube-ovn and multus CNI to be present, so by default it will only work on `paas-full` bundle.
22+
To function, the service requires kube-ovn and multus CNI to be present, so by default it will only work on `isp-full` bundle.
2323
Kube-ovn provides VPC and Subnet resources and performs isolation and networking maintenance such as DHCP. Under the hood it uses ovn virtual routers and virtual switches.
2424
Multus enables a multi-nic capability, so a pod or a VM could have two or more network interfaces.
2525

‎content/en/docs/v1/operations/cluster/upgrade.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,7 @@ kubectl get packages.cozystack.io cozystack.cozystack-platform -o yaml
4343

4444
Upgrade the Cozystack operator Helm release to the target version:
4545

46-
{{% alert color="warning" %}}
47-
Do not use `--reuse-values` when upgrading the Cozystack operator. The Helm chart values contain hardcoded references to the platform OCI repository. Reusing old values would result in the new operator pointing to old package versions.
48-
49-
If you have custom values (e.g., `disableTelemetry`), pass them explicitly with `--set`.
50-
{{% /alert %}}
46+
{{< reuse-values-warning >}}
5147

5248
```bash
5349
helm upgrade cozystack oci://ghcr.io/cozystack/cozystack/cozy-installer \

content/en/docs/v1/operations/configuration/configmap.md renamed to content/en/docs/v1/operations/configuration/platform-package.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ description: "Reference for the Cozystack Platform Package, which defines key co
55
weight: 10
66
aliases:
77
- /docs/v1/install/cozystack/configmap
8+
- /docs/v1/operations/configuration/configmap
89
---
910

1011
This page explains the role of the Cozystack Platform Package and provides a full reference for its values.

‎content/en/docs/v1/operations/configuration/telemetry.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,7 @@ helm upgrade cozystack oci://ghcr.io/cozystack/cozystack/cozy-installer \
7777

7878
Replace `X.Y.Z` with your currently installed Cozystack version.
7979

80-
{{% alert color="warning" %}}
81-
Do not use `--reuse-values` when upgrading the Cozystack operator. The Helm chart values contain hardcoded references to the platform OCI repository. Reusing old values would result in the operator pointing to old package versions.
82-
{{% /alert %}}
80+
{{< reuse-values-warning >}}
8381

8482
This command updates the operator to disable telemetry data collection. If you wish to re-enable telemetry in the future, run the same command with `disableTelemetry=false`.
8583

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,28 @@ aliases:
99

1010
## Enable NFS driver
1111

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

14-
```yaml
15-
bundle-enable: nfs-driver
14+
```bash
15+
kubectl patch packages.cozystack.io cozystack.cozystack-platform --type=merge -p '{
16+
"spec": {
17+
"components": {
18+
"platform": {
19+
"values": {
20+
"bundles": {
21+
"enabledPackages": ["nfs-driver"]
22+
}
23+
}
24+
}
25+
}
26+
}
27+
}'
1628
```
1729

30+
{{% alert color="warning" %}}
31+
JSON Merge Patch (`--type=merge`) replaces arrays wholesale. If you already have entries in `enabledPackages`, include all of them in the patch to avoid losing existing values.
32+
{{% /alert %}}
33+
1834
Wait a minute for the platform chart to reconcile, then verify the HelmRelease has been created:
1935

2036
```bash
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{{ $_hugo_config := `{ "version": 1 }` }}
2+
<div class="alert alert-warning" role="alert">
3+
Do not use <code>--reuse-values</code> when upgrading the Cozystack operator. The Helm chart values contain hardcoded references to the platform OCI repository. Reusing old values would result in the operator pointing to old package versions.
4+
<br/><br/>
5+
If you have custom values (e.g., <code>disableTelemetry</code>), pass them explicitly with <code>--set</code>.
6+
</div>

0 commit comments

Comments
 (0)