Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[release-1.5] 📖 Reword and list which deployments have to be edited for exp features. #9205

Merged
merged 1 commit into from
Aug 16, 2023
Merged

[release-1.5] 📖 Reword and list which deployments have to be edited for exp features. #9205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions docs/book/src/tasks/experimental-features/experimental-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ For more details on setting up a development environment with `tilt`, see [Devel

## Enabling Experimental Features on Existing Management Clusters

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

```
kubectl edit -n capi-system deployment.apps/capi-controller-manager
Expand All @@ -68,12 +70,34 @@ kubectl edit -n capi-system deployment.apps/capi-controller-manager
--feature-gates=MachinePool=true,ClusterResourceSet=true
```
Similarly, to **validate** if a particular feature is enabled, see cluster-api-provider deployment arguments by:
Similarly, to **validate** if a particular feature is enabled, see the arguments by issuing:
```bash
kubectl describe -n capi-system deployment.apps/capi-controller-manager
```

Following controller manager deployments have to be edited in order to enable/disable their respective experimental features:

* [MachinePools](./machine-pools.md):
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
* [CABPK](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#cabpk).
* [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)
might also require this. Please consult the docs of the concrete [Infrastructure Provider](https://cluster-api.sigs.k8s.io/reference/providers#infrastructure)
regarding this.
* [ClusterResourceSet](./cluster-resource-set.md):
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
* [ClusterClass](./cluster-class/index.md):
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
* [KCP](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#kcp).
* [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)
might also require this. Please consult the docs of the concrete [Infrastructure Provider](https://cluster-api.sigs.k8s.io/reference/providers#infrastructure)
regarding this.
* [Ignition Bootstrap configuration](./ignition.md):
* [CABPK](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#cabpk).
* [KCP](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#kcp).
* [Runtime SDK](runtime-sdk/index.md):
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).

## Active Experimental Features

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