📖 Add basic overview doc and feature flags #6538
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
killianmuldoon
changed the title
k8s-ci-robot
added
the
size/S
killianmuldoon
force-pushed
the
runtime-sdk/basic-first-docs
branch
from
0b3d938 to
4f0f3db
Compare
killianmuldoon
force-pushed
the
runtime-sdk/basic-first-docs
branch
from
4f0f3db to
e37ead9
Compare
| @@ -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. | |||
There was a problem hiding this comment.
not sure how specific we want to be here, e.g. may be mention available Runtime Hook and particular Runtime Extensions
There was a problem hiding this comment.
I think this is definitely a work in progress just to get us started. My plan was to add documentation piece by piece as we add in some of the particular hooks, and hopefully add in some examples of extensions as they get developed and published.
There was a problem hiding this comment.
I think for now the current description is fine.
I think we should extend the documentation once the hooks are merged similar to how we did it with ClusterClass.
I expect us to have at least one additional page describing the cluster lifecycle hooks and one for topology mutation with user facing documentation. (I added a sub-task for book documentation to the umbrella issues of the hooks)
|
/lgtm |
k8s-ci-robot
added
the
lgtm
| @@ -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. | |||
There was a problem hiding this comment.
I think for now the current description is fine.
I think we should extend the documentation once the hooks are merged similar to how we did it with ClusterClass.
I expect us to have at least one additional page describing the cluster lifecycle hooks and one for topology mutation with user facing documentation. (I added a sub-task for book documentation to the umbrella issues of the hooks)
killianmuldoon
force-pushed
the
runtime-sdk/basic-first-docs
branch
from
e37ead9 to
cddde1c
Compare
k8s-ci-robot
removed
the
lgtm
Signed-off-by: killianmuldoon <[email protected]>
killianmuldoon
force-pushed
the
runtime-sdk/basic-first-docs
branch
from
cddde1c to
9e31a2d
Compare
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sbueringer The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Signed-off-by: killianmuldoon [email protected]
Add the Runtime SDK feature flag in a couple of places in the docs and add a small experimental feature doc on how to enable it.
Fixes #6384