Skip to content

Commit 33a9211

Browse files
authored
Merge pull request #9173 from mercedes-benz/book-adjust-exp-feature-section
📖 Reword and list which deployments have to be edited for exp features.
2 parents 7e1f658 + b6fb030 commit 33a9211

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

docs/book/src/tasks/experimental-features/experimental-features.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ For more details on setting up a development environment with `tilt`, see [Devel
5656

5757
## Enabling Experimental Features on Existing Management Clusters
5858

59-
To enable/disable features on existing management clusters, users can modify CAPI controller manager deployment which will restart all controllers with requested features.
59+
To enable/disable features on existing management clusters, users can edit the corresponding controller manager
60+
deployments, which will then trigger a restart with the requested features. E.g. for the CAPI controller manager
61+
deployment:
6062

6163
```
6264
kubectl edit -n capi-system deployment.apps/capi-controller-manager
@@ -68,12 +70,34 @@ kubectl edit -n capi-system deployment.apps/capi-controller-manager
6870
--feature-gates=MachinePool=true,ClusterResourceSet=true
6971
```
7072
71-
Similarly, to **validate** if a particular feature is enabled, see cluster-api-provider deployment arguments by:
73+
Similarly, to **validate** if a particular feature is enabled, see the arguments by issuing:
7274
7375
```bash
7476
kubectl describe -n capi-system deployment.apps/capi-controller-manager
7577
```
7678

79+
Following controller manager deployments have to be edited in order to enable/disable their respective experimental features:
80+
81+
* [MachinePools](./machine-pools.md):
82+
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
83+
* [CABPK](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#cabpk).
84+
* [CAPD](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#capd). Other [Infrastructure Providers](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#infrastructure-provider)
85+
might also require this. Please consult the docs of the concrete [Infrastructure Provider](https://cluster-api.sigs.k8s.io/reference/providers#infrastructure)
86+
regarding this.
87+
* [ClusterResourceSet](./cluster-resource-set.md):
88+
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
89+
* [ClusterClass](./cluster-class/index.md):
90+
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
91+
* [KCP](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#kcp).
92+
* [CAPD](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#capd). Other [Infrastructure Providers](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#infrastructure-provider)
93+
might also require this. Please consult the docs of the concrete [Infrastructure Provider](https://cluster-api.sigs.k8s.io/reference/providers#infrastructure)
94+
regarding this.
95+
* [Ignition Bootstrap configuration](./ignition.md):
96+
* [CABPK](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#cabpk).
97+
* [KCP](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#kcp).
98+
* [Runtime SDK](runtime-sdk/index.md):
99+
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
100+
77101
## Active Experimental Features
78102

79103
* [MachinePools](./machine-pools.md)

0 commit comments

Comments
 (0)