Skip to content

📖 book: document required permissions for GetObjectFromContractVersionedRef #12998

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

Merged
k8s-ci-robot merged 1 commit into from
Nov 17, 2025
Merged

📖 book: document required permissions for GetObjectFromContractVersionedRef #12998

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/book/src/developer/providers/migrations/v1.10-to-v1.11.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2800,6 +2800,12 @@ As documented in [Suggested changes for providers](#suggested-changes-for-provid
external.GetObjectFromContractVersionedRef(ctx, r.Client, cluster.Spec.InfrastructureRef, cluster.Namespace)
```

- This functions requires the permissions to `get`, `list` and `watch` objects of the type `customresourcedefinitions` to identify the used contract version.

```go
// +kubebuilder:rbac:groups=apiextensions.k8s.io,resources=customresourcedefinitions,verbs=get;list;watch
```

- Go clients writing status of core Cluster API objects, should use at least Cluster API v1.9 Go types.
If that is not possible, avoid updating or patching the entire status field and instead you should patch only individual fields.
(Cluster API v1.9 introduced `.status.v1beta2` fields that are necessary for lossless v1beta2 => v1beta1 => v1beta2 round trips)
Expand Down Expand Up @@ -2854,6 +2860,12 @@ As documented in [Suggested changes for providers](#suggested-changes-for-provid
external.GetObjectFromContractVersionedRef(ctx, r.Client, cluster.Spec.InfrastructureRef, cluster.Namespace)
```

- This functions requires the permissions to `get`, `list` and `watch` objects of the type `customresourcedefinitions` to identify the used contract version.

```go
// +kubebuilder:rbac:groups=apiextensions.k8s.io,resources=customresourcedefinitions,verbs=get;list;watch
```

- core Cluster API added the new CRD migrator component in the v1.9 release. For more details, see: https://github.com/kubernetes-sigs/cluster-api/issues/11894
- CRD migration in clusterctl has been deprecated and will be removed in CAPI v1.13, so it's recommended to
adopt the CRD migrator in providers instead.
Expand Down