diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 2d909ea736c1..8af8efa2a357 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -22,6 +22,7 @@ - [Writing a ClusterClass](./tasks/experimental-features/cluster-class/write-clusterclass.md) - [Changing a ClusterClass](./tasks/experimental-features/cluster-class/change-clusterclass.md) - [Operating a managed Cluster](./tasks/experimental-features/cluster-class/operate-cluster.md) + - [Runtime SDK](./tasks/experimental-features/runtime-sdk.md) - [Ignition Bootstrap configuration](./tasks/experimental-features/ignition.md) - [Security Guidelines](./security/index.md) - [Pod Security Standards](./security/pod-security-standards.md) diff --git a/docs/book/src/developer/testing.md b/docs/book/src/developer/testing.md index 942cc1bb568d..f7cb49c792be 100644 --- a/docs/book/src/developer/testing.md +++ b/docs/book/src/developer/testing.md @@ -223,6 +223,7 @@ kustomize_substitutions: EXP_MACHINE_POOL: "true" EXP_CLUSTER_RESOURCE_SET: "true" EXP_KUBEADM_BOOTSTRAP_FORMAT_IGNITION: "true" + EXP_RUNTIME_SDK: "true" ``` diff --git a/docs/book/src/developer/tilt.md b/docs/book/src/developer/tilt.md index b1b324e19502..e9ec504c0e69 100644 --- a/docs/book/src/developer/tilt.md +++ b/docs/book/src/developer/tilt.md @@ -79,6 +79,7 @@ kustomize_substitutions: EXP_MACHINE_POOL: "true" EXP_CLUSTER_RESOURCE_SET: "true" EXP_KUBEADM_BOOTSTRAP_FORMAT_IGNITION: "true" + EXP_RUNTIME_SDK: "true" ``` {{#tabs name:"tab-tilt-kustomize-substitution" tabs:"AWS,Azure,DigitalOcean,GCP"}} diff --git a/docs/book/src/tasks/experimental-features/experimental-features.md b/docs/book/src/tasks/experimental-features/experimental-features.md index d1bdfced8e14..79630116d4fc 100644 --- a/docs/book/src/tasks/experimental-features/experimental-features.md +++ b/docs/book/src/tasks/experimental-features/experimental-features.md @@ -33,7 +33,9 @@ variables: EXP_CLUSTER_RESOURCE_SET: "true" EXP_MACHINE_POOL: "true" CLUSTER_TOPOLOGY: "true" + EXP_RUNTIME_SDK: "true" ``` + Another way is to set them as environmental variables before running e2e tests. ## Enabling Experimental Features on Tilt @@ -45,6 +47,7 @@ kustomize_substitutions: EXP_CLUSTER_RESOURCE_SET: 'true' EXP_MACHINE_POOL: 'true' CLUSTER_TOPOLOGY: 'true' + EXP_RUNTIME_SDK: 'true' ``` 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 * [ClusterResourceSet](./cluster-resource-set.md) * [ClusterClass](./cluster-class/index.md) * [Ignition Bootstrap configuration](./ignition.md) +* [Runtime SDK](./runtime-sdk.md) **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. In short, they are not subject to any compatibility or deprecation promise. diff --git a/docs/book/src/tasks/experimental-features/runtime-sdk.md b/docs/book/src/tasks/experimental-features/runtime-sdk.md new file mode 100644 index 000000000000..d831dc9e3336 --- /dev/null +++ b/docs/book/src/tasks/experimental-features/runtime-sdk.md @@ -0,0 +1,12 @@ +# Experimental Feature: Runtime SDK + +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. + + +**Feature gate name**: `RuntimeSDK` + +**Variable name to enable/disable the feature gate**: `EXP_RUNTIME_SDK` + + +More details on the Runtime SDK can be found at: +[RuntimeSDK CAEP](./../../../../proposals/20220221-runtime-SDK.md) \ No newline at end of file