Skip to content

API Reference

Packages

openstack.k-orc.cloud/v1alpha1

Package v1alpha1 contains API Schema definitions for the openstack v1alpha1 API group

Package v1alpha1 contains API Schema definitions for the openstack v1alpha1 API group

Resource Types

Address

Appears in: - PortResourceSpec

Field Description Default Validation
ip IPvAny ip contains a fixed IP address assigned to the port. It must belong
to the referenced subnet's CIDR. If not specified, OpenStack
allocates an available IP from the referenced subnet.		 MaxLength: 45
MinLength: 1
subnetRef KubernetesNameRef subnetRef references the subnet from which to allocate the IP
address.		 MaxLength: 253
MinLength: 1

AllocationPool

Appears in: - SubnetResourceSpec

Field Description Default Validation
start IPvAny start is the first IP address in the allocation pool. MaxLength: 45
MinLength: 1
end IPvAny end is the last IP address in the allocation pool. MaxLength: 45
MinLength: 1

AllocationPoolStatus

Appears in: - SubnetResourceStatus

Field Description Default Validation
start string start is the first IP address in the allocation pool. MaxLength: 1024
end string end is the last IP address in the allocation pool. MaxLength: 1024

AllowedAddressPair

Appears in: - PortResourceSpec

Field Description Default Validation
ip IPvAny ip contains an IP address which a server connected to the port can
send packets with. It can be an IP Address or a CIDR (if supported
by the underlying extension plugin).		 MaxLength: 45
MinLength: 1
mac MAC mac contains a MAC address which a server connected to the port can
send packets with. Defaults to the MAC address of the port.		 MaxLength: 17
MinLength: 1

AllowedAddressPairStatus

Appears in: - PortResourceStatus

Field Description Default Validation
ip string ip contains an IP address which a server connected to the port can
send packets with.		 MaxLength: 1024
mac string mac contains a MAC address which a server connected to the port can
send packets with.		 MaxLength: 1024

AvailabilityZoneHint

Underlying type: string

Validation: - MaxLength: 255 - MinLength: 1

Appears in: - NetworkResourceSpec - RouterResourceSpec

CIDR

Underlying type: string

Validation: - Format: cidr - MaxLength: 49 - MinLength: 1

Appears in: - HostRoute - SecurityGroupRule - SubnetFilter - SubnetResourceSpec

CloudCredentialsReference

CloudCredentialsReference is a reference to a secret containing OpenStack credentials.

Appears in: - FlavorSpec - ImageSpec - NetworkSpec - PortSpec - RouterSpec - SecurityGroupSpec - ServerSpec - SubnetSpec

Field Description Default Validation
secretName string secretName is the name of a secret in the same namespace as the resource being provisioned.
The secret must contain a key named clouds.yaml which contains an OpenStack clouds.yaml file.
The secret may optionally contain a key named cacert containing a PEM-encoded CA certificate.		 MaxLength: 253
MinLength: 1
cloudName string cloudName specifies the name of the entry in the clouds.yaml file to use. MaxLength: 256
MinLength: 1

DNSDomain

Underlying type: string

Validation: - MaxLength: 255 - MinLength: 1 - Pattern: ^[A-Za-z0-9]{1,63}(.[A-Za-z0-9-]{1,63})*(.[A-Za-z]{2,63})*.?$

Appears in: - NetworkResourceSpec

Ethertype

Underlying type: string

Validation: - Enum: [IPv4 IPv6]

Appears in: - SecurityGroupRule

ExternalGateway

Appears in: - RouterResourceSpec

Field Description Default Validation
networkRef KubernetesNameRef networkRef is a reference to the ORC Network which the external
gateway is on.		 MaxLength: 253
MinLength: 1

ExternalGatewayStatus

Appears in: - RouterResourceStatus

Field Description Default Validation
networkID string networkID is the ID of the network the gateway is on. MaxLength: 1024

FilterByNeutronTags

Appears in: - NetworkFilter - PortFilter - RouterFilter - SecurityGroupFilter - SubnetFilter

Field Description Default Validation
tags NeutronTag array tags is a list of tags to filter by. If specified, the resource must
have all of the tags specified to be included in the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
tagsAny NeutronTag array tagsAny is a list of tags to filter by. If specified, the resource
must have at least one of the tags specified to be included in the
result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTags NeutronTag array notTags is a list of tags to filter by. If specified, resources which
contain all of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTagsAny NeutronTag array notTagsAny is a list of tags to filter by. If specified, resources
which contain any of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1

FixedIPStatus

Appears in: - PortResourceStatus

Field Description Default Validation
ip string ip contains a fixed IP address assigned to the port. MaxLength: 1024
subnetID string subnetID is the ID of the subnet this IP is allocated from. MaxLength: 1024

Flavor

Flavor is the Schema for an ORC resource.

Appears in: - FlavorList

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string Flavor
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec FlavorSpec spec specifies the desired state of the resource.

FlavorFilter

FlavorFilter defines an existing resource by its properties

Validation: - MinProperties: 1

Appears in: - FlavorImport

Field Description Default Validation
name OpenStackName name of the existing resource MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
ram integer ram is the memory of the flavor, measured in MB. Minimum: 1
vcpus integer vcpus is the number of vcpus for the flavor. Minimum: 1
disk integer disk is the size of the root disk in GiB. Minimum: 0

FlavorImport

FlavorImport specifies an existing resource which will be imported instead of creating a new one

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - FlavorSpec

Field Description Default Validation
id string id contains the unique identifier of an existing OpenStack resource. Note
that when specifying an import by ID, the resource MUST already exist.
The ORC object will enter an error state if the resource does not exist.		 Format: uuid
filter FlavorFilter filter contains a resource query which is expected to return a single
result. The controller will continue to retry if filter returns no
results. If filter returns multiple results the controller will set an
error state and will not continue to retry.		 MinProperties: 1

FlavorList

FlavorList contains a list of Flavor.

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string FlavorList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Flavor array items contains a list of Flavor.

FlavorResourceSpec

NetworkResourceSpec contains the desired state of a network

Appears in: - FlavorSpec

Field Description Default Validation
name OpenStackName name will be the name of the created resource. If not specified, the
name of the ORC object will be used.		 MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description string description contains a free form description of the flavor. MaxLength: 65535
MinLength: 1
ram integer ram is the memory of the flavor, measured in MB. Minimum: 1
vcpus integer vcpus is the number of vcpus for the flavor. Minimum: 1
disk integer disk is the size of the root disk that will be created in GiB. If 0
the root disk will be set to exactly the size of the image used to
deploy the instance. However, in this case the scheduler cannot
select the compute host based on the virtual image size. Therefore,
0 should only be used for volume booted instances or for testing
purposes. Volume-backed instances can be enforced for flavors with
zero root disk via the
os_compute_api:servers:create:zero_disk_flavor policy rule.		 Minimum: 0
swap integer swap is the size of a dedicated swap disk that will be allocated, in
MiB. If 0 (the default), no dedicated swap disk will be created.		 Minimum: 0
isPublic boolean isPublic flags a flavor as being available to all projects or not.
ephemeral integer ephemeral is the size of the ephemeral disk that will be created, in GiB.
Ephemeral disks may be written over on server state changes. So should only
be used as a scratch space for applications that are aware of its
limitations. Defaults to 0.		 Minimum: 0

FlavorResourceStatus

FlavorResourceStatus represents the observed state of the resource.

Appears in: - FlavorStatus

