Skip to content

Commit f502212

Browse files
committed
docs: update public documentation to always use meta handler
1 parent 9b00c5e commit f502212

File tree

7 files changed

+43
-43
lines changed

7 files changed

+43
-43
lines changed

docs/content/audit-policy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ title: "Audit policy"
44

55
Kubernetes auditing provides a security-relevant, chronological set of records documenting the sequence of actions in a
66
cluster. The cluster audits the activities generated by users, by applications that use the Kubernetes API, and by the
7-
control plane itself. The `auditpolicypatch` external patch will generate appropriate configuration for the Kubernetes
7+
control plane itself. The `clusterconfigpatch` external patch will generate appropriate configuration for the Kubernetes
88
control plane.
99

10-
To enable the audit policy enable the `auditpolicypatch` external patch on `ClusterClass`.
10+
To enable the meta handler enable the `clusterconfigvars` and `clusterconfigpatch` external patches on `ClusterClass`.
1111

1212
```yaml
1313
apiVersion: cluster.x-k8s.io/v1beta1
@@ -16,9 +16,9 @@ metadata:
1616
name: <NAME>
1717
spec:
1818
patches:
19-
- name: audit-policy
19+
- name: cluster-config
2020
external:
21-
generateExtension: "auditpolicypatch.capi-runtime-extensions"
21+
generateExtension: "clusterconfigpatch.capi-runtime-extensions"
2222
```
2323
2424
Applying this configuration will result in new bootstrap files on the `KubeadmControlPlaneTemplate`.

docs/content/calico-cni.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ The hook creates two `ClusterResourceSets`: one to deploy the Tigera Operator, a
1111
Calico via the Tigera `Installation` CRD. The Tigera Operator CRS is shared between all clusters in the operator,
1212
whereas the Calico installation CRS is unique per cluster.
1313

14-
To enable the meta handler enable the `clusterconfigvars` and `clusterconfigpatch`
15-
external patches on `ClusterClass`.
14+
To enable the meta handler enable the `clusterconfigvars` and `clusterconfigpatch` external patches on `ClusterClass`.
1615

1716
```yaml
1817
apiVersion: cluster.x-k8s.io/v1beta1

docs/content/cluster-config.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ ClusterClasses, allowing for a single configuration variable with nested values.
77
with the least configuration. The included patches are usable individually, but require declaring all the individual
88
patch and variable handlers in the ClusterClass.
99

10-
To enable the meta handler enable the `clusterconfigvars` and `clusterconfigpatch`
11-
external patches on `ClusterClass`.
10+
To enable the meta handler enable the `clusterconfigvars` and `clusterconfigpatch` external patches on `ClusterClass`.
1211

1312
```yaml
1413
apiVersion: cluster.x-k8s.io/v1beta1

docs/content/etcd.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "etcd"
44

