Merge pull request #1515 from shiftstack/docs

📖 Document removal of OpenStackMachineSpec.Subnet

Author: k8s-ci-robot

docs/book/src/SUMMARY.md

@@ -10,5 +10,6 @@
     - [CRD Changes](./topics/crd-changes/index.md)
         - [v1alpha4 to v1alpha5](./topics/crd-changes/v1alpha4-to-v1alpha5.md)
         - [v1alpha5 to v1alpha6](./topics/crd-changes/v1alpha5-to-v1alpha6.md)
+        - [v1alpha6 to v1alpha7](./topics/crd-changes/v1alpha6-to-v1alpha7.md)
 - [Development](./development/development.md)
 - [Hacking CI](./development/ci.md)

docs/book/src/clusteropenstack/configuration.md

@@ -5,6 +5,8 @@
 - [Required configuration](#required-configuration)
   - [OpenStack version](#openstack-version)
   - [Operating system image](#operating-system-image)
+    - [cloud-init based images](#cloud-init-based-images)
+    - [Ignition based images](#ignition-based-images)
   - [SSH key pair](#ssh-key-pair)
   - [OpenStack credential](#openstack-credential)
     - [Generate credentials](#generate-credentials)
@@ -222,7 +224,7 @@ during an upgrade. When the API server has a floating IP, this role is fulfilled
 floating IP even if there is no load balancer. When the API server does not have a floating
 IP, the load balancer virtual IP on the cluster network is used.
 
-## Restrict Access to the API server
+### Restrict Access to the API server
 
 > **NOTE**
 >

docs/book/src/development/ci.md

@@ -5,6 +5,7 @@
 - [Hacking CI for the E2E tests](#hacking-ci-for-the-e2e-tests)
   - [Prow](#prow)
   - [DevStack](#devstack)
+    - [DevStack OS](#devstack-os)
     - [Configuration](#configuration)
     - [Build order](#build-order)
     - [Networking](#networking)
@@ -25,7 +26,7 @@ The E2E tests require an OpenStack cloud to run against, which we provision duri
 
 The entry point for the creation of the test DevStack is `hack/ci/create_devstack.sh`, which is executed by `scripts/ci-e2e.sh`. We create 2 instances: `controller` and `worker`. Each will provision itself via cloud-init using config defined in `hack/ci/cloud-init`.
 
-## DevStack OS
+### DevStack OS
 
 In GCE, DevStack is installed on a community-maintained Ubuntu 20.04 LTS cloud image. The cloud-init config is also intended to work on CentOS 8, and this is known to work as of 2021-01-12. However, note that this is not regularly tested. See the comment in `hack/ci/gce-project.sh` for how to deploy on CentOS.
 

docs/book/src/development/development.md

@@ -10,7 +10,10 @@
   - [Running E2E tests locally](#running-e2e-tests-locally)
     - [Support for clouds using SSL](#support-for-clouds-using-ssl)
     - [Support for clouds with multiple external networks](#support-for-clouds-with-multiple-external-networks)
-    - [OpenStack prerequisites](#openstack-prerequisites)
+    - [E2E test environment](#e2e-test-environment)
+      - [Requirements](#requirements)
+      - [Create E2E test environment](#create-e2e-test-environment)
+        - [OpenStack](#openstack)
   - [Running E2E tests using rootless podman](#running-e2e-tests-using-rootless-podman)
     - [Host configuration](#host-configuration)
     - [Running podman system service to emulate docker daemon](#running-podman-system-service-to-emulate-docker-daemon)

docs/book/src/topics/crd-changes/v1alpha5-to-v1alpha6.md

@@ -12,8 +12,6 @@
 
 # v1alpha5 compared to v1alpha6
 
-> ⚠️ v1alpha6 has not been released yet.
-
 ## Migration
 
 All users are encouraged to migrate their usage of the CAPO CRDs from older versions to `v1alpha6`. This includes yaml files and source code. As CAPO implements automatic conversions between the CRD versions, this migration can happen after installing the new CAPO release.

docs/book/src/topics/crd-changes/v1alpha6-to-v1alpha7.md

@@ -0,0 +1,35 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [v1alpha6 compared to v1alpha7](#v1alpha6-compared-to-v1alpha7)
+  - [Migration](#migration)
+  - [API Changes](#api-changes)
+    - [`OpenStackCluster`](#openstackcluster)
+    - [`OpenStackMachine`](#openstackmachine)
+      - [Removal of Subnet](#removal-of-subnet)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# v1alpha6 compared to v1alpha7
+
+> ⚠️ v1alpha7 has not been released yet.
+
+## Migration
+
+All users are encouraged to migrate their usage of the CAPO CRDs from older versions to `v1alpha6`. This includes yaml files and source code. As CAPO implements automatic conversions between the CRD versions, this migration can happen after installing the new CAPO release.
+
+## API Changes
+
+This only documents backwards incompatible changes. Fields that were added to v1alpha6 are not listed here.
+
+### `OpenStackCluster`
+
+### `OpenStackMachine`
+
+#### Removal of Subnet
+
+The OpenStackMachine spec previously contained a `subnet` field which could used
+to set the `accessIPv4` field on Nova servers. This feature was not widely
+used, difficult to use, and could not be extended to support IPv6. It is
+removed without replacement.

docs/book/src/topics/external-cloud-provider.md

@@ -3,7 +3,7 @@
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
 
 - [External Cloud Provider](#external-cloud-provider)
-  - [Steps](#steps)
+  - [Steps of using external cloud provider template](#steps-of-using-external-cloud-provider-template)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 

hack/tools/Makefile

@@ -37,7 +37,7 @@ ifeq ($(OS), linux)
 	GTAR := tar
 endif
 
-MDBOOK_EXTRACT_COMMAND := tar xfvz $(SHARE_DIR)/mdbook.tar.gz -C bin
+MDBOOK_EXTRACT_COMMAND := tar xfvz $(SHARE_DIR)/mdbook.tar.gz -C $(BIN_DIR)
 MDBOOK_ARCHIVE_EXT := .tar.gz
 
 ifeq ($(OS), windows)
@@ -62,19 +62,19 @@ $(GTAR):
 
 
 CONTROLLER_GEN := $(BIN_DIR)/controller-gen
-$(CONTROLLER_GEN): $(BIN_DIR) go.mod go.sum # Build controller-gen from tools folder.
+$(CONTROLLER_GEN): go.mod go.sum | $(BIN_DIR) # Build controller-gen from tools folder.
 	go build -tags=tools -o $@ sigs.k8s.io/controller-tools/cmd/controller-gen
 
 CONVERSION_GEN := $(BIN_DIR)/conversion-gen
-$(CONVERSION_GEN): $(BIN_DIR) go.mod go.sum
+$(CONVERSION_GEN): go.mod go.sum | $(BIN_DIR)
 	go build -tags=tools -o $@ k8s.io/code-generator/cmd/conversion-gen
 
 DEFAULTER_GEN := $(BIN_DIR)/defaulter-gen
-$(DEFAULTER_GEN): $(BIN_DIR) go.mod go.sum
+$(DEFAULTER_GEN): go.mod go.sum | $(BIN_DIR)
 	go build -tags=tools -o $@ k8s.io/code-generator/cmd/defaulter-gen
 
 ENVSUBST := $(BIN_DIR)/envsubst
-$(ENVSUBST): $(BIN_DIR) go.mod go.sum # Build envsubst from tools folder.
+$(ENVSUBST): go.mod go.sum | $(BIN_DIR) # Build envsubst from tools folder.
 	go build -tags=tools -o $@ github.com/a8m/envsubst/cmd/envsubst
 
 GH_SHARE := $(SHARE_DIR)/gh
@@ -86,63 +86,63 @@ $(GH_SHARE)/gh.tar.gz: $(GH_SHARE)
 	curl -L "https://github.com/cli/cli/releases/download/v$(GH_VERSION)/gh_$(GH_VERSION)_$(GH_ARCH_SUFFIX).tar.gz" -o $@
 
 GH := $(BIN_DIR)/gh
-GH: $(GTAR) $(GH_SHARE)/gh.tar.gz
-	$(GTAR) -xvf share/gh/gh.tar.gz gh_$(GH_VERSION)_$(GH_ARCH_SUFFIX)/bin/gh --strip-components 1 --directory $(BIN_DIR)
+$(GH): $(GTAR) $(GH_SHARE)/gh.tar.gz | $(BIN_DIR)
+	$(GTAR) -xvf $(SHARE_DIR)/gh/gh.tar.gz gh_$(GH_VERSION)_$(GH_ARCH_SUFFIX)/bin/gh --strip-components 1 --directory $(BIN_DIR)
 	chmod +x $@
 	touch -m $@
 
 GINKGO := $(BIN_DIR)/ginkgo
-$(GINKGO): $(BIN_DIR) go.mod go.sum
+$(GINKGO): go.mod go.sum | $(BIN_DIR)
 	go build -tags=tools -o $@ github.com/onsi/ginkgo/v2/ginkgo
 
 GOJQ := $(BIN_DIR)/gojq
-$(GOJQ): $(BIN_DIR) go.mod go.sum
+$(GOJQ): go.mod go.sum | $(BIN_DIR)
 	go build -tags=tools -o $@ github.com/itchyny/gojq/cmd/gojq
 
 GOLANGCI_LINT := $(BIN_DIR)/golangci-lint
 $(GOLANGCI_LINT): Makefile ensure-golangci-lint.sh | $(BIN_DIR)
 	./ensure-golangci-lint.sh -b $(BIN_DIR) $(GOLANGCI_LINT_VERSION)
 
 KUSTOMIZE := $(BIN_DIR)/kustomize
-$(KUSTOMIZE): $(BIN_DIR) go.mod go.sum # Build kustomize from tools folder.
+$(KUSTOMIZE): go.mod go.sum | $(BIN_DIR) # Build kustomize from tools folder.
 	CGO_ENABLED=0 go build -tags=tools -o $@ sigs.k8s.io/kustomize/kustomize/v4
 
 MDBOOK_SHARE := $(SHARE_DIR)/mdbook$(MDBOOK_ARCHIVE_EXT)
 $(MDBOOK_SHARE): ../../versions.mk $(SHARE_DIR)
 	curl -sL -o $(MDBOOK_SHARE) "https://github.com/rust-lang/mdBook/releases/download/$(MDBOOK_VERSION)/mdBook-$(MDBOOK_VERSION)-x86_64-$(RUST_TARGET)$(MDBOOK_ARCHIVE_EXT)"
 
 MDBOOK := $(BIN_DIR)/mdbook
-$(MDBOOK): $(BIN_DIR) $(MDBOOK_SHARE)
+$(MDBOOK): $(MDBOOK_SHARE) | $(BIN_DIR)
 	$(MDBOOK_EXTRACT_COMMAND)
 	chmod +x $@
 	touch -m $@
 
 MDBOOK_EMBED := $(BIN_DIR)/mdbook-embed
-$(MDBOOK_EMBED): $(BIN_DIR) go.mod go.sum
+$(MDBOOK_EMBED): go.mod go.sum | $(BIN_DIR)
 	go build -tags=tools -o $(BIN_DIR)/mdbook-embed sigs.k8s.io/cluster-api/hack/tools/mdbook/embed
 
 MDBOOK_RELEASELINK := $(BIN_DIR)/mdbook-releaselink
-$(MDBOOK_RELEASELINK): $(BIN_DIR) go.mod go.sum
+$(MDBOOK_RELEASELINK): go.mod go.sum | $(BIN_DIR)
 	go build -tags=tools -o $(BIN_DIR)/mdbook-releaselink sigs.k8s.io/cluster-api/hack/tools/mdbook/releaselink
 
 MDBOOK_TABULATE := $(BIN_DIR)/mdbook-tabulate
-$(MDBOOK_TABULATE): $(BIN_DIR) go.mod go.sum
+$(MDBOOK_TABULATE): go.mod go.sum | $(BIN_DIR)
 	go build -tags=tools -o $(BIN_DIR)/mdbook-tabulate sigs.k8s.io/cluster-api/hack/tools/mdbook/tabulate
 
 MOCKGEN := $(BIN_DIR)/mockgen
-$(MOCKGEN): $(BIN_DIR) go.mod go.sum # Build mockgen from tools folder.
+$(MOCKGEN): go.mod go.sum | $(BIN_DIR) # Build mockgen from tools folder.
 	go build -tags=tools -o $@ github.com/golang/mock/mockgen
 
 RELEASE_NOTES := $(BIN_DIR)/release-notes
-$(RELEASE_NOTES): $(BIN_DIR) go.mod go.sum
+$(RELEASE_NOTES): go.mod go.sum | $(BIN_DIR)
 	go build -tags tools -o $@ sigs.k8s.io/cluster-api/hack/tools/release
 
 PLANTUML := $(BIN_DIR)/plantuml-sentinal
-$(PLANTUML): plantuml.Dockerfile ../../versions.mk
+$(PLANTUML): plantuml.Dockerfile ../../versions.mk | $(BIN_DIR)
 	docker build --build-arg PLANTUML_VERSION=$(PLANTUML_VERSION)  . -f plantuml.Dockerfile -t "plantuml-builder"
 	touch $@
 
 .PHONY: clean
 clean: ## Remove all tools
-	rm -rf bin
-	rm -rf share
+	rm -rf $(BIN_DIR)
+	rm -rf $(SHARE_DIR)