-
Package v1alpha1 is a version of the API.
+ -Resource Types: --
MachineProviderConfig contains OpenStack specific configuration for a machine.
+MachineProviderConfig contains OpenStack specific configuration for a machine. +
spec
-
-MachineProviderConfigSpec
-
+MachineProviderConfigSpec
|
(Optional)
- - -
|
-(Appears on: -MachineProviderConfig) +(Appears on:MachineProviderConfig)
+-
MachineProviderConfigSpec contains provider specific configuration for creating and managing machines.
+MachineProviderConfigSpec contains provider specific configuration for creating and managing machines. +
imageID
@@ -338,7 +135,7 @@ string
|
securityGroups
-[]string
+string array
|
@@ -349,11 +146,11 @@ string |
tags
-map[string]string
+object (keys:string, values:string)
|
- Tags is a map of key-value pairs that annotate the instance. Tags are stored in the instance’s Metadata field. +Tags is a map of key-value pairs that annotate the instance. Tags are stored in the instance's Metadata field. |
|||
|
(Optional)
- SubnetID is the ID of the subnet the instance should belong to.
-Deprecated - use SubnetID is the ID of the subnet the instance should belong to. |
|||||||
subnetIDs
-[]string
+string array
|
@@ -401,15 +197,14 @@ string |
(Optional)
- PodNetworkCidr is the CIDR range for the pods assigned to this instance. -Deprecated: use PodNetworkCIDRs instead +PodNetworkCidr is the CIDR range for the pods assigned to this instance. |
|||||
podNetworkCIDRs
-[]string
+string array
|
@@ -421,7 +216,7 @@ Deprecated: use PodNetworkCIDRs instead |
rootDiskSize
-int
+integer
|
@@ -444,7 +239,7 @@ string |
useConfigDrive
-bool
+boolean
|
@@ -467,27 +262,30 @@ string |
networks
-
-[]OpenStackNetwork
-
+OpenStackNetwork array
|
- Networks is a list of networks the instance should belong to. Networks is mutually exclusive with the NetworkID option -and only one should be specified. +Networks is a list of networks the instance should belong to. Networks is mutually exclusive with the NetworkID option |
-(Appears on: -MachineProviderConfigSpec) +(Appears on:MachineProviderConfigSpec)
+-
OpenStackNetwork describes a network this instance should belong to.
+OpenStackNetwork describes a network this instance should belong to. +
id
@@ -522,16 +321,15 @@ string
|
podNetwork
-bool
+boolean
|
PodNetwork specifies whether this network is part of the pod network. |
-Generated with gen-crd-api-reference-docs -
+ + diff --git a/hack/api-reference/api.yaml b/hack/api-reference/api.yaml new file mode 100644 index 00000000..0e420f64 --- /dev/null +++ b/hack/api-reference/api.yaml @@ -0,0 +1,23 @@ +# SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and Gardener contributors +# +# SPDX-License-Identifier: Apache-2.0 + +processor: + ignoreFields: + - "TypeMeta" + ignoreTypes: + - "ParseError$" + - "List$" + +render: + kubernetesVersion: "1.33" + knownTypes: + - name: Duration + package: k8s.io/apimachinery/pkg/apis/meta/v1 + link: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration + - name: RawExtension + package: k8s.io/apimachinery/pkg/runtime + link: https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension + - name: IntOrString + package: k8s.io/apimachinery/pkg/util/intstr + link: https://pkg.go.dev/k8s.io/apimachinery/pkg/util/intstr#IntOrString diff --git a/hack/tools.go b/hack/tools.go index 154d6fb1..c6b15ff1 100644 --- a/hack/tools.go +++ b/hack/tools.go @@ -9,10 +9,9 @@ package tools import ( - _ "github.com/ahmetb/gen-crd-api-reference-docs" + _ "github.com/elastic/crd-ref-docs" _ "github.com/gardener/gardener/hack" _ "github.com/gardener/gardener/hack/.ci" - _ "github.com/gardener/gardener/hack/api-reference/template" _ "github.com/gardener/gardener/pkg/apis" _ "github.com/onsi/ginkgo/v2" _ "github.com/onsi/gomega" diff --git a/pkg/apis/openstack/v1alpha1/doc.go b/pkg/apis/openstack/v1alpha1/doc.go index f9a2b460..7feb5208 100644 --- a/pkg/apis/openstack/v1alpha1/doc.go +++ b/pkg/apis/openstack/v1alpha1/doc.go @@ -8,7 +8,7 @@ // +k8s:openapi-gen=true // +groupName=openstack.machine.gardener.cloud -//go:generate sh -c "gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/api.json -template-dir $GARDENER_HACK_DIR/api-reference/template -out-file ../../../../hack/api-reference/api.md" +//go:generate crd-ref-docs --source-path=. --config=../../../../hack/api-reference/api.yaml --renderer=markdown --templates-dir=$GARDENER_HACK_DIR/api-reference/template --log-level=ERROR --output-path=../../../../hack/api-reference/api.md // Package v1alpha1 is a version of the API. package v1alpha1