55
Override the container image repository and tag for [etcd](https://github.com/etcd-io/etcd).
66

7-
To enable this handler set the `etcdpatch` and `etcdvars` external patches on `ClusterClass`.
7+
To enable the meta handler enable the `clusterconfigvars` and `clusterconfigpatch` external patches on `ClusterClass`.
88

99
```yaml
1010
apiVersion: cluster.x-k8s.io/v1beta1
@@ -13,10 +13,10 @@ metadata:
1313
name: <NAME>
1414
spec:
1515
patches:
16-
- name: image-registry
16+
- name: cluster-config
1717
external:
18-
generateExtension: "etcdpatch.capi-runtime-extensions"
19-
discoverVariablesExtension: "etcdvars.capi-runtime-extensions"
18+
generateExtension: "clusterconfigpatch.capi-runtime-extensions"
19+
discoverVariablesExtension: "clusterconfigvars.capi-runtime-extensions"
2020
```
2121
2222
On the cluster resource then specify desired etcd image repository and/or image tag values:
@@ -29,11 +29,12 @@ metadata:
2929
spec:
3030
topology:
3131
variables:
32-
- name: etcd
33-
values:
34-
image:
35-
repository: my-registry.io/my-org/my-repo
36-
tag: "v3.5.99_custom.0"
32+
- name: clusterConfig
33+
value:
34+
etcd:
35+
image:
36+
repository: my-registry.io/my-org/my-repo
37+
tag: "v3.5.99_custom.0"
3738
```
3839
3940
Applying this configuration will result in the following value being set:

docs/content/extra-apiserver-cert-sans.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ title: "Extra API Server Certificate SANs"
55
If the API server can be accessed by alternative DNS addresses then setting additional SANs on the API server
66
certificate is necessary in order for clients to successfully validate the API server certificate.
77

8-
To enable the API server certificate SANs enable the `extraapiservercertsansvars` and `extraapiservercertsanspatch`
9-
external patches on `ClusterClass`.
8+
To enable the meta handler enable the `clusterconfigvars` and `clusterconfigpatch` external patches on `ClusterClass`.
109

1110
```yaml
1211
apiVersion: cluster.x-k8s.io/v1beta1
@@ -15,10 +14,10 @@ metadata:
1514
name: <NAME>
1615
spec:
1716
patches:
18-
- name: apiserver-cert-sans
17+
- name: cluster-config
1918
external:
20-
generateExtension: "extraapiservercertsanspatch.capi-runtime-extensions"
21-
discoverVariablesExtension: "extraapiservercertsansvars.capi-runtime-extensions"
19+
generateExtension: "clusterconfigpatch.capi-runtime-extensions"
20+
discoverVariablesExtension: "clusterconfigvars.capi-runtime-extensions"
2221
```
2322
2423
On the cluster resource then specify desired certificate SANs values:
@@ -31,10 +30,11 @@ metadata:
3130
spec:
3231
topology:
3332
variables:
34-
- name: extraAPIServerCertSANs
33+
- name: clusterConfig
3534
value:
36-
- a.b.c.example.com
37-
- d.e.f.example.com
35+
extraAPIServerCertSANs:
36+
- a.b.c.example.com
37+
- d.e.f.example.com
3838
```
3939
4040
Applying this configuration will result in the certificate SANs being correctly set in the

docs/content/http-proxy.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ In some network environments it is necessary to use HTTP proxy to successfuly ex
66
To configure Kubernetes components (`containerd`, `kubelet`) to use HTTP proxy use the `httpproxypatch`
77
external patch that will generate appropriate configuration for control plane and worker nodes.
88

9-
To enable the http proxy enable the `httpproxypatch` external patch on `ClusterClass`.
9+
To enable the meta handler enable the `clusterconfigvars` and `clusterconfigpatch` external patches on `ClusterClass`.
1010

1111
```yaml
1212
apiVersion: cluster.x-k8s.io/v1beta1
@@ -15,10 +15,10 @@ metadata:
1515
name: <NAME>
1616
spec:
1717
patches:
18-
- name: http-proxy
18+
- name: cluster-config
1919
external:
20-
generateExtension: "httpproxypatch.capi-runtime-extensions"
21-
discoverVariablesExtension: "httpproxyvars.capi-runtime-extensions"
20+
generateExtension: "clusterconfigpatch.capi-runtime-extensions"
21+
discoverVariablesExtension: "clusterconfigvars.capi-runtime-extensions"
2222
```
2323
2424
On the cluster resource then specify desired HTTP proxy values:
@@ -31,13 +31,14 @@ metadata:
3131
spec:
3232
topology:
3333
variables:
34-
- name: proxy
34+
- name: clusterConfig
3535
value:
36-
http: http://example.com
37-
https: http://example.com
38-
additionalNo:
39-
- no-proxy-1.example.com
40-
- no-proxy-2.example.com
36+
proxy:
37+
http: http://example.com
38+
https: https://example.com
39+
additionalNo:
40+
- no-proxy-1.example.com
41+
- no-proxy-2.example.com
4142
```
4243
4344
The `additionalNo` list will be added to default pre-calculated values that apply on k8s networking

docs/content/kubernetes-image-repository.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Kubernete Image Repository"
44

55
Override the container image repository used when pulling Kubernetes images.
66

7-
To enable this handler set the `imagerepositorypatch` and `imagerepositoryvars` external patches on `ClusterClass`.
7+
To enable the meta handler enable the `clusterconfigvars` and `clusterconfigpatch` external patches on `ClusterClass`.
88

99
```yaml
1010
apiVersion: cluster.x-k8s.io/v1beta1
@@ -13,10 +13,10 @@ metadata:
1313
name: <NAME>
1414
spec:
1515
patches:
16-
- name: image-repository
16+
- name: cluster-config
1717
external:
18-
generateExtension: "imagerepositorypatch.capi-runtime-extensions"
19-
discoverVariablesExtension: "imagerepositoryvars.capi-runtime-extensions"
18+
generateExtension: "clusterconfigpatch.capi-runtime-extensions"
19+
discoverVariablesExtension: "clusterconfigvars.capi-runtime-extensions"
2020
```
2121
2222
On the cluster resource then specify desired Kubernetes image repository value:
@@ -27,10 +27,10 @@ kind: Cluster
2727
metadata:
2828
name: <NAME>
2929
spec:
30-
topology:
31-
variables:
32-
- name: kubernetesImageRepository
33-
value: "my-registry.io/my-org/my-repo"
30+
variables:
31+
- name: clusterConfig
32+
value:
33+
imageRepository: my-registry.io/my-org/my-repo
3434
```
3535
3636
Applying this configuration will result in the following value being set:

0 commit comments

Comments
 (0)