Field Description Default Validation
name string name is a Human-readable name for the flavor. Might not be unique. MaxLength: 1024
description string description is a human-readable description for the resource. MaxLength: 65535
ram integer ram is the memory of the flavor, measured in MB.
vcpus integer vcpus is the number of vcpus for the flavor.
disk integer disk is the size of the root disk that will be created in GiB.
swap integer swap is the size of a dedicated swap disk that will be allocated, in
MiB.
isPublic boolean isPublic flags a flavor as being available to all projects or not.
ephemeral integer ephemeral is the size of the ephemeral disk, in GiB.

FlavorSpec

FlavorSpec defines the desired state of an ORC object.

Appears in: - Flavor

Field Description Default Validation
import FlavorImport import refers to an existing OpenStack resource which will be imported instead of
creating a new one.		 MaxProperties: 1
MinProperties: 1
resource FlavorResourceSpec resource specifies the desired state of the resource.

resource may not be specified if the management policy is unmanaged.

resource must be specified if the management policy is managed.
managementPolicy ManagementPolicy managementPolicy defines how ORC will treat the object. Valid values are
managed: ORC will create, update, and delete the resource; unmanaged:
ORC will import an existing resource, and will not apply updates to it or
delete it.		 managed Enum: [managed unmanaged]
managedOptions ManagedOptions managedOptions specifies options which may be applied to managed objects.
cloudCredentialsRef CloudCredentialsReference cloudCredentialsRef points to a secret containing OpenStack credentials

HostRoute

Appears in: - SubnetResourceSpec

Field Description Default Validation
destination CIDR destination for the additional route. Format: cidr
MaxLength: 49
MinLength: 1
nextHop IPvAny nextHop for the additional route. MaxLength: 45
MinLength: 1

HostRouteStatus

Appears in: - SubnetResourceStatus

Field Description Default Validation
destination string destination for the additional route. MaxLength: 1024
nextHop string nextHop for the additional route. MaxLength: 1024

IPVersion

Underlying type: integer

Validation: - Enum: [4 6]

Appears in: - SubnetFilter - SubnetResourceSpec

IPv6AddressMode

Underlying type: string

Validation: - Enum: [slaac dhcpv6-stateful dhcpv6-stateless]

Appears in: - IPv6Options

IPv6Options

Validation: - MinProperties: 1

Appears in: - SubnetFilter - SubnetResourceSpec

Field Description Default Validation
addressMode IPv6AddressMode addressMode specifies mechanisms for assigning IPv6 IP addresses. Enum: [slaac dhcpv6-stateful dhcpv6-stateless]
raMode IPv6RAMode raMode specifies the IPv6 router advertisement mode. It specifies whether
the networking service should transmit ICMPv6 packets.		 Enum: [slaac dhcpv6-stateful dhcpv6-stateless]

IPv6RAMode

Underlying type: string

Validation: - Enum: [slaac dhcpv6-stateful dhcpv6-stateless]

Appears in: - IPv6Options

IPvAny

Underlying type: string

Validation: - MaxLength: 45 - MinLength: 1

Appears in: - Address - AllocationPool - AllowedAddressPair - HostRoute - SubnetFilter - SubnetGateway - SubnetResourceSpec

Image

Image is the Schema for an ORC resource.

Appears in: - ImageList

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string Image
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ImageSpec spec specifies the desired state of the resource.

ImageCompression

Underlying type: string

Validation: - Enum: [xz gz bz2]

Appears in: - ImageContentSourceDownload

ImageContainerFormat

Underlying type: string

Validation: - Enum: [ami ari aki bare ovf ova docker compressed]

Appears in: - ImageContent

ImageContent

Appears in: - ImageResourceSpec

Field Description Default Validation
containerFormat ImageContainerFormat containerFormat is the format of the image container.
qcow2 and raw images do not usually have a container. This is specified as "bare", which is also the default.
Permitted values are ami, ari, aki, bare, ovf, ova, and docker.		 bare Enum: [ami ari aki bare ovf ova docker compressed]
diskFormat ImageDiskFormat diskFormat is the format of the disk image.
Normal values are "qcow2", or "raw". Glance may be configured to support others.		 Enum: [ami ari aki vhd vhdx vmdk raw qcow2 vdi ploop iso]
download ImageContentSourceDownload download describes how to obtain image data by downloading it from a URL.
Must be set when creating a managed image.

ImageContentSourceDownload

Appears in: - ImageContent

Field Description Default Validation
url string url containing image data Format: uri
MaxLength: 2048
decompress ImageCompression decompress specifies that the source data must be decompressed with the
given compression algorithm before being stored. Specifying Decompress
will disable the use of Glance's web-download, as web-download cannot
currently deterministically decompress downloaded content.		 Enum: [xz gz bz2]
hash ImageHash hash is a hash which will be used to verify downloaded data, i.e.
before any decompression. If not specified, no hash verification will be
performed. Specifying a Hash will disable the use of Glance's
web-download, as web-download cannot currently deterministically verify
the hash of downloaded content.

ImageDiskFormat

Underlying type: string

Validation: - Enum: [ami ari aki vhd vhdx vmdk raw qcow2 vdi ploop iso]

Appears in: - ImageContent

ImageFilter

ImageFilter defines a Glance query

Validation: - MinProperties: 1

Appears in: - ImageImport

Field Description Default Validation
name OpenStackName name specifies the name of a Glance image MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$

ImageHWBus

Underlying type: string

ImageHWBus is a type of hardware bus.

Permitted values are scsi, virtio, uml, xen, ide, usb, and lxc.

Validation: - Enum: [scsi virtio uml xen ide usb lxc]

Appears in: - ImagePropertiesHardware

ImageHash

Appears in: - ImageContentSourceDownload - ImageResourceStatus

Field Description Default Validation
algorithm ImageHashAlgorithm algorithm is the hash algorithm used to generate value. Enum: [md5 sha1 sha256 sha512]
value string value is the hash of the image data using Algorithm. It must be hex encoded using lowercase letters. MaxLength: 1024
MinLength: 1
Pattern: ^[0-9a-f]+$

ImageHashAlgorithm

Underlying type: string

Validation: - Enum: [md5 sha1 sha256 sha512]

Appears in: - ImageHash

ImageImport

ImageImport specifies an existing resource which will be imported instead of creating a new one

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - ImageSpec

Field Description Default Validation
id string id contains the unique identifier of an existing OpenStack resource. Note
that when specifying an import by ID, the resource MUST already exist.
The ORC object will enter an error state if the resource does not exist.		 Format: uuid
filter ImageFilter filter contains a resource query which is expected to return a single
result. The controller will continue to retry if filter returns no
results. If filter returns multiple results the controller will set an
error state and will not continue to retry.		 MinProperties: 1

ImageList

ImageList contains a list of Image.

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string ImageList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Image array items contains a list of Image.

ImageProperties

Appears in: - ImageResourceSpec

Field Description Default Validation
minDiskGB integer minDiskGB is the minimum amount of disk space in GB that is required to boot the image Minimum: 1
minMemoryMB integer minMemoryMB is the minimum amount of RAM in MB that is required to boot the image. Minimum: 1
hardware ImagePropertiesHardware hardware is a set of properties which control the virtual hardware
created by Nova.

ImagePropertiesHardware

Appears in: - ImageProperties

Field Description Default Validation
cpuSockets integer cpuSockets is the preferred number of sockets to expose to the guest Minimum: 1
cpuCores integer cpuCores is the preferred number of cores to expose to the guest Minimum: 1
cpuThreads integer cpuThreads is the preferred number of threads to expose to the guest Minimum: 1
cpuPolicy string cpuPolicy is used to pin the virtual CPUs (vCPUs) of instances to the
host's physical CPU cores (pCPUs). Host aggregates should be used to
separate these pinned instances from unpinned instances as the latter
will not respect the resourcing requirements of the former.

