sigs.k8s.io/cluster-api@v1.7.1/docs/book/src/tasks/experimental-features/runtime-sdk/index.md (about)

     1  # Experimental Feature: Runtime SDK (alpha)
     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  <aside class="note warning">
     6  
     7  All currently implemented hooks require to also enable the [ClusterClass](../cluster-class/index.md) feature.
     8  
     9  </aside>
    10  
    11  <aside class="note warning">
    12  
    13  <h1>Caution</h1>
    14  
    15  Please note Runtime SDK is an advanced feature. If implemented incorrectly, a failing Runtime Extension can severely impact the Cluster API runtime.
    16  
    17  </aside>
    18  
    19  **Feature gate name**: `RuntimeSDK`
    20  
    21  **Variable name to enable/disable the feature gate**: `EXP_RUNTIME_SDK`
    22  
    23  Additional documentation:
    24  
    25  * Background information:
    26      * [Runtime SDK CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20220221-runtime-SDK.md)
    27      * [Topology Mutation Hook CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20220330-topology-mutation-hook.md)
    28      * [Runtime Hooks for Add-on Management CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20220414-runtime-hooks.md)
    29  * For Runtime Extension developers:
    30      * [Implementing Runtime Extensions](./implement-extensions.md)
    31      * [Implementing Lifecycle Hook Extensions](./implement-lifecycle-hooks.md)
    32      * [Implementing Topology Mutation Hook Extensions](./implement-topology-mutation-hook.md)
    33  * For Cluster operators:
    34      * [Deploying Runtime Extensions](./deploy-runtime-extension.md)