Skip to content

api.md

Latest commit

 

History

History
2115 lines (2115 loc) · 38 KB

api.md

File metadata and controls

2115 lines (2115 loc) · 38 KB

Packages:

openstack.provider.extensions.gardener.cloud/v1alpha1

Package v1alpha1 contains the OpenStack provider API resources.

Resource Types:

CloudProfileConfig

CloudProfileConfig contains provider-specific configuration that is embedded into Gardener’s CloudProfile resource.

Field Description
apiVersion
string		 openstack.provider.extensions.gardener.cloud/v1alpha1
kind
string 		CloudProfileConfig
constraints
Constraints

Constraints is an object containing constraints for certain values in the control plane config.
dnsServers
[]string 		(Optional)

DNSServers is a list of IPs of DNS servers used while creating subnets.
dhcpDomain
string 		(Optional)

DHCPDomain is the dhcp domain of the OpenStack system configured in nova.conf. Only meaningful for Kubernetes 1.10.1+. See kubernetes/kubernetes#61890 for details.
keystoneURL
string 		(Optional)

KeyStoneURL is the URL for auth{n,z} in OpenStack (pointing to KeyStone).
keystoneCACert
string 		(Optional)

KeystoneCACert is the CA Bundle for the KeyStoneURL.
keystoneForceInsecure
bool 		(Optional)

KeyStoneForceInsecure is a flag to control whether the OpenStack client should perform no certificate validation.
keystoneURLs
[]KeyStoneURL 		(Optional)

KeyStoneURLs is a region-URL mapping for auth{n,z} in OpenStack (pointing to KeyStone).
machineImages
[]MachineImages

MachineImages is the list of machine images that are understood by the controller. It maps logical names and versions to provider-specific identifiers.
requestTimeout
Kubernetes meta/v1.Duration 		(Optional)

RequestTimeout specifies the HTTP timeout against the OpenStack API.
rescanBlockStorageOnResize
bool 		(Optional)

RescanBlockStorageOnResize specifies whether the storage plugin scans and checks new block device size before it resizes the filesystem.
ignoreVolumeAZ
bool 		(Optional)

IgnoreVolumeAZ specifies whether the volumes AZ should be ignored when scheduling to nodes, to allow for differences between volume and compute zone naming.
nodeVolumeAttachLimit
int32 		(Optional)

NodeVolumeAttachLimit specifies how many volumes can be attached to a node.
useSNAT
bool 		(Optional)

UseSNAT specifies whether S-NAT is supposed to be used for the Gardener managed OpenStack router.
serverGroupPolicies
[]string 		(Optional)

ServerGroupPolicies specify the allowed server group policies for worker groups.
resolvConfOptions
[]string 		(Optional)

ResolvConfOptions specifies options to be added to /etc/resolv.conf on workers
storageClasses
[]StorageClassDefinition 		(Optional)

StorageClasses defines storageclasses for the shoot

ControlPlaneConfig

ControlPlaneConfig contains configuration settings for the control plane.

Field Description
apiVersion
string		 openstack.provider.extensions.gardener.cloud/v1alpha1
kind
string 		ControlPlaneConfig
cloudControllerManager
CloudControllerManagerConfig 		(Optional)

CloudControllerManager contains configuration settings for the cloud-controller-manager.
loadBalancerClasses
[]LoadBalancerClass 		(Optional)

LoadBalancerClasses available for a dedicated Shoot.
loadBalancerProvider
string

LoadBalancerProvider is the name of the load balancer provider in the OpenStack environment.
zone
string 		(Optional)

Zone is the OpenStack zone. Deprecated: Don’t use anymore. Will be removed in a future version.
storage
Storage 		(Optional)

Storage contains configuration for storage in the cluster.

InfrastructureConfig

InfrastructureConfig infrastructure configuration resource

Field Description
apiVersion
string		 openstack.provider.extensions.gardener.cloud/v1alpha1
kind
string 		InfrastructureConfig
floatingPoolName
string

FloatingPoolName contains the FloatingPoolName name in which LoadBalancer FIPs should be created.
floatingPoolSubnetName
string 		(Optional)