Permitted values are shared (the default), and dedicated.

shared: The guest vCPUs will be allowed to freely float across host
pCPUs, albeit potentially constrained by NUMA policy.

dedicated: The guest vCPUs will be strictly pinned to a set of host
pCPUs. In the absence of an explicit vCPU topology request, the
drivers typically expose all vCPUs as sockets with one core and one
thread. When strict CPU pinning is in effect the guest CPU topology
will be setup to match the topology of the CPUs to which it is
pinned. This option implies an overcommit ratio of 1.0. For example,
if a two vCPU guest is pinned to a single host core with two threads,
then the guest will get a topology of one socket, one core, two
threads.		 Enum: [shared dedicated]
cpuThreadPolicy string cpuThreadPolicy further refines a CPUPolicy of 'dedicated' by stating
how hardware CPU threads in a simultaneous multithreading-based (SMT)
architecture be used. SMT-based architectures include Intel
processors with Hyper-Threading technology. In these architectures,
processor cores share a number of components with one or more other
cores. Cores in such architectures are commonly referred to as
hardware threads, while the cores that a given core share components
with are known as thread siblings.

Permitted values are prefer (the default), isolate, and require.

prefer: The host may or may not have an SMT architecture. Where an
SMT architecture is present, thread siblings are preferred.

isolate: The host must not have an SMT architecture or must emulate a
non-SMT architecture. If the host does not have an SMT architecture,
each vCPU is placed on a different core as expected. If the host does
have an SMT architecture - that is, one or more cores have thread
siblings - then each vCPU is placed on a different physical core. No
vCPUs from other guests are placed on the same core. All but one
thread sibling on each utilized core is therefore guaranteed to be
unusable.

require: The host must have an SMT architecture. Each vCPU is
allocated on thread siblings. If the host does not have an SMT
architecture, then it is not used. If the host has an SMT
architecture, but not enough cores with free thread siblings are
available, then scheduling fails.		 Enum: [prefer isolate require]
cdromBus ImageHWBus cdromBus specifies the type of disk controller to attach CD-ROM devices to. Enum: [scsi virtio uml xen ide usb lxc]
diskBus ImageHWBus diskBus specifies the type of disk controller to attach disk devices to. Enum: [scsi virtio uml xen ide usb lxc]
scsiModel string scsiModel enables the use of VirtIO SCSI (virtio-scsi) to provide
block device access for compute instances; by default, instances use
VirtIO Block (virtio-blk). VirtIO SCSI is a para-virtualized SCSI
controller device that provides improved scalability and performance,
and supports advanced SCSI hardware.

The only permitted value is virtio-scsi.		 Enum: [virtio-scsi]
vifModel string vifModel specifies the model of virtual network interface device to use.

Permitted values are e1000, e1000e, ne2k_pci, pcnet, rtl8139, virtio,
and vmxnet3.		 Enum: [e1000 e1000e ne2k_pci pcnet rtl8139 virtio vmxnet3]

ImageResourceSpec

ImageResourceSpec contains the desired state of a Glance image

Appears in: - ImageSpec

Field Description Default Validation
name OpenStackName name will be the name of the created Glance image. If not specified, the
name of the Image object will be used.		 MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
protected boolean protected specifies that the image is protected from deletion.
If not specified, the default is false.
tags ImageTag array tags is a list of tags which will be applied to the image. A tag has a maximum length of 255 characters. MaxItems: 32
MaxLength: 255
MinLength: 1
visibility ImageVisibility visibility of the image Enum: [public private shared community]
properties ImageProperties properties is metadata available to consumers of the image
content ImageContent content specifies how to obtain the image content.

ImageResourceStatus

ImageResourceStatus represents the observed state of a Glance image

Appears in: - ImageStatus

Field Description Default Validation
hash ImageHash hash is the hash of the image data published by Glance. Note that this is
a hash of the data stored internally by Glance, which will have been
decompressed and potentially format converted depending on server-side
configuration which is not visible to clients. It is expected that this
hash will usually differ from the download hash.
sizeB integer sizeB is the size of the image data, in bytes
virtualSizeB integer virtualSizeB is the size of the disk the image data represents, in bytes

ImageSpec

ImageSpec defines the desired state of an ORC object.

Appears in: - Image

Field Description Default Validation
import ImageImport import refers to an existing OpenStack resource which will be imported instead of
creating a new one.		 MaxProperties: 1
MinProperties: 1
resource ImageResourceSpec resource specifies the desired state of the resource.

resource may not be specified if the management policy is unmanaged.

resource must be specified if the management policy is managed.
managementPolicy ManagementPolicy managementPolicy defines how ORC will treat the object. Valid values are
managed: ORC will create, update, and delete the resource; unmanaged:
ORC will import an existing resource, and will not apply updates to it or
delete it.		 managed Enum: [managed unmanaged]
managedOptions ManagedOptions managedOptions specifies options which may be applied to managed objects.
cloudCredentialsRef CloudCredentialsReference cloudCredentialsRef points to a secret containing OpenStack credentials

ImageStatusExtra

Appears in: - ImageStatus

Field Description Default Validation
downloadAttempts integer downloadAttempts is the number of times the controller has attempted to download the image contents

ImageTag

Underlying type: string

Validation: - MaxLength: 255 - MinLength: 1

Appears in: - ImageResourceSpec

ImageVisibility

Underlying type: string

Validation: - Enum: [public private shared community]

Appears in: - ImageResourceSpec

KubernetesNameRef

Underlying type: string

Validation: - MaxLength: 253 - MinLength: 1

Appears in: - Address - ExternalGateway - PortRefs - PortSpec - RouterInterfaceSpec - ServerPortSpec - ServerResourceSpec - SubnetRefs - SubnetResourceSpec - SubnetSpec - UserDataSpec

MAC

Underlying type: string

Validation: - MaxLength: 17 - MinLength: 1

Appears in: - AllowedAddressPair

MTU

Underlying type: integer

Validation: - Maximum: 9216 - Minimum: 68

Appears in: - NetworkResourceSpec

ManagedOptions

Appears in: - FlavorSpec - ImageSpec - NetworkSpec - PortSpec - RouterSpec - SecurityGroupSpec - ServerSpec - SubnetSpec

Field Description Default Validation
onDelete OnDelete onDelete specifies the behaviour of the controller when the ORC
object is deleted. Options are delete - delete the OpenStack resource;
detach - do not delete the OpenStack resource. If not specified, the
default is delete.		 delete Enum: [delete detach]

ManagementPolicy

Underlying type: string

Validation: - Enum: [managed unmanaged]

Appears in: - FlavorSpec - ImageSpec - NetworkSpec - PortSpec - RouterSpec - SecurityGroupSpec - ServerSpec - SubnetSpec

Network

Network is the Schema for an ORC resource.

Appears in: - NetworkList

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string Network
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec NetworkSpec spec specifies the desired state of the resource.

NetworkFilter

NetworkFilter defines an existing resource by its properties

Validation: - MinProperties: 1

Appears in: - NetworkImport

Field Description Default Validation
name OpenStackName name of the existing resource MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description of the existing resource MaxLength: 255
MinLength: 1
external boolean external indicates whether the network has an external routing
facility that’s not managed by the networking service.
tags NeutronTag array tags is a list of tags to filter by. If specified, the resource must
have all of the tags specified to be included in the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
tagsAny NeutronTag array tagsAny is a list of tags to filter by. If specified, the resource
must have at least one of the tags specified to be included in the
result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTags NeutronTag array notTags is a list of tags to filter by. If specified, resources which
contain all of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTagsAny NeutronTag array notTagsAny is a list of tags to filter by. If specified, resources
which contain any of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1

