From 8249e4f2691c69606aa6d88654346b803cf2bddf Mon Sep 17 00:00:00 2001 From: Matthew Booth Date: Tue, 2 Apr 2024 14:27:51 +0100 Subject: [PATCH] Add API docs for v1alpha1 --- Makefile | 2 +- api/v1alpha1/doc.go | 3 + .../gen-crd-api-reference-docs/config.json | 12 +- docs/book/src/api/v1alpha1/api.md | 317 ++++++++++++++++++ docs/book/src/api/v1beta1/api.md | 10 +- 5 files changed, 332 insertions(+), 12 deletions(-) create mode 100644 docs/book/src/api/v1alpha1/api.md diff --git a/Makefile b/Makefile index 8b905651da..67f5b6ac16 100644 --- a/Makefile +++ b/Makefile @@ -289,7 +289,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-v1alpha7 generate-api-docs-v1alpha6 +generate-api-docs: generate-api-docs-v1beta1 generate-api-docs-v1alpha7 generate-api-docs-v1alpha6 generate-api-docs-v1alpha1 generate-api-docs-%: $(GEN_CRD_API_REFERENCE_DOCS) FORCE $(GEN_CRD_API_REFERENCE_DOCS) \ -api-dir=./api/$* \ diff --git a/api/v1alpha1/doc.go b/api/v1alpha1/doc.go index 7fff087c61..367506620a 100644 --- a/api/v1alpha1/doc.go +++ b/api/v1alpha1/doc.go @@ -14,4 +14,7 @@ See the License for the specific language governing permissions and limitations under the License. */ +// package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group +// +kubebuilder:object:generate=true +// +groupName=infrastructure.cluster.x-k8s.io package v1alpha1 diff --git a/docs/book/gen-crd-api-reference-docs/config.json b/docs/book/gen-crd-api-reference-docs/config.json index 5c4e964917..840ab6b56d 100644 --- a/docs/book/gen-crd-api-reference-docs/config.json +++ b/docs/book/gen-crd-api-reference-docs/config.json @@ -17,15 +17,15 @@ }, { "typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api/api/v1beta1", - "docsURLTemplate": "https://doc.crds.dev/github.com/kubernetes-sigs/cluster-api@v1.5.1" - }, - { - "typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api/api/v1beta1", - "docsURLTemplate": "https://doc.crds.dev/github.com/kubernetes-sigs/cluster-api@v1.5.1" + "docsURLTemplate": "https://doc.crds.dev/github.com/kubernetes-sigs/cluster-api@v1.6.0" }, { "typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api/errors", "docsURLTemplate": "https://pkg.go.dev/sigs.k8s.io/cluster-api@v1.5.1/errors#{{.TypeIdentifier}}" + }, + { + "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}}" } ], "typeDisplayNamePrefixOverrides": { @@ -33,4 +33,4 @@ "k8s.io/apimachinery/pkg/apis/": "Kubernetes " }, "markdownDisabled": false - } \ No newline at end of file + } diff --git a/docs/book/src/api/v1alpha1/api.md b/docs/book/src/api/v1alpha1/api.md new file mode 100644 index 0000000000..fa456a74f9 --- /dev/null +++ b/docs/book/src/api/v1alpha1/api.md @@ -0,0 +1,317 @@ +

infrastructure.cluster.x-k8s.io/v1alpha1

+

+

package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group

+

+Resource Types: + +

OpenStackFloatingIPPool +

+

+

OpenStackFloatingIPPool is the Schema for the openstackfloatingippools API.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ +Kubernetes meta/v1.ObjectMeta + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +OpenStackFloatingIPPoolSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + +
+preAllocatedFloatingIPs
+ +[]string + +		 +

PreAllocatedFloatingIPs is a list of floating IPs precreated in OpenStack that should be used by this pool. +These are used before allocating new ones and are not deleted from OpenStack when the pool is deleted.

+
+maxIPs
+ +int + +		 +(Optional) +

MaxIPs is the maximum number of floating ips that can be allocated from this pool, if nil there is no limit. +If set, the pool will stop allocating floating ips when it reaches this number of ClaimedIPs.