FloatingPoolSubnetName contains the fixed name of subnet or matching name pattern for subnet in the Floating IP Pool where the router should be attached to.
networks
Networks

Networks is the OpenStack specific network configuration

WorkerStatus

WorkerStatus contains information about created worker resources.

Field Description
apiVersion
string		 openstack.provider.extensions.gardener.cloud/v1alpha1
kind
string 		WorkerStatus
machineImages
[]MachineImage 		(Optional)

MachineImages is a list of machine images that have been used in this worker. Usually, the extension controller gets the mapping from name/version to the provider-specific machine image data in its componentconfig. However, if a version that is still in use gets removed from this componentconfig it cannot reconcile anymore existing Worker resources that are still using this version. Hence, it stores the used versions in the provider status to ensure reconciliation is possible.
serverGroupDependencies
[]ServerGroupDependency 		(Optional)

ServerGroupDependencies is a list of external server group dependencies.

CSIManila

(Appears on: Storage)

CSIManila contains configuration for CSI Manila driver (support for NFS volumes)

Field Description
enabled
bool

Enabled is the switch to enable the CSI Manila driver support

CloudControllerManagerConfig

(Appears on: ControlPlaneConfig)

CloudControllerManagerConfig contains configuration settings for the cloud-controller-manager.

Field Description
featureGates
map[string]bool 		(Optional)

FeatureGates contains information about enabled feature gates.

Constraints

(Appears on: CloudProfileConfig)

Constraints is an object containing constraints for the shoots.

Field Description
floatingPools
[]FloatingPool

FloatingPools contains constraints regarding allowed values of the ‘floatingPoolName’ block in the control plane config.
loadBalancerProviders
[]LoadBalancerProvider

LoadBalancerProviders contains constraints regarding allowed values of the ‘loadBalancerProvider’ block in the control plane config.

FloatingPool

(Appears on: Constraints)

FloatingPool contains constraints regarding allowed values of the ‘floatingPoolName’ block in the control plane config.

Field Description
name
string

Name is the name of the floating pool.
region
string 		(Optional)

Region is the region name.
domain
string 		(Optional)

Domain is the domain name.
defaultFloatingSubnet
string 		(Optional)

DefaultFloatingSubnet is the default floating subnet for the floating pool.
nonConstraining
bool 		(Optional)

NonConstraining specifies whether this floating pool is not constraining, that means additionally available independent of other FP constraints.
loadBalancerClasses
[]LoadBalancerClass 		(Optional)

LoadBalancerClasses contains a list of supported labeled load balancer network settings.

FloatingPoolStatus

(Appears on: NetworkStatus)

FloatingPoolStatus contains information about the floating pool.

Field Description
id
string

ID is the floating pool id.
name
string

Name is the floating pool name.

InfrastructureState

InfrastructureState is the state which is persisted as part of the infrastructure status.

Field Description
data
map[string]string

InfrastructureStatus

InfrastructureStatus contains information about created infrastructure resources.

Field Description
networks
NetworkStatus

Networks contains information about the created Networks and some related resources.
node
NodeStatus

Node contains information about Node related resources.
securityGroups
[]SecurityGroup

SecurityGroups is a list of security groups that have been created.

KeyStoneURL

(Appears on: CloudProfileConfig)

KeyStoneURL is a region-URL mapping for auth{n,z} in OpenStack (pointing to KeyStone).

Field Description
region
string

Region is the name of the region.
url
string

URL is the keystone URL.
caCert
string

CACert is the CA Bundle for the KeyStoneURL.

LoadBalancerClass

(Appears on: ControlPlaneConfig, FloatingPool)

LoadBalancerClass defines a restricted network setting for generic LoadBalancer classes.

Field Description
name
string

Name is the name of the LB class
purpose
string 		(Optional)

Purpose is reflecting if the loadbalancer class has a special purpose e.g. default, internal.
floatingSubnetID
string 		(Optional)

FloatingSubnetID is the subnetwork ID of a dedicated subnet in floating network pool.
floatingSubnetTags
string 		(Optional)

