Skip to content

Commit 4aa91d3

Browse files
committed
More docs changes
1 parent f0761d6 commit 4aa91d3

File tree

3 files changed

+9
-11
lines changed

3 files changed

+9
-11
lines changed

docs/book/src/SUMMARY.md

-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
- [Autoscaling](./tasks/automated-machine-management/autoscaling.md)
2929
- [Healthchecking](./tasks/automated-machine-management/healthchecking.md)
3030
- [Experimental Features](./tasks/experimental-features/experimental-features.md)
31-
- [MachinePools](./tasks/experimental-features/machine-pools.md)
3231
- [MachineSetPreflightChecks](./tasks/experimental-features/machineset-preflight-checks.md)
3332
- [ClusterResourceSet](./tasks/experimental-features/cluster-resource-set.md)
3433
- [ClusterClass](./tasks/experimental-features/cluster-class/index.md)

docs/book/src/developer/repository-layout.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ This is a place for defining errors returned by CAPI. Error types defined here c
138138

139139
[~/exp](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp)
140140

141-
This folder contains experimental features of CAPI. Experimental features are unreliable until they are promoted to the main repository. Each experimental feature is supposed to be present in a subfolder of [~/exp](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp) folder e.g. ClusterResourceSet is present inside [~/exp/addons](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp/addons) folder. Historically, machine pool resources are not present in a sub-directory. Migrating them to a subfolder like `~/exp/machinepools` is still pending as it can potentially break existing users who are relying on existing folder structure.
141+
This folder contains experimental features of CAPI. Experimental features are unreliable until they are promoted to the main repository. Each experimental feature is supposed to be present in a subfolder of [~/exp](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp) folder e.g. ClusterResourceSet is present inside [~/exp/addons](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp/addons) folder.
142142

143143
CRDs for experimental features are present outside [~/exp](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp) directory in [~/config](https://github.com/kubernetes-sigs/cluster-api/tree/main/config) folder. Also, these CRDs are deployed in the cluster irrespective of the feature gate value. These features can be enabled and disabled using feature gates supplied to the core Cluster API controller.
144144

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

+8-9
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,8 @@ EXP_SOME_FEATURE_NAME: "true"
2121
In case a variable is defined in both the config file and as an OS environment variable, the environment variable takes precedence.
2222
For more information on how to set variables for clusterctl, see [clusterctl Configuration File](../../clusterctl/configuration.md)
2323
24-
Some features like `MachinePools` may require infrastructure providers to implement a separate CRD that handles the infrastructure side of the feature too.
24+
Some features may require infrastructure providers to implement a separate CRD that handles the infrastructure side of the feature too.
2525
For such a feature to work, infrastructure providers should also enable their controllers if it is implemented as a feature. If it is not implemented as a feature, no additional step is necessary.
26-
As an example, Cluster API Provider Azure (CAPZ) has support for MachinePool through the infrastructure type `AzureMachinePool`.
2726
2827
## Enabling Experimental Features for e2e Tests
2928
@@ -63,7 +62,7 @@ kubectl edit -n capi-system deployment.apps/capi-controller-manager
6362
// Enable/disable available features by modifying Args below.
6463
Args:
6564
--leader-elect
66-
--feature-gates=MachinePool=true,ClusterResourceSet=true
65+
--feature-gates=ClusterResourceSet=true
6766
```
6867
6968
Similarly, to **validate** if a particular feature is enabled, see the arguments by issuing:
@@ -77,17 +76,17 @@ Following controller manager deployments have to be edited in order to enable/di
7776
* [MachinePools](./machine-pools.md):
7877
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
7978
* [CABPK](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#cabpk).
80-
* [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)
81-
might also require this. Please consult the docs of the concrete [Infrastructure Provider](https://cluster-api.sigs.k8s.io/reference/providers#infrastructure)
82-
regarding this.
79+
* [CAPD](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#capd).
80+
* Other [Infrastructure Providers](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#infrastructure-provider)
81+
might also require this. Please consult the docs of the concrete [Infrastructure Provider](https://cluster-api.sigs.k8s.io/reference/providers#infrastructure).
8382
* [ClusterResourceSet](./cluster-resource-set.md):
8483
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
8584
* [ClusterClass](./cluster-class/index.md):
8685
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
8786
* [KCP](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#kcp).
88-
* [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)
89-
might also require this. Please consult the docs of the concrete [Infrastructure Provider](https://cluster-api.sigs.k8s.io/reference/providers#infrastructure)
90-
regarding this.
87+
* [CAPD](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#capd).
88+
* Other [Infrastructure Providers](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#infrastructure-provider)
89+
might also require this. Please consult the docs of the concrete [Infrastructure Provider](https://cluster-api.sigs.k8s.io/reference/providers#infrastructure).
9190
* [Ignition Bootstrap configuration](./ignition.md):
9291
* [CABPK](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#cabpk).
9392
* [KCP](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#kcp).

0 commit comments

Comments
 (0)