NetworkImport

NetworkImport specifies an existing resource which will be imported instead of creating a new one

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - NetworkSpec

Field Description Default Validation
id string id contains the unique identifier of an existing OpenStack resource. Note
that when specifying an import by ID, the resource MUST already exist.
The ORC object will enter an error state if the resource does not exist.		 Format: uuid
filter NetworkFilter filter contains a resource query which is expected to return a single
result. The controller will continue to retry if filter returns no
results. If filter returns multiple results the controller will set an
error state and will not continue to retry.		 MinProperties: 1

NetworkList

NetworkList contains a list of Network.

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string NetworkList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Network array items contains a list of Network.

NetworkResourceSpec

NetworkResourceSpec contains the desired state of a network

Appears in: - NetworkSpec

Field Description Default Validation
name OpenStackName name will be the name of the created resource. If not specified, the
name of the ORC object will be used.		 MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description is a human-readable description for the resource. MaxLength: 255
MinLength: 1
tags NeutronTag array tags is a list of tags which will be applied to the network. MaxItems: 64
MaxLength: 255
MinLength: 1
adminStateUp boolean adminStateUp is the administrative state of the network, which is up (true) or down (false)
dnsDomain DNSDomain dnsDomain is the DNS domain of the network MaxLength: 255
MinLength: 1
Pattern: ^[A-Za-z0-9]{1,63}(.[A-Za-z0-9-]{1,63})*(.[A-Za-z]{2,63})*.?$
mtu MTU mtu is the the maximum transmission unit value to address
fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
Defaults to 1500.		 Maximum: 9216
Minimum: 68
portSecurityEnabled boolean portSecurityEnabled is the port security status of the network.
Valid values are enabled (true) and disabled (false). This value is
used as the default value of port_security_enabled field of a newly
created port.
external boolean external indicates whether the network has an external routing
facility that’s not managed by the networking service.
shared boolean shared indicates whether this resource is shared across all
projects. By default, only administrative users can change this
value.
availabilityZoneHints AvailabilityZoneHint array availabilityZoneHints is the availability zone candidate for the network. MaxItems: 32
MaxLength: 255
MinLength: 1

NetworkResourceStatus

NetworkResourceStatus represents the observed state of the resource.

Appears in: - NetworkStatus

Field Description Default Validation
name string name is a Human-readable name for the network. Might not be unique. MaxLength: 1024
description string description is a human-readable description for the resource. MaxLength: 1024
projectID string projectID is the project owner of the network. MaxLength: 1024
tags string array tags is the list of tags on the resource. MaxItems: 32
createdAt Time createdAt shows the date and time when the resource was created. The date and time stamp format is ISO 8601
updatedAt Time updatedAt shows the date and time when the resource was updated. The date and time stamp format is ISO 8601
revisionNumber integer revisionNumber optionally set via extensions/standard-attr-revisions
adminStateUp boolean adminStateUp is the administrative state of the network,
which is up (true) or down (false).
availabilityZoneHints string array availabilityZoneHints is the availability zone candidate for the
network.		 MaxItems: 32
dnsDomain string dnsDomain is the DNS domain of the network MaxLength: 1024
mtu integer mtu is the the maximum transmission unit value to address
fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
portSecurityEnabled boolean portSecurityEnabled is the port security status of the network.
Valid values are enabled (true) and disabled (false). This value is
used as the default value of port_security_enabled field of a newly
created port.
provider ProviderPropertiesStatus provider contains provider-network properties.
external boolean external defines whether the network may be used for creation of
floating IPs. Only networks with this flag may be an external
gateway for routers. The network must have an external routing
facility that is not managed by the networking service. If the
network is updated from external to internal the unused floating IPs
of this network are automatically deleted when extension
floatingip-autodelete-internal is present.
shared boolean shared specifies whether the network resource can be accessed by any
tenant.
subnets string array subnets associated with this network. MaxItems: 32

NetworkSpec

NetworkSpec defines the desired state of an ORC object.

Appears in: - Network

Field Description Default Validation
import NetworkImport import refers to an existing OpenStack resource which will be imported instead of
creating a new one.		 MaxProperties: 1
MinProperties: 1
resource NetworkResourceSpec resource specifies the desired state of the resource.

resource may not be specified if the management policy is unmanaged.

resource must be specified if the management policy is managed.
managementPolicy ManagementPolicy managementPolicy defines how ORC will treat the object. Valid values are
managed: ORC will create, update, and delete the resource; unmanaged:
ORC will import an existing resource, and will not apply updates to it or
delete it.		 managed Enum: [managed unmanaged]
managedOptions ManagedOptions managedOptions specifies options which may be applied to managed objects.
cloudCredentialsRef CloudCredentialsReference cloudCredentialsRef points to a secret containing OpenStack credentials

NeutronDescription

Underlying type: string

Validation: - MaxLength: 255 - MinLength: 1

Appears in: - NetworkFilter - NetworkResourceSpec - PortFilter - PortResourceSpec - RouterFilter - RouterResourceSpec - SecurityGroupFilter - SecurityGroupResourceSpec - SecurityGroupRule - SubnetFilter - SubnetResourceSpec

NeutronStatusMetadata

Appears in: - NetworkResourceStatus - PortResourceStatus - RouterResourceSpec - SecurityGroupResourceStatus - SubnetResourceStatus

Field Description Default Validation
createdAt Time createdAt shows the date and time when the resource was created. The date and time stamp format is ISO 8601
updatedAt Time updatedAt shows the date and time when the resource was updated. The date and time stamp format is ISO 8601
revisionNumber integer revisionNumber optionally set via extensions/standard-attr-revisions

NeutronTag

Underlying type: string

NeutronTag represents a tag on a Neutron resource. It may not be empty and may not contain commas.

Validation: - MaxLength: 255 - MinLength: 1

Appears in: - FilterByNeutronTags - NetworkFilter - NetworkResourceSpec - PortFilter - PortResourceSpec - RouterFilter - RouterResourceSpec - SecurityGroupFilter - SecurityGroupResourceSpec - SubnetFilter - SubnetResourceSpec

OnDelete

Underlying type: string

Validation: - Enum: [delete detach]

Appears in: - ManagedOptions

OpenStackName

Underlying type: string

Validation: - MaxLength: 255 - MinLength: 1 - Pattern: ^[^,]+$

Appears in: - FlavorFilter - FlavorResourceSpec - ImageFilter - ImageResourceSpec - NetworkFilter - NetworkResourceSpec - PortFilter - PortResourceSpec - RouterFilter - RouterResourceSpec - SecurityGroupFilter - SecurityGroupResourceSpec - ServerFilter - ServerResourceSpec - SubnetFilter - SubnetResourceSpec

Port

Port is the Schema for an ORC resource.

Appears in: - PortList

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string Port
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec PortSpec spec specifies the desired state of the resource.

PortFilter

PortFilter specifies a filter to select a port. At least one parameter must be specified.

Validation: - MinProperties: 1

Appears in: - PortImport

Field Description Default Validation
name OpenStackName name of the existing resource MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description of the existing resource MaxLength: 255
MinLength: 1
tags NeutronTag array tags is a list of tags to filter by. If specified, the resource must
have all of the tags specified to be included in the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
tagsAny NeutronTag array tagsAny is a list of tags to filter by. If specified, the resource
must have at least one of the tags specified to be included in the
result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTags NeutronTag array notTags is a list of tags to filter by. If specified, resources which
contain all of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTagsAny NeutronTag array notTagsAny is a list of tags to filter by. If specified, resources
which contain any of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1

