Skip to content

📖 Add v1beta2 doc updates + migration doc for v1beta1 to v1beta2#3098

Open
bnallapeta wants to merge 3 commits intokubernetes-sigs:mainfrom
bnallapeta:migration_docs
Open

📖 Add v1beta2 doc updates + migration doc for v1beta1 to v1beta2#3098
bnallapeta wants to merge 3 commits intokubernetes-sigs:mainfrom
bnallapeta:migration_docs

Conversation

@bnallapeta
Copy link
Copy Markdown
Contributor

What this PR does / why we need it:

  • Updates documentation across the codebase for v1beta2.
  • Adds a migration doc

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 #2944

TODOs:

  • squashed commits
  • if necessary:
    • includes documentation
    • adds unit tests

/hold

Signed-off-by: Bharath Nallapeta <nr.bharath97@gmail.com>
@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 2, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 2, 2026

Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!

Name Link
🔨 Latest commit d2e2d17
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-sigs-cluster-api-openstack/deploys/69ce1d45ed829000084647a9
😎 Deploy Preview https://deploy-preview-3098--kubernetes-sigs-cluster-api-openstack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 2, 2026
@bnallapeta
Copy link
Copy Markdown
Contributor Author

The .lycheeignore file excludes 3 external URLs that are valid but reject automated link checkers (docs.openstack.org returns 403, freedesktop.org returns 418). All 3 URLs resolve successfully with a browser. These were pre-existing links, the changes only triggered the check by modifying the files they're in.

Signed-off-by: Bharath Nallapeta <nr.bharath97@gmail.com>
Signed-off-by: Bharath Nallapeta <nr.bharath97@gmail.com>
Copy link
Copy Markdown
Contributor

@nikParasyr nikParasyr left a comment

Choose a reason for hiding this comment

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

/lgtm

Couple of nits/comments but not blockers


**For most users, no action is required.** The conversion webhooks handle all translation between v1beta1 and v1beta2 automatically. The changes below are relevant primarily for developers writing controllers or tooling that reads CAPO objects directly.

There are **no breaking changes to spec fields**. All spec fields from v1beta1 are present and unchanged in v1beta2. The breaking changes are limited to status fields and internal representations.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We intend to do some "cosmetic" changes to .spec, but i guess this should be updated when those changes land.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Agreed. Perhaps once your PRs are merged, please remember to update the docs accordingly.

|--------------|-----------------------|
| **v1beta1** | TBD (current stable) |
| **v1beta2** | TBD (current stable) |
| **v1beta1** | TBD (still served) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe not required in this PR but we should come up with a deprecation&removal timeline before we release

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point. @lentzi90 Do we have any guidance for the timelines from earlier API migrations?

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 3, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

The full list of commands accepted by this bot can be found here.

Details 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. 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

Status: Inbox

Development

Successfully merging this pull request may close these issues.

Create migration guide: docs/book/src/topics/crd-changes/v1beta1-to-v1beta2.md

3 participants