Skip to content

Commit 78e420b

Browse files
committed
docs: Add intro page to user docs
1 parent cd6a319 commit 78e420b

File tree

3 files changed

+27
-2
lines changed

3 files changed

+27
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
SPDX-License-Identifier: Apache-2.0
44
-->
55

6-
# CAPI Runtime Extensions Server
6+
# CAPI Runtime Extensions
7+
8+
For user docs, please see [https://d2iq-labs.github.io/capi-runtime-extensions/].
79

810
See [upstream documentation](https://cluster-api.sigs.k8s.io/tasks/experimental-features/runtime-sdk/index.html).
911

devbox.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"shell": {
4040
"scripts": {
4141
"preview-docs": [
42-
"cd docs && hugo serve -F -D"
42+
"cd docs && hugo server -F -D"
4343
]
4444
}
4545
}

docs/content/_index.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,26 @@ type = "docs"
1414
[cascade._target]
1515
path = "/**"
1616
+++
17+
18+
Cluster API provides declarative APIs for provisioning, upgrading, and operating Kubernetes clusters across multiple
19+
infrastructure providers. The [`ClusterClass`][clusterclass] feature brings huge improvements in how users manage
20+
clusters, providing a single resource for a user to mutate to orchestrate upgrades, etc. `ClusterClass` also brings much
21+
improved templating over the [`clusterctl generate cluster`][clusterctl generate cluster] environment-variable driven
22+
templating by introducing variables specified with an OpenAPI schema that can then be applied to the generated resources
23+
via patches.
24+
25+
The [Runtime SDK] feature provides an extensibility mechanism to hook into `ClusterClass` managed Kubernetes clusters'
26+
lifecycle. This project, CAPI Runtime Extensions, provides implementations of various runtime hooks that can be used in
27+
`ClusterClasses` across providers. This includes variables and patches that can be used across any provider to configure
28+
generic Kubernetes capabilities, such as configuring audit policy or HTTP proxy configuration. These capabilities are
29+
not provider-specific and delivering these capabilities in code instead of directly embedded in `ClusterClass`
30+
definitions leads to a much more robust experience via fast-feedback unit tests, as opposed to long running e2e tests.
31+
32+
In addition to cluster resource customizations, this project enables management of essential cluster addons (e.g. CNI)
33+
via variable definitions, e.g. selecting a CNI provider via variables defined on the `Cluster` resource itself. The goal
34+
is to provide a single resource, the `Cluster`, that a user has to interact with to describe a fully-operational
35+
Kubernetes cluster.
36+
37+
[clusterclass]: https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-class/
38+
[clusterctl generate cluster]: https://cluster-api.sigs.k8s.io/clusterctl/commands/generate-cluster.html
39+
[Runtime SDK]: https://cluster-api.sigs.k8s.io/tasks/experimental-features/runtime-sdk/

0 commit comments

Comments
 (0)