docs: Getting Started first cluster focuses on AKS ASO #5319

willie-yao · 2024-12-03T23:26:26Z

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This PR rewrites the quickstart to use CAPI Operator to provision a CAPZ management cluster, and to use a helm chart to deploy an AzureASOManagedCluster.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #4866

Special notes for your reviewer:

TODOs:

squashed commits
includes documentation
adds unit tests
cherry-pick candidate

Release note:

Overhaul Quickstart UX using AzureASOManagedCluster

codecov · 2024-12-03T23:36:16Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.53%. Comparing base (983bf8b) to head (11ba88f).
Report is 15 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5319   +/-   ##
=======================================
  Coverage   52.53%   52.53%           
=======================================
  Files         272      272           
  Lines       29421    29422    +1     
=======================================
+ Hits        15456    15457    +1     
  Misses      13166    13166           
  Partials      799      799

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dtzar · 2024-12-04T18:38:08Z

docs/book/src/getting-started.md

+
+Specify values for the CAPZ AKS-ASO helm chart in a `values.yaml` file. For exmaple:
+
+```yaml


I'd say to specify here ONLY the minimum values required to provision a cluster and use the default values file provided with the chart. Exception might be keeping location

dtzar · 2024-12-04T18:39:10Z

docs/book/src/getting-started.md

+
+Create a `values.yaml` file for the CAPI Operator helm chart like so:
+
+```yaml


Would be nice to have the bash command to create the file so it can just be executed.

dtzar · 2024-12-04T18:39:56Z

docs/book/src/getting-started.md


