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

extend docs on clusterclass #163

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

salasberryfin
Copy link
Contributor

@salasberryfin salasberryfin commented Oct 11, 2024

Description

This PR introduces a new section on cluster classes.

  • Adds a guide on how to deploy class and cluster for each provider (tabbed)
  • For now only CAPZ is available (it was also added to Turtles E2E). The goal is to have other tabs for the other certified providers that support cluster topology.
  • Uses new examples from rancher-turtles-fleet-examples repo.
  • This also adds a sub-section in the Certified Providers table with basic information on ClusterClass support for each of the certified providers.

I think we should probably re-think the other cluster class guide (deploying via Fleet) and align both. I'd probably do this in a separate PR.

Fixes #161

@salasberryfin salasberryfin added area/documentation Improvements or additions to documentation kind/enhancement New feature or request labels Oct 11, 2024
@salasberryfin salasberryfin force-pushed the clusterclass-extend-docs branch 5 times, most recently from cb5fd10 to 70ebf35 Compare October 11, 2024 09:43
@salasberryfin salasberryfin requested a review from a team October 11, 2024 09:43
Copy link
Contributor

@furkatgofurov7 furkatgofurov7 left a comment

Choose a reason for hiding this comment

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

Few small nits/suggestions, otherwise looks great, thanks!

docs/getting-started/cluster-class/intro.md Outdated Show resolved Hide resolved
docs/getting-started/cluster-class/provision.md Outdated Show resolved Hide resolved
docs/getting-started/cluster-class/provision.md Outdated Show resolved Hide resolved
Comment on lines 72 to 80
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
name: kubeadm-control-plane
namespace: capi-kubeadm-control-plane-system
spec:
name: kubeadm
type: controlPlane
configSecret:
name: variables
Copy link
Contributor

Choose a reason for hiding this comment

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

We don’t need kubeadm provider to deploy AKS cluster

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, that is correct. This is needed to satisfy CAPI's webhooks that require a valid reference to a bootstrap object. Whatever is referenced here won't be used at any point in provisioning. For now I think I'll change it to RKE2, as it will simplify things for Turtles' users but I'll be taking a look at how this is implemented upstream and whether we can remove this hard requirement because this will happen with any other provider that supports managed clusters (namely aws, gcp).

Comment on lines 30 to 46
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
name: azure
namespace: capz-system
spec:
type: infrastructure
name: azure
credentials:
rancherCloudCredential: <rancher-credential-name> # Rancher credentials secret for Azure
configSecret:
name: azure-variables
variables:
CLUSTER_TOPOLOGY: "true"
EXP_CLUSTER_RESOURCE_SET: "true"
EXP_MACHINE_POOL: "true"
EXP_AKS_RESOURCE_HEALTH: "true"
Copy link
Contributor

Choose a reason for hiding this comment

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

This CAPIProvider should look like

        apiVersion: turtles-capi.cattle.io/v1alpha1
        kind: CAPIProvider
        metadata:
            name: azure
            namespace: capz-system
        spec:
            type: infrastructure

in order to work. All other fields are not required in AKS case.

@salasberryfin salasberryfin force-pushed the clusterclass-extend-docs branch from 70ebf35 to 14d6b72 Compare October 11, 2024 10:43
Signed-off-by: Carlos Salas <[email protected]>
@salasberryfin salasberryfin force-pushed the clusterclass-extend-docs branch from 14d6b72 to f3ac6db Compare October 14, 2024 06:34
@salasberryfin salasberryfin merged commit f61e8ff into rancher:main Oct 17, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation kind/enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend Cluster Class examples
4 participants