FloatingSubnetTags is a list of tags which can be used to select subnets in the floating network pool.
floatingSubnetName
string 		(Optional)

FloatingSubnetName is can either be a name or a name pattern of a subnet in the floating network pool.
floatingNetworkID
string 		(Optional)

FloatingNetworkID is the network ID of the floating network pool.
subnetID
string 		(Optional)

SubnetID is the ID of a local subnet used for LoadBalancer provisioning. Only usable if no FloatingPool configuration is done.

LoadBalancerProvider

(Appears on: Constraints)

LoadBalancerProvider contains constraints regarding allowed values of the ‘loadBalancerProvider’ block in the control plane config.

Field Description
name
string

Name is the name of the load balancer provider.
region
string 		(Optional)

Region is the region name.

MachineImage

(Appears on: WorkerStatus)

MachineImage is a mapping from logical names and versions to provider-specific machine image data.

Field Description
name
string

Name is the logical name of the machine image.
version
string

Version is the logical version of the machine image.
image
string

Image is the name of the image.
id
string

ID is the id of the image. (one of Image or ID must be set)
architecture
string 		(Optional)

Architecture is the CPU architecture of the machine image
capabilities
github.com/gardener/gardener/pkg/apis/core/v1beta1.Capabilities

Capabilities of the machine image.

MachineImageFlavor

(Appears on: MachineImageVersion)

MachineImageFlavor groups all RegionAMIMappings for a specific set of capabilities.

Field Description
regions
[]RegionIDMapping

Regions is a mapping to the correct Image ID for the machine image in the supported regions.
image
string

Image is the name of the image.
capabilities
github.com/gardener/gardener/pkg/apis/core/v1beta1.Capabilities

Capabilities that are supported by the Image ID in this set.

MachineImageVersion

(Appears on: MachineImages)

MachineImageVersion contains a version and a provider-specific identifier.

Field Description
version
string

Version is the version of the image.
image
string

Image is the name of the image.
regions
[]RegionIDMapping

Regions is an optional mapping to the correct Image ID for the machine image in the supported regions.
capabilityFlavors
[]MachineImageFlavor

CapabilityFlavors is grouping of region AMIs by capabilities.

MachineImages

(Appears on: CloudProfileConfig)

MachineImages is a mapping from logical names and versions to provider-specific identifiers.

Field Description
name
string

Name is the logical name of the machine image.
versions
[]MachineImageVersion

Versions contains versions and a provider-specific identifier.

MachineLabel

(Appears on: WorkerConfig)

MachineLabel define key value pair to label machines.

Field Description
name
string

Name is the machine label key
value
string

Value is the machine label value
triggerRollingOnUpdate
bool

TriggerRollingOnUpdate controls if the machines should be rolled if the value changes

NetworkStatus

(Appears on: InfrastructureStatus)

NetworkStatus contains information about a generated Network or resources created in an existing Network.

Field Description
id
string

ID is the Network id.
name
string

Name is the Network name.
floatingPool
FloatingPoolStatus

FloatingPool contains information about the floating pool.
router
RouterStatus

Router contains information about the Router and related resources.
subnets
[]Subnet

Subnets is a list of subnets that have been created.
shareNetwork
ShareNetworkStatus 		(Optional)

ShareNetwork contains information about a created/provided ShareNetwork

Networks

(Appears on: InfrastructureConfig)

Networks holds information about the Kubernetes and infrastructure networks.

Field Description
router
Router 		(Optional)

Router indicates whether to use an existing router or create a new one.
worker
string

Worker is a CIDRs of a worker subnet (private) to create (used for the VMs). Deprecated: use workers instead.
workers
string

Workers is a CIDRs of a worker subnet (private) to create (used for the VMs).
id
string 		(Optional)

ID is the ID of an existing private network.
shareNetwork
ShareNetwork 		(Optional)

ShareNetwork holds information about the share network (used for shared file systems like NFS)

NodeStatus

(Appears on: InfrastructureStatus)

NodeStatus contains information about Node related resources.

Field Description
keyName
string

KeyName is the name of the SSH key.

Purpose (string alias)

