Merge pull request #3098 from bnallapeta/migration_docs

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

Author: k8s-ci-robot

.github/workflows/pr-link-check.yaml

@@ -63,6 +63,8 @@ jobs:
           --fallback-extensions "md"
           --github-token "${GITHUB_TOKEN}"
           --insecure
+          --max-retries 3
+          --retry-wait-time 5
           --exclude-all-private
           --no-progress
           $(cat changed-files.txt | tr '\n' ' ')

.lycheeignore

@@ -0,0 +1,7 @@
+# External sites that block automated link checkers (return 403/418 despite being valid)
+https://docs.openstack.org/api-ref/network/v2/index.html
+https://docs.openstack.org/keystone/latest/user/application_credentials.html
+https://www.freedesktop.org/software/systemd/man/latest/sysupdate.d.html
+
+# Our own site; links are valid once deployed, but flaky under automated checks
+https://cluster-api-openstack.sigs.k8s.io/.*

CONTRIBUTING.md

@@ -36,9 +36,10 @@ Cluster API Provider OpenStack maintains the most recent release/releases for al
 
 | API Version  | Supported Until       |
 |--------------|-----------------------|
-| **v1beta1**  | TBD (current stable)  |
+| **v1beta2**  | TBD (current stable)  |
+| **v1beta1**  | TBD (still served)    |
 
-- For the current stable API version (v1beta1) we support the two most recent minor releases; older minor releases are immediately unsupported when a new major/minor release is available.
+- For the current stable API version (v1beta2) we support the two most recent minor releases; older minor releases are immediately unsupported when a new major/minor release is available.
 - For older API versions we only support the most recent minor release until the API version reaches EOL.
 - We will maintain test coverage for all supported minor releases and for one additional release for the current stable API version in case we have to do an emergency patch release.
   For example, if v0.11 and v0.12 are currently supported, we will also maintain test coverage for v0.10 for one additional release cycle. When v0.13 is released, tests for v0.10 will be removed.
@@ -57,10 +58,11 @@ Cluster API Provider OpenStack maintains the most recent release/releases for al
 
 ### Removal of v1alpha apiVersions
 
-| Minor Release | v1beta1       | v1alpha7   | v1alpha6   | v1alpha5   |
-|---------------|---------------|------------|------------|------------|
-| v0.14.x       | **supported** |            |            |            |
-| v0.13.x       | **supported** |            |            |            |
+| Minor Release | v1beta2       | v1beta1       | v1alpha7   | v1alpha6   | v1alpha5   |
+|---------------|---------------|---------------|------------|------------|------------|
+| v0.15.x       | **supported** | **supported** |            |            |            |
+| v0.14.x       |               | **supported** |            |            |            |
+| v0.13.x       |               | **supported** |            |            |            |
 | v0.12.x       | **supported** | not served |            |            |
 | v0.11.x       | **supported** | deprecated | not served |            |
 | v0.10.x       | **supported** | supported  | deprecated | not served |

Makefile

@@ -419,7 +419,7 @@ generate-manifests: $(CONTROLLER_GEN) ## Generate manifests e.g. CRD, RBAC etc.
 		rbac:roleName=manager-role
 
 .PHONY: generate-api-docs
-generate-api-docs: generate-api-docs-v1beta1 generate-api-docs-v1alpha1
+generate-api-docs: generate-api-docs-v1beta2 generate-api-docs-v1beta1 generate-api-docs-v1alpha1
 generate-api-docs-%: $(GEN_CRD_API_REFERENCE_DOCS) FORCE
 	$(GEN_CRD_API_REFERENCE_DOCS) \
 		-api-dir=./api/$* \

docs/book/gen-crd-api-reference-docs/config.json

@@ -26,6 +26,10 @@
       {
         "typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api-provider-openstack/api/v1beta1",
         "docsURLTemplate": "https://cluster-api-openstack.sigs.k8s.io/api/v1beta1/api#infrastructure.cluster.x-k8s.io/v1beta1.{{.TypeIdentifier}}"
+      },
+      {
+        "typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api-provider-openstack/api/v1beta2",
+        "docsURLTemplate": "https://cluster-api-openstack.sigs.k8s.io/api/v1beta2/api#infrastructure.cluster.x-k8s.io/v1beta2.{{.TypeIdentifier}}"
       }
     ],
     "typeDisplayNamePrefixOverrides": {

docs/book/src/SUMMARY.md

@@ -17,8 +17,10 @@
         - [v1alpha5 to v1alpha6](./topics/crd-changes/v1alpha5-to-v1alpha6.md)
         - [v1alpha6 to v1alpha7](./topics/crd-changes/v1alpha6-to-v1alpha7.md)
         - [v1alpha7 to v1beta1](./topics/crd-changes/v1alpha7-to-v1beta1.md)
+        - [v1beta1 to v1beta2](./topics/crd-changes/v1beta1-to-v1beta2.md)
 - [API reference](./api/index.md)
     - [v1alpha1](./api/v1alpha1/api.md)
     - [v1beta1](./api/v1beta1/api.md)
+    - [v1beta2](./api/v1beta2/api.md)
 - [Development](./development/development.md)
 - [Hacking CI](./development/ci.md)