# Functions

GetOpenStackBackupOperationInProgress - If there is a backup or restore in progress, returns a string indicating the operation.
GetOpenStackBackupRequestsWithLabel - Return a list of all OpenStackBackupRequestss in the namespace that have (optional) labels.
GetOpenStackBackupsWithLabel - Return a list of all OpenStackBackups in the namespace that have (optional) labels.
GetOSPVersion - returns unified ospdirectorv1beta1.OSPVersion for upstream/downstream version - TemplateVersion16_2 for eitner 16.2 or upstream train - TemplateVersion17_0 for eitner 17.0 or upstream wallaby.
GetOSPVersionFromImageURL -.
IsUniqMAC - check if the MAC address is uniq or already present in the reservations.
NewCondition - Create a new condition object.
OpenStackBackupOverridesReconcile - Should a controller pause reconciliation for a particular resource given potential backup operations?.

# Constants

APIActionCreate - "create" API verb.
APIActionDelete - "delete" API verb.
APIActionUpdate - "update" API verb.
AttachTypeBridge -.
AttachTypeSriov -.
BackupCleaning - the backup is waiting to restore until cleaning is completed.
BackupCleanRestore - restore operator config contained in this backup after first deleting current config.
BackupLoading - the backup is being loaded into the operator to prepare for restoring via reconciliation.
BackupQuiescing - the backup/restore is waiting for controllers to complete pending operations.
BackupReconciling - the backup is being restored via reconciliation as the config of the operator.
BackupRestore - restore operator config contained in this backup.
BackupRestored - the backup was restored as the config of the operator.
BackupRestoreError - the backup restore failed for some reason.
BackupSave - save current operator config.
BackupSaved - the backup contains the saved config of the operator.
BackupSaveError - the backup failed to save the operator config for some reason.
BackupSaving - the backup is saving the current config of the operator.
BackupWaiting - the backup/restore is blocked by prerequisite objects.
BaremetalHostCondReasonCloudInitSecretError - error creating cloud-init secrets for metal3.
BaremetalHostCondReasonGetError - error get metal3 bmh object.
BaremetalHostCondReasonListError - metal3 bmh list objects error.
BaremetalHostCondReasonUpdateError - error updating metal3 bmh object.
BaremetalSetCondReasonBaremetalHostStatusNotFound - bare metal host status not found.
BaremetalSetCondReasonNetworkDataSecretDeleteError - error deleting network data secret.
BaremetalSetCondReasonProvisioningErrors - errors during bmh provisioning.
BaremetalSetCondReasonScaleDownInsufficientAnnotatedHosts - not enough nodes annotated for deletion.
BaremetalSetCondReasonScaleUpInsufficientHosts - not enough nodes for requested host count.
BaremetalSetCondReasonUserDataSecretDeleteError - error deleting user data secret.
BaremetalSetCondReasonVirtualMachineCountZero - no bmh requested.
BaremetalSetCondReasonVirtualMachineDeprovisioning - bmh deprovisioning in progress.
BaremetalSetCondReasonVirtualMachineProvisioned - bmh provisioned.
BaremetalSetCondReasonVirtualMachineProvisioning - bmh provisioning in progress.
BaremetalSetCondTypeDeprovisioning - one or more BaremetalHosts are deprovisioning.
BaremetalSetCondTypeEmpty - special state for 0 requested BaremetalHosts and 0 already provisioned.
BaremetalSetCondTypeError - general catch-all for actual errors.
BaremetalSetCondTypeInsufficient - one or more BaremetalHosts not found (either for scale-up or scale-down) to satisfy count request.
BaremetalSetCondTypeProvisioned - the requested BaremetalHosts count has been satisfied.
BaremetalSetCondTypeProvisioning - one or more BaremetalHosts are provisioning.
BaremetalSetCondTypeWaiting - something other than BaremetalHost availability is causing the OpenStackBaremetalSet to wait.
CommonCondReasonAddOSNetLabelError - error adding osnet labels.
CommonCondReasonAddRefLabelError - error adding reference label.
CommonCondReasonCAConfigMapError - ca config map error.
CommonCondReasonCAConfigMapMissing - ca config map does not exist.
CommonCondReasonCIDRParseError - could not parse CIDR.
CommonCondReasonConfigMapError - config map error.
CommonCondReasonConfigMapMissing - config map does not exist.
CommonCondReasonControllerReferenceError - error set controller reference on object.
CommonCondReasonCRStatusUpdateError - error updating CR status.
CommonCondReasonDeploymentSecretError - deployment secret error.
CommonCondReasonDeploymentSecretMissing - deployment secret does not exist.
CommonCondReasonIdmSecretError - idm secret error.
CommonCondReasonIdmSecretMissing - idm secret does not exist.
CommonCondReasonInit - new resource set to reason Init.
CommonCondReasonNewHostnameError - error creating new hostname.
CommonCondReasonNNCPError - NNCP error.
CommonCondReasonOSNetAvailable - openstack networks available.
CommonCondReasonOSNetError - openstack network error.
CommonCondReasonOSNetNotFound - openstack network not found.
CommonCondReasonOSNetWaiting - openstack network waiting.
CommonCondReasonOwnerRefLabeledObjectsDeleteError - error deleting object using OwnerRef label.
CommonCondReasonRemoveFinalizerError - error removing finalizer from object.
CommonCondReasonSecretDeleteError - secret deletion error.
CommonCondReasonSecretError - secret error.
CommonCondReasonSecretMissing - secret does not exist.
CommonCondReasonServiceNotFound - service not found.
CommonCondTypeCreated - general resource created.
CommonCondTypeDeprovisioning - one or more resources are deprovisioning.
CommonCondTypeEmpty - special state for 0 requested resources and 0 already provisioned.
CommonCondTypeError - general catch-all for actual errors.
CommonCondTypeProvisioned - the requested resource count has been satisfied.
CommonCondTypeProvisioning - one or more resoources are provisioning.
CommonCondTypeWaiting - something is causing the CR to wait.
ConfigGeneratorCondReasonClusterServiceIPError - error rendering environmane file.
ConfigGeneratorCondReasonCMCreateError - error creating/update CM.
ConfigGeneratorCondReasonCMHashChanged - cm hash changed.
ConfigGeneratorCondReasonCMHashError - error creating/update CM.
ConfigGeneratorCondReasonCMNotFound - configmap not found.
ConfigGeneratorCondReasonCMUpdated - configmap updated.
ConfigGeneratorCondReasonConfigCreate - config create in progress.
ConfigGeneratorCondReasonCustomRolesNotFound - custom roles file not found.
ConfigGeneratorCondReasonEphemeralHeatDelete - Ephemeral heat delete.
ConfigGeneratorCondReasonEphemeralHeatLaunch - Ephemeral heat to launch.
ConfigGeneratorCondReasonEphemeralHeatUpdated - Ephemeral heat created/updated.
ConfigGeneratorCondReasonFencingTemplateError - Error creating fencing config parameters.
ConfigGeneratorCondReasonInputLabelError - error adding/update ConfigGeneratorInputLabel.
ConfigGeneratorCondReasonJobCreated - created job.
ConfigGeneratorCondReasonJobDelete - delete job.
ConfigGeneratorCondReasonJobFailed - failed job.
ConfigGeneratorCondReasonJobFinished - job finished.
ConfigGeneratorCondReasonRenderEnvFilesError - error rendering environmane file.
ConfigGeneratorCondReasonVMInstanceList - VM instance list error.
ConfigGeneratorCondReasonWaitingNodesProvisioned - waiting on nodes be provisioned.
ConfigGeneratorCondTypeError - the config generation hit a generic error.
ConfigGeneratorCondTypeFinished - the config generation has finished executing.
ConfigGeneratorCondTypeGenerating - the config generator is executing.
ConfigGeneratorCondTypeInitializing - the config generator is preparing to execute.
ConfigGeneratorCondTypeWaiting - the config generator is blocked by prerequisite objects.
ControlPlaneDeprovisioning - one or more VMs are deprovisioning.
ControlPlaneEmpty - special state for 0 requested VMs and 0 already provisioned.
ControlPlaneError - general catch-all for actual errors.
ControlPlaneName -.
ControlPlaneNameLower -.
ControlPlaneProvisioned - the requested VM count for all roles has been satisfied.
ControlPlaneProvisioning - one or more VMs are provisioning.
ControlPlaneReasonDeploymentSSHKeysGenError - Deployment SSH Keys generation Error.
ControlPlaneReasonDeploymentSSHKeysSecretCreateOrUpdateError - Deployment SSH Keys Secret Crate or Update Error.
ControlPlaneReasonDeploymentSSHKeysSecretError - Deployment SSH Keys Secret Error.
ControlPlaneReasonNetNotFound - osctlplane not found.
ControlPlaneReasonNotSupportedVersion - osctlplane not found.
ControlPlaneReasonTripleoPasswordsSecretCreateError - Tripleo password secret create error.
ControlPlaneReasonTripleoPasswordsSecretError - Tripleo password secret error.
ControlPlaneReasonTripleoPasswordsSecretNotFound - Tripleo password secret not found.
ControlPlaneWaiting - something is causing the OpenStackBaremetalSet to wait.
DefaultDomainName -.
DefaultOVNChassisPhysNetMACPrefix - default prefix used to create MAC addresses for OVNStaticBridgeMacMappings.
DefaultOVNChassisPhysNetName - default physnet netname used for OVNStaticBridgeMacMappings.
EphemeralHeatCondGenPassSecretError - error generating password secret.
EphemeralHeatCondHeatError - error creating/updating Heat pod or service.
EphemeralHeatCondMariaDBError - error creating/updating MariaDB pod or service.
EphemeralHeatCondRabbitMQError - error creating/updating RabbitMQ pod or service.
EphemeralHeatCondWaitOnHeat - waiting for Heat pod to be ready.
EphemeralHeatCondWaitOnMariaDB - waiting for MariaDB pod to be ready.
EphemeralHeatCondWaitOnPassSecret - waiting for the generated password secret to populate.
EphemeralHeatCondWaitOnRabbitMQ - waiting for RabbitMQ pod to be ready.
EphemeralHeatReady - Heat is available for use.
HostRefInitState - intial HostRef state of a new node which has not yet assigned.
MACCondReasonAllMACAddressesCreated - all MAC addresses created.
MACCondReasonCreateMACError - error creating MAC address.
MACCondReasonError - General error getting the OSMACaddr object.
MACCondReasonMACNotFound - osmacaddr object not found.
MACCondReasonNetNotFound - osnet not found.
MACCondReasonRemovedIPs - the removed MAC reservations.
MACCondTypeConfigured - the MAC addresses have been created.
MACCondTypeCreating - we are waiting for mac addresses to be created.
MACCondTypeError - the mac creation hit a error.
MACCondTypeWaiting - the mac creation is blocked by prerequisite objects.
NetAttachCondReasonCreated - osnetattachment created.
NetAttachCondReasonCreateError - error creating osnetatt object.
NetAttachConfigured - the nodes have been configured by the underlying network resources.
NetAttachConfiguring - the underlying network resources are configuring the nodes.
NetAttachError - the network configuration hit a generic error.
NetAttachInitializing - we are waiting for underlying OCP network resource(s) to appear.
NetAttachWaiting - the network configuration is blocked by prerequisite objects.
NetCondReasonCreated - osnet created.
NetCondReasonCreateError - error creating osnet object.
NetCondReasonNetNotFound - error osnet not found.
NetConfigCondReasonIPReservation - ip reservation created.
NetConfigCondReasonIPReservationError - Failed to do ip reservation.
NetConfigCondReasonWaitingOnHost - waiting on host to be added to osnetcfg.
NetConfigCondReasonWaitingOnIPsForHost - waiting on IPs for all configured networks to be created.
NetConfigConfigured - the nodes have been configured by the underlying network resources.
NetConfigConfiguring - the underlying network resources are configuring the nodes.
NetConfigError - the network configuration hit a generic error.
NetConfigInitializing - we are waiting for underlying OCP network resource(s) to appear.
NetConfigured - the nodes have been configured by the underlying network resources.
NetConfiguring - the underlying network resources are configuring the nodes.
NetConfigWaiting - the network configuration is blocked by prerequisite objects.
NetError - the network configuration hit a generic error.
NetInitializing - we are waiting for underlying OCP network resource(s) to appear.
NetWaiting - the network configuration is blocked by prerequisite objects.
OpenStackProvisionServerCondReasonCreated - osprov server object created.
OpenStackProvisionServerCondReasonCreateError - error creating osprov server object.
OpenStackProvisionServerCondReasonDeploymentCreated - osprovserver associated deployment has been created/update.
OpenStackProvisionServerCondReasonDeploymentError - osprovserver associated deployment failed to create/update.
OpenStackProvisionServerCondReasonGetError - osprovserver list objects error.
OpenStackProvisionServerCondReasonInterfaceAcquireError - osprovserver hit an error while finding provisioning interface name.
OpenStackProvisionServerCondReasonInterfaceNotFound - osprovserver unable to find provisioning interface name.
OpenStackProvisionServerCondReasonListError - osprovserver list objects error.
OpenStackProvisionServerCondReasonLocalImageURLParseError - osprovserver was unable to parse its received local image URL.
OpenStackProvisionServerCondReasonNotFound - osprovserver object not found.
OpenStackProvisionServerCondReasonProvisioned - osprovserver associated pod is provisioned.
OpenStackProvisionServerCondReasonProvisioning - osprovserver associated pod is provisioning.
OsClientCondReasonCreated - created openstackclient.
OsClientCondReasonError - error creating openstackclient.
OsClientCondReasonPodDeleteError - pod delete error.
OsClientCondReasonPodError - error creating pod.
OsClientCondReasonPodMissing - openstackclient pod missing.
OsClientCondReasonPodProvisioned - pod created.
OsClientCondReasonProvisioned - pod created.
OsClientCondReasonPVCError - error creating pvc.
OsClientCondReasonPVCProvisioned - pvcs provisioned.
ProvisionServerCondTypeError - general catch-all for actual errors.
ProvisionServerCondTypeProvisioned - the provision server pod is ready.
ProvisionServerCondTypeProvisioning - the provision server pod is provisioning.
ProvisionServerCondTypeWaiting - something else is causing the OpenStackProvisionServer to wait.
TemplateVersion16_2 - OSP 16.2 template version.
TemplateVersion17_0 - OSP 17.0 template version.
TemplateVersionTrain - upstream train template version.
TemplateVersionWallaby - upstream wallaby template version.
VMSetCondReasonBaseImageNotReady - VM base image not ready.
VMSetCondReasonCloudInitSecretError - error creating the CloudInitSecret.
VMSetCondReasonCreated - vmset created.
VMSetCondReasonDeploymentSecretError - deployment secret error.
VMSetCondReasonDeploymentSecretMissing - deployment secret does not exist.
VMSetCondReasonDeprovisioning - vmset deprovisioning.
VMSetCondReasonError - error creating osvmset.
VMSetCondReasonInitialize - vmset initialize.
VMSetCondReasonKubeConfigError - error getting the KubeConfig used by the operator.
VMSetCondReasonKubevirtFencingServiceAccountError - error creating/reading the KubevirtFencingServiceAccount secret.
VMSetCondReasonNamespaceFencingDataError - error creating the namespace fencing data.
VMSetCondReasonPasswordSecretError - password secret error.
VMSetCondReasonPasswordSecretMissing - password secret does not exist.
VMSetCondReasonPersitentVolumeClaimCreating - Persitent Volume Claim create in progress.
VMSetCondReasonPersitentVolumeClaimError - Persitent Volume Claim error.
VMSetCondReasonPersitentVolumeClaimNotFound - Persitent Volume Claim Not Found.
VMSetCondReasonProvisioned - vmset provisioned.
VMSetCondReasonProvisioning - vmset provisioning.
VMSetCondReasonVirtualMachineAnnotationMissmatch - Unable to find sufficient amount of VirtualMachine replicas annotated for scale-down.
VMSetCondReasonVirtualMachineCountZero - no virtual machines requested.
VMSetCondReasonVirtualMachineDeprovisioning - virtual machine deprovisioning in progress.
VMSetCondReasonVirtualMachineGetError - failed to get virtual machine.
VMSetCondReasonVirtualMachineNetworkDataError - Error creating VM NetworkData.
VMSetCondReasonVirtualMachineProvisioned - virtual machines provisioned.
VMSetCondReasonVirtualMachineProvisioning - virtual machine provisioning in progress.
VMSetCondTypeDeprovisioning - one or more VMs are deprovisioning.
VMSetCondTypeEmpty - special state for 0 requested VMs and 0 already provisioned.
VMSetCondTypeError - general catch-all for actual errors.
VMSetCondTypeProvisioned - the requested VM count has been satisfied.
VMSetCondTypeProvisioning - one or more VMs are provisioning.
VMSetCondTypeWaiting - something is causing the OpenStackVmSet to wait.