(Appears on: SecurityGroup, Subnet)

Purpose is a purpose of a resource.

RegionIDMapping

(Appears on: MachineImageFlavor, MachineImageVersion)

RegionIDMapping is a mapping to the correct ID for the machine image in the given region.

Field Description
name
string

Name is the name of the region.
id
string

ID is the ID for the machine image in the given region.
architecture
string 		(Optional)

Architecture is the CPU architecture of the machine image

Router

(Appears on: Networks)

Router indicates whether to use an existing router or create a new one.

Field Description
id
string

ID is the router id of an existing OpenStack router.

RouterStatus

(Appears on: NetworkStatus)

RouterStatus contains information about a generated Router or resources attached to an existing Router.

Field Description
id
string

ID is the Router id.
ip
string

IP is the router ip. Deprecated: use ExternalFixedIPs instead.
externalFixedIP
[]string

ExternalFixedIPs is the list of the router’s assigned external fixed IPs.

SecurityGroup

(Appears on: InfrastructureStatus)

SecurityGroup is an OpenStack security group related to a Network.

Field Description
purpose
Purpose

Purpose is a logical description of the security group.
id
string

ID is the security group id.
name
string

Name is the security group name.

ServerGroup

(Appears on: WorkerConfig)

ServerGroup contains configuration data for setting up a server group.

Field Description
policy
string

Policy describes the kind of affinity policy for instances of the server group. https://docs.openstack.org/python-openstackclient/ussuri/cli/command-objects/server-group.html

ServerGroupDependency

(Appears on: WorkerStatus)

ServerGroupDependency is a reference to an external machine dependency of OpenStack server groups.

Field Description
poolName
string

PoolName identifies the worker pool that this dependency belongs
id
string

ID is the provider’s generated ID for a server group
name
string

Name is the name of the server group

ShareNetwork

(Appears on: Networks)

ShareNetwork holds information about the share network (used for shared file systems like NFS)

Field Description
enabled
bool

Enabled is the switch to enable the creation of a share network

ShareNetworkStatus

(Appears on: NetworkStatus)

ShareNetworkStatus contains information about a generated ShareNetwork

Field Description
id
string

ID is the Network id.
name
string

Name is the Network name.

Storage

(Appears on: ControlPlaneConfig)

Storage contains configuration for storage in the cluster.

Field Description
csiManila
CSIManila 		(Optional)

CSIManila contains configuration for CSI Manila driver (support for NFS volumes)

StorageClassDefinition

(Appears on: CloudProfileConfig)

StorageClassDefinition is a definition of a storageClass

Field Description
name
string

Name is the name of the storageclass
default
bool 		(Optional)

Default set the storageclass to the default one
provisioner
string 		(Optional)

Provisioner set the Provisioner inside the storageclass
parameters
map[string]string 		(Optional)

Parameters adds parameters to the storageclass (storageclass.parameters)
annotations
map[string]string 		(Optional)

Annotations sets annotations for the storageclass
labels
map[string]string 		(Optional)

Labels sets labels for the storageclass
reclaimPolicy
string 		(Optional)

ReclaimPolicy sets reclaimPolicy for the storageclass
volumeBindingMode
string 		(Optional)

VolumeBindingMode sets bindingMode for the storageclass

Subnet

(Appears on: NetworkStatus)

Subnet is an OpenStack subnet related to a Network.

Field Description
purpose
Purpose

Purpose is a logical description of the subnet.
id
string

ID is the subnet id.

WorkerConfig

WorkerConfig contains configuration data for a worker pool.

Field Description
nodeTemplate
github.com/gardener/gardener/pkg/apis/extensions/v1alpha1.NodeTemplate

NodeTemplate contains resource information of the machine which is used by Cluster Autoscaler to generate nodeTemplate during scaling a nodeGroup from zero.
serverGroup
ServerGroup

ServerGroup contains configuration data for the worker pool’s server group. If this object is present, OpenStack provider extension will try to create a new server group for instances of this worker pool.
machineLabels
[]MachineLabel

MachineLabels define key value pairs to add to machines.

Generated with gen-crd-api-reference-docs