Skip to content

Commit 80de37b

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

File tree

5 files changed

+30
-27
lines changed

5 files changed

+30
-27
lines changed

docs/content/audit-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ spec:
1818
patches:
1919
- name: audit-policy
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/etcd.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ spec:
1515
patches:
1616
- name: image-registry
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: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ spec:
1717
patches:
1818
- name: apiserver-cert-sans
1919
external:
20-
generateExtension: "extraapiservercertsanspatch.capi-runtime-extensions"
21-
discoverVariablesExtension: "extraapiservercertsansvars.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 certificate SANs values:
@@ -31,10 +31,11 @@ metadata:
3131
spec:
3232
topology:
3333
variables:
34-
- name: extraAPIServerCertSANs
34+
- name: clusterConfig
3535
value:
36-
- a.b.c.example.com
37-
- d.e.f.example.com
36+
extraAPIServerCertSANs:
37+
- a.b.c.example.com
38+
- d.e.f.example.com
3839
```
3940
4041
Applying this configuration will result in the certificate SANs being correctly set in the

docs/content/http-proxy.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ spec:
1717
patches:
1818
- name: http-proxy
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: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ spec:
1515
patches:
1616
- name: image-repository
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)