Skip to content

Commit ee24d66

Browse files
authored
fix(docs): correct component values override instructions (#436)
## What this PR does Fixes the "Overwriting Component Parameters" section in the components reference. The previous instructions incorrectly showed overriding component values through the Platform Package. The correct approach is to modify the specific Package resource directly (e.g. `cozystack.metallb`) and specify values in its `spec.components` section. The values structure follows the `values.yaml` of the respective system chart in the Cozystack repository. Updated the example to show enabling FRR-K8s mode for MetalLB with a link to the system chart values.
2 parents fc2994b + cd20130 commit ee24d66

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

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

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,29 @@ aliases:
1010
### Overwriting Component Parameters
1111

1212
You might want to override specific options for the components.
13-
To achieve this, specify values in the `spec.components` section of the Platform Package.
13+
To achieve this, modify the corresponding Package resource and specify values
14+
in the `spec.components` section. The values structure follows the
15+
[values.yaml](https://github.com/cozystack/cozystack/tree/main/packages/system)
16+
of the respective system chart in the Cozystack repository.
1417

15-
For example, if you want to overwrite `k8sServiceHost` and `k8sServicePort` for cilium,
16-
take a look at its [values.yaml](https://github.com/cozystack/cozystack/blob/238061efbc0da61d60068f5de31d6eaa35c4d994/packages/system/cilium/values.yaml#L18-L19) file.
17-
18-
Then specify these options in the `networking` component of your Platform Package:
18+
For example, if you want to enable FRR-K8s mode for MetalLB, look at its
19+
[values.yaml](https://github.com/cozystack/cozystack/blob/main/packages/system/metallb/values.yaml)
20+
to understand the available parameters, then modify the `cozystack.metallb` Package:
1921

2022
```yaml
2123
apiVersion: cozystack.io/v1alpha1
2224
kind: Package
2325
metadata:
24-
name: cozystack.cozystack-platform
26+
name: cozystack.metallb
27+
namespace: cozy-system
2528
spec:
26-
variant: distro-full
29+
variant: default
2730
components:
28-
platform:
29-
values:
30-
networking:
31-
podCIDR: "10.244.0.0/16"
32-
serviceCIDR: "10.96.0.0/16"
33-
networking:
31+
metallb:
3432
values:
35-
cilium:
36-
k8sServiceHost: 11.22.33.44
37-
k8sServicePort: 6443
33+
metallb:
34+
frrk8s:
35+
enabled: true
3836
```
3937
4038
### Enabling and Disabling Components

0 commit comments

Comments
 (0)