PortImport

PortImport specifies an existing resource which will be imported instead of creating a new one

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - PortSpec

Field Description Default Validation
id string id contains the unique identifier of an existing OpenStack resource. Note
that when specifying an import by ID, the resource MUST already exist.
The ORC object will enter an error state if the resource does not exist.		 Format: uuid
filter PortFilter filter contains a resource query which is expected to return a single
result. The controller will continue to retry if filter returns no
results. If filter returns multiple results the controller will set an
error state and will not continue to retry.		 MinProperties: 1

PortList

PortList contains a list of Port.

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string PortList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Port array items contains a list of Port.

PortNumber

Underlying type: integer

Validation: - Maximum: 65535 - Minimum: 0

Appears in: - PortRangeSpec

PortRangeSpec

Appears in: - SecurityGroupRule

Field Description Default Validation
min PortNumber min is the minimum port number in the range that is matched by the security group rule.
If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal
to the port_range_max attribute value. If the protocol is ICMP, this value must be an ICMP type		 Maximum: 65535
Minimum: 0
max PortNumber max is the maximum port number in the range that is matched by the security group rule.
If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal
to the port_range_min attribute value. If the protocol is ICMP, this value must be an ICMP code.		 Maximum: 65535
Minimum: 0

PortRangeStatus

Appears in: - SecurityGroupRuleStatus

Field Description Default Validation
min integer min is the minimum port number in the range that is matched by the security group rule.
If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal
to the port_range_max attribute value. If the protocol is ICMP, this value must be an ICMP type
max integer max is the maximum port number in the range that is matched by the security group rule.
If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal
to the port_range_min attribute value. If the protocol is ICMP, this value must be an ICMP code.

PortRefs

Appears in: - PortSpec

Field Description Default Validation
networkRef KubernetesNameRef networkRef is a reference to the ORC Network which this port is associated with. MaxLength: 253
MinLength: 1

PortResourceSpec

Appears in: - PortSpec

Field Description Default Validation
name OpenStackName name is a human-readable name of the port. If not set, the object's name will be used. MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description is a human-readable description for the resource. MaxLength: 255
MinLength: 1
tags NeutronTag array tags is a list of tags which will be applied to the port. MaxItems: 32
MaxLength: 255
MinLength: 1
allowedAddressPairs AllowedAddressPair array allowedAddressPairs are allowed addresses associated with this port. MaxItems: 32
addresses Address array addresses are the IP addresses for the port. MaxItems: 32
securityGroupRefs OpenStackName array securityGroupRefs are the names of the security groups associated
with this port.		 MaxItems: 32
MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$

PortResourceStatus

Appears in: - PortStatus

Field Description Default Validation
name string name is the human-readable name of the resource. Might not be unique. MaxLength: 1024
description string description is a human-readable description for the resource. MaxLength: 1024
projectID string projectID is the project owner of the resource. MaxLength: 1024
tags string array tags is the list of tags on the resource. MaxItems: 32
adminStateUp boolean adminStateUp is the administrative state of the port,
which is up (true) or down (false).
macAddress string macAddress is the MAC address of the port. MaxLength: 1024
deviceID string deviceID is the ID of the device that uses this port. MaxLength: 1024
deviceOwner string deviceOwner is the entity type that uses this port. MaxLength: 1024
allowedAddressPairs AllowedAddressPairStatus array allowedAddressPairs is a set of zero or more allowed address pair
objects each where address pair object contains an IP address and
MAC address.		 MaxItems: 32
fixedIPs FixedIPStatus array fixedIPs is a set of zero or more fixed IP objects each where fixed
IP object contains an IP address and subnet ID from which the IP
address is assigned.		 MaxItems: 32
securityGroups string array securityGroups contains the IDs of security groups applied to the port. MaxItems: 32
propagateUplinkStatus boolean propagateUplinkStatus represents the uplink status propagation of
the port.
createdAt Time createdAt shows the date and time when the resource was created. The date and time stamp format is ISO 8601
updatedAt Time updatedAt shows the date and time when the resource was updated. The date and time stamp format is ISO 8601
revisionNumber integer revisionNumber optionally set via extensions/standard-attr-revisions

PortSpec

PortSpec defines the desired state of an ORC object.

Appears in: - Port

Field Description Default Validation
networkRef KubernetesNameRef networkRef is a reference to the ORC Network which this port is associated with. MaxLength: 253
MinLength: 1
import PortImport import refers to an existing OpenStack resource which will be imported instead of
creating a new one.		 MaxProperties: 1
MinProperties: 1
resource PortResourceSpec resource specifies the desired state of the resource.

resource may not be specified if the management policy is unmanaged.

resource must be specified if the management policy is managed.
managementPolicy ManagementPolicy managementPolicy defines how ORC will treat the object. Valid values are
managed: ORC will create, update, and delete the resource; unmanaged:
ORC will import an existing resource, and will not apply updates to it or
delete it.		 managed Enum: [managed unmanaged]
managedOptions ManagedOptions managedOptions specifies options which may be applied to managed objects.
cloudCredentialsRef CloudCredentialsReference cloudCredentialsRef points to a secret containing OpenStack credentials

Protocol

Underlying type: string

Validation: - Enum: [ah dccp egp esp gre icmp icmpv6 igmp ipip ipv6-encap ipv6-frag ipv6-icmp ipv6-nonxt ipv6-opts ipv6-route ospf pgm rsvp sctp tcp udp udplite vrrp]

Appears in: - SecurityGroupRule

ProviderPropertiesStatus

Appears in: - NetworkResourceStatus

Field Description Default Validation
networkType string networkType is the type of physical network that this
network should be mapped to. Supported values are flat, vlan, vxlan, and gre.
Valid values depend on the networking back-end.		 MaxLength: 1024
physicalNetwork string physicalNetwork is the physical network where this network
should be implemented. The Networking API v2.0 does not provide a
way to list available physical networks. For example, the Open
vSwitch plug-in configuration file defines a symbolic name that maps
to specific bridges on each compute host.		 MaxLength: 1024
segmentationID integer segmentationID is the ID of the isolated segment on the
physical network. The network_type attribute defines the
segmentation model. For example, if the network_type value is vlan,
this ID is a vlan identifier. If the network_type value is gre, this
ID is a gre key.

Router

Router is the Schema for an ORC resource.

Appears in: - RouterList

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string Router
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec RouterSpec spec specifies the desired state of the resource.

RouterFilter

RouterFilter specifies a query to select an OpenStack router. At least one property must be set.

Validation: - MinProperties: 1

Appears in: - RouterImport

Field Description Default Validation
name OpenStackName name of the existing resource MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description of the existing resource MaxLength: 255
MinLength: 1
tags NeutronTag array tags is a list of tags to filter by. If specified, the resource must
have all of the tags specified to be included in the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
tagsAny NeutronTag array tagsAny is a list of tags to filter by. If specified, the resource
must have at least one of the tags specified to be included in the
result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTags NeutronTag array notTags is a list of tags to filter by. If specified, resources which
contain all of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTagsAny NeutronTag array notTagsAny is a list of tags to filter by. If specified, resources
which contain any of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1

RouterImport

RouterImport specifies an existing resource which will be imported instead of creating a new one

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - RouterSpec

