Skip to content

Commit e37ead9

Browse files
Add basic overview doc and feature flags
Signed-off-by: killianmuldoon <[email protected]>
1 parent 875d9e3 commit e37ead9

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
- [Writing a ClusterClass](./tasks/experimental-features/cluster-class/write-clusterclass.md)
2323
- [Changing a ClusterClass](./tasks/experimental-features/cluster-class/change-clusterclass.md)
2424
- [Operating a managed Cluster](./tasks/experimental-features/cluster-class/operate-cluster.md)
25+
- [Runtime SDK](./tasks/experimental-features/runtime-sdk.md)
2526
- [Ignition Bootstrap configuration](./tasks/experimental-features/ignition.md)
2627
- [Security Guidelines](./security/index.md)
2728
- [Pod Security Standards](./security/pod-security-standards.md)

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ variables:
3333
EXP_CLUSTER_RESOURCE_SET: "true"
3434
EXP_MACHINE_POOL: "true"
3535
CLUSTER_TOPOLOGY: "true"
36+
EXP_RUNTIME_SDK: "true"
3637
```
38+
3739
Another way is to set them as environmental variables before running e2e tests.
3840

3941
## Enabling Experimental Features on Tilt
@@ -45,6 +47,7 @@ kustomize_substitutions:
4547
EXP_CLUSTER_RESOURCE_SET: 'true'
4648
EXP_MACHINE_POOL: 'true'
4749
CLUSTER_TOPOLOGY: 'true'
50+
EXP_RUNTIME_SDK: 'true'
4851
```
4952

5053
For more details on setting up a development environment with `tilt`, see [Developing Cluster API with Tilt](../../developer/tilt.md)
@@ -73,6 +76,7 @@ Similarly, to **validate** if a particular feature is enabled, see cluster-api-p
7376
* [ClusterResourceSet](./cluster-resource-set.md)
7477
* [ClusterClass](./cluster-class/index.md)
7578
* [Ignition Bootstrap configuration](./ignition.md)
79+
* [Runtime SDK](./runtime-sdk.md)
7680
7781
**Warning**: Experimental features are unreliable, i.e., some may one day be promoted to the main repository, or they may be modified arbitrarily or even disappear altogether.
7882
In short, they are not subject to any compatibility or deprecation promise.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Experimental Feature: Runtime SDK
2+
3+
The Runtime SDK feature provides an extensibility mechanism that allows systems, products, and services built on top of Cluster API to hook into a workload cluster’s lifecycle.
4+
5+
6+
**Feature gate name**: `RuntimeSDK`
7+
8+
**Variable name to enable/disable the feature gate**: `EXP_RUNTIME_SDK`
9+
10+
11+
More details on the Runtime SDK can be found at:
12+
[RuntimeSDK CAEP](./../../../../proposals/20220221-runtime-SDK.md)

0 commit comments

Comments
 (0)