📖 Document CRD changes from v1alpha4 to v1alpha5

[apricote]

What this PR does / why we need it:

List backwards-incompatible changes made to the CRDs going from v1alpha4 to v1alpha5. I only added those I knew about and I understood. @mdbooth maybe you want to provide some more details about the Port and Network changes you can Emilio did, but I did not have the time to understand and document them.

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

/hold

[netlify]

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

Name	Link
🔨 Latest commit	66d6869
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-cluster-api-openstack/deploys/6266955a2624ed0009addcec
😎 Deploy Preview	https://deploy-preview-1216--kubernetes-sigs-cluster-api-openstack.netlify.app/print
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[tobiasgiese]

/retest

unrelated to PR

[tobiasgiese]

@apricote do you want to close issue #1188 after this PR is merged? If not you should change the fixes to sth like depends on in your PR description

[jichenjc]

/test pull-cluster-api-provider-openstack-e2e-test

[jichenjc]

thanks for updating this, can you help to include
#1101
as well?

[mdbooth]

@apricote some text for the network changes

---

When using Ports it is now possible to specify network and subnet by filter instead of just ID. As a consequence, the relevant ID fields are now moved into the new filter specifications:

ports:
- networkId: d-e-a-d
  fixedIPs:
  - subnetId: b-e-e-f

becomes:

ports:
- network:
    id: d-e-a-d
  fixedIPs:
    subnet:
      id: b-e-e-f

Networks are now deprecated. With one exception, all functionality of Networks is now available for Ports. Consequently, Networks will be removed from the API in a future release.

The ability of a Network to add multiple ports with a single directive will not be added to Ports. When moving to Ports, all ports must be added explicitly. Specifically, when evaluating the network or subnet filter of a Network, if there are multiple matches we will add all of these to the server. By contrast we raise an error if the network or subnet filter of a Port does not return exactly one result.

tenantId was previously a synonym for projectId in both network and subnet filters. This has now been removed. Use projectId instead.

The following fields are removed from network and subnet filters without replacement:

• status
• adminStateUp
• shared
• marker
• limit
• sortKey
• sortDir
• subnetPoolId

[apricote]

thanks for updating this, can you help to include #1101 as well?

@jichenjc for now I only added breaking changes and omitted new features. Do you think we should also include all new features here?

---

@apricote do you want to close issue #1188 after this PR is merged? If not you should change the fixes to sth like depends on in your PR description

@tobiasgiese That was my goal, going forward I hope that every PR that makes changes to the CRDs also documents those changes in the book.

[jichenjc]

for now I only added breaking changes and omitted new features. Do you think we should also include all new features here?

ok, didn't get this , I am ok to just list the breaking changes :) thanks~

[apricote]

@apricote some text for the network changes

@mdbooth Thanks a lot! Added this in the latest push.

[mdbooth]

/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: apricote, mdbooth

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [mdbooth]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[jichenjc]

/test pull-cluster-api-provider-openstack-e2e-test

not sure why the gate failure ratio is high recently

[jichenjc]

/hold cancel