Skip to content

🌱 Update examples & code snippets in Cluster API book to v1beta2 for Cluster #12483

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🌱 Update examples & code snippets in Cluster API book to v1beta2 for Cluster #12483

wants to merge 1 commit into from
+19 −19

Conversation

sivchari
Copy link
Member

@sivchari sivchari commented Jul 14, 2025 •
edited
Loading

Part of #12448

What this PR does / why we need it:

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 #

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-area PR is missing an area label labels Jul 14, 2025
@k8s-ci-robot k8s-ci-robot requested review from chrischdi and elmiko July 14, 2025 07:55
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign fabriziopandini for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 14, 2025
sivchari
sivchari commented Jul 14, 2025
View reviewed changes
docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md Outdated
Copy link
Member Author

Choose a reason for hiding this comment

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

We should change the L.231 URL in the future. Should I open the issue to follow up ?

sbueringer
sbueringer reviewed Jul 14, 2025
View reviewed changes
docs/book/src/developer/providers/getting-started/building-running-and-testing.md Outdated
@@ -149,7 +149,7 @@ spec:
pods:
cidrBlocks: ["192.168.0.0/16"]
infrastructureRef:
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha1
apiGroup: infrastructure.cluster.x-k8s.io/v1beta2
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
apiGroup: infrastructure.cluster.x-k8s.io/v1beta2
apiGroup: infrastructure.cluster.x-k8s.io

Please check if there are other similar cases

@sivchari sivchari changed the title 🌱 Update examples & code snippets in Cluster API book to v1beta2 🌱 Update examples & code snippets in Cluster API book to v1beta2 for Cluster Jul 14, 2025
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 14, 2025
@sivchari sivchari requested a review from sbueringer July 14, 2025 11:53
@sivchari
update doc for Cluster
e4054dc 
Signed-off-by: sivchari <[email protected]>
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 15, 2025
fabriziopandini
fabriziopandini reviewed Jul 15, 2025
View reviewed changes
docs/book/src/tasks/using-kustomize.md
@@ -123,7 +123,7 @@ Add the following content to the `namereference.yaml` transformer configuration:
```yaml
- kind: Cluster
group: cluster.x-k8s.io
version: v1alpha3
Copy link
Member

Choose a reason for hiding this comment

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

Wow, this was really old! Nice catch!

docs/book/src/user/quick-start.md
@@ -92,7 +92,7 @@ a target [management cluster] on the selected [infrastructure provider].
```bash
cat > kind-cluster-with-extramounts.yaml <<EOF
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
apiVersion: kind.x-k8s.io/v1beta2
Copy link
Member

Choose a reason for hiding this comment

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

kind.x-k8s.io/v1alpha4 should not be bumped (it is still the current API version for kind configuration)

Copy link
Member

Choose a reason for hiding this comment

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

Same below

docs/book/src/tasks/bootstrap/kubeadm-bootstrap/index.md
@@ -17,18 +17,18 @@ infrastructure object.

```yaml
kind: DockerCluster
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
Copy link
Member

@fabriziopandini fabriziopandini Jul 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This is docker cluster; are you planning a follow up PR taking care of all the other occurrences of DockerCluster/DockerClusterTemplate?

Copy link
Member Author

Choose a reason for hiding this comment

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

I updated it because of DockerCluster is related with Cluster, but I decided to revert it.
This PR modify only Cluster resource, then would to change DockerCluster and DockerClusterTemplate by other PR. Thanks.

Copy link
Member

Choose a reason for hiding this comment

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

Sounds good

Copy link
Member

@sbueringer sbueringer Jul 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Please also rebase this and other PRs on top of main before we continue with review. Just to ensure we have the latest state of everything (some PRs also updated some parts of the docs)

@fabriziopandini
Copy link
Member

FYI, I also found a few examples of Clusters objects that are still using spec.topology.class instead of spec.topology.classRef, could you kindly fix also those?

@fabriziopandini fabriziopandini added the area/documentation Issues or PRs related to documentation label Jul 17, 2025
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/needs-area PR is missing an area label label Jul 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabriziopandini fabriziopandini fabriziopandini left review comments

@chrischdi chrischdi Awaiting requested review from chrischdi

@elmiko elmiko Awaiting requested review from elmiko

@sbueringer sbueringer Awaiting requested review from sbueringer

Assignees
No one assigned
Labels
area/documentation Issues or PRs related to documentation 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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sivchari @k8s-ci-robot @fabriziopandini @sbueringer