-If you are looking to install additional ASO CRDs, set `ADDITIONAL_ASO_CRDS` to the list of CRDs you want to install. Refer to adding additional CRDs for Azure Service Operator [here](./topics/aso.md#Using-aso-for-non-capz-resources).


Let's keep this and include it in the CAPI-Operator install values file.

dtzar · 2024-12-04T20:52:32Z

docs/book/src/getting-started.md

+helm install quick-start capi/azure-aks-aso -f values.yaml
+```
+
+For more information on the `azure-aks-aso` helm chart, see the [chart documentation](https://github.com/mboersma/cluster-api-charts/tree/main/charts/azure-aks-aso#azure-aks-aso-chart).


You can remove the clusterctl comments since we don't even use this in these steps.

dtzar · 2024-12-04T20:53:14Z

docs/book/src/getting-started.md


-If you are looking to install additional ASO CRDs, set `ADDITIONAL_ASO_CRDS` to the list of CRDs you want to install. Refer to adding additional CRDs for Azure Service Operator [here](./topics/aso.md#Using-aso-for-non-capz-resources).
+The recommended way to build a cluster is to install a CAPZ management cluster using [Cluster API Operator](https://github.com/kubernetes-sigs/cluster-api-operator), then utilizing a helm chart to create a workload cluster, specifically an [ASO Managed Cluster](./managed/asomanagedcluster.md).


Need to add in pre-requisites that people have helm installed at top of this page and remove requirement for clusterctl

dtzar · 2024-12-04T21:04:02Z

Would appreciate a blurb somewhere in the quickstart (such as an optional/advanced next step at the end) like: "To see how CAPZ can be utilized in a platform engineering environment to provision AKS clusters with GitOps practices using ArgoCD and Backstage, see the AKS-platform-engineering sample repository".

dtzar · 2024-12-04T21:19:02Z

docs/book/src/getting-started.md

-If you are looking to install additional ASO CRDs, set `ADDITIONAL_ASO_CRDS` to the list of CRDs you want to install. Refer to adding additional CRDs for Azure Service Operator [here](./topics/aso.md#Using-aso-for-non-capz-resources).
+The recommended way to build a cluster is to install a CAPZ management cluster using [Cluster API Operator](https://github.com/kubernetes-sigs/cluster-api-operator), then utilizing a helm chart to create a workload cluster, specifically an [ASO Managed Cluster](./managed/asomanagedcluster.md).
+
+To create a cluster manually, check out the [Cluster API Quick Start](https://cluster-api.sigs.k8s.io/user/quick-start.html) for in-depth instructions. Make sure to select the "Azure" tabs. If you are looking to install additional ASO CRDs, set `ADDITIONAL_ASO_CRDS` to the list of CRDs you want to install. Refer to adding additional CRDs for Azure Service Operator [here](./topics/aso.md#Using-aso-for-non-capz-resources).


Remove this line. Instead add in comment at top of the page something like: "This quickstart is for provisioning a managed (AKS) cluster with the CAPI-operator and helm. See the CAPI quickstart to provision a self-managed cluster on Azure using clusterctl. The identity instructions can apply to either self-managed or managed cluster provisioning."

jackfrancis · 2024-12-06T00:37:59Z

/lgtm
/approve

@dtzar @mbrow137 feel free to submit any follow-ups to this

k8s-ci-robot · 2024-12-06T00:38:05Z

LGTM label has been added.

Git tree hash: f003a54767a17f7605c0147749b2516bc5e63bad

k8s-ci-robot · 2024-12-06T00:38:05Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jackfrancis

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:

~~OWNERS~~ [jackfrancis]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

docs/book/src/getting-started.md

mboersma

/lgtm

k8s-ci-robot · 2024-12-10T17:58:21Z

LGTM label has been added.

Git tree hash: 5d2de7b508556b8415c7896fca675902ded70a5d

k8s-ci-robot requested review from Jont828 and mboersma December 3, 2024 23:26

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 3, 2024

dtzar reviewed Dec 4, 2024

View reviewed changes

dtzar suggested changes Dec 4, 2024

View reviewed changes

jackfrancis changed the title ~~WIP: Overhaul Quickstart UX using AzureASOManagedCluster~~ docs: Getting Started first cluster focuses on AKS ASO Dec 6, 2024

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 6, 2024

k8s-ci-robot assigned jackfrancis Dec 6, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 6, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 6, 2024

mboersma reviewed Dec 10, 2024

View reviewed changes

docs/book/src/getting-started.md Outdated Show resolved Hide resolved

docs/book/src/getting-started.md Outdated Show resolved Hide resolved

docs/book/src/getting-started.md Outdated Show resolved Hide resolved

Update getting-started

11ba88f

willie-yao force-pushed the aso-quick-start branch from fb194c3 to 11ba88f Compare December 10, 2024 17:54

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 10, 2024

k8s-ci-robot requested a review from jackfrancis December 10, 2024 17:54

mboersma approved these changes Dec 10, 2024

View reviewed changes

k8s-ci-robot assigned mboersma Dec 10, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 10, 2024

k8s-ci-robot merged commit 3ac9ff9 into kubernetes-sigs:main Dec 10, 2024
20 checks passed

k8s-ci-robot added this to the v1.18 milestone Dec 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Getting Started first cluster focuses on AKS ASO #5319

docs: Getting Started first cluster focuses on AKS ASO #5319

willie-yao commented Dec 3, 2024

codecov bot commented Dec 3, 2024 •

edited

Loading

dtzar Dec 4, 2024 •

edited

Loading

dtzar Dec 4, 2024

dtzar Dec 4, 2024

dtzar Dec 4, 2024

dtzar Dec 4, 2024 •

edited

Loading

dtzar commented Dec 4, 2024 •

edited

Loading

dtzar Dec 4, 2024

jackfrancis commented Dec 6, 2024

k8s-ci-robot commented Dec 6, 2024

k8s-ci-robot commented Dec 6, 2024

mboersma left a comment

k8s-ci-robot commented Dec 10, 2024


		Specify values for the CAPZ AKS-ASO helm chart in a `values.yaml` file. For exmaple:

		```yaml


		Create a `values.yaml` file for the CAPI Operator helm chart like so:

		```yaml


		If you are looking to install additional ASO CRDs, set `ADDITIONAL_ASO_CRDS` to the list of CRDs you want to install. Refer to adding additional CRDs for Azure Service Operator [here](./topics/aso.md#Using-aso-for-non-capz-resources).


		If you are looking to install additional ASO CRDs, set `ADDITIONAL_ASO_CRDS` to the list of CRDs you want to install. Refer to adding additional CRDs for Azure Service Operator [here](./topics/aso.md#Using-aso-for-non-capz-resources).
		The recommended way to build a cluster is to install a CAPZ management cluster using [Cluster API Operator](https://github.com/kubernetes-sigs/cluster-api-operator), then utilizing a helm chart to create a workload cluster, specifically an [ASO Managed Cluster](./managed/asomanagedcluster.md).

docs: Getting Started first cluster focuses on AKS ASO #5319

docs: Getting Started first cluster focuses on AKS ASO #5319

Conversation

willie-yao commented Dec 3, 2024

codecov bot commented Dec 3, 2024 • edited Loading

Codecov Report

dtzar Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

dtzar Dec 4, 2024

Choose a reason for hiding this comment

dtzar Dec 4, 2024

Choose a reason for hiding this comment

dtzar Dec 4, 2024

Choose a reason for hiding this comment

dtzar Dec 4, 2024 • edited Loading

Choose a reason for hiding this comment

dtzar commented Dec 4, 2024 • edited Loading

dtzar Dec 4, 2024

Choose a reason for hiding this comment

jackfrancis commented Dec 6, 2024

k8s-ci-robot commented Dec 6, 2024

k8s-ci-robot commented Dec 6, 2024

mboersma left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 10, 2024

codecov bot commented Dec 3, 2024 •

edited

Loading

dtzar Dec 4, 2024 •

edited

Loading

dtzar Dec 4, 2024 •

edited

Loading

dtzar commented Dec 4, 2024 •

edited

Loading