infrastructure.cluster.x-k8s.io/v1alpha1

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

Resource Types:

OpenStackClusterIdentity

OpenStackClusterIdentity is a cluster-scoped identity that centralizes OpenStack credentials.

Field Description
apiVersion
string		 infrastructure.cluster.x-k8s.io/v1alpha1
kind
string 		OpenStackClusterIdentity
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
OpenStackClusterIdentitySpec

secretRef
OpenStackCredentialSecretReference

SecretRef references the credentials Secret containing a clouds.yaml file.
namespaceSelector
Kubernetes meta/v1.LabelSelector 		(Optional)

NamespaceSelector limits which namespaces may use this identity. If nil, all namespaces are allowed.

OpenStackServer

OpenStackServer is the Schema for the openstackservers API.

Field Description
apiVersion
string		 infrastructure.cluster.x-k8s.io/v1alpha1
kind
string 		OpenStackServer
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
OpenStackServerSpec

additionalBlockDevices
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.AdditionalBlockDevice 		(Optional)

AdditionalBlockDevices is a list of specifications for additional block devices to attach to the server instance.
availabilityZone
string 		(Optional)

AvailabilityZone is the availability zone in which to create the server instance.
configDrive
bool 		(Optional)

ConfigDrive is a flag to enable config drive for the server instance.
flavor
string 		(Optional)

The flavor reference for the flavor for the server instance.
flavorID
string 		(Optional)

FlavorID allows flavors to be specified by ID. This field takes precedence over Flavor.
floatingIPPoolRef
Kubernetes core/v1.TypedLocalObjectReference 		(Optional)

FloatingIPPoolRef is a reference to a FloatingIPPool to allocate a floating IP from.
identityRef
sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.OpenStackIdentityReference

IdentityRef is a reference to a secret holding OpenStack credentials.
image
sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.ImageParam

The image to use for the server instance.
ports
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.PortOpts

Ports to be attached to the server instance.
rootVolume
sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.RootVolume 		(Optional)

RootVolume is the specification for the root volume of the server instance.
sshKeyName
string

SSHKeyName is the name of the SSH key to inject in the instance.
securityGroups
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.SecurityGroupParam 		(Optional)

SecurityGroups is a list of security groups names to assign to the instance.
serverGroup
sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.ServerGroupParam 		(Optional)

ServerGroup is the server group to which the server instance belongs.
serverMetadata
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.ServerMetadata 		(Optional)

ServerMetadata is a map of key value pairs to add to the server instance.
tags
[]string

Tags which will be added to the machine and all dependent resources which support them. These are in addition to Tags defined on the cluster. Requires Nova api 2.52 minimum!
trunk
bool 		(Optional)

Trunk is a flag to indicate if the server instance is created on a trunk port or not.
userDataRef
Kubernetes core/v1.LocalObjectReference 		(Optional)

UserDataRef is a reference to a secret containing the user data to be injected into the server instance.
schedulerHintAdditionalProperties
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.SchedulerHintAdditionalProperty 		(Optional)

SchedulerHintAdditionalProperties are arbitrary key/value pairs that provide additional hints to the OpenStack scheduler. These hints can influence how instances are placed on the infrastructure, such as specifying certain host aggregates or availability zones.
status
OpenStackServerStatus

OpenStackClusterIdentitySpec

(Appears on: OpenStackClusterIdentity)

OpenStackClusterIdentitySpec defines the desired state for an OpenStackClusterIdentity.

Field Description
secretRef
OpenStackCredentialSecretReference

SecretRef references the credentials Secret containing a clouds.yaml file.
namespaceSelector
Kubernetes meta/v1.LabelSelector 		(Optional)

NamespaceSelector limits which namespaces may use this identity. If nil, all namespaces are allowed.

OpenStackCredentialSecretReference

(Appears on: OpenStackClusterIdentitySpec)

OpenStackCredentialSecretReference references a Secret containing OpenStack credentials.

Field Description
name
string

Name of the Secret which contains a clouds.yaml key (and optionally cacert).
namespace
string

Namespace where the Secret resides.

OpenStackFloatingIPPool

OpenStackFloatingIPPool is the Schema for the openstackfloatingippools API.

Field Description
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.

Field Description
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.

Field Description
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/core/v1beta1.Conditions

OpenStackServerSpec

(Appears on: OpenStackServer)