Field Description Default Validation
id string id contains the unique identifier of an existing OpenStack resource. Note
that when specifying an import by ID, the resource MUST already exist.
The ORC object will enter an error state if the resource does not exist.		 Format: uuid
filter RouterFilter filter contains a resource query which is expected to return a single
result. The controller will continue to retry if filter returns no
results. If filter returns multiple results the controller will set an
error state and will not continue to retry.		 MinProperties: 1

RouterInterface

RouterInterface is the Schema for an ORC resource.

Appears in: - RouterInterfaceList

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string RouterInterface
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec RouterInterfaceSpec spec specifies the desired state of the resource.

RouterInterfaceList

RouterInterfaceList contains a list of RouterInterface.

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string RouterInterfaceList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items RouterInterface array items contains a list of RouterInterface. MaxItems: 32

RouterInterfaceSpec

Appears in: - RouterInterface

Field Description Default Validation
type RouterInterfaceType type specifies the type of the router interface. Enum: [Subnet]
MaxLength: 8
MinLength: 1
routerRef KubernetesNameRef routerRef references the router to which this interface belongs. MaxLength: 253
MinLength: 1
subnetRef KubernetesNameRef subnetRef references the subnet the router interface is created on. MaxLength: 253
MinLength: 1

RouterInterfaceType

Underlying type: string

Validation: - Enum: [Subnet] - MaxLength: 8 - MinLength: 1

Appears in: - RouterInterfaceSpec

RouterList

RouterList contains a list of Router.

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string RouterList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Router array items contains a list of Router.

RouterResourceSpec

Appears in: - RouterSpec

Field Description Default Validation
name OpenStackName name is a human-readable name of the router. If not set, the
object's name will be used.		 MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description is a human-readable description for the resource. MaxLength: 255
MinLength: 1
tags NeutronTag array tags is a list of tags which will be applied to the router. MaxItems: 32
MaxLength: 255
MinLength: 1
adminStateUp boolean adminStateUp represents the administrative state of the resource,
which is up (true) or down (false). Default is true.
externalGateways ExternalGateway array externalGateways is a list of external gateways for the router. MaxItems: 32
distributed boolean distributed indicates whether the router is distributed or not. It
is available when dvr extension is enabled.
availabilityZoneHints AvailabilityZoneHint array availabilityZoneHints is the availability zone candidate for the router. MaxItems: 32
MaxLength: 255
MinLength: 1
createdAt Time createdAt shows the date and time when the resource was created. The date and time stamp format is ISO 8601
updatedAt Time updatedAt shows the date and time when the resource was updated. The date and time stamp format is ISO 8601
revisionNumber integer revisionNumber optionally set via extensions/standard-attr-revisions

RouterResourceStatus

Appears in: - RouterStatus

Field Description Default Validation
name string name is the human-readable name of the resource. Might not be unique. MaxLength: 1024
description string description is a human-readable description for the resource. MaxLength: 1024
projectID string projectID is the project owner of the resource. MaxLength: 1024
tags string array tags is the list of tags on the resource. MaxItems: 32
adminStateUp boolean adminStateUp is the administrative state of the router,
which is up (true) or down (false).
externalGateways ExternalGatewayStatus array externalGateways is a list of external gateways for the router. MaxItems: 32
availabilityZoneHints string array availabilityZoneHints is the availability zone candidate for the
router.		 MaxItems: 32

RouterSpec

RouterSpec defines the desired state of an ORC object.

Appears in: - Router

Field Description Default Validation
import RouterImport import refers to an existing OpenStack resource which will be imported instead of
creating a new one.		 MaxProperties: 1
MinProperties: 1
resource RouterResourceSpec resource specifies the desired state of the resource.

resource may not be specified if the management policy is unmanaged.

resource must be specified if the management policy is managed.
managementPolicy ManagementPolicy managementPolicy defines how ORC will treat the object. Valid values are
managed: ORC will create, update, and delete the resource; unmanaged:
ORC will import an existing resource, and will not apply updates to it or
delete it.		 managed Enum: [managed unmanaged]
managedOptions ManagedOptions managedOptions specifies options which may be applied to managed objects.
cloudCredentialsRef CloudCredentialsReference cloudCredentialsRef points to a secret containing OpenStack credentials

RuleDirection

Underlying type: string

Validation: - Enum: [ingress egress]

Appears in: - SecurityGroupRule

SecurityGroup

SecurityGroup is the Schema for an ORC resource.

Appears in: - SecurityGroupList

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string SecurityGroup
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec SecurityGroupSpec spec specifies the desired state of the resource.

SecurityGroupFilter

SecurityGroupFilter defines an existing resource by its properties

Validation: - MinProperties: 1

Appears in: - SecurityGroupImport

Field Description Default Validation
name OpenStackName name of the existing resource MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description of the existing resource MaxLength: 255
MinLength: 1
tags NeutronTag array tags is a list of tags to filter by. If specified, the resource must
have all of the tags specified to be included in the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
tagsAny NeutronTag array tagsAny is a list of tags to filter by. If specified, the resource
must have at least one of the tags specified to be included in the
result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTags NeutronTag array notTags is a list of tags to filter by. If specified, resources which
contain all of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTagsAny NeutronTag array notTagsAny is a list of tags to filter by. If specified, resources
which contain any of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1

SecurityGroupImport

SecurityGroupImport specifies an existing resource which will be imported instead of creating a new one

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - SecurityGroupSpec

Field Description Default Validation
id string id contains the unique identifier of an existing OpenStack resource. Note
that when specifying an import by ID, the resource MUST already exist.
The ORC object will enter an error state if the resource does not exist.		 Format: uuid
filter SecurityGroupFilter filter contains a resource query which is expected to return a single
result. The controller will continue to retry if filter returns no
results. If filter returns multiple results the controller will set an
error state and will not continue to retry.		 MinProperties: 1

SecurityGroupList

SecurityGroupList contains a list of SecurityGroup.

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string SecurityGroupList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items SecurityGroup array items contains a list of SecurityGroup.

SecurityGroupResourceSpec

SecurityGroupResourceSpec contains the desired state of a security group

Appears in: - SecurityGroupSpec

Field Description Default Validation
name OpenStackName name will be the name of the created resource. If not specified, the
name of the ORC object will be used.		 MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description is a human-readable description for the resource. MaxLength: 255
MinLength: 1
tags NeutronTag array tags is a list of tags which will be applied to the security group. MaxItems: 32
MaxLength: 255
MinLength: 1
stateful boolean stateful indicates if the security group is stateful or stateless.
rules SecurityGroupRule array rules is a list of security group rules belonging to this SG. MaxItems: 256
MinProperties: 1

SecurityGroupResourceStatus

SecurityGroupResourceStatus represents the observed state of the resource.

Appears in: - SecurityGroupStatus

Field Description Default Validation
name string name is a Human-readable name for the security group. Might not be unique. MaxLength: 1024
description string description is a human-readable description for the resource. MaxLength: 1024
projectID string projectID is the project owner of the security group. MaxLength: 1024
tags string array tags is the list of tags on the resource. MaxItems: 32
stateful boolean stateful indicates if the security group is stateful or stateless.
rules SecurityGroupRuleStatus array rules is a list of security group rules belonging to this SG. MaxItems: 256
createdAt Time createdAt shows the date and time when the resource was created. The date and time stamp format is ISO 8601
updatedAt Time updatedAt shows the date and time when the resource was updated. The date and time stamp format is ISO 8601
revisionNumber integer revisionNumber optionally set via extensions/standard-attr-revisions

SecurityGroupRule

SecurityGroupRule defines a Security Group rule

Validation: - MinProperties: 1

Appears in: - SecurityGroupResourceSpec

