Skip to content

Commit 2e74514

Browse files
committed
ASOAPI: update docs
1 parent 7e0ce0c commit 2e74514

File tree

4 files changed

+11
-9
lines changed

4 files changed

+11
-9
lines changed

docs/book/install-and-build.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ genCRDAPIReferenceDocs="${genCRDAPIReferenceDocsPath}/gen-crd-api-reference-docs
7676

7777
${genCRDAPIReferenceDocs} -config "${genCRDAPIReferenceDocsPath}/example-config.json" -template-dir "${genCRDAPIReferenceDocsPath}/template" -api-dir ./api/v1beta1 -out-file ./docs/book/src/reference/v1beta1-api-raw.html
7878
${genCRDAPIReferenceDocs} -config "${genCRDAPIReferenceDocsPath}/example-config.json" -template-dir "${genCRDAPIReferenceDocsPath}/template" -api-dir ./exp/api/v1beta1 -out-file ./docs/book/src/reference/v1beta1-exp-api-raw.html
79+
${genCRDAPIReferenceDocs} -config "${genCRDAPIReferenceDocsPath}/example-config.json" -template-dir "${genCRDAPIReferenceDocsPath}/template" -api-dir ./exp/api/v1alpha1 -out-file ./docs/book/src/reference/v1alpha1-exp-api-raw.html
7980

8081
# Finally build the book.
8182
(cd docs/book && /tmp/mdbook build)

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,4 @@
4747
- [Reference](./reference/reference.md)
4848
- [v1beta1 API](./reference/v1beta1-api.md)
4949
- [v1beta1 exp API](./reference/v1beta1-exp-api.md)
50+
- [v1alpha1 exp API](./reference/v1alpha1-exp-api.md)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{ #include v1alpha1-exp-api-raw.html }}

docs/book/src/topics/aso.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ An example configuration file and demo for `Azure Cache for Redis` can be found
8282

8383
## Experimental ASO API
8484

85-
CAPZ has begun to experiment with a new flavor of APIs that attempt to address the following limitations of
85+
New in CAPZ v1.15.0 is a new flavor of APIs that addresses the following limitations of
8686
the existing CAPZ APIs for advanced use cases:
8787

8888
- A limited set of Azure resource types can be represented.
@@ -97,7 +97,7 @@ This new experimental API defines new AzureASOManagedCluster, AzureASOManagedCon
9797
AzureASOManagedMachinePool resources. An AzureASOManagedCluster might look like this:
9898

9999
```yaml
100-
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
100+
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha1
101101
kind: AzureASOManagedCluster
102102
metadata:
103103
name: my-cluster
@@ -112,6 +112,8 @@ spec:
112112
location: eastus
113113
```
114114
115+
See [here](https://github.com/kubernetes-sigs/cluster-api-provider-azure/blob/main/templates/cluster-template-aks-aso.yaml) for a full AKS example using all the new resources.
116+
115117
The main element of the new API is `spec.resources` in each new resource, which defines arbitrary, literal ASO
116118
resources inline to be managed by CAPZ. These inline ASO resource definitions take the place of almost all
117119
other configuration currently defined by CAPZ. e.g. Instead of a CAPZ-specific `spec.location` field on the
@@ -120,15 +122,12 @@ resource defined in an AzureASOManagedControlPlane's `spec.resources`. This patt
120122
full, any ASO-supported version of a resource type in any of these new CAPZ resources.
121123

122124
The obvious tradeoff with this new style of API is that CAPZ resource definitions can become more verbose for
123-
basic use cases. To address this, CAPZ will still offer flavor templates that use this API with all of the
125+
basic use cases. To address this, CAPZ still offers flavor templates that use this API with all of the
124126
boilerplate predefined to serve as a starting point for customization.
125127

126128
The overall theme of this API is to leverage ASO as much as possible for representing Azure resources in the
127129
Kubernetes API, thereby making CAPZ the thinnest possible translation layer between ASO and Cluster API.
128130

129-
This experiment will help inform CAPZ whether this pattern may be a candidate for a potential v2 API. If
130-
you're interested in trying this out, stay tuned! This functionality is available, but under heavy
131-
construction and not yet in a usable state, behind the `ASOAPI` feature flag (set by the `EXP_ASO_API`
132-
environment variable).
133-
134-
Feedback is welcome!
131+
This experiment will help inform CAPZ whether this pattern may be a candidate for a potential v2 API. This
132+
functionality is available behind the `ASOAPI` feature flag (set by the `EXP_ASO_API` environment variable).
133+
Please try it out and offer any feedback!

0 commit comments

Comments
 (0)