Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Add clusterclass quickstart guide #5374

Conversation

killianmuldoon
Copy link
Contributor

@killianmuldoon killianmuldoon commented Oct 1, 2021

What this PR does / why we need it:

Add a simple quick start guide to the CAPI book under experimental features. The guide shows how to create and then update a CAPD cluster from Kind install through to deletion using ClusterClass and Managed Topologies.

Fixes #5368
Signed-off-by: killianmuldoon [email protected]

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 1, 2021
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 1, 2021
Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx for tackling this!

@killianmuldoon
Copy link
Contributor Author

New version fixes most of the nits, errors and issues. Outstanding are things that rely on v1beta1/1.0 - machineDeployment columns and v1beta1 types. I haven't been able to prove this out with clusterctl just yet, but can update as soon as I'm sure.

@killianmuldoon
Copy link
Contributor Author

Updated now to v1beta1 types using the release candidate version of CAPI and other providers.

- Install [Kind] and [Docker]

ClusterClass is currently behind a feature gate that needs to be enabled.
This tutorial will also use another experimental gated feature - Cluster Resource Set - in this tutorial. This is not required for ClusterClass but is used in this tutorial to set up networking.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This tutorial will also use another experimental gated feature - Cluster Resource Set - in this tutorial. This is not required for ClusterClass but is used in this tutorial to set up networking.
This tutorial will also use another experimental gated feature - Cluster Resource Set -. This is not required for ClusterClass to work, but is used in this tutorial to set up networking.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This tutorial will also use another experimental gated feature - Cluster Resource Set - in this tutorial. This is not required for ClusterClass but is used in this tutorial to set up networking.
This tutorial will also use another experimental gated feature - Cluster Resource Set -. This is not required for ClusterClass but is used in this tutorial to set up networking.

1) KubeadmConfigTemplate

The ClusterClass - first in the below yaml - contains references to the templates needed to build a full cluster using the shape defined in the ClusterClass.
```yaml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm ok with both solutions. Up to you

@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 4, 2021
@sbueringer
Copy link
Member

sbueringer commented Oct 5, 2021

@killianmuldoon Can you please resolve the resolved conversations/findings for a better overview? Thank you

@killianmuldoon killianmuldoon force-pushed the pr-clusterclass-quickstart-guide branch from f75e7bf to 0258a82 Compare October 5, 2021 10:30
Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

last nit from my side

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 5, 2021
@killianmuldoon killianmuldoon force-pushed the pr-clusterclass-quickstart-guide branch from 34cbfa0 to 72c16f1 Compare October 5, 2021 11:25
@sbueringer
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 5, 2021
- Install [Kind] and [Docker]

ClusterClass is currently behind a feature gate that needs to be enabled.
This tutorial will also use another experimental gated feature - Cluster Resource Set - in this tutorial. This is not required for ClusterClass but is used in this tutorial to set up networking.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This tutorial will also use another experimental gated feature - Cluster Resource Set - in this tutorial. This is not required for ClusterClass but is used in this tutorial to set up networking.
This tutorial will also use another experimental gated feature - Cluster Resource Set -. This is not required for ClusterClass but is used in this tutorial to set up networking.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 5, 2021
@fabriziopandini
Copy link
Member

lgtm pending squash

@killianmuldoon killianmuldoon force-pushed the pr-clusterclass-quickstart-guide branch from 5af66fa to 233f070 Compare October 5, 2021 16:08
@killianmuldoon
Copy link
Contributor Author

Squashed

@fabriziopandini
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 5, 2021
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 5, 2021
@sbueringer
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot merged commit 59968db into kubernetes-sigs:main Oct 5, 2021
@k8s-ci-robot k8s-ci-robot added this to the v0.4 milestone Oct 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ClusterClass quick start to the CAPI book
5 participants