# Variables

AddToScheme adds the types in this group-version to the given scheme.
GroupVersion is group version used to register these objects.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.

# Structs

Condition - A particular overall condition of a certain resource.
ConditionDetails used for passing condition information into generic functions e.f.
CPUCountReq defines a specific hardware request for CPU core count.
CPUMhzReq defines a specific hardware request for CPU clock speed.
CPUReqs defines specific CPU hardware requests.
CrsForBackup -.
DiskGbReq defines a specific hardware request for disk size.
DiskReqs defines specific disk hardware requests.
DiskSSDReq defines a specific hardware request for disk of type SSD (true) or rotational (false).
HardwareReqs defines request hardware attributes for the BaremetalHost replicas.
Hash - struct to add hashes to status.
Host -.
HostStatus represents the hostname and IP info for a specific host.
IPReservation contains an IP, Hostname, and a VIP flag.
MemGbReq defines a specific hardware request for memory size.
MemReqs defines specific memory hardware requests.
NetDetails of a subnet.
Network describes a tripleo network.
NetworkStatus represents the network details of a network.
NodeConfigurationPolicy - policy definition to create NodeNetworkConfigurationPolicy or NodeSriovConfigurationPolicy.
NodeIPReservation contains an IP and Deleted flag.
NodeSriovConfigurationPolicy - Node selector and desired state for SRIOV network.
OpenStackBackup is used to backup OpenShift resources representing an OSP overcloud.
OpenStackBackupList contains a list of OpenStackBackup.
OpenStackBackupRequest is the Schema for the openstackbackuprequests API.
OpenStackBackupRequestList contains a list of OpenStackBackupRequest.
OpenStackBackupRequestSpec defines the desired state of OpenStackBackupRequest.
OpenStackBackupRequestStatus defines the observed state of OpenStackBackupRequest.
OpenStackBackupSpec defines the desired state of OpenStackBackup.
OpenStackBackupStatus defines the observed state of OpenStackBackup.
OpenStackBaremetalSet represent a set of baremetal hosts for a specific role within the Overcloud deployment.
OpenStackBaremetalSetList contains a list of OpenStackBaremetalSet.
OpenStackBaremetalSetProvisioningStatus represents the overall provisioning state of all BaremetalHosts in the OpenStackBaremetalSet (with an optional explanatory message).
OpenStackBaremetalSetSpec defines the desired state of OpenStackBaremetalSet.
OpenStackBaremetalSetStatus defines the observed state of OpenStackBaremetalSet.
OpenStackClient used to create a container for deploying, scaling, and managing the OpenStack Overcloud.
OpenStackClientList contains a list of OpenStackClient.
OpenStackClientSpec defines the desired state of OpenStackClient.
OpenStackClientStatus defines the observed state of OpenStackClient.
OpenStackConfigGenerator Used to configure Heat environments and template customizations to generate Ansible playbooks for OpenStack Overcloud deployment.
OpenStackConfigGeneratorDefaults -.
OpenStackConfigGeneratorList contains a list of OpenStackConfigGenerator.
OpenStackConfigGeneratorSpec defines the desired state of OpenStackConfigGenerator.
OpenStackConfigGeneratorStatus defines the observed state of OpenStackConfigGenerator.
OpenStackConfigVersion is the Schema for the openstackconfigversions API.
OpenStackConfigVersionList contains a list of OpenStackConfigVersion.
OpenStackConfigVersionSpec defines the desired state of OpenStackConfigVersion.
OpenStackConfigVersionStatus defines the observed state of OpenStackConfigVersion.
OpenStackControlPlane represents a virtualized OpenStack control plane configuration.
OpenStackControlPlaneDefaults -.
OpenStackControlPlaneList contains a list of OpenStackControlPlane.
OpenStackControlPlaneProvisioningStatus represents the overall provisioning state of the OpenStackControlPlane (with an optional explanatory message).
OpenStackControlPlaneSpec defines the desired state of OpenStackControlPlane.
OpenStackControlPlaneStatus defines the observed state of OpenStackControlPlane.
OpenStackEphemeralHeat is the Schema for the openstackephemeralheats API.
OpenStackEphemeralHeatDefaults -.
OpenStackEphemeralHeatList contains a list of OpenStackEphemeralHeat.
OpenStackEphemeralHeatSpec defines the desired state of OpenStackEphemeralHeat.
OpenStackEphemeralHeatStatus defines the observed state of OpenStackEphemeralHeat.
OpenStackHostStatus per host IP set.
OpenStackMACAddress is the Schema for the openstackmacaddresses API.
OpenStackMACAddressList contains a list of OpenStackMACAddress.
OpenStackMACAddressSpec defines the desired state of OpenStackMACAddress.
OpenStackMACAddressStatus defines the observed state of OpenStackMACAddress.
OpenStackMACNodeReservation defines the observed state of the MAC addresses per PhysNetworks.
OpenStackMACRoleReservation -.
OpenStackNet represents the IPAM configuration for baremetal and VM hosts within OpenStack Overcloud deployment.
OpenStackNetAttachment is the Schema for the openstacknetattachments API.
OpenStackNetAttachmentList contains a list of OpenStackNetAttachment.
OpenStackNetAttachmentSpec defines the desired state of OpenStackNetAttachment.
OpenStackNetAttachmentStatus defines the observed state of OpenStackNetAttachment.
OpenStackNetConfig is the Schema for the openstacknetconfigs API.
OpenStackNetConfigList contains a list of OpenStackNetConfig.
OpenStackNetConfigProvisioningStatus represents the overall provisioning state of the OpenStackNetConfig (with an optional explanatory message).
OpenStackNetConfigSpec defines the desired state of OpenStackNetConfig.
OpenStackNetConfigStatus defines the observed state of OpenStackNetConfig.
OpenStackNetList contains a list of OpenStackNet.
OpenStackNetRoleReservation defines the observed state of the Role Net reservation.
OpenStackNetRoleStatus defines the observed state of the Role Net status.
OpenStackNetSpec defines the desired state of OpenStackNet.
OpenStackNetStaticNodeReservations defines the static reservations of the nodes.
OpenStackNetStatus defines the observed state of OpenStackNet.
OpenStackProvisionServer is the Schema for the openstackprovisionservers API.
OpenStackProvisionServerDefaults -.
OpenStackProvisionServerList contains a list of OpenStackProvisionServer.
OpenStackProvisionServerProvisioningStatus represents the overall provisioning state of all BaremetalHosts in the OpenStackProvisionServer (with an optional explanatory message).
OpenStackProvisionServerSpec defines the desired state of OpenStackProvisionServer.
OpenStackProvisionServerStatus defines the observed state of OpenStackProvisionServer.
OpenStackVirtualMachineRoleSpec - defines the desired state of VMs.
OpenStackVMSet represents a set of virtual machines hosts for a specific role within the Overcloud deployment.
OpenStackVMSetList contains a list of OpenStackVMSet.
OpenStackVMSetProvisioningStatus represents the overall provisioning state of all VMs in the OpenStackVMSet (with an optional explanatory message).
OpenStackVMSetSpec defines the desired state of an OpenStackVMSet.
OpenStackVMSetStatus defines the observed state of OpenStackVMSet.
OVNBridgeMacMappingConfig defines the desired state of OpenStackMACAddress.
Physnet - name and prefix to be used for the physnet.
Route definition.
SriovState - SRIOV-specific configuration details for an OSP network.
Subnet defines the tripleo subnet.

# Type aliases

APIAction - typedef to enumerate API verbs.
AttachType -.
BackupMode - whether the backup should be saved or restored.
BackupState - the state of this openstack network.
ConditionList - A list of conditions.
ConditionReason - Why a particular condition is true, false or unknown.
ConditionType - A summarizing name for a given condition.
ConfigGeneratorReason - the reason of the condition for this config generator.
ConfigGeneratorState - the state of the execution of this config generator.
ControlPlaneProvisioningReason - the reason of the condition for this openstack ctlplane.
HardwareReqType is used to enumerate the various hardware requests that can be made for the set.
OSPVersion - OSP template version.
ProvisioningState - the overall state of all VMs in this OpenStackVmSet.