Field Description Default Validation
description NeutronDescription description is a human-readable description for the resource. MaxLength: 255
MinLength: 1
direction RuleDirection direction represents the direction in which the security group rule
is applied. Can be ingress or egress.		 Enum: [ingress egress]
remoteIPPrefix CIDR remoteIPPrefix is an IP address block. Should match the Ethertype (IPv4 or IPv6) Format: cidr
MaxLength: 49
MinLength: 1
protocol Protocol protocol is the IP protocol is represented by a string Enum: [ah dccp egp esp gre icmp icmpv6 igmp ipip ipv6-encap ipv6-frag ipv6-icmp ipv6-nonxt ipv6-opts ipv6-route ospf pgm rsvp sctp tcp udp udplite vrrp]
ethertype Ethertype ethertype must be IPv4 or IPv6, and addresses represented in CIDR
must match the ingress or egress rules.		 Enum: [IPv4 IPv6]
portRange PortRangeSpec portRange sets the minimum and maximum ports range that the security group rule
matches. If the protocol is [tcp, udp, dccp sctp,udplite] PortRange.Min must be less than
or equal to the PortRange.Max attribute value.
If the protocol is ICMP, this PortRamge.Min must be an ICMP code and PortRange.Max
should be an ICMP type

SecurityGroupRuleStatus

Appears in: - SecurityGroupResourceStatus

Field Description Default Validation
id string id is the ID of the security group rule. MaxLength: 1024
description string description is a human-readable description for the resource. MaxLength: 1024
direction string direction represents the direction in which the security group rule
is applied. Can be ingress or egress.		 MaxLength: 1024
remoteGroupID string remoteGroupID is the remote group UUID to associate with this security group rule
RemoteGroupID		 MaxLength: 1024
remoteIPPrefix string remoteIPPrefix is an IP address block. Should match the Ethertype (IPv4 or IPv6) MaxLength: 1024
protocol string protocol is the IP protocol can be represented by a string, an
integer, or null		 MaxLength: 1024
ethertype string ethertype must be IPv4 or IPv6, and addresses represented in CIDR
must match the ingress or egress rules.		 MaxLength: 1024
portRange PortRangeStatus portRange sets the minimum and maximum ports range that the security group rule
matches. If the protocol is [tcp, udp, dccp sctp,udplite] PortRange.Min must be less than
or equal to the PortRange.Max attribute value.
If the protocol is ICMP, this PortRamge.Min must be an ICMP code and PortRange.Max
should be an ICMP type

SecurityGroupSpec

SecurityGroupSpec defines the desired state of an ORC object.

Appears in: - SecurityGroup

Field Description Default Validation
import SecurityGroupImport import refers to an existing OpenStack resource which will be imported instead of
creating a new one.		 MaxProperties: 1
MinProperties: 1
resource SecurityGroupResourceSpec resource specifies the desired state of the resource.

resource may not be specified if the management policy is unmanaged.

resource must be specified if the management policy is managed.
managementPolicy ManagementPolicy managementPolicy defines how ORC will treat the object. Valid values are
managed: ORC will create, update, and delete the resource; unmanaged:
ORC will import an existing resource, and will not apply updates to it or
delete it.		 managed Enum: [managed unmanaged]
managedOptions ManagedOptions managedOptions specifies options which may be applied to managed objects.
cloudCredentialsRef CloudCredentialsReference cloudCredentialsRef points to a secret containing OpenStack credentials

Server

Server is the Schema for an ORC resource.

Appears in: - ServerList

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string Server
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServerSpec spec specifies the desired state of the resource.

ServerFilter

ServerFilter defines an existing resource by its properties

Validation: - MinProperties: 1

Appears in: - ServerImport

Field Description Default Validation
name OpenStackName name of the existing resource MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$

ServerImport

ServerImport specifies an existing resource which will be imported instead of creating a new one

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - ServerSpec

Field Description Default Validation
id string id contains the unique identifier of an existing OpenStack resource. Note
that when specifying an import by ID, the resource MUST already exist.
The ORC object will enter an error state if the resource does not exist.		 Format: uuid
filter ServerFilter filter contains a resource query which is expected to return a single
result. The controller will continue to retry if filter returns no
results. If filter returns multiple results the controller will set an
error state and will not continue to retry.		 MinProperties: 1

ServerList

ServerList contains a list of Server.

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string ServerList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Server array items contains a list of Server.

ServerPortSpec

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - ServerResourceSpec

Field Description Default Validation
portRef KubernetesNameRef portRef is a reference to a Port object. Server creation will wait for
this port to be created and available.		 MaxLength: 253
MinLength: 1

ServerResourceSpec

ServerResourceSpec contains the desired state of a server

Appears in: - ServerSpec

Field Description Default Validation
name OpenStackName name will be the name of the created resource. If not specified, the
name of the ORC object will be used.		 MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
imageRef KubernetesNameRef imageRef references the image to use for the server instance.
NOTE: This is not required in case of boot from volume.		 MaxLength: 253
MinLength: 1
flavorRef KubernetesNameRef flavorRef references the flavor to use for the server instance. MaxLength: 253
MinLength: 1
userData UserDataSpec userData specifies data which will be made available to the server at
boot time, either via the metadata service or a config drive. It is
typically read by a configuration service such as cloud-init or ignition.		 MaxProperties: 1
MinProperties: 1
ports ServerPortSpec array ports defines a list of ports which will be attached to the server. MaxItems: 32
MaxProperties: 1
MinProperties: 1

ServerResourceStatus

ServerResourceStatus represents the observed state of the resource.

Appears in: - ServerStatus

Field Description Default Validation
name string name is the human-readable name of the resource. Might not be unique. MaxLength: 1024
hostID string hostID is the host where the server is located in the cloud. MaxLength: 1024
accessIPv4 string accessIPv4 contains the IPv4 addresses of the server, suitable for
remote access for administration.		 MaxLength: 1024
accessIPv6 string accessIPv6 contains the IPv6 addresses of the server, suitable for
remote access for administration.		 MaxLength: 1024
imageID string imageID indicates the OS image used to deploy the server. MaxLength: 1024
keyName string keyName indicates which public key was injected into the server on launch. MaxLength: 1024
securityGroups string array securityGroups includes the security groups that this instance has
applied to it.		 MaxItems: 32

ServerSpec

ServerSpec defines the desired state of an ORC object.

Appears in: - Server

Field Description Default Validation
import ServerImport import refers to an existing OpenStack resource which will be imported instead of
creating a new one.		 MaxProperties: 1
MinProperties: 1
resource ServerResourceSpec resource specifies the desired state of the resource.

resource may not be specified if the management policy is unmanaged.

resource must be specified if the management policy is managed.
managementPolicy ManagementPolicy managementPolicy defines how ORC will treat the object. Valid values are
managed: ORC will create, update, and delete the resource; unmanaged:
ORC will import an existing resource, and will not apply updates to it or
delete it.		 managed Enum: [managed unmanaged]
managedOptions ManagedOptions managedOptions specifies options which may be applied to managed objects.
cloudCredentialsRef CloudCredentialsReference cloudCredentialsRef points to a secret containing OpenStack credentials

Subnet

Subnet is the Schema for an ORC resource.

Appears in: - SubnetList

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string Subnet
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec SubnetSpec spec specifies the desired state of the resource.

SubnetFilter

SubnetFilter specifies a filter to select a subnet. At least one parameter must be specified.

Validation: - MinProperties: 1

Appears in: - SubnetImport