+
+identityRef
+ + +sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.OpenStackIdentityReference + + +		 +

IdentityRef is a reference to a identity to be used when reconciling this pool.

+
+floatingIPNetwork
+ + +sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.NetworkParam + + +		 +(Optional) +

FloatingIPNetwork is the external network to use for floating ips, if there’s only one external network it will be used by default

+
+reclaimPolicy
+ + +ReclaimPolicy + + +		 +

The stratergy to use for reclaiming floating ips when they are released from a machine

+
+
+status
+ + +OpenStackFloatingIPPoolStatus + + +		 +
+

OpenStackFloatingIPPoolSpec +

+

+(Appears on: +OpenStackFloatingIPPool) +

+

+

OpenStackFloatingIPPoolSpec defines the desired state of OpenStackFloatingIPPool.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+preAllocatedFloatingIPs
+ +[]string + +		 +

PreAllocatedFloatingIPs is a list of floating IPs precreated in OpenStack that should be used by this pool. +These are used before allocating new ones and are not deleted from OpenStack when the pool is deleted.

+
+maxIPs
+ +int + +		 +(Optional) +

MaxIPs is the maximum number of floating ips that can be allocated from this pool, if nil there is no limit. +If set, the pool will stop allocating floating ips when it reaches this number of ClaimedIPs.

+
+identityRef
+ + +sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.OpenStackIdentityReference + + +		 +

IdentityRef is a reference to a identity to be used when reconciling this pool.

+
+floatingIPNetwork
+ + +sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.NetworkParam + + +		 +(Optional) +

FloatingIPNetwork is the external network to use for floating ips, if there’s only one external network it will be used by default

+
+reclaimPolicy
+ + +ReclaimPolicy + + +		 +

The stratergy to use for reclaiming floating ips when they are released from a machine

+
+

OpenStackFloatingIPPoolStatus +

+

+(Appears on: +OpenStackFloatingIPPool) +

+

+

OpenStackFloatingIPPoolStatus defines the observed state of OpenStackFloatingIPPool.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+claimedIPs
+ +[]string + +		 +(Optional) +
+availableIPs
+ +[]string + +		 +(Optional) +
+failedIPs
+ +[]string + +		 +(Optional) +

FailedIPs contains a list of floating ips that failed to be allocated

+
+floatingIPNetwork
+ + +sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.NetworkStatus + + +		 +(Optional) +

floatingIPNetwork contains information about the network used for floating ips

+
+conditions
+ + +sigs.k8s.io/cluster-api/api/v1beta1.Conditions + + +		 +
+

ReclaimPolicy +(string alias)

+

+(Appears on: +OpenStackFloatingIPPoolSpec) +

+

+

ReclaimPolicy is a string type alias to represent reclaim policies for floating ips.

+

+ + + + + + + + + + + + +
ValueDescription

"Delete"

ReclaimDelete is the reclaim policy for floating ips.

+

"Retain"

ReclaimRetain is the reclaim policy for floating ips.

+
+
+

+Generated with gen-crd-api-reference-docs. +

diff --git a/docs/book/src/api/v1beta1/api.md b/docs/book/src/api/v1beta1/api.md index c29f255954..715cdc5b94 100644 --- a/docs/book/src/api/v1beta1/api.md +++ b/docs/book/src/api/v1beta1/api.md @@ -331,7 +331,7 @@ Kubernetes cluster, which also disables SecurityGroups

controlPlaneEndpoint
- + sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint @@ -2337,7 +2337,7 @@ Kubernetes cluster, which also disables SecurityGroups

controlPlaneEndpoint
- + sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint @@ -2502,7 +2502,7 @@ LoadBalancer failureDomains
- + sigs.k8s.io/cluster-api/api/v1beta1.FailureDomains @@ -2919,7 +2919,7 @@ Kubernetes cluster, which also disables SecurityGroups

controlPlaneEndpoint
- + sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint @@ -3426,7 +3426,7 @@ controller’s output.

conditions
- + sigs.k8s.io/cluster-api/api/v1beta1.Conditions