OpenStackServerSpec defines the desired state of OpenStackServer.

Field Description
additionalBlockDevices
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.AdditionalBlockDevice 		(Optional)

AdditionalBlockDevices is a list of specifications for additional block devices to attach to the server instance.
availabilityZone
string 		(Optional)

AvailabilityZone is the availability zone in which to create the server instance.
configDrive
bool 		(Optional)

ConfigDrive is a flag to enable config drive for the server instance.
flavor
string 		(Optional)

The flavor reference for the flavor for the server instance.
flavorID
string 		(Optional)

FlavorID allows flavors to be specified by ID. This field takes precedence over Flavor.
floatingIPPoolRef
Kubernetes core/v1.TypedLocalObjectReference 		(Optional)

FloatingIPPoolRef is a reference to a FloatingIPPool to allocate a floating IP from.
identityRef
sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.OpenStackIdentityReference

IdentityRef is a reference to a secret holding OpenStack credentials.
image
sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.ImageParam

The image to use for the server instance.
ports
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.PortOpts

Ports to be attached to the server instance.
rootVolume
sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.RootVolume 		(Optional)

RootVolume is the specification for the root volume of the server instance.
sshKeyName
string

SSHKeyName is the name of the SSH key to inject in the instance.
securityGroups
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.SecurityGroupParam 		(Optional)

SecurityGroups is a list of security groups names to assign to the instance.
serverGroup
sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.ServerGroupParam 		(Optional)

ServerGroup is the server group to which the server instance belongs.
serverMetadata
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.ServerMetadata 		(Optional)

ServerMetadata is a map of key value pairs to add to the server instance.
tags
[]string

Tags which will be added to the machine and all dependent resources which support them. These are in addition to Tags defined on the cluster. Requires Nova api 2.52 minimum!
trunk
bool 		(Optional)

Trunk is a flag to indicate if the server instance is created on a trunk port or not.
userDataRef
Kubernetes core/v1.LocalObjectReference 		(Optional)

UserDataRef is a reference to a secret containing the user data to be injected into the server instance.
schedulerHintAdditionalProperties
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.SchedulerHintAdditionalProperty 		(Optional)

SchedulerHintAdditionalProperties are arbitrary key/value pairs that provide additional hints to the OpenStack scheduler. These hints can influence how instances are placed on the infrastructure, such as specifying certain host aggregates or availability zones.

OpenStackServerStatus

(Appears on: OpenStackServer)

OpenStackServerStatus defines the observed state of OpenStackServer.

Field Description
ready
bool

Ready is true when the OpenStack server is ready.
instanceID
string 		(Optional)

InstanceID is the ID of the server instance.
instanceState
sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.InstanceState 		(Optional)

InstanceState is the state of the server instance.
addresses
[]Kubernetes core/v1.NodeAddress 		(Optional)

Addresses is the list of addresses of the server instance.
resolved
ResolvedServerSpec 		(Optional)

Resolved contains parts of the machine spec with all external references fully resolved.
resources
ServerResources 		(Optional)

Resources contains references to OpenStack resources created for the machine.
conditions
sigs.k8s.io/cluster-api/api/core/v1beta1.Conditions 		(Optional)

Conditions defines current service state of the OpenStackServer.

ReclaimPolicy (string alias)

(Appears on: OpenStackFloatingIPPoolSpec)

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

Value Description

"Delete"

ReclaimDelete is the reclaim policy for floating ips.

"Retain"

ReclaimRetain is the reclaim policy for floating ips.

ResolvedServerSpec

(Appears on: OpenStackServerStatus)

ResolvedServerSpec contains resolved references to resources required by the server.

Field Description
serverGroupID
string 		(Optional)

ServerGroupID is the ID of the server group the server should be added to and is calculated based on ServerGroupFilter.
imageID
string 		(Optional)

ImageID is the ID of the image to use for the server and is calculated based on ImageFilter.
flavorID
string 		(Optional)

FlavorID is the ID of the flavor to use.
ports
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.ResolvedPortSpec 		(Optional)

Ports is the fully resolved list of ports to create for the server.

ServerResources

(Appears on: OpenStackServerStatus)

ServerResources contains references to OpenStack resources created for the server.

Field Description
ports
[]sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1.PortStatus 		(Optional)

Ports is the status of the ports created for the server.

ServerStatusError (string alias)

Value Description

"CreateError"

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