Field Description Default Validation
name OpenStackName name of the existing resource MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description of the existing resource MaxLength: 255
MinLength: 1
ipVersion IPVersion ipVersion of the existing resource Enum: [4 6]
gatewayIP IPvAny gatewayIP is the IP address of the gateway of the existing resource MaxLength: 45
MinLength: 1
cidr CIDR cidr of the existing resource Format: cidr
MaxLength: 49
MinLength: 1
ipv6 IPv6Options ipv6 options of the existing resource MinProperties: 1
tags NeutronTag array tags is a list of tags to filter by. If specified, the resource must
have all of the tags specified to be included in the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
tagsAny NeutronTag array tagsAny is a list of tags to filter by. If specified, the resource
must have at least one of the tags specified to be included in the
result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTags NeutronTag array notTags is a list of tags to filter by. If specified, resources which
contain all of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1
notTagsAny NeutronTag array notTagsAny is a list of tags to filter by. If specified, resources
which contain any of the given tags will be excluded from the result.		 MaxItems: 32
MaxLength: 255
MinLength: 1

SubnetGateway

Appears in: - SubnetResourceSpec

Field Description Default Validation
type SubnetGatewayType type specifies how the default gateway will be created. Automatic
specifies that neutron will automatically add a default gateway. This is
also the default if no Gateway is specified. None specifies that the
subnet will not have a default gateway. IP specifies that the subnet
will use a specific address as the default gateway, which must be
specified in IP.		 Enum: [None Automatic IP]
ip IPvAny ip is the IP address of the default gateway, which must be specified if
Type is IP. It must be a valid IP address, either IPv4 or IPv6,
matching the IPVersion in SubnetResourceSpec.		 MaxLength: 45
MinLength: 1

SubnetGatewayType

Underlying type: string

Appears in: - SubnetGateway

SubnetImport

SubnetImport specifies an existing resource which will be imported instead of creating a new one

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - SubnetSpec

Field Description Default Validation
id string id contains the unique identifier of an existing OpenStack resource. Note
that when specifying an import by ID, the resource MUST already exist.
The ORC object will enter an error state if the resource does not exist.		 Format: uuid
filter SubnetFilter filter contains a resource query which is expected to return a single
result. The controller will continue to retry if filter returns no
results. If filter returns multiple results the controller will set an
error state and will not continue to retry.		 MinProperties: 1

SubnetList

SubnetList contains a list of Subnet.

Field Description Default Validation
apiVersion string openstack.k-orc.cloud/v1alpha1
kind string SubnetList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Subnet array items contains a list of Subnet.

SubnetRefs

Appears in: - SubnetSpec

Field Description Default Validation
networkRef KubernetesNameRef networkRef is a reference to the ORC Network which this subnet is associated with. MaxLength: 253
MinLength: 1

SubnetResourceSpec

Appears in: - SubnetSpec

Field Description Default Validation
name OpenStackName name is a human-readable name of the subnet. If not set, the object's name will be used. MaxLength: 255
MinLength: 1
Pattern: ^[^,]+$
description NeutronDescription description is a human-readable description for the resource. MaxLength: 255
MinLength: 1
tags NeutronTag array tags is a list of tags which will be applied to the subnet. MaxItems: 32
MaxLength: 255
MinLength: 1
ipVersion IPVersion ipVersion is the IP version for the subnet. Enum: [4 6]
cidr CIDR cidr is the address CIDR of the subnet. It must match the IP version specified in IPVersion. Format: cidr
MaxLength: 49
MinLength: 1
allocationPools AllocationPool array allocationPools are IP Address pools that will be available for DHCP. IP
addresses must be in CIDR.		 MaxItems: 32
gateway SubnetGateway gateway specifies the default gateway of the subnet. If not specified,
neutron will add one automatically. To disable this behaviour, specify a
gateway with a type of None.
enableDHCP boolean enableDHCP will either enable to disable the DHCP service.
dnsNameservers IPvAny array dnsNameservers are the nameservers to be set via DHCP. MaxItems: 16
MaxLength: 45
MinLength: 1
dnsPublishFixedIP boolean dnsPublishFixedIP will either enable or disable the publication of
fixed IPs to the DNS. Defaults to false.
hostRoutes HostRoute array hostRoutes are any static host routes to be set via DHCP. MaxItems: 256
ipv6 IPv6Options ipv6 contains IPv6-specific options. It may only be set if IPVersion is 6. MinProperties: 1
routerRef KubernetesNameRef routerRef specifies a router to attach the subnet to MaxLength: 253
MinLength: 1

SubnetResourceStatus

Appears in: - SubnetStatus

Field Description Default Validation
name string name is the human-readable name of the subnet. Might not be unique. MaxLength: 1024
description string description is a human-readable description for the resource. MaxLength: 1024
ipVersion integer ipVersion specifies IP version, either 4' or6'.
cidr string cidr representing IP range for this subnet, based on IP version. MaxLength: 1024
gatewayIP string gatewayIP is the default gateway used by devices in this subnet, if any. MaxLength: 1024
dnsNameservers string array dnsNameservers is a list of name servers used by hosts in this subnet. MaxItems: 16
dnsPublishFixedIP boolean dnsPublishFixedIP specifies whether the fixed IP addresses are published to the DNS.
allocationPools AllocationPoolStatus array allocationPools is a list of sub-ranges within CIDR available for dynamic
allocation to ports.		 MaxItems: 32
hostRoutes HostRouteStatus array hostRoutes is a list of routes that should be used by devices with IPs
from this subnet (not including local subnet route).		 MaxItems: 256
enableDHCP boolean enableDHCP specifies whether DHCP is enabled for this subnet or not.
projectID string projectID is the project owner of the subnet. MaxLength: 1024
ipv6AddressMode string ipv6AddressMode specifies mechanisms for assigning IPv6 IP addresses. MaxLength: 1024
ipv6RAMode string ipv6RAMode is the IPv6 router advertisement mode. It specifies
whether the networking service should transmit ICMPv6 packets.		 MaxLength: 1024
subnetPoolID string subnetPoolID is the id of the subnet pool associated with the subnet. MaxLength: 1024
tags string array tags optionally set via extensions/attributestags MaxItems: 32
createdAt Time createdAt shows the date and time when the resource was created. The date and time stamp format is ISO 8601
updatedAt Time updatedAt shows the date and time when the resource was updated. The date and time stamp format is ISO 8601
revisionNumber integer revisionNumber optionally set via extensions/standard-attr-revisions

SubnetSpec

SubnetSpec defines the desired state of an ORC object.

Appears in: - Subnet

Field Description Default Validation
networkRef KubernetesNameRef networkRef is a reference to the ORC Network which this subnet is associated with. MaxLength: 253
MinLength: 1
import SubnetImport import refers to an existing OpenStack resource which will be imported instead of
creating a new one.		 MaxProperties: 1
MinProperties: 1
resource SubnetResourceSpec resource specifies the desired state of the resource.

resource may not be specified if the management policy is unmanaged.

resource must be specified if the management policy is managed.
managementPolicy ManagementPolicy managementPolicy defines how ORC will treat the object. Valid values are
managed: ORC will create, update, and delete the resource; unmanaged:
ORC will import an existing resource, and will not apply updates to it or
delete it.		 managed Enum: [managed unmanaged]
managedOptions ManagedOptions managedOptions specifies options which may be applied to managed objects.
cloudCredentialsRef CloudCredentialsReference cloudCredentialsRef points to a secret containing OpenStack credentials

UserDataSpec

Validation: - MaxProperties: 1 - MinProperties: 1

Appears in: - ServerResourceSpec

Field Description Default Validation
secretRef KubernetesNameRef secretRef is a reference to a Secret containing the user data for this server. MaxLength: 253
MinLength: 1