ctlplane_resources.adoc

[#custom-resources]
== Custom Resources

* <<openstackclient,OpenStackClient>>
* <<openstackcontrolplane,OpenStackControlPlane>>
* <<openstackversion,OpenStackVersion>>

[#sub-resources]
=== Sub Resources

* <<openstackclientlist,OpenStackClientList>>
* <<openstackclientspec,OpenStackClientSpec>>
* <<openstackclientspeccore,OpenStackClientSpecCore>>
* <<openstackclientstatus,OpenStackClientStatus>>
* <<barbicansection,BarbicanSection>>
* <<cacertconfig,CACertConfig>>
* <<certconfig,CertConfig>>
* <<certsection,CertSection>>
* <<cindersection,CinderSection>>
* <<dnsmasqsection,DNSMasqSection>>
* <<designatesection,DesignateSection>>
* <<galerasection,GaleraSection>>
* <<glancesection,GlanceSection>>
* <<heatsection,HeatSection>>
* <<horizonsection,HorizonSection>>
* <<ironicsection,IronicSection>>
* <<keystonesection,KeystoneSection>>
* <<manilasection,ManilaSection>>
* <<memcachedsection,MemcachedSection>>
* <<neutronsection,NeutronSection>>
* <<novacelloverridespec,NovaCellOverrideSpec>>
* <<novasection,NovaSection>>
* <<octaviasection,OctaviaSection>>
* <<openstackclientsection,OpenStackClientSection>>
* <<openstackcontrolplanelist,OpenStackControlPlaneList>>
* <<openstackcontrolplanespec,OpenStackControlPlaneSpec>>
* <<openstackcontrolplanestatus,OpenStackControlPlaneStatus>>
* <<openstackextravolmounts,OpenStackExtraVolMounts>>
* <<override,Override>>
* <<ovnresources,OvnResources>>
* <<ovnsection,OvnSection>>
* <<placementsection,PlacementSection>>
* <<rabbitmqsection,RabbitmqSection>>
* <<redissection,RedisSection>>
* <<swiftsection,SwiftSection>>
* <<tlscastatus,TLSCAStatus>>
* <<tlsingressconfig,TLSIngressConfig>>
* <<tlspodlevelconfig,TLSPodLevelConfig>>
* <<tlssection,TLSSection>>
* <<tlsserviceoverride,TLSServiceOverride>>
* <<tlsstatus,TLSStatus>>
* <<telemetrysection,TelemetrySection>>
* <<watchersection,WatcherSection>>
* <<containerdefaults,ContainerDefaults>>
* <<containerimages,ContainerImages>>
* <<containertemplate,ContainerTemplate>>
* <<customcontainerimages,CustomContainerImages>>
* <<openstackversionlist,OpenStackVersionList>>
* <<openstackversionspec,OpenStackVersionSpec>>
* <<openstackversionstatus,OpenStackVersionStatus>>
* <<servicedefaults,ServiceDefaults>>
* <<apioverridespec,APIOverrideSpec>>
* <<barbicanapi,BarbicanAPI>>
* <<barbicanapilist,BarbicanAPIList>>
* <<barbicanapispec,BarbicanAPISpec>>
* <<barbicanapistatus,BarbicanAPIStatus>>
* <<barbicanapitemplate,BarbicanAPITemplate>>
* <<barbicanapitemplatecore,BarbicanAPITemplateCore>>
* <<barbicankeystonelistener,BarbicanKeystoneListener>>
* <<barbicankeystonelistenerlist,BarbicanKeystoneListenerList>>
* <<barbicankeystonelistenerspec,BarbicanKeystoneListenerSpec>>
* <<barbicankeystonelistenerstatus,BarbicanKeystoneListenerStatus>>
* <<barbicankeystonelistenertemplate,BarbicanKeystoneListenerTemplate>>
* <<barbican,Barbican>>
* <<barbicanlist,BarbicanList>>
* <<barbicanspec,BarbicanSpec>>
* <<barbicanspecbase,BarbicanSpecBase>>
* <<barbicanspeccore,BarbicanSpecCore>>
* <<barbicanstatus,BarbicanStatus>>
* <<barbicanworker,BarbicanWorker>>
* <<barbicanworkerlist,BarbicanWorkerList>>
* <<barbicanworkerspec,BarbicanWorkerSpec>>
* <<barbicanworkerstatus,BarbicanWorkerStatus>>
* <<barbicanworkertemplate,BarbicanWorkerTemplate>>
* <<barbicancomponenttemplate,BarbicanComponentTemplate>>
* <<barbicanpkcs11template,BarbicanPKCS11Template>>
* <<barbicantemplate,BarbicanTemplate>>
* <<passwordselector,PasswordSelector>>
* <<apioverridespec,APIOverrideSpec>>
* <<cinderapi,CinderAPI>>
* <<cinderapilist,CinderAPIList>>
* <<cinderapispec,CinderAPISpec>>
* <<cinderapistatus,CinderAPIStatus>>
* <<cinderapitemplate,CinderAPITemplate>>
* <<cinderapitemplatecore,CinderAPITemplateCore>>
* <<cinderbackup,CinderBackup>>
* <<cinderbackuplist,CinderBackupList>>
* <<cinderbackupspec,CinderBackupSpec>>
* <<cinderbackupstatus,CinderBackupStatus>>
* <<cinderbackuptemplate,CinderBackupTemplate>>
* <<cinderbackuptemplatecore,CinderBackupTemplateCore>>
* <<cinderscheduler,CinderScheduler>>
* <<cinderschedulerlist,CinderSchedulerList>>
* <<cinderschedulerspec,CinderSchedulerSpec>>
* <<cinderschedulerstatus,CinderSchedulerStatus>>
* <<cinderschedulertemplate,CinderSchedulerTemplate>>
* <<cinderschedulertemplatecore,CinderSchedulerTemplateCore>>
* <<cinder,Cinder>>
* <<cinderextravolmounts,CinderExtraVolMounts>>
* <<cinderlist,CinderList>>
* <<cinderspec,CinderSpec>>
* <<cinderspecbase,CinderSpecBase>>
* <<cinderspeccore,CinderSpecCore>>
* <<cinderstatus,CinderStatus>>
* <<dbpurge,DBPurge>>
* <<cindervolume,CinderVolume>>
* <<cindervolumelist,CinderVolumeList>>
* <<cindervolumespec,CinderVolumeSpec>>
* <<cindervolumestatus,CinderVolumeStatus>>
* <<cindervolumetemplate,CinderVolumeTemplate>>
* <<cindervolumetemplatecore,CinderVolumeTemplateCore>>
* <<cinderservicetemplate,CinderServiceTemplate>>
* <<cindertemplate,CinderTemplate>>
* <<passwordselector,PasswordSelector>>
* <<designateservicetemplate,DesignateServiceTemplate>>
* <<designateservicetemplatecore,DesignateServiceTemplateCore>>
* <<designatetemplate,DesignateTemplate>>
* <<passwordselector,PasswordSelector>>
* <<apioverridespec,APIOverrideSpec>>
* <<designateapi,DesignateAPI>>
* <<designateapilist,DesignateAPIList>>
* <<designateapispecbase,DesignateAPISpecBase>>
* <<designateapistatus,DesignateAPIStatus>>
* <<bind9overridespec,Bind9OverrideSpec>>
* <<designatebackendbind9,DesignateBackendbind9>>
* <<designatebackendbind9list,DesignateBackendbind9List>>
* <<designatebackendbind9specbase,DesignateBackendbind9SpecBase>>
* <<designatebackendbind9status,DesignateBackendbind9Status>>
* <<designatecentral,DesignateCentral>>
* <<designatecentrallist,DesignateCentralList>>
* <<designatecentralspecbase,DesignateCentralSpecBase>>
* <<designatecentralstatus,DesignateCentralStatus>>
* <<designatemdns,DesignateMdns>>
* <<designatemdnslist,DesignateMdnsList>>
* <<designatemdnsspecbase,DesignateMdnsSpecBase>>
* <<designatemdnsstatus,DesignateMdnsStatus>>
* <<mdnsoverridespec,MdnsOverrideSpec>>
* <<designateproducer,DesignateProducer>>
* <<designateproducerlist,DesignateProducerList>>
* <<designateproducerspecbase,DesignateProducerSpecBase>>
* <<designateproducerstatus,DesignateProducerStatus>>
* <<designate,Designate>>
* <<designateextravolmounts,DesignateExtraVolMounts>>
* <<designatelist,DesignateList>>
* <<designatensrecord,DesignateNSRecord>>
* <<designatespec,DesignateSpec>>
* <<designatespecbase,DesignateSpecBase>>
* <<designatespeccore,DesignateSpecCore>>
* <<designatestatus,DesignateStatus>>
* <<designateunbound,DesignateUnbound>>
* <<designateunboundlist,DesignateUnboundList>>
* <<designateunboundspecbase,DesignateUnboundSpecBase>>
* <<designateunboundstatus,DesignateUnboundStatus>>
* <<stubzone,StubZone>>
* <<unboundoverridespec,UnboundOverrideSpec>>
* <<designateworker,DesignateWorker>>
* <<designateworkerlist,DesignateWorkerList>>
* <<designateworkerspecbase,DesignateWorkerSpecBase>>
* <<designateworkerstatus,DesignateWorkerStatus>>
* <<apioverridespec,APIOverrideSpec>>
* <<glanceapitemplate,GlanceAPITemplate>>
* <<imagecache,ImageCache>>
* <<storage,Storage>>
* <<glanceapi,GlanceAPI>>
* <<glanceapilist,GlanceAPIList>>
* <<glanceapispec,GlanceAPISpec>>
* <<glanceapistatus,GlanceAPIStatus>>
* <<dbpurge,DBPurge>>
* <<glance,Glance>>
* <<glanceextravolmounts,GlanceExtraVolMounts>>
* <<glancelist,GlanceList>>
* <<glancespec,GlanceSpec>>
* <<glancespeccore,GlanceSpecCore>>
* <<glancestatus,GlanceStatus>>
* <<passwordselector,PasswordSelector>>
* <<quotalimits,QuotaLimits>>
* <<apioverridespec,APIOverrideSpec>>
* <<heatextravolmounts,HeatExtraVolMounts>>
* <<heatservicetemplate,HeatServiceTemplate>>
* <<heattemplate,HeatTemplate>>
* <<passwordselector,PasswordSelector>>
* <<heatapi,HeatAPI>>
* <<heatapilist,HeatAPIList>>
* <<heatapispec,HeatAPISpec>>
* <<heatapistatus,HeatAPIStatus>>
* <<heatapitemplate,HeatAPITemplate>>
* <<heatapitemplatecore,HeatAPITemplateCore>>
* <<heatcfnapi,HeatCfnAPI>>
* <<heatcfnapilist,HeatCfnAPIList>>
* <<heatcfnapispec,HeatCfnAPISpec>>
* <<heatcfnapistatus,HeatCfnAPIStatus>>
* <<heatcfnapitemplate,HeatCfnAPITemplate>>
* <<heatcfnapitemplatecore,HeatCfnAPITemplateCore>>
* <<heatengine,HeatEngine>>
* <<heatenginelist,HeatEngineList>>
* <<heatenginespec,HeatEngineSpec>>
* <<heatenginestatus,HeatEngineStatus>>
* <<heatenginetemplate,HeatEngineTemplate>>
* <<heat,Heat>>
* <<heatlist,HeatList>>
* <<heatspec,HeatSpec>>
* <<heatspecbase,HeatSpecBase>>
* <<heatspeccore,HeatSpecCore>>
* <<heatstatus,HeatStatus>>
* <<horizionoverridespec,HorizionOverrideSpec>>
* <<horizon,Horizon>>
* <<horizonextravolmounts,HorizonExtraVolMounts>>
* <<horizonlist,HorizonList>>
* <<horizonspec,HorizonSpec>>
* <<horizonspeccore,HorizonSpecCore>>
* <<horizonstatus,HorizonStatus>>
* <<ironicservicetemplate,IronicServiceTemplate>>
* <<keystoneendpoints,KeystoneEndpoints>>
* <<passwordselector,PasswordSelector>>
* <<apioverridespec,APIOverrideSpec>>
* <<ironicapi,IronicAPI>>
* <<ironicapilist,IronicAPIList>>
* <<ironicapispec,IronicAPISpec>>
* <<ironicapistatus,IronicAPIStatus>>
* <<ironicapitemplate,IronicAPITemplate>>
* <<ironicconductor,IronicConductor>>
* <<ironicconductorlist,IronicConductorList>>
* <<ironicconductorspec,IronicConductorSpec>>
* <<ironicconductorstatus,IronicConductorStatus>>
* <<ironicconductortemplate,IronicConductorTemplate>>
* <<inspectoroverridespec,InspectorOverrideSpec>>
* <<ironicinspector,IronicInspector>>
* <<ironicinspectorlist,IronicInspectorList>>
* <<ironicinspectorpasswordselector,IronicInspectorPasswordSelector>>
* <<ironicinspectorspec,IronicInspectorSpec>>
* <<ironicinspectorstatus,IronicInspectorStatus>>
* <<ironicinspectortemplate,IronicInspectorTemplate>>
* <<ironicneutronagent,IronicNeutronAgent>>
* <<ironicneutronagentlist,IronicNeutronAgentList>>
* <<ironicneutronagentspec,IronicNeutronAgentSpec>>
* <<ironicneutronagentstatus,IronicNeutronAgentStatus>>
* <<ironicneutronagenttemplate,IronicNeutronAgentTemplate>>
* <<dhcprange,DHCPRange>>
* <<ironic,Ironic>>
* <<ironicimages,IronicImages>>
* <<ironiclist,IronicList>>
* <<ironicspec,IronicSpec>>
* <<ironicspeccore,IronicSpecCore>>
* <<ironicstatus,IronicStatus>>
* <<apioverridespec,APIOverrideSpec>>
* <<httpdcustomization,HttpdCustomization>>
* <<keystoneapi,KeystoneAPI>>
* <<keystoneapilist,KeystoneAPIList>>
* <<keystoneapispec,KeystoneAPISpec>>
* <<keystoneapispeccore,KeystoneAPISpecCore>>
* <<keystoneapistatus,KeystoneAPIStatus>>
* <<keystoneextramounts,KeystoneExtraMounts>>
* <<passwordselector,PasswordSelector>>
* <<endpoint,Endpoint>>
* <<keystoneendpoint,KeystoneEndpoint>>
* <<keystoneendpointlist,KeystoneEndpointList>>
* <<keystoneendpointspec,KeystoneEndpointSpec>>
* <<keystoneendpointstatus,KeystoneEndpointStatus>>
* <<keystoneservice,KeystoneService>>
* <<keystoneservicelist,KeystoneServiceList>>
* <<keystoneservicespec,KeystoneServiceSpec>>
* <<keystoneservicestatus,KeystoneServiceStatus>>
* <<manilaservicetemplate,ManilaServiceTemplate>>
* <<manilatemplate,ManilaTemplate>>
* <<passwordselector,PasswordSelector>>
* <<apioverridespec,APIOverrideSpec>>
* <<manilaapi,ManilaAPI>>
* <<manilaapilist,ManilaAPIList>>
* <<manilaapispec,ManilaAPISpec>>
* <<manilaapistatus,ManilaAPIStatus>>
* <<manilaapitemplate,ManilaAPITemplate>>
* <<manilaapitemplatecore,ManilaAPITemplateCore>>
* <<manilascheduler,ManilaScheduler>>
* <<manilaschedulerlist,ManilaSchedulerList>>
* <<manilaschedulerspec,ManilaSchedulerSpec>>
* <<manilaschedulerstatus,ManilaSchedulerStatus>>
* <<manilaschedulertemplate,ManilaSchedulerTemplate>>
* <<manilaschedulertemplatecore,ManilaSchedulerTemplateCore>>
* <<manilashare,ManilaShare>>
* <<manilasharelist,ManilaShareList>>
* <<manilasharespec,ManilaShareSpec>>
* <<manilasharestatus,ManilaShareStatus>>
* <<manilasharetemplate,ManilaShareTemplate>>
* <<manilasharetemplatecore,ManilaShareTemplateCore>>
* <<dbpurge,DBPurge>>
* <<manila,Manila>>
* <<maniladebug,ManilaDebug>>
* <<manilaextravolmounts,ManilaExtraVolMounts>>
* <<manilalist,ManilaList>>
* <<manilaspec,ManilaSpec>>
* <<manilaspecbase,ManilaSpecBase>>
* <<manilaspeccore,ManilaSpecCore>>
* <<manilastatus,ManilaStatus>>
* <<galerabackup,GaleraBackup>>
* <<galerabackuplist,GaleraBackupList>>
* <<galerabackupspec,GaleraBackupSpec>>
* <<galerabackupstatus,GaleraBackupStatus>>
* <<galerabackuptransferstoragespec,GaleraBackupTransferStorageSpec>>
* <<galera,Galera>>
* <<galeraattributes,GaleraAttributes>>
* <<galeralist,GaleraList>>
* <<galeraspec,GaleraSpec>>
* <<galeraspeccore,GaleraSpecCore>>
* <<galerastatus,GaleraStatus>>
* <<mariadbaccount,MariaDBAccount>>
* <<mariadbaccountlist,MariaDBAccountList>>
* <<mariadbaccountspec,MariaDBAccountSpec>>
* <<mariadbaccountstatus,MariaDBAccountStatus>>
* <<mariadbdatabase,MariaDBDatabase>>
* <<mariadbdatabaselist,MariaDBDatabaseList>>
* <<mariadbdatabasespec,MariaDBDatabaseSpec>>
* <<mariadbdatabasestatus,MariaDBDatabaseStatus>>
* <<apioverridespec,APIOverrideSpec>>
* <<neutronapi,NeutronAPI>>
* <<neutronapilist,NeutronAPIList>>
* <<neutronapispec,NeutronAPISpec>>
* <<neutronapispeccore,NeutronAPISpecCore>>
* <<neutronapistatus,NeutronAPIStatus>>
* <<neutronapitls,NeutronApiTLS>>
* <<neutronextravolmounts,NeutronExtraVolMounts>>
* <<passwordselector,PasswordSelector>>
* <<novacellimages,NovaCellImages>>
* <<novaimages,NovaImages>>
* <<novaservicebase,NovaServiceBase>>
* <<passwordselector,PasswordSelector>>
* <<apioverridespec,APIOverrideSpec>>
* <<novaapi,NovaAPI>>
* <<novaapilist,NovaAPIList>>
* <<novaapispec,NovaAPISpec>>
* <<novaapistatus,NovaAPIStatus>>
* <<novaapitemplate,NovaAPITemplate>>
* <<novacell,NovaCell>>
* <<novacelldbpurge,NovaCellDBPurge>>
* <<novacelllist,NovaCellList>>
* <<novacellspec,NovaCellSpec>>
* <<novacellstatus,NovaCellStatus>>
* <<novacelltemplate,NovaCellTemplate>>
* <<novacompute,NovaCompute>>
* <<novacomputecellstatus,NovaComputeCellStatus>>
* <<novacomputelist,NovaComputeList>>
* <<novacomputespec,NovaComputeSpec>>
* <<novacomputestatus,NovaComputeStatus>>
* <<novacomputetemplate,NovaComputeTemplate>>
* <<novaconductor,NovaConductor>>
* <<novaconductorlist,NovaConductorList>>
* <<novaconductorspec,NovaConductorSpec>>
* <<novaconductorstatus,NovaConductorStatus>>
* <<novaconductortemplate,NovaConductorTemplate>>
* <<metadataoverridespec,MetadataOverrideSpec>>
* <<novametadata,NovaMetadata>>
* <<novametadatalist,NovaMetadataList>>
* <<novametadataspec,NovaMetadataSpec>>
* <<novametadatastatus,NovaMetadataStatus>>
* <<novametadatatemplate,NovaMetadataTemplate>>
* <<novanovncproxy,NovaNoVNCProxy>>
* <<novanovncproxylist,NovaNoVNCProxyList>>
* <<novanovncproxyspec,NovaNoVNCProxySpec>>
* <<novanovncproxystatus,NovaNoVNCProxyStatus>>
* <<novanovncproxytemplate,NovaNoVNCProxyTemplate>>
* <<tlssection,TLSSection>>
* <<vncproxyoverridespec,VNCProxyOverrideSpec>>
* <<novascheduler,NovaScheduler>>
* <<novaschedulerlist,NovaSchedulerList>>
* <<novaschedulerspec,NovaSchedulerSpec>>
* <<novaschedulerstatus,NovaSchedulerStatus>>
* <<novaschedulertemplate,NovaSchedulerTemplate>>
* <<nova,Nova>>
* <<novalist,NovaList>>
* <<novaspeccore,NovaSpecCore>>
* <<novastatus,NovaStatus>>
* <<octaviaamphoracontroller,OctaviaAmphoraController>>
* <<octaviaamphoracontrollerlist,OctaviaAmphoraControllerList>>
* <<octaviaamphoracontrollerspec,OctaviaAmphoraControllerSpec>>
* <<octaviaamphoracontrollerspeccore,OctaviaAmphoraControllerSpecCore>>
* <<octaviaamphoracontrollerstatus,OctaviaAmphoraControllerStatus>>
* <<apioverridespec,APIOverrideSpec>>
* <<octaviaapi,OctaviaAPI>>
* <<octaviaapilist,OctaviaAPIList>>
* <<octaviaapispec,OctaviaAPISpec>>
* <<octaviaapispeccore,OctaviaAPISpecCore>>
* <<octaviaapistatus,OctaviaAPIStatus>>
* <<octaviaapitls,OctaviaApiTLS>>
* <<octaviarsyslog,OctaviaRsyslog>>
* <<octaviarsysloglist,OctaviaRsyslogList>>
* <<octaviarsyslogspec,OctaviaRsyslogSpec>>
* <<octaviarsyslogspeccore,OctaviaRsyslogSpecCore>>
* <<octaviarsyslogstatus,OctaviaRsyslogStatus>>
* <<octaviarsyslogtarget,OctaviaRsyslogTarget>>
* <<octavia,Octavia>>
* <<octaviaamphoraflavor,OctaviaAmphoraFlavor>>
* <<octavialbmgmtnetworks,OctaviaLbMgmtNetworks>>
* <<octavialist,OctaviaList>>
* <<octaviaspec,OctaviaSpec>>
* <<octaviaspecbase,OctaviaSpecBase>>
* <<octaviaspeccore,OctaviaSpecCore>>
* <<octaviastatus,OctaviaStatus>>
* <<passwordselector,PasswordSelector>>
* <<bondconfig,BondConfig>>
* <<cpucountreq,CPUCountReq>>
* <<cpumhzreq,CPUMhzReq>>
* <<cpureqs,CPUReqs>>
* <<diskgbreq,DiskGbReq>>
* <<diskreqs,DiskReqs>>
* <<diskssdreq,DiskSSDReq>>
* <<hardwarereqs,HardwareReqs>>
* <<hoststatus,HostStatus>>
* <<ipstatus,IPStatus>>
* <<instancespec,InstanceSpec>>
* <<memgbreq,MemGbReq>>
* <<memreqs,MemReqs>>
* <<openstackbaremetalset,OpenStackBaremetalSet>>
* <<openstackbaremetalsetlist,OpenStackBaremetalSetList>>
* <<openstackbaremetalsetspec,OpenStackBaremetalSetSpec>>
* <<openstackbaremetalsetstatus,OpenStackBaremetalSetStatus>>
* <<openstackbaremetalsettemplatespec,OpenStackBaremetalSetTemplateSpec>>
* <<openstackprovisionserver,OpenStackProvisionServer>>
* <<openstackprovisionserverdefaults,OpenStackProvisionServerDefaults>>
* <<openstackprovisionserverlist,OpenStackProvisionServerList>>
* <<openstackprovisionserverspec,OpenStackProvisionServerSpec>>
* <<openstackprovisionserverstatus,OpenStackProvisionServerStatus>>
* <<bond,Bond>>
* <<ovncontroller,OVNController>>
* <<ovncontrollerlist,OVNControllerList>>
* <<ovncontrollerspec,OVNControllerSpec>>
* <<ovncontrollerspeccore,OVNControllerSpecCore>>
* <<ovncontrollerstatus,OVNControllerStatus>>
* <<ovsexternalids,OVSExternalIDs>>
* <<ovndbcluster,OVNDBCluster>>
* <<ovndbclusterlist,OVNDBClusterList>>
* <<ovndbclusteroverridespec,OVNDBClusterOverrideSpec>>
* <<ovndbclusterspec,OVNDBClusterSpec>>
* <<ovndbclusterspeccore,OVNDBClusterSpecCore>>
* <<ovndbclusterstatus,OVNDBClusterStatus>>
* <<ovnnorthd,OVNNorthd>>
* <<ovnnorthdlist,OVNNorthdList>>
* <<ovnnorthdspec,OVNNorthdSpec>>
* <<ovnnorthdspeccore,OVNNorthdSpecCore>>
* <<ovnnorthdstatus,OVNNorthdStatus>>
* <<apioverridespec,APIOverrideSpec>>
* <<passwordselector,PasswordSelector>>
* <<placementapi,PlacementAPI>>
* <<placementapilist,PlacementAPIList>>
* <<placementapispec,PlacementAPISpec>>
* <<placementapispeccore,PlacementAPISpecCore>>
* <<placementapistatus,PlacementAPIStatus>>
* <<passwordselector,PasswordSelector>>
* <<proxyoverridespec,ProxyOverrideSpec>>
* <<swiftproxy,SwiftProxy>>
* <<swiftproxylist,SwiftProxyList>>
* <<swiftproxyspec,SwiftProxySpec>>
* <<swiftproxyspeccore,SwiftProxySpecCore>>
* <<swiftproxystatus,SwiftProxyStatus>>
* <<swiftdisk,SwiftDisk>>
* <<swiftring,SwiftRing>>
* <<swiftringlist,SwiftRingList>>
* <<swiftringspec,SwiftRingSpec>>
* <<swiftringspeccore,SwiftRingSpecCore>>
* <<swiftringstatus,SwiftRingStatus>>
* <<swiftstorage,SwiftStorage>>
* <<swiftstoragelist,SwiftStorageList>>
* <<swiftstoragespec,SwiftStorageSpec>>
* <<swiftstoragespeccore,SwiftStorageSpecCore>>
* <<swiftstoragestatus,SwiftStorageStatus>>
* <<swift,Swift>>
* <<swiftlist,SwiftList>>
* <<swiftspec,SwiftSpec>>
* <<swiftspecbase,SwiftSpecBase>>
* <<swiftspeccore,SwiftSpecCore>>
* <<swiftstatus,SwiftStatus>>
* <<apioverridespec,APIOverrideSpec>>
* <<aodh,Aodh>>
* <<aodhcore,AodhCore>>
* <<autoscaling,Autoscaling>>
* <<autoscalinglist,AutoscalingList>>
* <<autoscalingspec,AutoscalingSpec>>
* <<autoscalingspecbase,AutoscalingSpecBase>>
* <<autoscalingspeccore,AutoscalingSpecCore>>
* <<autoscalingstatus,AutoscalingStatus>>
* <<ceilometer,Ceilometer>>
* <<ceilometerlist,CeilometerList>>
* <<ceilometerspec,CeilometerSpec>>
* <<ceilometerspeccore,CeilometerSpecCore>>
* <<ceilometerstatus,CeilometerStatus>>
* <<ksmstatus,KSMStatus>>
* <<logging,Logging>>
* <<logginglist,LoggingList>>
* <<loggingspec,LoggingSpec>>
* <<loggingstatus,LoggingStatus>>
* <<metricstorage,MetricStorage>>
* <<metricstoragelist,MetricStorageList>>
* <<metricstoragespec,MetricStorageSpec>>
* <<metricstoragestatus,MetricStorageStatus>>
* <<monitoringstack,MonitoringStack>>
* <<persistentstorage,PersistentStorage>>
* <<storage,Storage>>
* <<autoscalingsection,AutoscalingSection>>
* <<autoscalingsectioncore,AutoscalingSectionCore>>
* <<ceilometersection,CeilometerSection>>
* <<ceilometersectioncore,CeilometerSectionCore>>
* <<loggingsection,LoggingSection>>
* <<metricstoragesection,MetricStorageSection>>
* <<passwordsselector,PasswordsSelector>>
* <<telemetry,Telemetry>>
* <<telemetrylist,TelemetryList>>
* <<telemetryspec,TelemetrySpec>>
* <<telemetryspecbase,TelemetrySpecBase>>
* <<telemetryspeccore,TelemetrySpecCore>>
* <<telemetrystatus,TelemetryStatus>>
* <<passwordselector,PasswordSelector>>
* <<watchercommon,WatcherCommon>>
* <<watcherimages,WatcherImages>>
* <<watcherspeccore,WatcherSpecCore>>
* <<watchersubcrscommon,WatcherSubCrsCommon>>
* <<watchersubcrstemplate,WatcherSubCrsTemplate>>
* <<apioverridespec,APIOverrideSpec>>
* <<watcherapi,WatcherAPI>>
* <<watcherapilist,WatcherAPIList>>
* <<watcherapispec,WatcherAPISpec>>
* <<watcherapistatus,WatcherAPIStatus>>
* <<watcherapitemplate,WatcherAPITemplate>>
* <<watcherapplier,WatcherApplier>>
* <<watcherapplierlist,WatcherApplierList>>
* <<watcherapplierspec,WatcherApplierSpec>>
* <<watcherapplierstatus,WatcherApplierStatus>>
* <<watcherappliertemplate,WatcherApplierTemplate>>
* <<watcherdecisionengine,WatcherDecisionEngine>>
* <<watcherdecisionenginelist,WatcherDecisionEngineList>>
* <<watcherdecisionenginespec,WatcherDecisionEngineSpec>>
* <<watcherdecisionenginestatus,WatcherDecisionEngineStatus>>
* <<watcherdecisionenginetemplate,WatcherDecisionEngineTemplate>>
* <<watcher,Watcher>>
* <<watcherdbpurge,WatcherDBPurge>>
* <<watcherlist,WatcherList>>
* <<watcherstatus,WatcherStatus>>
* <<mtlssection,MTLSSection>>
* <<memcached,Memcached>>
* <<memcachedlist,MemcachedList>>
* <<memcachedspec,MemcachedSpec>>
* <<memcachedspeccore,MemcachedSpecCore>>
* <<memcachedstatus,MemcachedStatus>>
* <<tlssection,TLSSection>>
* <<bgpconfiguration,BGPConfiguration>>
* <<bgpconfigurationlist,BGPConfigurationList>>
* <<bgpconfigurationspec,BGPConfigurationSpec>>
* <<bgpconfigurationstatus,BGPConfigurationStatus>>
* <<frrnodeconfigurationselectortype,FRRNodeConfigurationSelectorType>>
* <<dnsdata,DNSData>>
* <<dnsdatalist,DNSDataList>>
* <<dnsdataspec,DNSDataSpec>>
* <<dnsdatastatus,DNSDataStatus>>
* <<dnshost,DNSHost>>
* <<dnsmasq,DNSMasq>>
* <<dnsmasqlist,DNSMasqList>>
* <<dnsmasqoption,DNSMasqOption>>
* <<dnsmasqoverridespec,DNSMasqOverrideSpec>>
* <<dnsmasqspec,DNSMasqSpec>>
* <<dnsmasqspeccore,DNSMasqSpecCore>>
* <<dnsmasqstatus,DNSMasqStatus>>
* <<ipset,IPSet>>
* <<ipsetlist,IPSetList>>
* <<ipsetnetwork,IPSetNetwork>>
* <<ipsetreservation,IPSetReservation>>
* <<ipsetspec,IPSetSpec>>
* <<ipsetstatus,IPSetStatus>>
* <<allocationrange,AllocationRange>>
* <<netconfig,NetConfig>>
* <<netconfiglist,NetConfigList>>
* <<netconfigspec,NetConfigSpec>>
* <<network,Network>>
* <<route,Route>>
* <<subnet,Subnet>>
* <<ipaddress,IPAddress>>
* <<reservation,Reservation>>
* <<reservationlist,ReservationList>>
* <<reservationspec,ReservationSpec>>
* <<rabbitmq,RabbitMq>>
* <<rabbitmqlist,RabbitMqList>>
* <<rabbitmqspec,RabbitMqSpec>>
* <<rabbitmqspeccore,RabbitMqSpecCore>>
* <<rabbitmqstatus,RabbitMqStatus>>
* <<transporturl,TransportURL>>
* <<transporturllist,TransportURLList>>
* <<transporturlspec,TransportURLSpec>>
* <<transporturlstatus,TransportURLStatus>>

[#openstackclient]
==== OpenStackClient

OpenStackClient is the Schema for the openstackclients API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<openstackclientspec,OpenStackClientSpec>>
| false

| status
|
| <<openstackclientstatus,OpenStackClientStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackclientlist]
==== OpenStackClientList

OpenStackClientList contains a list of OpenStackClient

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<openstackclient,OpenStackClient>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#openstackclientspec]
==== OpenStackClientSpec

OpenStackClientSpec defines the desired state of OpenStackClient

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage for the OpenstackClient container (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#openstackclientspeccore]
==== OpenStackClientSpecCore

OpenStackClientSpecCore defines the desired state of OpenStackClient

|===
| Field | Description | Scheme | Required

| openStackConfigMap
| OpenStackConfigMap is the name of the ConfigMap containing the clouds.yaml
| *string
| true

| openStackConfigSecret
| OpenStackConfigSecret is the name of the Secret containing the secure.yaml
| *string
| true

| nodeSelector
| NodeSelector to target subset of worker nodes
| *map[string]string
| false

| env
| List of environment variables to set in the container.
| []corev1.EnvVar
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackclientstatus]
==== OpenStackClientStatus

OpenStackClientStatus defines the observed state of OpenStackClient

|===
| Field | Description | Scheme | Required

| podName
| PodName
| string
| false

| conditions
| Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this object.
| int64
| false

| hash
| Map of hashes to track e.g. pod spec
| map[string]string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicansection]
==== BarbicanSection

BarbicanSection defines the desired state of Barbican service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Barbican service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Barbican Service
| *barbicanv1.BarbicanSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cacertconfig]
==== CACertConfig

CACertConfig defines details for ca cert configs

|===
| Field | Description | Scheme | Required

| duration
| The requested 'duration' (i.e. lifetime) of the Certificate. The Certificate will be renewed either 2/3 through its duration or `renewBefore` period before its expiry, whichever is later. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration
| *metav1.Duration
| true

| renewBefore
| How long before the currently issued certificate's expiry cert-manager should renew the certificate. The default is 2/3 of the issued certificate's duration. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration
| *metav1.Duration
| false

| customIssuer
| CustomIssuer - use pre-created issue for this CA. No CA and issure is being created the CA cert and chain needs to be added using the CaBundleSecretName.
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#certconfig]
==== CertConfig

CertConfig defines details for cert configs

|===
| Field | Description | Scheme | Required

| duration
| The requested 'duration' (i.e. lifetime) of the Certificate. The Certificate will be renewed either 2/3 through its duration or `renewBefore` period before its expiry, whichever is later. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration
| *metav1.Duration
| true

| renewBefore
| How long before the currently issued certificate's expiry cert-manager should renew the certificate. The default is 2/3 of the issued certificate's duration. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration
| *metav1.Duration
| false
|===

<<custom-resources,Back to Custom Resources>>

[#certsection]
==== CertSection

CertSection defines details for CA config and its certs

|===
| Field | Description | Scheme | Required

| cert
| Cert - defines details for cert config
| <<certconfig,CertConfig>>
| true

| ca
| Ca - defines details for CA cert config
| <<cacertconfig,CACertConfig>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cindersection]
==== CinderSection

CinderSection defines the desired state of Cinder service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Cinder service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating Cinder Resources
| *cinderv1.CinderSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false

| uniquePodNames
| UniquePodNames - Use a unique prefix for cinder CRs to have unique pod names. Convenient to avoid podname (and thus hostname) collision between different deployments. Useful for CI jobs as well as preproduction and production environments that use the same storage backend, etc.
| bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#dnsmasqsection]
==== DNSMasqSection

DNSMasqSection defines the desired state of DNSMasq service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether DNSMasq service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the DNSMasq service
| *networkv1.DNSMasqSpecCore
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatesection]
==== DesignateSection

DesignateSection defines the desired state of the Designate service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether the Designate service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating Designate Resources
| *designatev1.DesignateSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#galerasection]
==== GaleraSection

GaleraSection defines the desired state of Galera services

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Galera services should be deployed and managed
| bool
| true

| templates
| Templates - Overrides to use when creating the Galera databases
| *map[string]mariadbv1.GaleraSpecCore
| false
|===

<<custom-resources,Back to Custom Resources>>

[#glancesection]
==== GlanceSection

GlanceSection defines the desired state of Glance service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Glance service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Glance Service
| *glancev1.GlanceSpecCore
| false

| apiOverrides
| APIOverride, provides the ability to override the generated manifest of several child resources.
| map[string]<<override,Override>>
| false

| uniquePodNames
| UniquePodNames - Use a unique prefix for glance CRs to have unique pod names. Convenient to avoid podname (and thus hostname) collision between different deployments. Useful for CI jobs as well as preproduction and production environments that use the same storage backend, etc.
| bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatsection]
==== HeatSection

HeatSection defines the desired state of Heat services

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Heat services should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Heat services
| *heatv1.HeatSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false

| cnfAPIOverride
| CnfAPIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#horizonsection]
==== HorizonSection

HorizonSection defines the desired state of Horizon services

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Horizon services should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Horizon services
| *horizonv1.HorizonSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicsection]
==== IronicSection

IronicSection defines the desired state of Ironic services

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Ironic services should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Ironic services
| *ironicv1.IronicSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false

| inspectorOverride
| InspectorOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#keystonesection]
==== KeystoneSection

KeystoneSection defines the desired state of Keystone service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Keystone service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Keystone service
| *keystonev1.KeystoneAPISpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilasection]
==== ManilaSection

ManilaSection defines the desired state of Manila service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Manila service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating Manila Resources
| *manilav1.ManilaSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#memcachedsection]
==== MemcachedSection

MemcachedSection defines the desired state of Memcached services

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Memcached services should be deployed and managed
| bool
| true

| templates
| Templates - Overrides to use when creating the Memcached databases
| *map[string]memcachedv1.MemcachedSpecCore
| false
|===

<<custom-resources,Back to Custom Resources>>

[#neutronsection]
==== NeutronSection

NeutronSection defines the desired state of Neutron service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Neutron service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Neutron Service
| *neutronv1.NeutronAPISpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novacelloverridespec]
==== NovaCellOverrideSpec

NovaCellOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| noVNCProxy
|
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novasection]
==== NovaSection

NovaSection defines the desired state of Nova services

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Nova services should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Nova services
| *novav1.NovaSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false

| cellOverride
| CellOverride, provides the ability to override the generated manifest of several child resources for a nova cell. cell0 never have compute nodes and therefore it won't have a noVNCProxy deployed. Providing an override for cell0 noVNCProxy does not have an effect.
| map[string]<<novacelloverridespec,NovaCellOverrideSpec>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviasection]
==== OctaviaSection

OctaviaSection defines the desired state of the Octavia service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether the Octavia service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating Octavia Resources
| *octaviav1.OctaviaSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackclientsection]
==== OpenStackClientSection

OpenStackClientSection defines the desired state of the OpenStackClient

|===
| Field | Description | Scheme | Required

| template
| Template - Overrides to use when creating the OpenStackClient Resource
| v1beta1.OpenStackClientSpecCore
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackcontrolplane]
==== OpenStackControlPlane

OpenStackControlPlane is the Schema for the openstackcontrolplanes API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<openstackcontrolplanespec,OpenStackControlPlaneSpec>>
| false

| status
|
| <<openstackcontrolplanestatus,OpenStackControlPlaneStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackcontrolplanelist]
==== OpenStackControlPlaneList

OpenStackControlPlaneList contains a list of OpenStackControlPlane

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<openstackcontrolplane,OpenStackControlPlane>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#openstackcontrolplanespec]
==== OpenStackControlPlaneSpec

OpenStackControlPlaneSpec defines the desired state of OpenStackControlPlane

|===
| Field | Description | Scheme | Required

| secret
| Secret - FIXME: make this optional
| string
| true

| storageClass
| StorageClass -
| string
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running control plane services
| map[string]string
| false

| tls
| TLS - Parameters related to the TLS
| <<tlssection,TLSSection>>
| true

| dns
| DNS - Parameters related to the DNSMasq service
| <<dnsmasqsection,DNSMasqSection>>
| false

| keystone
| Keystone - Parameters related to the Keystone service
| <<keystonesection,KeystoneSection>>
| false

| placement
| Placement - Parameters related to the Placement service
| <<placementsection,PlacementSection>>
| false

| glance
| Glance - Parameters related to the Glance service
| <<glancesection,GlanceSection>>
| false

| cinder
| Cinder - Parameters related to the Cinder service
| <<cindersection,CinderSection>>
| false

| galera
| Galera - Parameters related to the Galera services
| <<galerasection,GaleraSection>>
| false

| rabbitmq
| Rabbitmq - Parameters related to the Rabbitmq service
| <<rabbitmqsection,RabbitmqSection>>
| false

| notificationsBusInstance
| NotificationsBusInstance - the name of RabbitMQ Cluster CR to select a Messaging Bus Service instance used by all services that produce or consume notifications. Avoid colocating it with RabbitMQ services used for PRC. That instance will be pushed down for services, unless overriden in templates.
| *string
| false

| memcached
| Memcached - Parameters related to the Memcached service
| <<memcachedsection,MemcachedSection>>
| false

| ovn
| Ovn - Overrides to use when creating the OVN Services
| <<ovnsection,OvnSection>>
| false

| neutron
| Neutron - Overrides to use when creating the Neutron Service
| <<neutronsection,NeutronSection>>
| false

| nova
| Nova - Parameters related to the Nova services
| <<novasection,NovaSection>>
| false

| heat
| Heat - Parameters related to the Heat services
| <<heatsection,HeatSection>>
| false

| ironic
| Ironic - Parameters related to the Ironic services
| <<ironicsection,IronicSection>>
| false

| manila
| Manila - Parameters related to the Manila service
| <<manilasection,ManilaSection>>
| false

| horizon
| Horizon - Parameters related to the Horizon services
| <<horizonsection,HorizonSection>>
| false

| telemetry
| Telemetry - Parameters related to the OpenStack Telemetry services
| <<telemetrysection,TelemetrySection>>
| false

| swift
| Swift - Parameters related to the Swift service
| <<swiftsection,SwiftSection>>
| false

| octavia
| Octavia - Parameters related to the Octavia service
| <<octaviasection,OctaviaSection>>
| false

| designate
| Designate - Parameters related to the Designate service
| <<designatesection,DesignateSection>>
| false

| barbican
| Barbican - Parameters related to the Barbican service
| <<barbicansection,BarbicanSection>>
| false

| redis
| Redis - Parameters related to the Redis service
| <<redissection,RedisSection>>
| false

| openstackclient
| OpenStackClient - Parameters related to the OpenStackClient
| <<openstackclientsection,OpenStackClientSection>>
| false

| extraMounts
| ExtraMounts containing conf files and credentials that should be provided to the underlying operators. This struct can be defined in the top level CR and propagated to the underlying operators that accept it in their API (e.g., cinder/glance). However, if extraVolumes are specified within the single operator template Section, the globally defined ExtraMounts are ignored and overridden for the operator which has this section already.
| []<<openstackextravolmounts,OpenStackExtraVolMounts>>
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| watcher
| Watcher - Parameters related to the Watcher service
| <<watchersection,WatcherSection>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackcontrolplanestatus]
==== OpenStackControlPlaneStatus

OpenStackControlPlaneStatus defines the observed state of OpenStackControlPlane

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| tls
| TLS
| <<tlsstatus,TLSStatus>>
| false

| deployedVersion
| DeployedVersion
| *string
| false

| deployedOVNVersion
| DeployedOVNVersion
| *string
| false

| containerImages
| ContainerImages
| <<containerimages,ContainerImages>>
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this object.
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackextravolmounts]
==== OpenStackExtraVolMounts

OpenStackExtraVolMounts exposes additional parameters processed by the openstack-operator and defines the common VolMounts structure provided by the main storage module

|===
| Field | Description | Scheme | Required

| name
|
| string
| false

| region
|
| string
| false

| extraVol
|
| []storage.VolMounts
| true
|===

<<custom-resources,Back to Custom Resources>>

[#override]
==== Override

Override to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| route
| Route overrides to use when creating the public service endpoint
| *route.OverrideSpec
| false

| tls
| TLS - overrides tls parameters for public endpoint
| *<<tlsserviceoverride,TLSServiceOverride>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovnresources]
==== OvnResources

OvnResources defines the desired state of OVN services

|===
| Field | Description | Scheme | Required

| ovnDBCluster
| OVNDBCluster - Overrides to use when creating the OVNDBCluster services
| map[string]ovnv1.OVNDBClusterSpecCore
| false

| ovnNorthd
| OVNNorthd - Overrides to use when creating the OVNNorthd service
| ovnv1.OVNNorthdSpecCore
| false

| ovnController
| OVNController - Overrides to use when creating the OVNController service
| ovnv1.OVNControllerSpecCore
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovnsection]
==== OvnSection

OvnSection defines the desired state of OVN services

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether OVN services should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the OVN services
| *<<ovnresources,OvnResources>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#placementsection]
==== PlacementSection

PlacementSection defines the desired state of Placement service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Placement service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Placement API
| *placementv1.PlacementAPISpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#rabbitmqsection]
==== RabbitmqSection

RabbitmqSection defines the desired state of RabbitMQ service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether RabbitMQ services should be deployed and managed
| bool
| true

| templates
| Templates - Overrides to use when creating the Rabbitmq clusters
| *map[string]rabbitmqv1.RabbitMqSpecCore
| true
|===

<<custom-resources,Back to Custom Resources>>

[#redissection]
==== RedisSection

RedisSection defines the desired state of the Redis service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether the Redis service should be deployed and managed
| bool
| true

| templates
| Templates - Overrides to use when creating the Redis Resources
| *map[string]redisv1.RedisSpecCore
| false
|===

<<custom-resources,Back to Custom Resources>>

[#swiftsection]
==== SwiftSection

SwiftSection defines the desired state of Swift service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Swift service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating Swift Resources
| *swiftv1.SwiftSpecCore
| false

| proxyOverride
| ProxyOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#tlscastatus]
==== TLSCAStatus

TLSCAStatus defines the observed state of TLS

|===
| Field | Description | Scheme | Required

| name
|
| string
| true

| expires
|
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#tlsingressconfig]
==== TLSIngressConfig

TLSIngressConfig defines the desired state of the TLS configuration for the ingress configuration (route)

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether TLS should be enabled for endpoint type
| bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#tlspodlevelconfig]
==== TLSPodLevelConfig

TLSPodLevelConfig defines the desired state of the TLS configuration for TLS termination at the pod level

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether TLS should be enabled for endpoint type
| bool
| true

| internal
| Internal - default CA used for all OpenStackControlPlane and OpenStackDataplane endpoints, except OVN related CA and certs
| <<certsection,CertSection>>
| true

| libvirt
| Libvirt - CA used for libvirt/qemu services on OpenStackControlPlane and OpenStackDataplane
| <<certsection,CertSection>>
| true

| ovn
| Ovn - CA used for all OVN services on OpenStackControlPlane and OpenStackDataplane
| <<certsection,CertSection>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#tlssection]
==== TLSSection

TLSSection defines the desired state of TLS configuration

|===
| Field | Description | Scheme | Required

| ingress
|
| <<tlsingressconfig,TLSIngressConfig>>
| false

| podLevel
|
| <<tlspodlevelconfig,TLSPodLevelConfig>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#tlsserviceoverride]
==== TLSServiceOverride

TLSServiceOverride overrides tls parameters for public endpoint

|===
| Field | Description | Scheme | Required

| secretName
| Name of a Secret in the same Namespace as the service, containing the server's private key, public certificate and CA certificate for TLS. The Secret must store these as tls.key, tls.crt and ca.crt respectively.
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#tlsstatus]
==== TLSStatus

TLSStatus defines the observed state of TLS

|===
| Field | Description | Scheme | Required

| caList
|
| []<<tlscastatus,TLSCAStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#telemetrysection]
==== TelemetrySection

TelemetrySection defines the desired state of OpenStack Telemetry services

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether OpenStack Telemetry services should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the OpenStack Telemetry services
| *telemetryv1.TelemetrySpecCore
| false

| aodhApiOverride
| AodhAPIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false

| prometheusOverride
| PrometheusOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false

| alertmanagerOverride
| AlertmanagerOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watchersection]
==== WatcherSection

WatcherSection defines the desired state of Watcher service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether Watcher service should be deployed and managed
| bool
| true

| template
| Template - Overrides to use when creating the Watcher service
| *watcherv1.WatcherSpecCore
| false

| apiOverride
| APIOverride, provides the ability to override the generated manifest of several child resources.
| <<override,Override>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#containerdefaults]
==== ContainerDefaults

ContainerDefaults - struct that contains container image default URLs for each service (internal use only)

|===
| Field | Description | Scheme | Required

| cinderVolumeImage
|
| *string
| false

| manilaShareImage
|
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#containerimages]
==== ContainerImages

ContainerImages - struct acts as the source of truth for container image URLs to be deployed

|===
| Field | Description | Scheme | Required

| octaviaApacheImage
|
| *string
| false

| ceilometerProxyImage
|
| *string
| false

| cinderVolumeImages
| CinderVolumeImages custom Cinder Volume images for each backend (default Cinder volume image is stored 'default' key)
| map[string]*string
| false

| manilaShareImages
| ManilaShareImages custom Manila Share images for each backend (default Manila share image is stored 'default' key)
| map[string]*string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#containertemplate]
==== ContainerTemplate

ContainerTemplate - struct that contains container image URLs for each service in OpenStackControlplane

|===
| Field | Description | Scheme | Required

| agentImage
|
| *string
| false

| ansibleeeImage
|
| *string
| false

| aodhAPIImage
|
| *string
| false

| aodhEvaluatorImage
|
| *string
| false

| aodhListenerImage
|
| *string
| false

| aodhNotifierImage
|
| *string
| false

| apacheImage
| this is shared by BaremetalOperator, OctaviaOperator, and TelemetryOperator
| *string
| false

| barbicanAPIImage
|
| *string
| false

| barbicanKeystoneListenerImage
|
| *string
| false

| barbicanWorkerImage
|
| *string
| false

| ceilometerCentralImage
|
| *string
| false

| ceilometerComputeImage
|
| *string
| false

| ceilometerIpmiImage
|
| *string
| false

| ceilometerNotificationImage
|
| *string
| false

| ceilometerSgcoreImage
|
| *string
| false

| ceilometerMysqldExporterImage
|
| *string
| false

| cinderAPIImage
|
| *string
| false

| cinderBackupImage
|
| *string
| false

| cinderSchedulerImage
|
| *string
| false

| designateAPIImage
|
| *string
| false

| designateBackendbind9Image
|
| *string
| false

| designateCentralImage
|
| *string
| false

| designateMdnsImage
|
| *string
| false

| designateProducerImage
|
| *string
| false

| designateUnboundImage
|
| *string
| false

| designateWorkerImage
|
| *string
| false

| edpmFrrImage
|
| *string
| false

| edpmIscsidImage
|
| *string
| false

| edpmLogrotateCrondImage
|
| *string
| false

| edpmMultipathdImage
|
| *string
| false

| edpmNeutronDhcpAgentImage
|
| *string
| false

| edpmNeutronMetadataAgentImage
|
| *string
| false

| edpmNeutronOvnAgentImage
|
| *string
| false

| edpmNeutronSriovAgentImage
|
| *string
| false

| edpmOvnBgpAgentImage
|
| *string
| false

| edpmNodeExporterImage
|
| *string
| false

| edpmKeplerImage
|
| *string
| false

| edpmPodmanExporterImage
|
| *string
| false

| edpmOpenstackNetworkExporterImage
| Deprecated: Use OpenstackNetworkExporterImage instead
| *string
| false

| openstackNetworkExporterImage
|
| *string
| false

| glanceAPIImage
|
| *string
| false

| heatAPIImage
|
| *string
| false

| heatCfnapiImage
|
| *string
| false

| heatEngineImage
|
| *string
| false

| horizonImage
|
| *string
| false

| infraDnsmasqImage
|
| *string
| false

| infraMemcachedImage
|
| *string
| false

| infraRedisImage
|
| *string
| false

| ironicAPIImage
|
| *string
| false

| ironicConductorImage
|
| *string
| false

| ironicInspectorImage
|
| *string
| false

| ironicNeutronAgentImage
|
| *string
| false

| ironicPxeImage
|
| *string
| false

| ironicPythonAgentImage
|
| *string
| false

| keystoneAPIImage
|
| *string
| false

| ksmImage
|
| *string
| false

| manilaAPIImage
|
| *string
| false

| manilaSchedulerImage
|
| *string
| false

| mariadbImage
|
| *string
| false

| netUtilsImage
|
| *string
| false

| neutronAPIImage
|
| *string
| false

| novaAPIImage
|
| *string
| false

| novaComputeImage
|
| *string
| false

| novaConductorImage
|
| *string
| false

| novaNovncImage
|
| *string
| false

| novaSchedulerImage
|
| *string
| false

| octaviaAPIImage
|
| *string
| false

| octaviaHealthmanagerImage
|
| *string
| false

| octaviaHousekeepingImage
|
| *string
| false

| octaviaWorkerImage
|
| *string
| false

| octaviaRsyslogImage
|
| *string
| false

| openstackClientImage
|
| *string
| false

| osContainerImage
|
| *string
| false

| ovnControllerImage
|
| *string
| false

| ovnControllerOvsImage
|
| *string
| false

| ovnNbDbclusterImage
|
| *string
| false

| ovnNorthdImage
|
| *string
| false

| ovnSbDbclusterImage
|
| *string
| false

| placementAPIImage
|
| *string
| false

| rabbitmqImage
|
| *string
| false

| swiftAccountImage
|
| *string
| false

| swiftContainerImage
|
| *string
| false

| swiftObjectImage
|
| *string
| false

| swiftProxyImage
|
| *string
| false

| telemetryNodeExporterImage
|
| *string
| false

| testTempestImage
|
| *string
| false

| testTobikoImage
|
| *string
| false

| testHorizontestImage
|
| *string
| false

| testAnsibletestImage
|
| *string
| false

| watcherAPIImage
|
| *string
| false

| watcherApplierImage
|
| *string
| false

| watcherDecisionEngineImage
|
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#customcontainerimages]
=== CustomContainerImages

CustomContainerImages - struct for custom container images

|===
| Field | Description | Scheme | Required

| cinderVolumeImages
|
| map[string]*string
| false

| manilaShareImages
|
| map[string]*string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackversion]
==== OpenStackVersion

OpenStackVersion is the Schema for the openstackversionupdates API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<openstackversionspec,OpenStackVersionSpec>>
| false

| status
|
| <<openstackversionstatus,OpenStackVersionStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackversionlist]
==== OpenStackVersionList

OpenStackVersionList contains a list of OpenStackVersion

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<openstackversion,OpenStackVersion>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#openstackversionspec]
==== OpenStackVersionSpec

OpenStackVersionSpec - defines the desired state of OpenStackVersion

|===
| Field | Description | Scheme | Required

| targetVersion
| TargetVersion is the version of OpenStack to install (based on the availableVersion in the OpenStackVersion CR status)
| string
| true

| customContainerImages
| CustomContainerImages is a list of containerImages to customize for deployment
| <<customcontainerimages,CustomContainerImages>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackversionstatus]
==== OpenStackVersionStatus

OpenStackVersionStatus defines the observed state of OpenStackVersion

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| deployedVersion
|
| *string
| false

| availableVersion
|
| *string
| false

| containerImages
| This is the source of truth for the container images to be deployed.
| <<containerimages,ContainerImages>>
| false

| containerImageVersionDefaults
| where we keep track of the container images for previous versions
| map[string]*<<containerdefaults,ContainerDefaults>>
| false

| availableServiceDefaults
| AvailableServiceDefaults - struct that contains defaults for OSP services for each discovered available version
| map[string]*<<servicedefaults,ServiceDefaults>>
| false

| serviceDefaults
| ServiceDefaults - struct that contains current defaults for OSP services
| <<servicedefaults,ServiceDefaults>>
| false

| trackedCustomImages
| TrackedCustomImages tracks CustomContainerImages used for each version to detect changes
| map[string]<<customcontainerimages,CustomContainerImages>>
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this object.
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#servicedefaults]
==== ServiceDefaults

ServiceDefaults - struct that contains defaults for OSP services that can change over time but are associated with a specific OpenStack release version

|===
| Field | Description | Scheme | Required

| glanceWsgi
|
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanapi]
==== BarbicanAPI

BarbicanAPI is the Schema for the barbicanapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<barbicanapispec,BarbicanAPISpec>>
| false

| status
|
| <<barbicanapistatus,BarbicanAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanapilist]
==== BarbicanAPIList

BarbicanAPIList contains a list of BarbicanAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<barbicanapi,BarbicanAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanapispec]
==== BarbicanAPISpec

BarbicanAPISpec defines the desired state of BarbicanAPI

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - Barbican Database Hostname
| string
| true

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanapistatus]
==== BarbicanAPIStatus

BarbicanAPIStatus defines the observed state of BarbicanAPI

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of barbican API instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| apiEndpoint
| API endpoint
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| databaseHostname
| Barbican Database Hostname
| string
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanapitemplate]
==== BarbicanAPITemplate

BarbicanAPITemplate defines the input parameters for the Barbican API service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Barbican Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanapitemplatecore]
==== BarbicanAPITemplateCore

BarbicanAPITemplateCore -

|===
| Field | Description | Scheme | Required

| enableSecureRBAC
| EnableSecureRBAC - Enable Consistent and Secure RBAC policies
| bool
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| apiTimeout
| APITimeout for HAProxy and Apache defaults to Barbican APITimeout (seconds)
| int
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicankeystonelistener]
==== BarbicanKeystoneListener

BarbicanKeystoneListener is the Schema for the barbicankeystonelistener API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<barbicankeystonelistenerspec,BarbicanKeystoneListenerSpec>>
| false

| status
|
| <<barbicankeystonelistenerstatus,BarbicanKeystoneListenerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicankeystonelistenerlist]
==== BarbicanKeystoneListenerList

BarbicanKeystoneListenerList contains a list of BarbicanKeystoneListener

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<barbicankeystonelistener,BarbicanKeystoneListener>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicankeystonelistenerspec]
==== BarbicanKeystoneListenerSpec

BarbicanKeystoneListenerSpec defines the desired state of BarbicanKeystoneListener

|===
| Field | Description | Scheme | Required

| databaseHostname
|
| string
| true

| transportURLSecret
|
| string
| false

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicankeystonelistenerstatus]
==== BarbicanKeystoneListenerStatus

BarbicanKeystoneListenerStatus defines the observed state of BarbicanKeystoneListener

|===
| Field | Description | Scheme | Required

| readyCount
| INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file ReadyCount of barbican API instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| databaseHostname
| Barbican Database Hostname
| string
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicankeystonelistenertemplate]
==== BarbicanKeystoneListenerTemplate

BarbicanKeystoneListenerTemplate defines common Spec elements for the KeystoneListener process

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Barbican Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbican]
==== Barbican

Barbican is the Schema for the barbicans API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<barbicanspec,BarbicanSpec>>
| false

| status
|
| <<barbicanstatus,BarbicanStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanlist]
==== BarbicanList

BarbicanList contains a list of Barbican

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<barbican,Barbican>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanspec]
==== BarbicanSpec

BarbicanSpec defines the desired state of Barbican

|===
| Field | Description | Scheme | Required

| barbicanAPI
| BarbicanAPI - Spec definition for the  API services of this Barbican deployment
| <<barbicanapitemplate,BarbicanAPITemplate>>
| true

| barbicanWorker
| BarbicanWorker - Spec definition for the Worker service of this Barbican deployment
| <<barbicanworkertemplate,BarbicanWorkerTemplate>>
| true

| barbicanKeystoneListener
| BarbicanKeystoneListener - Spec definition for the KeystoneListener service of this Barbican deployment
| <<barbicankeystonelistenertemplate,BarbicanKeystoneListenerTemplate>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanspecbase]
==== BarbicanSpecBase

BarbicanSpecBase -

|===
| Field | Description | Scheme | Required

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this component. Setting here overrides any global NodeSelector settings within the Barbican CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| apiTimeout
| Barbican API timeout
| int
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanspeccore]
==== BarbicanSpecCore

BarbicanSpecCore defines the desired state of Barbican, for use with the OpenStackControlplane CR (no containerImages)

|===
| Field | Description | Scheme | Required

| barbicanAPI
| BarbicanAPI - Spec definition for the  API services of this Barbican deployment
| <<barbicanapitemplatecore,BarbicanAPITemplateCore>>
| true

| barbicanWorker
| BarbicanWorker - Spec definition for the Worker service of this Barbican deployment
| <<barbicanworkertemplatecore,BarbicanWorkerTemplateCore>>
| true

| barbicanKeystoneListener
| BarbicanKeystoneListener - Spec definition for the KeystoneListener service of this Barbican deployment
| <<barbicankeystonelistenertemplatecore,BarbicanKeystoneListenerTemplateCore>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanstatus]
==== BarbicanStatus

BarbicanStatus defines the observed state of Barbican

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| serviceID
| ServiceID
| string
| false

| conditions
| Conditions
| condition.Conditions
| false

| barbicanAPIReadyCount
| ReadyCount of Barbican API instances
| int32
| false

| barbicanWorkerReadyCount
| ReadyCount of Barbican Worker instances
| int32
| false

| barbicanKeystoneListenerReadyCount
| ReadyCount of Barbican KeystoneListener instances
| int32
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| databaseHostname
| Barbican Database Hostname
| string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanworker]
==== BarbicanWorker

BarbicanWorker is the Schema for the barbicanworkers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<barbicanworkerspec,BarbicanWorkerSpec>>
| false

| status
|
| <<barbicanworkerstatus,BarbicanWorkerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanworkerlist]
==== BarbicanWorkerList

BarbicanWorkerList contains a list of BarbicanWorker

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<barbicanworker,BarbicanWorker>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanworkerspec]
==== BarbicanWorkerSpec

BarbicanWorkerSpec defines the desired state of BarbicanWorker

|===
| Field | Description | Scheme | Required

| databaseHostname
|
| string
| true

| transportURLSecret
|
| string
| false

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanworkerstatus]
==== BarbicanWorkerStatus

BarbicanWorkerStatus defines the observed state of BarbicanWorker

|===
| Field | Description | Scheme | Required

| readyCount
| INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file ReadyCount of barbican API instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| databaseHostname
| Barbican Database Hostname
| string
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanworkertemplate]
==== BarbicanWorkerTemplate

BarbicanWorkerTemplate defines common Spec elements for the Worker process

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Barbican Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicancomponenttemplate]
==== BarbicanComponentTemplate

BarbicanComponentTemplate - Variables used by every sub-component of Barbican (e.g. API, Worker, Listener)

|===
| Field | Description | Scheme | Required

| nodeSelector
| NodeSelector to target subset of worker nodes running this component. Setting here overrides any global NodeSelector settings within the Barbican CR.
| *map[string]string
| false

| replicas
| Replicas of Barbican API to run
| *int32
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| customServiceConfigSecrets
| CustomServiceConfigSecrets - customize the service config using this parameter to specify Secrets that contain sensitive service config data. The content of each Secret gets added to the /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| []string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#barbicanpkcs11template]
==== BarbicanPKCS11Template

BarbicanPKCS11Template - Includes common HSM properties

|===
| Field | Description | Scheme | Required

| loginSecret
| OpenShift secret that stores the password to login to the PKCS11 session
| string
| true

| clientDataSecret
| The OpenShift secret that stores the HSM client data. These will be mounted to /var/lib/config-data/hsm
| string
| true

| clientDataPath
| Location to which kolla will copy the data in ClientDataSecret.
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#barbicantemplate]
==== BarbicanTemplate

BarbicanTemplate defines common Spec elements for all Barbican components including the top level CR

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount CR name used for barbican DB, defaults to barbican
| string
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Barbican
| string
| true

| simpleCryptoBackendSecret
| Secret containing the Key Encryption Key (KEK) used for the Simple Crypto backend
| string
| true

| secret
| Secret containing all passwords / keys needed
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Barbican services the default SA name
| string
| true

| pkcs11
|
| *<<barbicanpkcs11template,BarbicanPKCS11Template>>
| false

| enabledSecretStores
|
| []SecretStore
| false

| globalDefaultSecretStore
|
| SecretStore
| true
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the barbican service user password from the Secret
| string
| true

| simplecryptokek
|
| string
| true

| pkcs11pin
|
| string
| true

| simplecryptoadditionalkeks
| Fields containing additional Key Encryption Keys(KEK) used for the Simple Crypto backend It is expected that these fields will exist in the secret referenced in SimpleCryptoBackendSecret
| []string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderapi]
==== CinderAPI

CinderAPI is the Schema for the cinderapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<cinderapispec,CinderAPISpec>>
| false

| status
|
| <<cinderapistatus,CinderAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderapilist]
==== CinderAPIList

CinderAPIList contains a list of CinderAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<cinderapi,CinderAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderapispec]
==== CinderAPISpec

CinderAPISpec defines the desired state of CinderAPI

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - Cinder Database Hostname
| string
| true

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| true

| notificationsURLSecret
| Secret containing Notifications transport URL
| string
| false

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<cinderextravolmounts,CinderExtraVolMounts>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Cinder services the default SA name
| string
| true

| memcachedInstance
| Memcached instance name.
| *string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderapistatus]
==== CinderAPIStatus

CinderAPIStatus defines the observed state of CinderAPI

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| apiEndpoints
| API endpoints
| map[string]map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of Cinder API instances
| int32
| true

| serviceIDs
| ServiceIDs
| map[string]string
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is different than the spec generation, then the controller has not started processing the latest changes, and the status and its conditions are likely stale.
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderapitemplate]
==== CinderAPITemplate

CinderAPITemplate defines the input parameters for the Cinder API service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Cinder Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderapitemplatecore]
==== CinderAPITemplateCore

CinderAPITemplate defines the input parameters for the Cinder API service

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Cinder API Replicas
| *int32
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderbackup]
==== CinderBackup

CinderBackup is the Schema for the cinderbackups API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<cinderbackupspec,CinderBackupSpec>>
| false

| status
|
| <<cinderbackupstatus,CinderBackupStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderbackuplist]
==== CinderBackupList

CinderBackupList contains a list of CinderBackup

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<cinderbackup,CinderBackup>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderbackupspec]
==== CinderBackupSpec

CinderBackupSpec defines the desired state of CinderBackup

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - Cinder Database Hostname
| string
| true

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| true

| notificationsURLSecret
| Secret containing Notifications transport URL
| string
| false

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<cinderextravolmounts,CinderExtraVolMounts>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Cinder services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| memcachedInstance
| Memcached instance name.
| *string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderbackupstatus]
==== CinderBackupStatus

CinderBackupStatus defines the observed state of CinderBackup

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of Cinder Backup instances
| int32
| true

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is different than the spec generation, then the controller has not started processing the latest changes, and the status and its conditions are likely stale.
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderbackuptemplate]
==== CinderBackupTemplate

CinderBackupTemplate defines the input parameters for the Cinder Backup service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Cinder Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderbackuptemplatecore]
==== CinderBackupTemplateCore

CinderBackupTemplate defines the input parameters for the Cinder Backup service

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Cinder Backup Replicas
| *int32
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderscheduler]
==== CinderScheduler

CinderScheduler is the Schema for the cinderschedulers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<cinderschedulerspec,CinderSchedulerSpec>>
| false

| status
|
| <<cinderschedulerstatus,CinderSchedulerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderschedulerlist]
==== CinderSchedulerList

CinderSchedulerList contains a list of CinderScheduler

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<cinderscheduler,CinderScheduler>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderschedulerspec]
==== CinderSchedulerSpec

CinderSchedulerSpec defines the desired state of CinderScheduler

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - Cinder Database Hostname
| string
| true

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| true

| notificationsURLSecret
| Secret containing Notifications transport URL
| string
| false

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<cinderextravolmounts,CinderExtraVolMounts>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Cinder services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| memcachedInstance
| Memcached instance name.
| *string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderschedulerstatus]
==== CinderSchedulerStatus

CinderSchedulerStatus defines the observed state of CinderScheduler

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of Cinder Scheduler instances
| int32
| true

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is different than the spec generation, then the controller has not started processing the latest changes, and the status and its conditions are likely stale.
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderschedulertemplate]
==== CinderSchedulerTemplate

CinderSchedulerTemplate defines the input parameters for the Cinder Scheduler service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Cinder Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderschedulertemplatecore]
==== CinderSchedulerTemplateCore

CinderSchedulerTemplate defines the input parameters for the Cinder Scheduler service

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Cinder Scheduler Replicas
| *int32
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinder]
==== Cinder

Cinder is the Schema for the cinders API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<cinderspec,CinderSpec>>
| false

| status
|
| <<cinderstatus,CinderStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderextravolmounts]
==== CinderExtraVolMounts

CinderExtraVolMounts exposes additional parameters processed by the cinder-operator and defines the common VolMounts structure provided by the main storage module

|===
| Field | Description | Scheme | Required

| name
|
| string
| false

| region
|
| string
| false

| extraVol
|
| []storage.VolMounts
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderlist]
==== CinderList

CinderList contains a list of Cinder

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<cinder,Cinder>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderspec]
==== CinderSpec

CinderSpec defines the desired state of Cinder

|===
| Field | Description | Scheme | Required

| cinderAPI
| CinderAPI - Spec definition for the API service of this Cinder deployment
| <<cinderapitemplate,CinderAPITemplate>>
| true

| cinderScheduler
| CinderScheduler - Spec definition for the Scheduler service of this Cinder deployment
| <<cinderschedulertemplate,CinderSchedulerTemplate>>
| true

| cinderBackup
| CinderBackup - Spec definition for the Backup service of this Cinder deployment
| <<cinderbackuptemplate,CinderBackupTemplate>>
| true

| cinderVolumes
| CinderVolumes - Map of chosen names to spec definitions for the Volume(s) service(s) of this Cinder deployment
| map[string]<<cindervolumetemplate,CinderVolumeTemplate>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderspecbase]
==== CinderSpecBase

|===
| Field | Description | Scheme | Required

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Cinder
| string
| true

| memcachedInstance
| Memcached instance name.
| string
| true

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| customServiceConfig
| CustomServiceConfig - customize the service config for all Cinder services using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| string
| false

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<cinderextravolmounts,CinderExtraVolMounts>>
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting NodeSelector here acts as a default value and can be overridden by service specific NodeSelector Settings.
| *map[string]string
| false

| dbPurge
| DBPurge parameters -
| <<dbpurge,DBPurge>>
| false

| apiTimeout
| APITimeout for HAProxy, Apache, and rpc_response_timeout
| int
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| notificationsBusInstance
| RabbitMQ instance name used to request a transportURL that is used for notification purposes
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderspeccore]
==== CinderSpecCore

CinderSpecCore the same as CinderSpec without ContainerImage references

|===
| Field | Description | Scheme | Required

| cinderAPI
| CinderAPI - Spec definition for the API service of this Cinder deployment
| <<cinderapitemplatecore,CinderAPITemplateCore>>
| true

| cinderScheduler
| CinderScheduler - Spec definition for the Scheduler service of this Cinder deployment
| <<cinderschedulertemplatecore,CinderSchedulerTemplateCore>>
| true

| cinderBackup
| CinderBackup - Spec definition for the Backup service of this Cinder deployment
| <<cinderbackuptemplatecore,CinderBackupTemplateCore>>
| true

| cinderVolumes
| CinderVolumes - Map of chosen names to spec definitions for the Volume(s) service(s) of this Cinder deployment
| map[string]<<cindervolumetemplatecore,CinderVolumeTemplateCore>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cinderstatus]
==== CinderStatus

CinderStatus defines the observed state of Cinder

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| Cinder Database Hostname
| string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL entries
| string
| false

| notificationsURLSecret
| NotificationsURLSecret - Secret containing RabbitMQ notificationsURL
| *string
| false

| apiEndpoints
| API endpoints
| map[string]map[string]string
| false

| serviceIDs
| ServiceIDs
| map[string]string
| false

| cinderAPIReadyCount
| ReadyCount of Cinder API instance
| int32
| true

| cinderBackupReadyCount
| ReadyCount of Cinder Backup instance
| int32
| true

| cinderSchedulerReadyCount
| ReadyCount of Cinder Scheduler instance
| int32
| true

| cinderVolumesReadyCounts
| ReadyCounts of Cinder Volume instances
| map[string]int32
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is different than the spec generation, then the controller has not started processing the latest changes, and the status and its conditions are likely stale.
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#dbpurge]
==== DBPurge

DBPurge struct is used to model the parameters exposed to the Cinder cronJob

|===
| Field | Description | Scheme | Required

| age
| Age is the DBPurgeAge parameter and indicates the number of days of purging DB records
| int
| true

| schedule
| Schedule defines the crontab format string to schedule the DBPurge cronJob
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cindervolume]
==== CinderVolume

CinderVolume is the Schema for the cindervolumes API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<cindervolumespec,CinderVolumeSpec>>
| false

| status
|
| <<cindervolumestatus,CinderVolumeStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cindervolumelist]
==== CinderVolumeList

CinderVolumeList contains a list of CinderVolume

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<cindervolume,CinderVolume>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cindervolumespec]
==== CinderVolumeSpec

CinderVolumeSpec defines the desired state of CinderVolume

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - Cinder Database Hostname
| string
| true

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| true

| notificationsURLSecret
| Secret containing Notifications transport URL
| string
| false

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<cinderextravolmounts,CinderExtraVolMounts>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Cinder services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| memcachedInstance
| Memcached instance name.
| *string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cindervolumestatus]
==== CinderVolumeStatus

CinderVolumeStatus defines the observed state of CinderVolume

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of Cinder Volume instances
| int32
| true

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is different than the spec generation, then the controller has not started processing the latest changes, and the status and its conditions are likely stale.
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cindervolumetemplate]
==== CinderVolumeTemplate

CinderVolumeTemplate defines the input parameters for the Cinder Volume service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Cinder Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cindervolumetemplatecore]
==== CinderVolumeTemplateCore

CinderVolumeTemplate defines the input parameters for the Cinder Volume service

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Cinder Volume Replicas
| *int32
| true
|===

<<custom-resources,Back to Custom Resources>>

[#cinderservicetemplate]
==== CinderServiceTemplate

CinderServiceTemplate defines the input parameters that can be defined for a given Cinder service

|===
| Field | Description | Scheme | Required

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Cinder CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| string
| false

| customServiceConfigSecrets
| CustomServiceConfigSecrets - customize the service config using this parameter to specify Secrets that contain sensitive service config data. The content of each Secret gets added to the /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| []string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cindertemplate]
==== CinderTemplate

CinderTemplate defines common input parameters used by all Cinder services

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - optional username used for this service to register in cinder
| string
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount used for cinder DB, defaults to cinder
| string
| true

| secret
| Secret containing OpenStack password information
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the cinder service password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designateservicetemplate]
==== DesignateServiceTemplate

DesignateServiceTemplate defines the input parameters that can be defined for a given Designate service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Designate Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designateservicetemplatecore]
==== DesignateServiceTemplateCore

DesignateServiceTemplate defines the input parameters that can be defined for a given Designate service

|===
| Field | Description | Scheme | Required

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Designate CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| string
| false

| customServiceConfigSecrets
| CustomServiceConfigSecrets - customize the service config using this parameter to specify Secrets that contain sensitive service config data. The content of each Secret gets added to the /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| []string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatetemplate]
==== DesignateTemplate

DesignateTemplate defines common input parameters used by all Designate services

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - optional username used for this service to register in designate
| string
| true

| databaseAccount
| DatabaseAccount - name of MariaDBAccount which will be used to connect.
| string
| true

| secret
| Secret containing OpenStack password information for DesignatePassword
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| backendType
| BackendType - Defines the backend service/configuration we are using, i.e. bind9, PowerDNS, BYO, etc.. Helps maintain a single init container/init.sh to do container setup
| string
| true

| backendWorkerServerProtocol
| BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker & designate_mdns to/from the DNS server. Acceptable values are: "UDP", "TCP" Please Note: this MUST match what is in the /etc/designate.conf ['service:worker']
| string
| true

| backendMdnsServerProtocol
| BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker & designate_mdns to/from the DNS server. Acceptable values are: "UDP", "TCP" Please Note: this MUST match what is in the /etc/designate.conf ['service:mdns']
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the designate service password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateapi]
==== DesignateAPI

DesignateAPI is the Schema for the designateapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<designateapispec,DesignateAPISpec>>
| false

| status
|
| <<designateapistatus,DesignateAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateapilist]
==== DesignateAPIList

DesignateAPIList contains a list of DesignateAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<designateapi,DesignateAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designateapispecbase]
==== DesignateAPISpecBase

DesignateAPISpecBase -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Designate API Replicas
| *int32
| true

| databaseHostname
| DatabaseHostname - Designate Database Hostname
| string
| false

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Designate services the default SA name
| string
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| apiTimeout
| APITimeout for HAProxy and Apache defaults to DesignateSpecCore APITimeout (seconds)
| int
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designateapistatus]
==== DesignateAPIStatus

DesignateAPIStatus defines the observed state of DesignateAPI

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| apiEndpoints
| API endpoints
| map[string]map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of designate API instances
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#bind9overridespec]
==== Bind9OverrideSpec

|===
| Field | Description | Scheme | Required

| services
|
| []service.OverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatebackendbind9]
==== DesignateBackendbind9

DesignateBackendbind9 is the Schema for the designatebackendbind9

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<designatebackendbind9spec,DesignateBackendbind9Spec>>
| false

| status
|
| <<designatebackendbind9status,DesignateBackendbind9Status>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatebackendbind9list]
==== DesignateBackendbind9List

DesignateBackendbind9List contains a list of DesignateBackendbind9

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<designatebackendbind9,DesignateBackendbind9>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designatebackendbind9specbase]
==== DesignateBackendbind9SpecBase

DesignateBackendbind9SpecBase -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Designate Backendbind9 Replicas
| *int32
| true

| databaseHostname
| DatabaseHostname - Designate Database Hostname
| string
| false

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Designate services the default SA name
| string
| true

| customBindOptions
| CustomBindOptions - custom bind9 options
| []string
| false

| controlNetworkName
| ControlNetworkName - specify which network attachment is to be used for control, notifys and zone transfers.
| string
| true

| storageClass
| StorageClass
| string
| false

| storageRequest
| StorageRequest
| string
| true

| netUtilsImage
| NetUtilsImage - NetUtils container image
| string
| true

| override
| Allows services to be configured for accessing each designate bind pod. For best results, there should be an override for each replica.
| <<bind9overridespec,Bind9OverrideSpec>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatebackendbind9status]
==== DesignateBackendbind9Status

DesignateBackendbind9Status defines the observed state of DesignateBackendbind9

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of designate backendbind9 instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatecentral]
==== DesignateCentral

DesignateCentral is the Schema for the designatecentral API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<designatecentralspec,DesignateCentralSpec>>
| false

| status
|
| <<designatecentralstatus,DesignateCentralStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatecentrallist]
==== DesignateCentralList

DesignateCentralList contains a list of DesignateCentral

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<designatecentral,DesignateCentral>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designatecentralspecbase]
==== DesignateCentralSpecBase

DesignateCentralSpecBase -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Designate Central Replicas
| *int32
| true

| databaseHostname
| DatabaseHostname - Designate Database Hostname
| string
| false

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Designate services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| redisHostIPs
| List of Redis Host IP addresses
| []string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatecentralstatus]
==== DesignateCentralStatus

DesignateCentralStatus defines the observed state of DesignateCentral

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of designate central instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatemdns]
==== DesignateMdns

DesignateMdns is the Schema for the designatemdnses API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<designatemdnsspec,DesignateMdnsSpec>>
| false

| status
|
| <<designatemdnsstatus,DesignateMdnsStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatemdnslist]
==== DesignateMdnsList

DesignateMdnsList contains a list of DesignateMdns

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<designatemdns,DesignateMdns>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designatemdnsspecbase]
==== DesignateMdnsSpecBase

DesignateMdnsSpecBase -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Designate Mdns Replicas
| *int32
| true

| databaseHostname
| DatabaseHostname - Designate Database Hostname
| string
| false

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Designate services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| controlNetworkName
| ControlNetworkName - specify which network attachment is to be used for control, notifys and zone transfers.
| string
| true

| netUtilsImage
| NetUtilsImage - NetUtils container image
| string
| true

| override
| Allows services to be configured for accessing each mdns pod. For best results, there should be an override for each replica.
| <<mdnsoverridespec,MdnsOverrideSpec>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatemdnsstatus]
==== DesignateMdnsStatus

DesignateMdnsStatus defines the observed state of DesignateMdns

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of designate MDNS instances
| int32
| false

| desiredNumberScheduled
| DesiredNumberScheduled - total number of the nodes which should be running Daemon
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#mdnsoverridespec]
==== MdnsOverrideSpec

|===
| Field | Description | Scheme | Required

| services
|
| []service.OverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateproducer]
==== DesignateProducer

DesignateProducer is the Schema for the designateproducer API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<designateproducerspec,DesignateProducerSpec>>
| false

| status
|
| <<designateproducerstatus,DesignateProducerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateproducerlist]
==== DesignateProducerList

DesignateProducerList contains a list of DesignateProducer

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<designateproducer,DesignateProducer>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designateproducerspecbase]
==== DesignateProducerSpecBase

DesignateProducerSpec defines the desired state of DesignateProducer

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Designate Producer Replicas
| *int32
| true

| databaseHostname
| DatabaseHostname - Designate Database Hostname
| string
| false

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Designate services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| redisHostIPs
| List of Redis Host IP addresses
| []string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateproducerstatus]
==== DesignateProducerStatus

DesignateProducerStatus defines the observed state of DesignateProducer

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of designate Producer instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designate]
==== Designate

Designate is the Schema for the designates API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<designatespec,DesignateSpec>>
| false

| status
|
| <<designatestatus,DesignateStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateextravolmounts]
==== DesignateExtraVolMounts

DesignateExtraVolMounts exposes additional parameters processed by the designate-operator and defines the common VolMounts structure provided by the main storage module

|===
| Field | Description | Scheme | Required

| name
|
| string
| false

| region
|
| string
| false

| extraVol
|
| []storage.VolMounts
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designatelist]
==== DesignateList

DesignateList contains a list of Designate

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<designate,Designate>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designatensrecord]
==== DesignateNSRecord

DesignateNSRecord defines a DNS nameserver record

|===
| Field | Description | Scheme | Required

| hostname
| Hostname of the nameserver
| string
| true

| priority
| Priority of the nameserver
| int
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designatespec]
==== DesignateSpec

DesignateAPISpec defines the desired state of DesignateAPI

|===
| Field | Description | Scheme | Required

| designateAPI
| DesignateAPI - Spec definition for the API service of this Designate deployment
| <<designateapispec,DesignateAPISpec>>
| true

| designateCentral
| DesignateCentral - Spec definition for the Central service of this Designate deployment
| <<designatecentralspec,DesignateCentralSpec>>
| true

| designateWorker
| DesignateWorker - Spec definition for the Worker service of this Designate deployment
| <<designateworkerspec,DesignateWorkerSpec>>
| true

| designateMdns
| DesignateMdns - Spec definition for the Mdns service of this Designate deployment
| <<designatemdnsspec,DesignateMdnsSpec>>
| true

| designateProducer
| DesignateProducer - Spec definition for the Producer service of this Designate deployment
| <<designateproducerspec,DesignateProducerSpec>>
| true

| designateBackendbind9
| DesignateBackendbind9 - Spec definition for the Backendbind9 service of this Designate deployment
| <<designatebackendbind9spec,DesignateBackendbind9Spec>>
| true

| designateUnbound
| DesignateUnbound - Spec definition for the Unbound Resolver service of this Designate deployment
| <<designateunboundspec,DesignateUnboundSpec>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designatespecbase]
==== DesignateSpecBase

DesignateSpecBase -

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - optional username used for this service to register in designate
| string
| true

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - name of MariaDBAccount which will be used to connect.
| string
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Designate
| string
| true

| secret
| Secret containing OpenStack password information for designate AdminPassword
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and AdminUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| backendType
| BackendType - Defines the backend service/configuration we are using, i.e. bind9, unhbound, PowerDNS, BYO, etc.. Helps maintain a single init container/init.sh to do container setup
| string
| true

| backendWorkerServerProtocol
| BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker & designate_mdns to/from the DNS server. Acceptable values are: "UDP", "TCP" Please Note: this MUST match what is in the /etc/designate.conf ['service:worker']
| string
| true

| backendMdnsServerProtocol
| BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker & designate_mdns to/from the DNS server. Acceptable values are: "UDP", "TCP" Please Note: this MUST match what is in the /etc/designate.conf ['service:mdns']
| string
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| designateNetworkAttachment
| DesignateNetworkAttachment is a NetworkAttachment resource name for the Designate Control Network
| string
| true

| redisServiceName
| RedisServiceName is the name of the Redis instance to be used (must be in the same namespace as designate)
| string
| true

| apiTimeout
| Designate API timeout
| int
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| nsRecords
| NSRecords contains the list of nameserver records for the Designate pool
| []<<designatensrecord,DesignateNSRecord>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designatespeccore]
==== DesignateSpecCore

DesignateAPISpecCore - this version has no containerImage for use with the OpenStackControlplane

|===
| Field | Description | Scheme | Required

| designateAPI
| DesignateAPI - Spec definition for the API service of this Designate deployment
| <<designateapispeccore,DesignateAPISpecCore>>
| true

| designateCentral
| DesignateCentral - Spec definition for the Central service of this Designate deployment
| <<designatecentralspeccore,DesignateCentralSpecCore>>
| true

| designateWorker
| DesignateWorker - Spec definition for the Worker service of this Designate deployment
| <<designateworkerspeccore,DesignateWorkerSpecCore>>
| true

| designateMdns
| DesignateMdns - Spec definition for the Mdns service of this Designate deployment
| <<designatemdnsspeccore,DesignateMdnsSpecCore>>
| true

| designateProducer
| DesignateProducer - Spec definition for the Producer service of this Designate deployment
| <<designateproducerspeccore,DesignateProducerSpecCore>>
| true

| designateBackendbind9
| DesignateBackendbind9 - Spec definition for the Backendbind9 service of this Designate deployment
| <<designatebackendbind9speccore,DesignateBackendbind9SpecCore>>
| true

| designateUnbound
| DesignateUnbound - Spec definition for the Unbound Resolver service of this Designate deployment
| <<designateunboundspeccore,DesignateUnboundSpecCore>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designatestatus]
==== DesignateStatus

DesignateStatus defines the observed state of Designate

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| apiEndpoint
| API endpoint
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| DatabaseHostname - Designate Database Hostname
| string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| designateAPIReadyCount
| ReadyCount of Designate API instance
| int32
| false

| designateCentralReadyCount
| ReadyCount of Designate Central instance
| int32
| false

| designateWorkerReadyCount
| ReadyCount of Designate Worker instance
| int32
| false

| designateMdnsReadyCount
| ReadyCount of Designate Mdns instance
| int32
| false

| designateProducerReadyCount
| ReadyCount of Designate Producer instance
| int32
| false

| designateBackendbind9ReadyCount
| ReadyCount of Designate Backendbind9 instance
| int32
| false

| designateUnboundReadyCount
| ReadyCount of Designate Unbound instance
| int32
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| redisHostIPs
| List of Redis Host IP addresses
| []string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateunbound]
==== DesignateUnbound

DesignateUnbound is the Schema for the designateworker API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<designateunboundspec,DesignateUnboundSpec>>
| false

| status
|
| <<designateunboundstatus,DesignateUnboundStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateunboundlist]
==== DesignateUnboundList

DesignateUnboundList contains a list of DesignateUnbound

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<designateunbound,DesignateUnbound>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designateunboundspecbase]
==== DesignateUnboundSpecBase

DesignateUnboundSpecBase -

|===
| Field | Description | Scheme | Required

| serviceAccount
| ServiceAccount - service account name used internally to provide Designate services the default SA name
| string
| true

| replicas
| Replicas - Designate Unbound Replicas
| *int32
| true

| override
| Allows services to be configured for accessing each Unbound pod. For best results, there should be an override for each replica.
| <<unboundoverridespec,UnboundOverrideSpec>>
| false

| stubZones
| Allows configuring stub zone entries in the managed Unbound servers for the managed nameservers.
| []<<stubzone,StubZone>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateunboundstatus]
==== DesignateUnboundStatus

DesignateUnboundStatus defines the observed state of DesignateUnbound

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of designate central instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#stubzone]
==== StubZone

|===
| Field | Description | Scheme | Required

| name
|
| string
| true

| options
|
| map[string]string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#unboundoverridespec]
==== UnboundOverrideSpec

|===
| Field | Description | Scheme | Required

| services
|
| []service.OverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateworker]
==== DesignateWorker

DesignateWorker is the Schema for the designateworker API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<designateworkerspec,DesignateWorkerSpec>>
| false

| status
|
| <<designateworkerstatus,DesignateWorkerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateworkerlist]
==== DesignateWorkerList

DesignateWorkerList contains a list of DesignateWorker

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<designateworker,DesignateWorker>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#designateworkerspecbase]
==== DesignateWorkerSpecBase

DesignateWorkerSpecBase -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Designate Worker Replicas
| *int32
| true

| databaseHostname
| DatabaseHostname - Designate Database Hostname
| string
| false

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Designate services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false
|===

<<custom-resources,Back to Custom Resources>>

[#designateworkerstatus]
==== DesignateWorkerStatus

DesignateWorkerStatus defines the observed state of DesignateWorker

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of designate central instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#glanceapitemplate]
==== GlanceAPITemplate

GlanceAPITemplate defines the desired state of GlanceAPI

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of glance API to run
| *int32
| true

| containerImage
| Glance Container Image URL (will be set to environmental default if empty)
| string
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| customServiceConfigSecrets
| CustomServiceConfigSecrets - customize the service config using this parameter to specify Secrets that contain sensitive service config data. The content of each Secret gets added to the /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| []string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| storage
| Storage -
| <<storage,Storage>>
| false

| type
| Type - represents the layout of the glanceAPI deployment.
| string
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| imageCache
| ImageCache - It represents the struct to expose the ImageCache related parameters (size of the PVC and cronJob schedule)
| <<imagecache,ImageCache>>
| false

| apiTimeout
| APITimeout for HAProxy and Apache defaults to GlanceSpecCore APITimeout
| int
| false
|===

<<custom-resources,Back to Custom Resources>>

[#imagecache]
==== ImageCache

ImageCache - struct where the exposed imageCache params are defined

|===
| Field | Description | Scheme | Required

| size
| Size - Local storage request, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024)
| string
| true

| cleanerScheduler
| Schedule defines the crontab format string to schedule the Cleaner cronJob
| string
| true

| prunerScheduler
| Schedule defines the crontab format string to schedule the Pruner cronJob
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#storage]
==== Storage

Storage -

|===
| Field | Description | Scheme | Required

| storageClass
| StorageClass -
| string
| false

| storageRequest
| StorageRequest -
| string
| false

| external
| External -
| bool
| false
|===

<<custom-resources,Back to Custom Resources>>

[#glanceapi]
==== GlanceAPI

GlanceAPI is the Schema for the glanceapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<glanceapispec,GlanceAPISpec>>
| false

| status
|
| <<glanceapistatus,GlanceAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#glanceapilist]
==== GlanceAPIList

GlanceAPIList contains a list of GlanceAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<glanceapi,GlanceAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#glanceapispec]
==== GlanceAPISpec

GlanceAPISpec defines the desired state of GlanceAPI

|===
| Field | Description | Scheme | Required

| apiType
|
| string
| true

| serviceUser
| ServiceUser - optional username used for this service to register in glance
| string
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide GlanceAPI the default SA name
| string
| true

| databaseHostname
| DatabaseHostname - Glance Database Hostname
| string
| true

| databaseAccount
| DatabaseAccount - name of MariaDBAccount which will be used to connect.
| string
| true

| secret
| Secret containing OpenStack password information for glance AdminPassword
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<glanceextravolmounts,GlanceExtraVolMounts>>
| false

| quota
| QuotaEnforce if true, per-tenant quotas are enforced according to the registered keystone limits
| bool
| true

| memcachedInstance
| Memcached instance name.
| string
| true

| notificationBusSecret
| Secret containing RabbitMq transport URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#glanceapistatus]
==== GlanceAPIStatus

GlanceAPIStatus defines the observed state of GlanceAPI

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of glance API instances
| int32
| true

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| apiEndpoint
| API endpoint
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| domain
| Domain is a parameter used by each glanceAPI replicas to setup a worker and set the worker_self_reference_url config option. It's requierd when distributed image import is enabled and it enables pod to pod communication via the associated hostnames
| string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false

| notificationBusSecret
| NotificationBusSecret - Secret containing RabbitMQ transportURL for notification purposes
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#dbpurge-2]
==== DBPurge

DBPurge struct is used to model the parameters exposed to the Glance API CronJob

|===
| Field | Description | Scheme | Required

| age
| Age is the DBPurgeAge parameter and indicates the number of days of purging DB records
| int
| true

| schedule
| Schedule defines the crontab format string to schedule the DBPurge cronJob
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#glance]
==== Glance

Glance is the Schema for the glances API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<glancespec,GlanceSpec>>
| false

| status
|
| <<glancestatus,GlanceStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#glanceextravolmounts]
==== GlanceExtraVolMounts

GlanceExtraVolMounts exposes additional parameters processed by the glance-operator and defines the common VolMounts structure provided by the main storage module

|===
| Field | Description | Scheme | Required

| name
|
| string
| false

| region
|
| string
| false

| extraVol
|
| []storage.VolMounts
| true
|===

<<custom-resources,Back to Custom Resources>>

[#glancelist]
==== GlanceList

GlanceList contains a list of Glance

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<glance,Glance>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#glancespec]
==== GlanceSpec

GlanceSpec defines the desired state of Glance

|===
| Field | Description | Scheme | Required

| containerImage
| Glance Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#glancespeccore]
==== GlanceSpecCore

GlanceSpecCore defines the desired state of Glance

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - optional username used for this service to register in glance
| string
| true

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - name of MariaDBAccount which will be used to connect.
| string
| true

| memcachedInstance
| Memcached instance name.
| string
| true

| secret
| Secret containing OpenStack password information for glance's keystone password; no longer used for database password
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| customServiceConfigSecrets
| CustomServiceConfigSecrets - customize the service config using this parameter to specify Secrets that contain sensitive service config data. The content of each Secret gets added to the /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| []string
| false

| storage
| Storage -
| <<storage,Storage>>
| false

| glanceAPIs
| GlanceAPIs - Spec definition for the API service of this Glance deployment
| map[string]<<glanceapitemplate,GlanceAPITemplate>>
| true

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<glanceextravolmounts,GlanceExtraVolMounts>>
| false

| quotas
| Quotas is defined, per-tenant quotas are enforced according to the registered keystone limits
| <<quotalimits,QuotaLimits>>
| false

| imageCache
| ImageCache -
| <<imagecache,ImageCache>>
| true

| keystoneEndpoint
| KeystoneEndpoint - indicates which glanceAPI should be registered in the keystone catalog, and it acts as a selector for the underlying glanceAPI(s) that can be specified by name
| string
| true

| dbPurge
| DBPurge parameters -
| <<dbpurge,DBPurge>>
| false

| apiTimeout
| Default APITimeout for HAProxy and Apache, defaults to 60 seconds
| int
| true

| notificationBusInstance
| RabbitMQ instance name Needed to request a transportURL that is created and used for notification purposes
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#glancestatus]
==== GlanceStatus

GlanceStatus defines the observed state of Glance

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| apiEndpoint
| API endpoint
| map[string]string
| false

| serviceID
| ServiceID
| string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| Glance Database Hostname
| string
| false

| glanceAPIReadyCounts
| GlanceAPIReadyCounts -
| map[string]int32
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| notificationBusSecret
| NotificationsBusSecret - Secret containing RabbitMQ transportURL used for notification purposes
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the glance service password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#quotalimits]
==== QuotaLimits

QuotaLimits - The parameters exposed to the top level glance CR that represents the limits we set in keystone

|===
| Field | Description | Scheme | Required

| imageSizeTotal
|
| int
| true

| imageStageTotal
|
| int
| true

| imageCountTotal
|
| int
| true

| imageCountUpload
|
| int
| true
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatextravolmounts]
==== HeatExtraVolMounts

HeatExtraVolMounts exposes additional parameters processed by the heat-operator and defines the common VolMounts structure provided by the main storage module

|===
| Field | Description | Scheme | Required

| name
|
| string
| false

| region
|
| string
| false

| extraVol
|
| []storage.VolMounts
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatservicetemplate]
==== HeatServiceTemplate

HeatServiceTemplate -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas -
| *int32
| true

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| nodeSelector
| NodeSelector to target subset of worker nodes for running the service
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/heat/heat.conf.d directory as 02-custom-service.conf file.
| string
| false

| customServiceConfigSecrets
| CustomServiceConfigSecrets - customize the service config using this parameter to specify Secrets that contain sensitive service config data. The content of each Secret gets added to the /etc/heat/heat.conf.d directory as a custom config file.
| []string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heattemplate]
==== HeatTemplate

HeatTemplate -

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - optional username used for this service to register in heat
| string
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount used for heat DB, defaults to heat.
| string
| true

| secret
| Secret containing OpenStack password information for heat HeatDatabasePassword, HeatPassword and HeatAuthEncryptionKey
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| extraMounts
| ExtraMounts containing files and plugins
| []<<heatextravolmounts,HeatExtraVolMounts>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector ..

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the heat service password from the Secret
| string
| true

| authEncryptionKey
| AuthEncryptionKey - Selector to get the heat auth encryption key from the Secret
| string
| true

| stackDomainAdminPassword
| StackDomainAdminPassword - Selector to get the heat stack domain admin password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatapi]
==== HeatAPI

HeatAPI ...

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<heatapispec,HeatAPISpec>>
| false

| status
|
| <<heatapistatus,HeatAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatapilist]
==== HeatAPIList

HeatAPIList contains a list of HeatAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<heatapi,HeatAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatapispec]
==== HeatAPISpec

HeatAPISpec defines the desired state of HeatAPI

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - Heat Database Hostname
| string
| true

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Heat services the default SA name
| string
| true

| memcachedInstance
| Memcached instance name.
| *string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatapistatus]
==== HeatAPIStatus

HeatAPIStatus defines the observed state of HeatAPI

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of HeatAPI instances
| int32
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatapitemplate]
==== HeatAPITemplate

HeatAPITemplate defines the input parameters for the Heat API service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatapitemplatecore]
==== HeatAPITemplateCore

HeatAPITemplateCore -

|===
| Field | Description | Scheme | Required

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatcfnapi]
==== HeatCfnAPI

HeatCfnAPI ...

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<heatcfnapispec,HeatCfnAPISpec>>
| false

| status
|
| <<heatcfnapistatus,HeatCfnAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatcfnapilist]
==== HeatCfnAPIList

HeatCfnAPIList contains a list of HeatCfnAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<heatcfnapi,HeatCfnAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatcfnapispec]
==== HeatCfnAPISpec

HeatCfnAPISpec defines the desired state of HeatCfnAPI

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - Heat Database Hostname
| string
| true

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Heat services the default SA name
| string
| true

| memcachedInstance
| Memcached instance name.
| *string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatcfnapistatus]
==== HeatCfnAPIStatus

HeatCfnAPIStatus defines the observed state of HeatCfnAPI

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of HeatCfnAPI instances
| int32
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatcfnapitemplate]
==== HeatCfnAPITemplate

HeatCfnAPITemplate defines the input parameters for the Heat Cfn API service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatcfnapitemplatecore]
==== HeatCfnAPITemplateCore

HeatCfnAPITemplateCore -

|===
| Field | Description | Scheme | Required

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatengine]
==== HeatEngine

HeatEngine defined.

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<heatenginespec,HeatEngineSpec>>
| false

| status
|
| <<heatenginestatus,HeatEngineStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatenginelist]
==== HeatEngineList

HeatEngineList contains a list of HeatEngine

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<heatengine,HeatEngine>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatenginespec]
==== HeatEngineSpec

HeatEngineSpec defines the desired state of HeatEngine

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - Heat Database Hostname
| string
| true

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Heat services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| memcachedInstance
| Memcached instance name.
| *string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatenginestatus]
==== HeatEngineStatus

HeatEngineStatus defines the observed state of HeatEngine

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of HeatEngine instances
| int32
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatenginetemplate]
==== HeatEngineTemplate

HeatEngineTemplate defines the input parameters for the Heat Engine service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heat]
==== Heat

Heat is the Schema for the heats API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<heatspec,HeatSpec>>
| false

| status
|
| <<heatstatus,HeatStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatlist]
==== HeatList

HeatList contains a list of Heat

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<heat,Heat>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatspec]
==== HeatSpec

HeatSpec defines the desired state of Heat

|===
| Field | Description | Scheme | Required

| heatAPI
| HeatAPI - Spec definition for the API service of this Heat deployment
| <<heatapitemplate,HeatAPITemplate>>
| true

| heatCfnAPI
| HeatCfnAPI - Spec definition for the CfnAPI service of this Heat deployment
| <<heatcfnapitemplate,HeatCfnAPITemplate>>
| true

| heatEngine
| HeatEngine - Spec definition for the Engine service of this Heat deployment
| <<heatenginetemplate,HeatEngineTemplate>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatspecbase]
==== HeatSpecBase

HeatSpec defines the desired state of Heat

|===
| Field | Description | Scheme | Required

| databaseInstance
| MariaDB instance name. Right now required by the maridb-operator to get the credentials from the instance to create the DB. Might not be required in future.
| string
| true

| memcachedInstance
| Memcached instance name.
| string
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Heat
| string
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/heat/heat.conf.d directory as 01-custom.conf file.
| string
| false

| customServiceConfigSecrets
| CustomServiceConfigSecrets - customize the service config using this parameter to specify Secrets that contain sensitive service config data. The content of each Secret gets added to the /etc/heat/heat.conf.d directory as a custom config file.
| []string
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| nodeSelector
| NodeSelector to target subset of worker nodes for running the Heat services
| *map[string]string
| false

| apiTimeout
| APITimeout for Route and Apache
| int
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#heatspeccore]
==== HeatSpecCore

HeatSpecCore defines the desired state of Heat, for use with OpenStackControlplane (no containerImages)

|===
| Field | Description | Scheme | Required

| heatAPI
| HeatAPI - Spec definition for the API service of this Heat deployment
| <<heatapitemplatecore,HeatAPITemplateCore>>
| true

| heatCfnAPI
| HeatCfnAPI - Spec definition for the CfnAPI service of this Heat deployment
| <<heatcfnapitemplatecore,HeatCfnAPITemplateCore>>
| true

| heatEngine
| HeatEngine - Spec definition for the Engine service of this Heat deployment
| <<heatenginetemplatecore,HeatEngineTemplateCore>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#heatstatus]
==== HeatStatus

HeatStatus defines the observed state of Heat

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| databaseHostname
| Heat Database Hostname
| string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| heatApiReadyCount
| ReadyCount of Heat API instance
| int32
| false

| heatCfnApiReadyCount
| ReadyCount of Heat CfnAPI instance
| int32
| false

| heatEngineReadyCount
| ReadyCount of Heat Engine instance
| int32
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#horizionoverridespec]
==== HorizionOverrideSpec

HorizionOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster.
| *service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#horizon]
==== Horizon

Horizon is the Schema for the horizons API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<horizonspec,HorizonSpec>>
| false

| status
|
| <<horizonstatus,HorizonStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#horizonextravolmounts]
==== HorizonExtraVolMounts

HorizonExtraVolMounts exposes additional parameters processed by the horizon-operator and defines the common VolMounts structure provided by the main storage module

|===
| Field | Description | Scheme | Required

| name
|
| string
| false

| region
|
| string
| false

| extraVol
|
| []storage.VolMounts
| true
|===

<<custom-resources,Back to Custom Resources>>

[#horizonlist]
==== HorizonList

HorizonList contains a list of Horizon

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<horizon,Horizon>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#horizonspec]
==== HorizonSpec

HorizonSpec defines the desired state of Horizon

|===
| Field | Description | Scheme | Required

| containerImage
| horizon Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#horizonspeccore]
==== HorizonSpecCore

HorizonSpecCore -

|===
| Field | Description | Scheme | Required

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<horizionoverridespec,HorizionOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.SimpleService
| false

| replicas
| Replicas of horizon API to run
| *int32
| true

| secret
| Secret containing OpenStack password information for Horizon Secret Key
| string
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/openstack-dashboard/local_settings.d directory as 9999_custom_settings.py file.
| string
| true

| memcachedInstance
| Memcached instance name.
| string
| true

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| extraMounts
| ExtraMounts containing conf files
| []<<horizonextravolmounts,HorizonExtraVolMounts>>
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#horizonstatus]
==== HorizonStatus

HorizonStatus defines the observed state of Horizon

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| endpoint
| Endpoint url to access OpenStack Dashboard
| string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of Horizon instances
| int32
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicservicetemplate]
==== IronicServiceTemplate

IronicServiceTemplate defines the common input parameters for Ironic services

|===
| Field | Description | Scheme | Required

| replicas
| Replicas -
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Ironic CR
| *map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneendpoints]
==== KeystoneEndpoints

KeystoneEndpoints defines keystone endpoint parameters for service

|===
| Field | Description | Scheme | Required

| internal
| Internal endpoint URL
| string
| true

| public
| Public endpoint URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the ironic service password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicapi]
==== IronicAPI

IronicAPI is the Schema for the ironicapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ironicapispec,IronicAPISpec>>
| false

| status
|
| <<ironicapistatus,IronicAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicapilist]
==== IronicAPIList

IronicAPIList contains a list of IronicAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ironicapi,IronicAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicapispec]
==== IronicAPISpec

IronicAPISpec defines the desired state of IronicAPI

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Ironic API Container Image
| string
| true

| standalone
| Whether to deploy a standalone Ironic.
| bool
| true

| serviceUser
| ServiceUser - optional username used for this service to register in ironic
| string
| true

| secret
| Secret containing OpenStack password information for AdminPassword
| string
| false

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| databaseHostname
| DatabaseHostname - Ironic Database Hostname
| string
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount used for ironic DB, defaults to ironic.
| string
| true

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| rpcTransport
| RPC transport type - Which RPC transport implementation to use between conductor and API services. 'oslo' to use oslo.messaging transport or 'json-rpc' to use JSON RPC transport. NOTE \-> ironic requires oslo.messaging transport when not in standalone mode.
| string
| true

| keystoneEndpoints
| KeystoneEndpoints - Internally used Keystone API endpoints
| <<keystoneendpoints,KeystoneEndpoints>>
| true

| apiTimeout
| APITimeout for HAProxy, Apache
| int
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicapistatus]
==== IronicAPIStatus

IronicAPIStatus defines the observed state of IronicAPI

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| apiEndpoints
| API endpoint
| map[string]map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of ironic API instances
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicapitemplate]
==== IronicAPITemplate

IronicAPITemplate defines the input parameters for Ironic API service

|===
| Field | Description | Scheme | Required

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicconductor]
==== IronicConductor

IronicConductor is the Schema for the ironicconductors Conductor

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ironicconductorspec,IronicConductorSpec>>
| false

| status
|
| <<ironicconductorstatus,IronicConductorStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicconductorlist]
==== IronicConductorList

IronicConductorList contains a list of IronicConductor

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ironicconductor,IronicConductor>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicconductorspec]
==== IronicConductorSpec

IronicConductorSpec defines the desired state of IronicConductor

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Ironic Conductor Container Image
| string
| true

| standalone
| Whether to deploy a standalone Ironic.
| bool
| true

| pxeContainerImage
| PxeContainerImage - Ironic DHCP/TFTP/HTTP Container Image
| string
| true

| ironicPythonAgentImage
| IronicPythonAgentImage - Image containing the ironic-python-agent kernel and ramdisk
| string
| true

| serviceUser
| ServiceUser - optional username used for this service to register in ironic
| string
| true

| secret
| Secret containing OpenStack password information for AdminPassword
| string
| false

| passwordSelectors
| PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| databaseHostname
| DatabaseHostname - Ironic Database Hostname
| string
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount used for ironic DB, defaults to ironic.
| string
| true

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| rpcTransport
| RPC transport type - Which RPC transport implementation to use between conductor and API services. 'oslo' to use oslo.messaging transport or 'json-rpc' to use JSON RPC transport. NOTE \-> ironic requires oslo.messaging transport when not in standalone mode.
| string
| true

| keystoneEndpoints
| KeystoneEndpoints - Internally used Keystone API endpoints
| <<keystoneendpoints,KeystoneEndpoints>>
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| graphicalConsoles
| Whether to enable graphical consoles. NOTE: Setting this to Enabled is not supported.
| string
| true

| novncproxyImage
| NoVNCProxyImage - Ironic NoVNCProxy Container Image
| string
| false

| consoleImage
| ConsoleImage - Ironic Graphical Console Container Image
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicconductorstatus]
==== IronicConductorStatus

IronicConductorStatus defines the observed state of IronicConductor

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of ironic Conductor instances
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicconductortemplate]
==== IronicConductorTemplate

IronicConductorTemplate defines the input parameters for Ironic Conductor service

|===
| Field | Description | Scheme | Required

| conductorGroup
| ConductorGroup - Ironic Conductor conductor group.
| string
| true

| storageClass
| StorageClass
| string
| true

| storageRequest
| StorageRequest
| string
| true

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| provisionNetwork
| ProvisionNetwork - Additional network to attach to expose boot DHCP, TFTP, HTTP services.
| string
| false

| dhcpRanges
| DHCPRanges - List of DHCP ranges to use for provisioning
| []<<dhcprange,DHCPRange>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#inspectoroverridespec]
==== InspectorOverrideSpec

InspectorOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicinspector]
==== IronicInspector

IronicInspector is the Schema for the IronicInspector

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ironicinspectorspec,IronicInspectorSpec>>
| false

| status
|
| <<ironicinspectorstatus,IronicInspectorStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicinspectorlist]
==== IronicInspectorList

IronicInspectorList contains a list of IronicInspector

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ironicinspector,IronicInspector>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicinspectorpasswordselector]
==== IronicInspectorPasswordSelector

IronicInspectorPasswordSelector to identify the AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the ironic-inspector service password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicinspectorspec]
==== IronicInspectorSpec

IronicInspectorSpec defines the desired state of IronicInspector

|===
| Field | Description | Scheme | Required

| standalone
| Standalone - Whether to deploy a standalone Ironic Inspector.
| bool
| true

| containerImage
| ContainerImage - Ironic Inspector Container Image
| string
| true

| pxeContainerImage
| PxeContainerImage - Ironic Inspector DHCP/TFTP/HTTP Container Image
| string
| true

| ironicPythonAgentImage
| IronicPythonAgentImage - Image containing the ironic-python-agent kernel and ramdisk
| string
| true

| databaseInstance
| MariaDB instance name. Right now required by the maridb-operator to get the credentials from the instance to create the DB. Might not be required in future.
| string
| true

| secret
| Secret containing OpenStack password information for AdminPassword
| string
| false

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Ironic Inspector
| string
| true

| rpcTransport
| RPC transport type - Which RPC transport implementation to use between conductor and API services. 'oslo' to use oslo.messaging transport or 'json-rpc' to use JSON RPC transport. NOTE \-> ironic-inspector requires oslo.messaging transport when not in standalone mode.
| string
| true

| apiTimeout
| APITimeout for HAProxy, Apache
| int
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicinspectorstatus]
==== IronicInspectorStatus

IronicInspectorStatus defines the observed state of IronicInspector

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| apiEndpoints
| API endpoint
| map[string]map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| IronicInspector Database Hostname
| string
| false

| readyCount
| ReadyCount of Ironic Inspector instances
| int32
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicinspectortemplate]
==== IronicInspectorTemplate

IronicInspectorTemplate defines the input parameters for Ironic Inspector service

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - optional username used for this service to register in ironic-inspector
| string
| true

| replicas
| Replicas - Ironic Inspector Replicas
| *int32
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount used for ironic DB, defaults to ironic-inspector. this is separate from the account used for ironic, as a MariaDBAccount can only refer to a single MariaDBDatabase and it appears that ironic inspector uses its own MariaDBDatabase.
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
| <<ironicinspectorpasswordselector,IronicInspectorPasswordSelector>>
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Ironic CR
| *map[string]string
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| storageClass
| StorageClass
| string
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| inspectionNetwork
| InspectionNetwork - Additional network to attach to expose boot DHCP, TFTP, HTTP services.
| string
| false

| dhcpRanges
| DHCPRanges - List of DHCP ranges to use for provisioning
| []<<dhcprange,DHCPRange>>
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<inspectoroverridespec,InspectorOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicneutronagent]
==== IronicNeutronAgent

IronicNeutronAgent is the Schema for the ML2 baremetal - ironic-neutron-agent agents

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ironicneutronagentspec,IronicNeutronAgentSpec>>
| false

| status
|
| <<ironicneutronagentstatus,IronicNeutronAgentStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicneutronagentlist]
==== IronicNeutronAgentList

IronicNeutronAgentList contains a list of IronicConductor

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ironicneutronagent,IronicNeutronAgent>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicneutronagentspec]
==== IronicNeutronAgentSpec

IronicNeutronAgentSpec defines the desired state of ML2 baremetal - ironic-neutron-agent agents

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - ML2 baremtal - Ironic Neutron Agent Image
| string
| true

| serviceUser
| ServiceUser - optional username used for this service to register in ironic
| string
| true

| secret
| Secret containing OpenStack password information for IronicPassword
| string
| false

| passwordSelectors
| PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicneutronagentstatus]
==== IronicNeutronAgentStatus

IronicNeutronAgentStatus defines the observed state of ML2 baremetal - ironic-neutron-agent

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of ironic Conductor instances
| int32
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicneutronagenttemplate]
==== IronicNeutronAgentTemplate

IronicNeutronAgentTemplate defines the input parameters for ML2 baremetal - ironic-neutron-agent agents

|===
| Field | Description | Scheme | Required

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Ironic
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#dhcprange]
==== DHCPRange

DHCPRange to define address range for DHCP requests

|===
| Field | Description | Scheme | Required

| name
| Name - Name of the DHCPRange (used for tagging in dnsmasq)
| string
| false

| cidr
| Cidr - IP address prefix (CIDR) representing an IP network.
| string
| true

| start
| Start - Start of DHCP range
| string
| true

| end
| End - End of DHCP range
| string
| true

| gateway
| Gateway - IP address for the router
| string
| false

| mtu
| MTU - Maximum Transmission Unit
| int
| false

| podIndex
| PodIndex - Maps the DHCPRange to a specific statefulset pod index
| int
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironic]
==== Ironic

Ironic is the Schema for the ironics API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ironicspec,IronicSpec>>
| false

| status
|
| <<ironicstatus,IronicStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironicimages]
==== IronicImages

IronicImages to specify container images required by all ironic services

|===
| Field | Description | Scheme | Required

| api
| API - Ironic API Container Image (will be set to environmental default if empty)
| string
| true

| conductor
| Conductor - Ironic Conductor Container Image (will be set to environmental default if empty)
| string
| true

| inspector
| Inspector - Ironic Inspector Container Image (will be set to environmental default if empty)
| string
| true

| neutronAgent
| NeutronAgent - ML2 baremtal - Ironic Neutron Agent Image (will be set to environmental default if empty)
| string
| true

| pxe
| Pxe- Ironic DHCP/TFTP/HTTP Container Image URL (will be set to environmental default if empty)
| string
| true

| ironicPythonAgent
| IronicPythonAgent - Image containing the ironic-python-agent kernel and ramdisk
| string
| true

| novncproxy
| NoVNCProxy - Ironic NoVNCProxy Container Image (will be set to environmental default if empty)
| string
| false

| graphicalConsole
| GraphicalConsole - Ironic Graphical Console Container Image (will be set to environmental default if empty)
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ironiclist]
==== IronicList

IronicList contains a list of Ironic

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ironic,Ironic>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicspec]
==== IronicSpec

IronicSpec defines the desired state of Ironic

|===
| Field | Description | Scheme | Required

| images
| Images - Container images for all ironic services
| <<ironicimages,IronicImages>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicspeccore]
==== IronicSpecCore

IronicSpec defines the desired state of Ironic

|===
| Field | Description | Scheme | Required

| standalone
| Whether to deploy a standalone Ironic.
| bool
| true

| serviceUser
| ServiceUser - optional username used for this service to register in ironic
| string
| true

| databaseInstance
| MariaDB instance name. Right now required by the maridb-operator to get the credentials from the instance to create the DB. Might not be required in future.
| string
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount used for ironic DB, defaults to ironic.
| string
| true

| secret
| Secret containing OpenStack password information for ironic IronicPassword
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| ironicAPI
| IronicAPI - Spec definition for the API service of this Ironic deployment
| <<ironicapitemplate,IronicAPITemplate>>
| true

| ironicConductors
| IronicConductors - Spec definitions for the conductor service of this Ironic deployment
| []<<ironicconductortemplate,IronicConductorTemplate>>
| false

| ironicInspector
| IronicInspector - Spec definition for the inspector service of this Ironic deployment
| <<ironicinspectortemplate,IronicInspectorTemplate>>
| true

| ironicNeutronAgent
| IronicNeutronAgent - Spec definition for the ML2 baremetal ironic-neutron-agent service of this Ironic deployment
| <<ironicneutronagenttemplate,IronicNeutronAgentTemplate>>
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Ironic
| string
| true

| rpcTransport
| RPC transport type - Which RPC transport implementation to use between conductor and API services. 'oslo' to use oslo.messaging transport or 'json-rpc' to use JSON RPC transport. NOTE \-> ironic and ironic-inspector require oslo.messaging transport when not in standalone mode.
| string
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting NodeSelector here acts as a default value and can be overridden by service specific NodeSelector Settings.
| *map[string]string
| false

| storageClass
| Storage class to host data. This is passed to IronicConductors unless storageClass is explicitly set for the conductor.
| string
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| apiTimeout
| APITimeout for HAProxy, Apache
| int
| true

| graphicalConsoles
| Whether to enable graphical consoles. NOTE: Setting this to Enabled is not supported.
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ironicstatus]
==== IronicStatus

IronicStatus defines the observed state of Ironic

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| Ironic Database Hostname
| string
| false

| apiEndpoints
| API endpoint
| map[string]map[string]string
| false

| ironicAPIReadyCount
| ReadyCount of Ironic API instance
| int32
| false

| ironicConductorReadyCount
| ReadyCount of Ironic Conductor instance
| map[string]int32
| false

| ironicInspectorReadyCount
| ReadyCount of Ironic Inspector instance
| int32
| false

| ironicNeutronAgentReadyCount
| ReadyCount of Ironic Neutron Agent instance
| int32
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#httpdcustomization]
==== HttpdCustomization

HttpdCustomization - customize the httpd service

|===
| Field | Description | Scheme | Required

| processNumber
| ProcessNumber - Number of processes running in keystone API
| *int32
| true

| customConfigSecret
| CustomConfigSecret - customize the httpd vhost config using this parameter to specify a secret that contains service config data. The content of each provided snippet gets rendered as a go template and placed into /etc/httpd/conf/httpd_custom_+++<key>+++. In the default httpd template at the end of the vhost those custom configs get included using `Include conf/httpd_custom_+++<endpoint>+++_*`. For information on how sections in httpd configuration get merged, check section \"How the sections are merged\" in https://httpd.apache.org/docs/current/sections.html#merging+++</endpoint>++++++</key>+++
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneapi]
==== KeystoneAPI

KeystoneAPI is the Schema for the keystoneapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<keystoneapispec,KeystoneAPISpec>>
| false

| status
|
| <<keystoneapistatus,KeystoneAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneapilist]
==== KeystoneAPIList

KeystoneAPIList contains a list of KeystoneAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<keystoneapi,KeystoneAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneapispec]
==== KeystoneAPISpec

|===
| Field | Description | Scheme | Required

| containerImage
| Keystone Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneapispeccore]
==== KeystoneAPISpecCore

KeystoneAPISpec defines the desired state of KeystoneAPI

|===
| Field | Description | Scheme | Required

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - name of MariaDBAccount which will be used to connect.
| string
| true

| memcachedInstance
| Memcached instance name.
| string
| true

| region
| Region - optional region name for the keystone service
| string
| true

| adminProject
| AdminProject - admin project name
| string
| true

| adminUser
| AdminUser - admin user name
| string
| true

| replicas
| Replicas of keystone API to run
| *int32
| true

| secret
| Secret containing OpenStack password information for keystone AdminPassword
| string
| true

| enableSecureRBAC
| EnableSecureRBAC - Enable Consistent and Secure RBAC policies
| bool
| true

| trustFlushArgs
| TrustFlushArgs - Arguments added to keystone-manage trust_flush command
| string
| true

| trustFlushSchedule
| TrustFlushSchedule - Schedule to purge expired or soft-deleted trusts from database
| string
| true

| trustFlushSuspend
| TrustFlushSuspend - Suspend the cron job to purge trusts
| bool
| true

| fernetRotationDays
| FernetRotationDays - Rotate fernet token keys every X days
| *int32
| true

| fernetMaxActiveKeys
| FernetMaxActiveKeys - Maximum number of fernet token keys after rotation
| *int32
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the AdminUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| httpdCustomization
| HttpdCustomization - customize the httpd service
| <<httpdcustomization,HttpdCustomization>>
| true

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Keystone
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| apiTimeout
| APITimeout for HAProxy, Apache
| int
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| extraMounts
| ExtraMounts containing conf files
| []<<keystoneextramounts,KeystoneExtraMounts>>
| false

| federatedRealmConfig
| Secret containing the configuration for federated realms This is only needed when multiple realms are federated. Config files mount path is set to /var/lib/httpd/metadata/
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneapistatus]
==== KeystoneAPIStatus

KeystoneAPIStatus defines the observed state of KeystoneAPI

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of keystone API instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| apiEndpoints
| API endpoint
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| Keystone Database Hostname
| string
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes.
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false

| region
| Region - optional region name for the keystone service
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneextramounts]
==== KeystoneExtraMounts

KeystoneExtraVolMounts exposes additional parameters processed by keystone-operator and defines the common VolMounts structure provided by the main storage module

|===
| Field | Description | Scheme | Required

| name
|
| string
| false

| region
|
| string
| false

| extraVol
|
| []storage.VolMounts
| true
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| admin
| Admin - Selector to get the keystone Admin password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#endpoint]
==== Endpoint

Endpoint -

|===
| Field | Description | Scheme | Required

| interface
| Interface - public, internal, admin
| string
| true

| url
| URL - endpoint url
| string
| true

| id
| ID - endpoint id
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneendpoint]
==== KeystoneEndpoint

KeystoneEndpoint is the Schema for the keystoneendpoints API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<keystoneendpointspec,KeystoneEndpointSpec>>
| false

| status
|
| <<keystoneendpointstatus,KeystoneEndpointStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneendpointlist]
==== KeystoneEndpointList

KeystoneEndpointList contains a list of KeystoneEndpoint

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<keystoneendpoint,KeystoneEndpoint>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneendpointspec]
==== KeystoneEndpointSpec

KeystoneEndpointSpec defines the desired state of KeystoneEndpoint

|===
| Field | Description | Scheme | Required

| serviceName
| ServiceName - Name of the service to create the endpoint for
| string
| true

| endpoints
| Endpoints - map with service api endpoint URLs with the endpoint type as index
| map[string]string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneendpointstatus]
==== KeystoneEndpointStatus

KeystoneEndpointStatus defines the observed state of KeystoneEndpoint

|===
| Field | Description | Scheme | Required

| endpointIDs
|
| map[string]string
| false

| serviceID
|
| string
| false

| conditions
| Conditions
| condition.Conditions
| false

| endpoints
| Endpoints - current status of latest configured endpoints for the service
| []<<endpoint,Endpoint>>
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes.
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneservice]
==== KeystoneService

KeystoneService is the Schema for the keystoneservices API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<keystoneservicespec,KeystoneServiceSpec>>
| false

| status
|
| <<keystoneservicestatus,KeystoneServiceStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneservicelist]
==== KeystoneServiceList

KeystoneServiceList contains a list of KeystoneService

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<keystoneservice,KeystoneService>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneservicespec]
==== KeystoneServiceSpec

KeystoneServiceSpec defines the desired state of KeystoneService

|===
| Field | Description | Scheme | Required

| serviceType
| ServiceType - Type is the type of the service.
| string
| true

| serviceName
| ServiceName - Name of the service.
| string
| true

| serviceDescription
| ServiceDescription - Description for the service.
| string
| false

| enabled
| Enabled - whether or not the service is enabled.
| bool
| true

| serviceUser
| ServiceUser - optional username used for this service
| string
| true

| secret
| Secret containing OpenStack password information for the ServiceUser
| string
| true

| passwordSelector
| PasswordSelector - Selector to get the ServiceUser password from the Secret, e.g. PlacementPassword
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#keystoneservicestatus]
==== KeystoneServiceStatus

KeystoneServiceStatus defines the observed state of KeystoneService

|===
| Field | Description | Scheme | Required

| serviceID
|
| string
| false

| conditions
| Conditions
| condition.Conditions
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaservicetemplate]
==== ManilaServiceTemplate

ManilaServiceTemplate defines the input parameters that can be defined for a given Manila service

|===
| Field | Description | Scheme | Required

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Manila CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory a custom config file.+++</service>++++++</service>+++
| string
| false

| customServiceConfigSecrets
| CustomServiceConfigSecrets - customize the service config using this parameter to specify Secrets that contain sensitive service config data. The content of each Secret gets added to the /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| []string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilatemplate]
==== ManilaTemplate

ManilaTemplate defines common input parameters used by all Manila services

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - optional username used for this service to register in manila
| string
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount CR name used for manila DB, defaults to manila
| string
| true

| secret
| Secret containing OpenStack password information for AdminPassword
| string
| false

| passwordSelectors
| PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the manila service password from the Secret
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaapi]
==== ManilaAPI

ManilaAPI is the Schema for the manilaapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<manilaapispec,ManilaAPISpec>>
| false

| status
|
| <<manilaapistatus,ManilaAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaapilist]
==== ManilaAPIList

ManilaAPIList contains a list of ManilaAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<manilaapi,ManilaAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilaapispec]
==== ManilaAPISpec

ManilaAPISpec defines the desired state of ManilaAPI

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - Manila Database Hostname
| string
| false

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| notificationsURLSecret
| Secret containing Notification transport URL
| string
| false

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<manilaextravolmounts,ManilaExtraVolMounts>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide the default SA name
| string
| true

| memcachedInstance
| Memcached instance name.
| *string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilaapistatus]
==== ManilaAPIStatus

ManilaAPIStatus defines the observed state of ManilaAPI

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of Manila API instances
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaapitemplate]
==== ManilaAPITemplate

ManilaAPITemplate defines the input parameter for the ManilaAPI service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Manila API Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilaapitemplatecore]
==== ManilaAPITemplateCore

ManilaAPITemplateCore -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Manila API Replicas
| *int32
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilascheduler]
==== ManilaScheduler

ManilaScheduler is the Schema for the manilaschedulers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<manilaschedulerspec,ManilaSchedulerSpec>>
| false

| status
|
| <<manilaschedulerstatus,ManilaSchedulerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaschedulerlist]
==== ManilaSchedulerList

ManilaSchedulerList contains a list of ManilaScheduler

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<manilascheduler,ManilaScheduler>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilaschedulerspec]
==== ManilaSchedulerSpec

ManilaSchedulerSpec defines the desired state of ManilaScheduler

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - manila Database Hostname
| string
| false

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| notificationsURLSecret
| Secret containing Notification transport URL
| string
| false

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<manilaextravolmounts,ManilaExtraVolMounts>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide the default SA name
| string
| true

| memcachedInstance
| Memcached instance name.
| *string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaschedulerstatus]
==== ManilaSchedulerStatus

ManilaSchedulerStatus defines the observed state of ManilaScheduler

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of Manila Scheduler instances
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaschedulertemplate]
==== ManilaSchedulerTemplate

ManilaSchedulerTemplate defines the input parameter for the ManilaScheduler service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Manila API Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilaschedulertemplatecore]
==== ManilaSchedulerTemplateCore

ManilaSchedulerTemplateCore -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Manila API Replicas
| *int32
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilashare]
==== ManilaShare

ManilaShare is the Schema for the manilashares API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<manilasharespec,ManilaShareSpec>>
| false

| status
|
| <<manilasharestatus,ManilaShareStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilasharelist]
==== ManilaShareList

ManilaShareList contains a list of ManilaShare

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<manilashare,ManilaShare>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilasharespec]
==== ManilaShareSpec

ManilaShareSpec defines the desired state of ManilaShare

|===
| Field | Description | Scheme | Required

| databaseHostname
| DatabaseHostname - manila Database Hostname
| string
| false

| transportURLSecret
| Secret containing RabbitMq transport URL
| string
| false

| notificationsURLSecret
| Secret containing Notification transport URL
| string
| false

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<manilaextravolmounts,ManilaExtraVolMounts>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide the default SA name
| string
| true

| memcachedInstance
| Memcached instance name.
| *string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilasharestatus]
==== ManilaShareStatus

ManilaShareStatus defines the observed state of ManilaShare

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount of ManilaShare instances
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilasharetemplate]
==== ManilaShareTemplate

ManilaShareTemplate defines the input parameter for the ManilaShare service

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Manila API Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilasharetemplatecore]
==== ManilaShareTemplateCore

ManilaShareTemplateCore -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - Manila API Replicas
| *int32
| true
|===

<<custom-resources,Back to Custom Resources>>

[#dbpurge-2]
==== DBPurge

DBPurge struct is used to model the parameters exposed to the Manila API CronJob

|===
| Field | Description | Scheme | Required

| age
| Age is the DBPurgeAge parameter and indicates the number of days of purging DB records
| int
| true

| schedule
| Schedule defines the crontab format string to schedule the DBPurge cronJob
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manila]
==== Manila

Manila is the Schema for the manilas API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<manilaspec,ManilaSpec>>
| false

| status
|
| <<manilastatus,ManilaStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#maniladebug]
==== ManilaDebug

ManilaDebug contains flags related to multiple debug activities. See the individual comments for what this means for each flag.

|===
| Field | Description | Scheme | Required

| dbPurge
| DBPurge increases log verbosity by executing the db_purge command with "--debug".
| bool
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaextravolmounts]
==== ManilaExtraVolMounts

ManilaExtraVolMounts exposes additional parameters processed by the manila-operator and defines the common VolMounts structure provided by the main storage module

|===
| Field | Description | Scheme | Required

| name
|
| string
| false

| region
|
| string
| false

| extraVol
|
| []storage.VolMounts
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilalist]
==== ManilaList

ManilaList contains a list of Manila

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<manila,Manila>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#manilaspec]
==== ManilaSpec

ManilaSpec defines the desired state of Manila

|===
| Field | Description | Scheme | Required

| manilaAPI
| ManilaAPI - Spec definition for the API service of this Manila deployment
| <<manilaapitemplate,ManilaAPITemplate>>
| true

| manilaScheduler
| ManilaScheduler - Spec definition for the Scheduler service of this Manila deployment
| <<manilaschedulertemplate,ManilaSchedulerTemplate>>
| true

| manilaShares
| ManilaShares - Map of chosen names to spec definitions for the Share(s) service(s) of this Manila deployment
| map[string]<<manilasharetemplate,ManilaShareTemplate>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaspecbase]
==== ManilaSpecBase

ManilaSpecBase -

|===
| Field | Description | Scheme | Required

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Manila
| string
| true

| memcachedInstance
| Memcached instance name.
| string
| true

| debug
| Debug - enable debug for different deploy stages. If an init container is used, it runs and the actual action pod gets started with sleep infinity
| <<maniladebug,ManilaDebug>>
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| false

| customServiceConfig
| CustomServiceConfig - customize the service config for all Manila services using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory a custom config file.+++</service>++++++</service>+++
| string
| false

| extraMounts
| ExtraMounts containing conf files and credentials
| []<<manilaextravolmounts,ManilaExtraVolMounts>>
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting NodeSelector here acts as a default value and can be overridden by service specific NodeSelector Settings.
| *map[string]string
| false

| dbPurge
| DBPurge parameters -
| <<dbpurge,DBPurge>>
| false

| apiTimeout
| APITimeout for HAProxy, Apache, and rpc_response_timeout
| int
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| notificationsBusInstance
| RabbitMQ instance name used to request a transportURL that is used for notification purposes
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilaspeccore]
==== ManilaSpecCore

ManilaSpecCore defines the desired state of Manila. This version is used by OpenStackControlplane

|===
| Field | Description | Scheme | Required

| manilaAPI
| ManilaAPI - Spec definition for the API service of this Manila deployment
| <<manilaapitemplatecore,ManilaAPITemplateCore>>
| true

| manilaScheduler
| ManilaScheduler - Spec definition for the Scheduler service of this Manila deployment
| <<manilaschedulertemplatecore,ManilaSchedulerTemplateCore>>
| true

| manilaShares
| ManilaShares - Map of chosen names to spec definitions for the Share(s) service(s) of this Manila deployment
| map[string]<<manilasharetemplatecore,ManilaShareTemplateCore>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#manilastatus]
==== ManilaStatus

ManilaStatus defines the observed state of Manila

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| Manila Database Hostname
| string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| notificationsURLSecret
| NotificationsURLSecret - Secret containing RabbitMQ notificationsURL
| *string
| false

| manilaAPIReadyCount
| ReadyCount of Manila API instance
| int32
| false

| manilaSchedulerReadyCount
| ReadyCount of Manila Scheduler instance
| int32
| false

| manilaSharesReadyCounts
| ReadyCounts of Manila Share instances
| map[string]int32
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#galerabackup]
==== GaleraBackup

GaleraBackup is the Schema for the galerabackups API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<galerabackupspec,GaleraBackupSpec>>
| false

| status
|
| <<galerabackupstatus,GaleraBackupStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#galerabackuplist]
==== GaleraBackupList

GaleraBackupList contains a list of GaleraBackup

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<galerabackup,GaleraBackup>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#galerabackupspec]
==== GaleraBackupSpec

GaleraBackupSpec defines the desired state of GaleraBackup

|===
| Field | Description | Scheme | Required

| databaseInstance
| Galera cluster to backup
| string
| false

| storageClass
| Storage volume for backup data
| string
| false

| storageRequest
| Storage Request for backup data
| string
| false

| transferStorage
| Configuration of storage used for intermediate data transfer
| *<<galerabackuptransferstoragespec,GaleraBackupTransferStorageSpec>>
| false

| schedule
| The schedule in Cron format
| string
| true

| retention
| Time duration after which old backups must be reclaimed on disk
| *metav1.Duration
| false
|===

<<custom-resources,Back to Custom Resources>>

[#galerabackupstatus]
==== GaleraBackupStatus

GaleraBackupStatus defines the observed state of GaleraBackup

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track input changes
| map[string]string
| false

| conditions
| Deployment Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#galerabackuptransferstoragespec]
==== GaleraBackupTransferStorageSpec

|===
| Field | Description | Scheme | Required

| storageClass
| Storage volume for backup data
| string
| false

| storageRequest
| Storage Request for backup data
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#galera]
==== Galera

Galera is the Schema for the galeras API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<galeraspec,GaleraSpec>>
| false

| status
|
| <<galerastatus,GaleraStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#galeraattributes]
==== GaleraAttributes

GaleraAttributes holds startup information for a Galera host

|===
| Field | Description | Scheme | Required

| uuid
| UUID of the partition that is seen by the galera node
| string
| false

| seqno
| Last recorded replication sequence number in the DB
| string
| true

| safe_to_bootstrap
| This galera node can bootstrap a galera cluster
| bool
| false

| no_grastate
| This galera node has its state recovered from the DB
| bool
| false

| gcomm
| Gcomm URI used to connect to the galera cluster
| string
| false

| containerID
| Identifier of the container at the time the gcomm URI was injected
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#galeralist]
==== GaleraList

GaleraList contains a list of Galera

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<galera,Galera>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#galeraspec]
==== GaleraSpec

GaleraSpec defines the desired state of Galera

|===
| Field | Description | Scheme | Required

| containerImage
| Name of the galera container image to run (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#galeraspeccore]
==== GaleraSpecCore

GaleraSpec defines the desired state of Galera

|===
| Field | Description | Scheme | Required

| secret
| Name of the secret to look for password keys
| string
| true

| storageClass
| Storage class to host the mariadb databases
| string
| true

| storageRequest
| Storage size allocated for the mariadb databases
| string
| true

| replicas
| Size of the galera cluster deployment
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| customServiceConfig
| Customize config using this parameter to change service defaults, or overwrite rendered information using raw MariaDB config format. The content gets added to /etc/my.cnf.d/galera_custom.cnf
| string
| false

| tls
| TLS settings for MySQL service and internal Galera replication
| tls.SimpleService
| false

| disableNonTLSListeners
| When TLS is configured, only allow connections to the DB over TLS
| bool
| false

| logToDisk
| Log Galera pod's output to disk
| bool
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| resources
| Resources QoS configuration for pods
| corev1.ResourceRequirements
| false
|===

<<custom-resources,Back to Custom Resources>>

[#galerastatus]
==== GaleraStatus

GaleraStatus defines the observed state of Galera

|===
| Field | Description | Scheme | Required

| attributes
| A map of database node attributes for each pod
| map[string]<<galeraattributes,GaleraAttributes>>
| false

| safeToBootstrap
| Name of the node that can safely bootstrap a cluster
| string
| false

| bootstrapped
| Is the galera cluster currently running
| bool
| true

| stopRequired
| Does the galera cluster requires to be stopped globally
| bool
| true

| clusterProperties
| Map of properties that require full cluster restart if changed
| map[string]string
| false

| hash
| Map of hashes to track input changes
| map[string]string
| false

| conditions
| Deployment Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#mariadbaccount]
==== MariaDBAccount

MariaDBAccount is the Schema for the mariadbaccounts API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<mariadbaccountspec,MariaDBAccountSpec>>
| false

| status
|
| <<mariadbaccountstatus,MariaDBAccountStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#mariadbaccountlist]
==== MariaDBAccountList

MariaDBAccountList contains a list of MariaDBAccount

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<mariadbaccount,MariaDBAccount>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#mariadbaccountspec]
==== MariaDBAccountSpec

MariaDBAccountSpec defines the desired state of MariaDBAccount

|===
| Field | Description | Scheme | Required

| userName
| UserName for new account
| string
| true

| secret
| Name of secret which contains DatabasePassword
| string
| true

| requireTLS
| Account must use TLS to connect to the database
| bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#mariadbaccountstatus]
==== MariaDBAccountStatus

MariaDBAccountStatus defines the observed state of MariaDBAccount

|===
| Field | Description | Scheme | Required

| conditions
| Deployment Conditions
| condition.Conditions
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#mariadbdatabase]
==== MariaDBDatabase

MariaDBDatabase is the Schema for the mariadbdatabases API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<mariadbdatabasespec,MariaDBDatabaseSpec>>
| false

| status
|
| <<mariadbdatabasestatus,MariaDBDatabaseStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#mariadbdatabaselist]
==== MariaDBDatabaseList

MariaDBDatabaseList contains a list of MariaDBDatabase

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<mariadbdatabase,MariaDBDatabase>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#mariadbdatabasespec]
==== MariaDBDatabaseSpec

MariaDBDatabaseSpec defines the desired state of MariaDBDatabase

|===
| Field | Description | Scheme | Required

| secret
| Name of secret which contains DatabasePassword (deprecated)
| *string
| false

| name
| Name of the database in MariaDB
| string
| false

| defaultCharacterSet
| Default character set for this database
| string
| false

| defaultCollation
| Default collation for this database
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#mariadbdatabasestatus]
==== MariaDBDatabaseStatus

MariaDBDatabaseStatus defines the observed state of MariaDBDatabase

|===
| Field | Description | Scheme | Required

| conditions
| Deployment Conditions
| condition.Conditions
| false

| completed
|
| bool
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| tlsSupport
| Whether TLS is supported by the DB instance
| bool
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#neutronapi]
==== NeutronAPI

NeutronAPI is the Schema for the neutronapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<neutronapispec,NeutronAPISpec>>
| false

| status
|
| <<neutronapistatus,NeutronAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#neutronapilist]
==== NeutronAPIList

NeutronAPIList contains a list of NeutronAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<neutronapi,NeutronAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#neutronapispec]
==== NeutronAPISpec

NeutronAPISpec defines the desired state of NeutronAPI

|===
| Field | Description | Scheme | Required

| containerImage
| NeutronAPI Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#neutronapispeccore]
==== NeutronAPISpecCore

NeutronAPISpecCore -

|===
| Field | Description | Scheme | Required

| apiTimeout
| APITimeout for HAProxy, Apache
| int
| true

| serviceUser
| ServiceUser - optional username used for this service to register in neutron
| string
| true

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount CR name used for neutron DB, defaults to neutron
| string
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Neutron
| string
| true

| memcachedInstance
| Memcached instance name.
| string
| true

| replicas
| Replicas of neutron API to run
| *int32
| true

| secret
| Secret containing OpenStack password information for NeutronPassword
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| corePlugin
| CorePlugin - Neutron core plugin to use. Using "ml2" if not set.
| string
| true

| ml2MechanismDrivers
| Ml2MechanismDrivers - list of ml2 drivers to enable. Using {"ovn"} if not set.
| []string
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| DefaultConfigOverwrite - interface to overwrite default config files like policy.yaml
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| extraMounts
| ExtraMounts containing conf files
| []<<neutronextravolmounts,NeutronExtraVolMounts>>
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| <<neutronapitls,NeutronApiTLS>>
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| notificationsBusInstance
| NotificationsBusInstance is the name of the RabbitMqCluster CR to select the Message Bus Service instance used by the neutron to publish external notifications. If undefined, the value will be inherited from OpenStackControlPlane. An empty value "" leaves the notification drivers unconfigured and emitting no notifications at all. Avoid colocating it with RabbitMqClusterName used for RPC.
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#neutronapistatus]
==== NeutronAPIStatus

NeutronAPIStatus defines the observed state of NeutronAPI

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of neutron API instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| Neutron Database Hostname
| string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false

| notificationsTransportURLSecret
| NotificationsTransportURLSecret - Secret containing external notifications transportURL
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#neutronapitls]
==== NeutronApiTLS

|===
| Field | Description | Scheme | Required

| api
| API tls type which encapsulates for API services
| tls.APIService
| false

| ovn
| Ovn GenericService - holds the secret for the OvnDb client cert
| tls.GenericService
| false
|===

<<custom-resources,Back to Custom Resources>>

[#neutronextravolmounts]
==== NeutronExtraVolMounts

NeutronExtraVolMounts exposes additional parameters processed by the neutron-operator and defines the common VolMounts structure provided by the main storage module

|===
| Field | Description | Scheme | Required

| name
|
| string
| false

| region
|
| string
| false

| extraVol
|
| []storage.VolMounts
| true
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Database - Selector to get the neutron service password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novacellimages]
==== NovaCellImages

|===
| Field | Description | Scheme | Required

| conductorContainerImageURL
| ConductorContainerImageURL
| string
| true

| metadataContainerImageURL
| MetadataContainerImageURL
| string
| true

| novncproxyContainerImageURL
| NoVNCContainerImageURL
| string
| true

| computeContainerImageURL
| NovaComputeContainerImageURL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaimages]
==== NovaImages

|===
| Field | Description | Scheme | Required

| apiContainerImageURL
| APIContainerImageURL
| string
| true

| schedulerContainerImageURL
| SchedulerContainerImageURL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaservicebase]
==== NovaServiceBase

NovaServiceBase contains the fields that are needed for each nova service CRD

|===
| Field | Description | Scheme | Required

| containerImage
| The service specific Container Image URL (will be set to environmental default if empty)
| string
| true

| replicas
| Replicas of the service to run
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the keystone service user password from the Secret
| string
| true

| metadataSecret
| MetadataSecret - the name of the field to get the metadata secret from the Secret
| string
| true

| prefixMetadataCellsSecret
| prefixMetadataCellsSecret - the prefix name of the field to get the metadata secret from the Secret for cells. Vale of metadata_proxy_shared_secret information for the nova-metadata service. This secret is shared between nova and neutron ovn-metadata inside selected cell and if this is not defined the global metadata_proxy_shared_secret secret will be used
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novaapi]
==== NovaAPI

NovaAPI is the Schema for the novaapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<novaapispec,NovaAPISpec>>
| false

| status
|
| <<novaapistatus,NovaAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novaapilist]
==== NovaAPIList

NovaAPIList contains a list of NovaAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<novaapi,NovaAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaapispec]
==== NovaAPISpec

NovaAPISpec defines the desired state of NovaAPI

|===
| Field | Description | Scheme | Required

| apiTimeout
| APITimeout for Route and Apache
| int
| true

| secret
| Secret is the name of the Secret instance containing password information for the nova-api service. This secret is expected to be generated by the nova-operator based on the information passed to the Nova CR.
| string
| true

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| keystoneAuthURL
| KeystoneAuthURL configures the keystone API endpoint to be used by the service for authentication and authorization
| string
| true

| keystonePublicAuthURL
| KeystonePublicAuthURL configures the public keystone API endpoint. This can be different from KeystoneAuthURL. The service uses this value to redirect unauthenticated users.
| string
| true

| apiDatabaseAccount
| APIDatabaseAccount - MariaDBAccount to use when accessing the API DB
| string
| true

| apiDatabaseHostname
| APIDatabaseHostname - hostname to use when accessing the API DB
| string
| true

| cell0DatabaseAccount
| APIDatabaseAccount - MariaDBAccount to use when accessing the cell0 DB
| string
| true

| cell0DatabaseHostname
| APIDatabaseHostname - hostname to use when accessing the cell0 DB
| string
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Nova services the default SA name
| string
| true

| registeredCells
| RegisteredCells is a map keyed by cell names that are registered in the nova_api database with a value that is the hash of the given cell configuration. This is used to detect when a new cell is added or an existing cell is reconfigured to trigger refresh of the in memory cell caches of the service.
| map[string]string
| true

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| defaultConfigOverwrite
| DefaultConfigOverwrite - interface to overwrite default config files like e.g. api-paste.ini or policy.yaml.
| map[string]string
| false

| memcachedInstance
| MemcachedInstance is the name of the Memcached CR that all nova service will use.
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaapistatus]
==== NovaAPIStatus

NovaAPIStatus defines the observed state of NovaAPI

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount defines the number of replicas ready from nova-api
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novaapitemplate]
==== NovaAPITemplate

NovaAPITemplate defines the input parameters specified by the user to create a NovaAPI via higher level CRDs. NOTE(gibi): NovaAPITemplate has the same structure than NovaServiceBase BUT we want to default ContainerImage for the template, therefore the structs are duplicated.

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of the service to run
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Nova CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| defaultConfigOverwrite
| DefaultConfigOverwrite - interface to overwrite default config files like e.g. api-paste.ini or policy.yaml.
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novacell]
==== NovaCell

NovaCell is the Schema for the novacells API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<novacellspec,NovaCellSpec>>
| false

| status
|
| <<novacellstatus,NovaCellStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novacelldbpurge]
==== NovaCellDBPurge

NovaCellDBPurge defines the parameters for the DB archiving and purging cron job

|===
| Field | Description | Scheme | Required

| schedule
| Schedule defines when to run the DB maintenance job in a cron format. By default it runs every midnight.
| *string
| true

| archiveAge
| ArchiveAge defines the minimum age of the records in days that can be moved to the shadow tables.
| *int
| true

| purgeAge
| PurgeAge defines the minimum age of the records in days that can be deleted from the shadow tables
| *int
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novacelllist]
==== NovaCellList

NovaCellList contains a list of NovaCell

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<novacell,NovaCell>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novacellspec]
==== NovaCellSpec

NovaCellSpec defines the desired state of NovaCell

|===
| Field | Description | Scheme | Required

| cellName
| CellName is the name of the Nova Cell. The value "cell0" has a special meaning. The "cell0" Cell cannot have compute nodes associated and the conductor in this cell acts as the super conductor for all the cells in the deployment.
| string
| true

| apiTimeout
| APITimeout for Route and Apache
| int
| true

| secret
| Secret is the name of the Secret instance containing password information for the nova cell. This secret is expected to be generated by the nova-operator based on the information passed to the Nova CR.
| string
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this services.
| *map[string]string
| false

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| keystoneAuthURL
| KeystoneAuthURL - the URL that the service in the cell can use to talk to keystone
| string
| true

| apiDatabaseAccount
| APIDatabaseAccount - MariaDBAccount to use when accessing the API DB
| string
| true

| apiDatabaseHostname
| APIDatabaseHostname - hostname to use when accessing the API DB. If not provided then up-calls will be disabled. This filed is Required for cell0.
| string
| true

| cellDatabaseAccount
| CellDatabaseAccount - MariaDBAccount to use when accessing the cell DB
| string
| true

| cellDatabaseHostname
| CellDatabaseHostname - hostname to use when accessing the cell DB
| string
| true

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| conductorServiceTemplate
| ConductorServiceTemplate - defines the cell conductor deployment for the cell
| <<novaconductortemplate,NovaConductorTemplate>>
| true

| metadataServiceTemplate
| MetadataServiceTemplate - defines the metadata service dedicated for the cell.
| <<novametadatatemplate,NovaMetadataTemplate>>
| true

| noVNCProxyServiceTemplate
| NoVNCProxyServiceTemplate - defines the novncproxy service dedicated for the cell.
| <<novanovncproxytemplate,NovaNoVNCProxyTemplate>>
| true

| novaComputeTemplates
| NovaComputeTemplates - map of nova computes template with selected drivers in format compute_name: compute_template. Key from map is arbitrary name for the compute. because of that there is a 20 character limit on the compute name.
| map[string]<<novacomputetemplate,NovaComputeTemplate>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Nova services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| memcachedInstance
| MemcachedInstance is the name of the Memcached CR that all nova service will use.
| string
| true

| dbPurge
| DBPurge defines the parameters for the DB archiving and purging cron job
| <<novacelldbpurge,NovaCellDBPurge>>
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novacellstatus]
==== NovaCellStatus

NovaCellStatus defines the observed state of NovaCell

|===
| Field | Description | Scheme | Required

| hash
| INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| conductorServiceReadyCount
| ConductorServiceReadyCount defines the number of replicas ready from nova-conductor service in the cell
| int32
| false

| metadataServiceReadyCount
| MetadataServiceReadyCount defines the number of replicas ready from nova-metadata service in the cell
| int32
| false

| noVNCProxyServiceReadyCount
| NoVNCPRoxyServiceReadyCount defines the number of replicas ready from nova-novncproxy service in the cell
| int32
| false

| novaComputesStatus
| NovaComputesStatus is a map with format cell_name: NovaComputeCellStatus where NovaComputeCellStatus tell if compute with selected name deployed successfully and indicates if the compute is successfully mapped to the cell in the nova_api database. When a compute is removed from the Spec the operator will delete the related NovaCompute CR and then remove the compute from this Status field.
| map[string]<<novacomputecellstatus,NovaComputeCellStatus>>
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novacelltemplate]
==== NovaCellTemplate

NovaCellTemplate defines the input parameters specified by the user to create a NovaCell via higher level CRDs.

|===
| Field | Description | Scheme | Required

| cellDatabaseInstance
| CellDatabaseInstance is the name of the MariaDB CR to select the DB Service instance used as the DB of this cell.
| string
| true

| cellDatabaseAccount
| CellDatabaseAccount - MariaDBAccount to use when accessing the give cell DB
| string
| true

| cellMessageBusInstance
| CellMessageBusInstance is the name of the RabbitMqCluster CR to select the Message Bus Service instance used by the nova services to communicate in this cell. For cell0 it is unused.
| string
| true

| hasAPIAccess
| HasAPIAccess defines if this Cell is configured to have access to the API DB and message bus.
| bool
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running cell.
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| conductorServiceTemplate
| ConductorServiceTemplate - defines the cell conductor deployment for the cell.
| <<novaconductortemplate,NovaConductorTemplate>>
| true

| metadataServiceTemplate
| MetadataServiceTemplate - defines the metadata service dedicated for the cell. Note that for cell0 metadata service should not be deployed. Also if metadata service needs to be deployed per cell here then it should not be enabled to be deployed on the top level via the Nova CR at the same time. By default Nova CR deploys the metadata service at the top level and disables it on the cell level.
| <<novametadatatemplate,NovaMetadataTemplate>>
| true

| noVNCProxyServiceTemplate
| NoVNCProxyServiceTemplate - defines the novncproxy service dedicated for the cell. Note that for cell0 novncproxy should not be deployed so the enabled field of this template is defaulted to false in cell0 but defaulted to true in other cells.
| <<novanovncproxytemplate,NovaNoVNCProxyTemplate>>
| true

| novaComputeTemplates
| NovaComputeTemplates - map of nova computes template with selected drivers in format compute_name: compute_template. Key from map is arbitrary name for the compute with a limit of 20 characters.
| map[string]<<novacomputetemplate,NovaComputeTemplate>>
| false

| memcachedInstance
| MemcachedInstance is the name of the Memcached CR that the services in the cell will use. If defined then this takes precedence over Nova.Spec.MemcachedInstance for this cel
| string
| true

| dbPurge
| DBPurge defines the parameters for the DB archiving and purging cron job
| <<novacelldbpurge,NovaCellDBPurge>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novacompute]
==== NovaCompute

NovaCompute is the Schema for the NovaCompute

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<novacomputespec,NovaComputeSpec>>
| false

| status
|
| <<novacomputestatus,NovaComputeStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novacomputecellstatus]
==== NovaComputeCellStatus

NovaComputeCellStatus defines state of NovaCompute in cell

|===
| Field | Description | Scheme | Required

| deployed
| Deployed value: true means that the compute is deployed but can still be undiscovered
| bool
| true

| errors
| Errors value True means that during deployment, errors appear, and the user needs to check the compute for problems
| bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novacomputelist]
==== NovaComputeList

NovaComputeList contains a list of NovaCompute

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<novacompute,NovaCompute>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novacomputespec]
==== NovaComputeSpec

NovaComputeSpec defines the desired state of NovaCompute

|===
| Field | Description | Scheme | Required

| cellName
| CellName is the name of the Nova Cell this NovaCompute belongs to.
| string
| true

| computeName
| ComputeName - compute name.
| string
| true

| secret
| Secret is the name of the Secret instance containing password information for the NovaCompute service. This secret is expected to be generated by the nova-operator based on the information passed to the Nova CR.
| string
| true

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| keystoneAuthURL
|
| string
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Nova services the default SA name
| string
| true

| computeDriver
| ComputeDriver defines which driver to use for controlling virtualization
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| defaultConfigOverwrite
| DefaultConfigOverwrite - interface to overwrite default config files like e.g. provider.yaml
| map[string]string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novacomputestatus]
==== NovaComputeStatus

NovaComputeStatus defines the observed state of NovaCompute

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount defines the number of replicas ready from NovaCompute
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novacomputetemplate]
==== NovaComputeTemplate

NovaComputeTemplate defines the input parameters specified by the user to create a NovaCompute via higher level CRDs.

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of the service to run. For ironic.IronicDriver the max replica is 1
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Nova CR.
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| defaultConfigOverwrite
| DefaultConfigOverwrite - interface to overwrite default config files like e.g. provider.yaml
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| computeDriver
| ComputeDriver - defines which driver to use for controlling virtualization
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaconductor]
==== NovaConductor

NovaConductor is the Schema for the novaconductors API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<novaconductorspec,NovaConductorSpec>>
| false

| status
|
| <<novaconductorstatus,NovaConductorStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novaconductorlist]
==== NovaConductorList

NovaConductorList contains a list of NovaConductor

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<novaconductor,NovaConductor>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaconductorspec]
==== NovaConductorSpec

NovaConductorSpec defines the desired state of NovaConductor

|===
| Field | Description | Scheme | Required

| cellName
| CellName is the name of the Nova Cell this conductor belongs to.
| string
| true

| secret
| Secret is the name of the Secret instance containing password information for the nova-conductor service. This secret is expected to be generated by the nova-operator based on the information passed to the Nova CR.
| string
| true

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| keystoneAuthURL
| KeystoneAuthURL - the URL that the nova-conductor service can use to talk to keystone
| string
| true

| apiDatabaseAccount
| APIDatabaseAccount - MariaDBAccount to use when accessing the API DB
| string
| true

| apiDatabaseHostname
| APIDatabaseHostname - hostname to use when accessing the API DB. If not provided then up-calls will be disabled. This filed is Required for cell0.
| string
| true

| cellDatabaseAccount
| CellDatabaseAccount - MariaDBAccount to use when accessing the cell DB
| string
| true

| cellDatabaseHostname
| NOTE(gibi): This should be Required, see notes in KeystoneAuthURL CellDatabaseHostname - hostname to use when accessing the cell DB
| string
| true

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Nova services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| memcachedInstance
| MemcachedInstance is the name of the Memcached CR that all nova service will use.
| string
| true

| dbPurge
| DBPurge defines the parameters for the DB archiving and purging cron job
| <<novacelldbpurge,NovaCellDBPurge>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaconductorstatus]
==== NovaConductorStatus

NovaConductorStatus defines the observed state of NovaConductor

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount defines the number of replicas ready from nova-conductor
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novaconductortemplate]
==== NovaConductorTemplate

NovaConductorTemplate defines the input parameters specified by the user to create a NovaConductor via higher level CRDs.

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of the service to run
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Nova CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#metadataoverridespec]
==== MetadataOverrideSpec

MetadataOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster for internal communication.
| *service.OverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novametadata]
==== NovaMetadata

NovaMetadata is the Schema for the novametadata API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<novametadataspec,NovaMetadataSpec>>
| false

| status
|
| <<novametadatastatus,NovaMetadataStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novametadatalist]
==== NovaMetadataList

NovaMetadataList contains a list of NovaMetadata

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<novametadata,NovaMetadata>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novametadataspec]
==== NovaMetadataSpec

NovaMetadataSpec defines the desired state of NovaMetadata

|===
| Field | Description | Scheme | Required

| cellName
| CellName is the name of the Nova Cell this metadata service belongs to. If not provided then the metadata serving every cells in the deployment
| string
| false

| apiTimeout
| APITimeout for Route and Apache
| int
| true

| secret
| Secret is the name of the Secret instance containing password information for the nova-conductor service. This secret is expected to be generated by the nova-operator based on the information passed to the Nova CR.
| string
| true

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| keystoneAuthURL
| KeystoneAuthURL - the URL that the nova-metadata service can use to talk to keystone
| string
| true

| apiDatabaseAccount
| APIDatabaseAccount - MariaDBAccount to use when accessing the API DB
| string
| true

| apiDatabaseHostname
| APIDatabaseHostname - hostname to use when accessing the API DB. This filed is Required if the CellName is not provided
| string
| true

| cellDatabaseAccount
| CellDatabaseAccount - MariaDBAccount to use when accessing the cell DB
| string
| true

| cellDatabaseHostname
| CellDatabaseHostname - hostname to use when accessing the cell DB This is unused if CellName is not provided. But if it is provided then CellDatabaseHostName is also Required.
| string
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<metadataoverridespec,MetadataOverrideSpec>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Nova services the default SA name
| string
| true

| registeredCells
| RegisteredCells is a map keyed by cell names that are registered in the nova_api database with a value that is the hash of the given cell configuration. This is used to detect when a new cell is added or an existing cell is reconfigured to trigger refresh of the in memory cell caches of the service. This is empty for the case when nova-metadata runs within the cell.
| map[string]string
| false

| tls
| TLS - Parameters related to the TLS
| tls.SimpleService
| false

| defaultConfigOverwrite
| DefaultConfigOverwrite - interface to overwrite default config files like e.g. api-paste.ini.
| map[string]string
| false

| memcachedInstance
| MemcachedInstance is the name of the Memcached CR that all nova service will use.
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novametadatastatus]
==== NovaMetadataStatus

NovaMetadataStatus defines the observed state of NovaMetadata

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount defines the number of replicas ready from nova-metadata
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novametadatatemplate]
==== NovaMetadataTemplate

NovaMetadataTemplate defines the input parameters specified by the user to create a NovaMetadata via higher level CRDs.

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether NovaMetadata services should be deployed and managed. If it is set to false then the related NovaMetadata CR will be deleted if exists and owned by a higher level nova CR (Nova or NovaCell). If it exist but not owned by a higher level nova CR then the NovaMetadata CR will not be touched. If it is set to true the a NovaMetadata CR will be created. If there is already a manually created NovaMetadata CR with the relevant name then this operator will not try to update that CR, instead the higher level nova CR will be in error state until the manually create NovaMetadata CR is deleted manually.
| *bool
| true

| replicas
| Replicas of the service to run
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Nova CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| defaultConfigOverwrite
| DefaultConfigOverwrite - interface to overwrite default config files like e.g. api-paste.ini.
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<metadataoverridespec,MetadataOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.SimpleService
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novanovncproxy]
==== NovaNoVNCProxy

NovaNoVNCProxy is the Schema for the novanovncproxies API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<novanovncproxyspec,NovaNoVNCProxySpec>>
| false

| status
|
| <<novanovncproxystatus,NovaNoVNCProxyStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novanovncproxylist]
==== NovaNoVNCProxyList

NovaNoVNCProxyList contains a list of NovaNoVNCProxy

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<novanovncproxy,NovaNoVNCProxy>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novanovncproxyspec]
==== NovaNoVNCProxySpec

NovaNoVNCProxySpec defines the desired state of NovaNoVNCProxy

|===
| Field | Description | Scheme | Required

| cellName
| CellName is the name of the Nova Cell this novncproxy belongs to.
| string
| true

| secret
| Secret is the name of the Secret instance containing password information for the nova-novncproxy service. This secret is expected to be generated by the nova-operator based on the information passed to the Nova CR.
| string
| true

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| keystoneAuthURL
| KeystoneAuthURL - the URL that the nova-novncproxy service can use to talk to keystone
| string
| true

| cellDatabaseAccount
| CellDatabaseAccount - MariaDBAccount to use when accessing the cell DB
| string
| true

| cellDatabaseHostname
| CellDatabaseHostname - hostname to use when accessing the cell DB
| string
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<vncproxyoverridespec,VNCProxyOverrideSpec>>
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Nova services the default SA name
| string
| true

| tls
| TLS - Parameters related to the TLS
| <<tlssection,TLSSection>>
| true

| memcachedInstance
| MemcachedInstance is the name of the Memcached CR that all nova service will use.
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novanovncproxystatus]
==== NovaNoVNCProxyStatus

NovaNoVNCProxyStatus defines the observed state of NovaNoVNCProxy

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount defines the number of replicas ready from nova-novncproxy
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novanovncproxytemplate]
==== NovaNoVNCProxyTemplate

NovaNoVNCProxyTemplate defines the input parameters specified by the user to create a NovaNoVNCProxy via higher level CRDs.

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether NovaNoVNCProxy services should be deployed and managed. If it is set to false then the related NovaNoVNCProxy CR will be deleted if exists and owned by the NovaCell. If it exist but not owned by the NovaCell then the NovaNoVNCProxy will not be touched. If it is set to true the a NovaNoVNCProxy CR will be created. If there is already a manually created NovaNoVNCProxy CR with the relevant name then the cell will not try to update that CR, instead the NovaCell be in error state until the manually create NovaNoVNCProxy CR is deleted by the operator.
| *bool
| true

| replicas
| Replicas of the service to run
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<vncproxyoverridespec,VNCProxyOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| <<tlssection,TLSSection>>
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#tlssection-2]
==== TLSSection

TLSSection defines the desired state of TLS configuration

|===
| Field | Description | Scheme | Required

| service
| Service - Cert secret used for the nova novnc service endpoint
| tls.GenericService
| false

| vencrypt
| Vencrypt - cert secret containing the x509 certificate to be presented to the VNC server. The CommonName field should match the primary hostname of the controller node. If using a HA deployment, the Organization field can also be configured to a value that is common across all console proxy instances in the deployment. https://docs.openstack.org/nova/latest/admin/remote-console-access.html#novnc-proxy-server-configuration
| tls.GenericService
| false
|===

<<custom-resources,Back to Custom Resources>>

[#vncproxyoverridespec]
==== VNCProxyOverrideSpec

VNCProxyOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster.
| *service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novascheduler]
==== NovaScheduler

NovaScheduler is the Schema for the novaschedulers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<novaschedulerspec,NovaSchedulerSpec>>
| false

| status
|
| <<novaschedulerstatus,NovaSchedulerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novaschedulerlist]
==== NovaSchedulerList

NovaSchedulerList contains a list of NovaScheduler

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<novascheduler,NovaScheduler>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaschedulerspec]
==== NovaSchedulerSpec

NovaSchedulerSpec defines the desired state of NovaScheduler

|===
| Field | Description | Scheme | Required

| secret
| Secret is the name of the Secret instance containing password information for the nova-scheduler service. This secret is expected to be generated by the nova-operator based on the information passed to the Nova CR.
| string
| true

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| keystoneAuthURL
| KeystoneAuthURL - the URL that the nova-scheduler service can use to talk to keystone
| string
| true

| apiDatabaseAccount
| APIDatabaseAccount - MariaDBAccount to use when accessing the API DB
| string
| true

| apiDatabaseHostname
| APIDatabaseHostname - hostname to use when accessing the API DB
| string
| true

| cell0DatabaseAccount
| Cell0DatabaseAccount - MariaDBAccount to use when accessing the cell0 DB
| string
| true

| cell0DatabaseHostname
| Cell0DatabaseHostname - hostname to use when accessing the cell0 DB
| string
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Nova services the default SA name
| string
| true

| registeredCells
| RegisteredCells is a map keyed by cell names that are registered in the nova_api database with a value that is the hash of the given cell configuration. This is used to detect when a new cell is added or an existing cell is reconfigured to trigger refresh of the in memory cell caches of the service.
| map[string]string
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| memcachedInstance
| MemcachedInstance is the name of the Memcached CR that all nova service will use.
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaschedulerstatus]
==== NovaSchedulerStatus

NovaSchedulerStatus defines the observed state of NovaScheduler

|===
| Field | Description | Scheme | Required

| hash
| INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| readyCount
| ReadyCount defines the number of replicas ready from nova-scheduler
| int32
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novaschedulertemplate]
==== NovaSchedulerTemplate

NovaSchedulerTemplate defines the input parameters specified by the user to create a NovaScheduler via higher level CRDs.

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of the service to run
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting here overrides any global NodeSelector settings within the Nova CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#nova]
==== Nova

Nova is the Schema for the nova API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<novaspec,NovaSpec>>
| false

| status
|
| <<novastatus,NovaStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novalist]
==== NovaList

NovaList contains a list of Nova

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<nova,Nova>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#novaspeccore]
==== NovaSpecCore

NovaSpecCore defines the template for NovaSpec used in OpenStackControlPlane

|===
| Field | Description | Scheme | Required

| keystoneInstance
| KeystoneInstance to name of the KeystoneAPI CR to select the Service instance used by the Nova services to authenticate.
| string
| true

| apiDatabaseInstance
| APIDatabaseInstance is the name of the MariaDB CR to select the DB Service instance used for the Nova API DB.
| string
| true

| apiMessageBusInstance
| APIMessageBusInstance is the name of the RabbitMqCluster CR to select the Message Bus Service instance used by the Nova top level services to communicate.
| string
| true

| cellTemplates
| Cells is a mapping of cell names to NovaCellTemplate objects defining the cells in the deployment. The "cell0" cell is a mandatory cell in every deployment. Moreover any real deployment needs at least one additional normal cell as "cell0" cannot have any computes.
| map[string]<<novacelltemplate,NovaCellTemplate>>
| true

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| apiDatabaseAccount
| APIDatabaseAccount - MariaDBAccount to use when accessing the API DB
| string
| true

| apiTimeout
| APITimeout for Route and Apache
| int
| true

| secret
| Secret is the name of the Secret instance containing password information for nova like the keystone service password and DB passwords
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser passwords from the Secret
| <<passwordselector,PasswordSelector>>
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting NodeSelector here acts as a default value and can be overridden by service specific NodeSelector Settings.
| *map[string]string
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| apiServiceTemplate
| APIServiceTemplate - define the nova-api service
| <<novaapitemplate,NovaAPITemplate>>
| true

| schedulerServiceTemplate
| SchedulerServiceTemplate- define the nova-scheduler service
| <<novaschedulertemplate,NovaSchedulerTemplate>>
| true

| metadataServiceTemplate
| MetadataServiceTemplate - defines the metadata service that is global for the deployment serving all the cells. Note that if you want to deploy metadata per cell then the metadata service should be disabled here and enabled in the cellTemplates instead.
| <<novametadatatemplate,NovaMetadataTemplate>>
| true

| memcachedInstance
| MemcachedInstance is the name of the Memcached CR that all nova service will use.
| string
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| notificationsBusInstance
| NotificationsBusInstance is the name of the RabbitMqCluster CR to select the Message Bus Service instance used by the Nova top level services and all cells to publish notifications. If undefined, the value will be inherited from OpenStackControlPlane. An empty value "" leaves the notification drivers unconfigured and emitting no notifications at all. Avoid colocating it with RabbitMqClusterName, APIMessageBusInstance or CellMessageBusInstance used for RPC. For particular Nova cells, notifications cannot be disabled, nor configured differently.
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#novastatus]
==== NovaStatus

NovaStatus defines the observed state of Nova

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| apiServiceReadyCount
| APIServiceReadyCount defines the number or replicas ready from nova-api
| int32
| false

| schedulerServiceReadyCount
| SchedulerServiceReadyCount defines the number or replicas ready from nova-scheduler
| int32
| false

| metadataServiceReadyCount
| MetadataReadyCount defines the number of replicas ready from nova-metadata service
| int32
| false

| registeredCells
| RegisteredCells is a map keyed by cell names that are registered in the nova_api database with a value that is the hash of the given cell configuration.
| map[string]string
| false

| discoveredCells
| DiscoveredCells is a map keyed by cell names that have discovered all kubernetes managed computes in cell value is a hash of config from all kubernetes managed computes in cell
| map[string]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes.
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaamphoracontroller]
==== OctaviaAmphoraController

OctaviaAmphoraController is the Schema for the octaviaworkers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<octaviaamphoracontrollerspec,OctaviaAmphoraControllerSpec>>
| false

| status
|
| <<octaviaamphoracontrollerstatus,OctaviaAmphoraControllerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaamphoracontrollerlist]
==== OctaviaAmphoraControllerList

OctaviaAmphoraControllerList contains a list of OctaviaWorker

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<octaviaamphoracontroller,OctaviaAmphoraController>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaamphoracontrollerspec]
==== OctaviaAmphoraControllerSpec

OctaviaAmphoraControllerSpec defines common state for all Octavia Amphora Controllers

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Amphora Controller Container Image URL
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaamphoracontrollerspeccore]
==== OctaviaAmphoraControllerSpecCore

OctaviaAmphoraControllerSpecCore -

|===
| Field | Description | Scheme | Required

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - name of MariaDBAccount which will be used to connect for the main octavia database
| string
| true

| persistenceDatabaseAccount
| PersistenceDatabaseAccount - name of MariaDBAccount which will be used to connect for the persistence database
| string
| true

| databaseHostname
| DatabaseHostname - Octavia DB hostname
| string
| false

| serviceUser
| ServiceUser - service user name (TODO: beagles, do we need this at all)
| string
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Octavia services the default SA name
| string
| true

| role
| Role - the role for the controller (one of worker, housekeeping, healthmanager)
| string
| true

| secret
| Secret containing OpenStack password information for octavia OctaviaDatabasePassword, AdminPassword
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the AdminUser password from the Secret
| <<passwordselector,PasswordSelector>>
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| tenantName
| TenantName - the name of the OpenStack tenant that controls the Octavia resources
| string
| true

| tenantDomainName
| TenantDomainName - the name of the OpenStack domain associated with the tenant
| string
| true

| lbMgmtNetworkID
|
| string
| true

| lbSecurityGroupID
|
| string
| true

| amphoraCustomFlavors
| AmphoraCustomFlavors - User-defined flavors for Octavia
| []<<octaviaamphoraflavor,OctaviaAmphoraFlavor>>
| false

| amphoraImageOwnerID
|
| string
| false

| redisHosts
| List of Redis Hosts
| []string
| false

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| octaviaProviderSubnetGateway
| OctaviaProviderSubnetGateway -
| string
| true

| octaviaProviderSubnetCIDR
| OctaviaProviderSubnetCIDR -
| string
| true

| octaviaProviderSubnetExtraCIDRs
| OctaviaProviderSubnetExtraCIDRs -
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaamphoracontrollerstatus]
==== OctaviaAmphoraControllerStatus

OctaviaAmphoraControllerStatus defines the observed state of the Octavia Amphora Controller

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of Octavia Amphora Controllers
| int32
| false

| desiredNumberScheduled
| DesiredNumberScheduled - total number of the nodes which should be running Daemon
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachment status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaapi]
==== OctaviaAPI

OctaviaAPI is the Schema for the octaviaapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<octaviaapispec,OctaviaAPISpec>>
| false

| status
|
| <<octaviaapistatus,OctaviaAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaapilist]
==== OctaviaAPIList

OctaviaAPIList contains a list of OctaviaAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<octaviaapi,OctaviaAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaapispec]
==== OctaviaAPISpec

OctaviaAPISpec defines the desired state of OctaviaAPI

|===
| Field | Description | Scheme | Required

| containerImage
| Octavia Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaapispeccore]
==== OctaviaAPISpecCore

OctaviaAPISpecCore -

|===
| Field | Description | Scheme | Required

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - name of MariaDBAccount which will be used to connect for the main octavia database
| string
| true

| persistenceDatabaseAccount
| PersistenceDatabaseAccount - name of MariaDBAccount which will be used to connect for the persistence database
| string
| true

| databaseHostname
| DatabaseHostname - Octavia DB hostname
| string
| false

| serviceUser
| ServiceUser - service user name
| string
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Octavia services the default SA name
| string
| true

| replicas
| Replicas of octavia API to run
| *int32
| true

| secret
| Secret containing OpenStack password information for octavia OctaviaDatabasePassword, AdminPassword
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| tenantName
| TenantName - the name of the OpenStack tenant that controls the Octavia resources
| string
| true

| tenantDomainName
| TenantDomainName - the name of the OpenStack domain associated with the tenant
| string
| true

| tls
| TLS - Parameters related to the TLS
| <<octaviaapitls,OctaviaApiTLS>>
| false

| apiTimeout
| APITimeout for HAProxy and Apache defaults to OctaviaSpecCore APITimeout (seconds)
| int
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaapistatus]
==== OctaviaAPIStatus

OctaviaAPIStatus defines the observed state of OctaviaAPI

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of octavia API instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachment status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaapitls]
==== OctaviaApiTLS

|===
| Field | Description | Scheme | Required

| api
| API tls type which encapsulates for API services
| tls.APIService
| false

| ovn
| Ovn GenericService - holds the secret for the OvnDb client cert
| tls.GenericService
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviarsyslog]
==== OctaviaRsyslog

OctaviaRsyslog is the Schema for the octaviaworkers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<octaviarsyslogspec,OctaviaRsyslogSpec>>
| false

| status
|
| <<octaviarsyslogstatus,OctaviaRsyslogStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviarsysloglist]
==== OctaviaRsyslogList

OctaviaRsyslogList contains a list of OctaviaWorker

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<octaviarsyslog,OctaviaRsyslog>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octaviarsyslogspec]
==== OctaviaRsyslogSpec

OctaviaRsyslogSpec defines common state for all Octavia Amphora Controllers

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Rsyslog Container Image URL
| string
| false

| initContainerImage
| InitContainerImage - Rsyslog init Container Image URL for
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviarsyslogspeccore]
==== OctaviaRsyslogSpecCore

OctaviaRsyslogSpecCore -

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - service user name (TODO: beagles, do we need this at all)
| string
| true

| serviceAccount
| ServiceAccount - service account name used internally to provide Octavia services the default SA name
| string
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| adminLogTargets
| AdminLogTargets is a list of OctaviaRsyslogTarget, the admin logs are forwarded to those targets. Use only when forwarding to an external Rsyslog server.
| []<<octaviarsyslogtarget,OctaviaRsyslogTarget>>
| false

| tenantLogTargets
| TenantLogTargets is a list of OctaviaRsyslogTarget, the tenant logs are forwarded to those targets. Use only when forwarding to an external Rsyslog server.
| []<<octaviarsyslogtarget,OctaviaRsyslogTarget>>
| false

| octaviaProviderSubnetGateway
| OctaviaProviderSubnetGateway -
| string
| true

| octaviaProviderSubnetCIDR
| OctaviaProviderSubnetCIDR -
| string
| true

| octaviaProviderSubnetExtraCIDRs
| OctaviaProviderSubnetExtraCIDRs -
| []string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviarsyslogstatus]
==== OctaviaRsyslogStatus

OctaviaRsyslogStatus defines the observed state of the Octavia Amphora Controller

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of Octavia Amphora Controllers
| int32
| false

| desiredNumberScheduled
| DesiredNumberScheduled - total number of the nodes which should be running Daemon
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachment status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviarsyslogtarget]
==== OctaviaRsyslogTarget

|===
| Field | Description | Scheme | Required

| host
|
| string
| true

| port
|
| int
| true

| protocol
|
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octavia]
==== Octavia

Octavia is the Schema for the octavia API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<octaviaspec,OctaviaSpec>>
| false

| status
|
| <<octaviastatus,OctaviaStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaamphoraflavor]
==== OctaviaAmphoraFlavor

OctaviaAmphoraFlavor Settings for custom Amphora flavors

|===
| Field | Description | Scheme | Required

| name
|
| string
| true

| description
|
| string
| true

| VCPUs
|
| int
| true

| RAM
|
| int
| true

| disk
|
| int
| true

| RxTxFactor
|
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octavialbmgmtnetworks]
==== OctaviaLbMgmtNetworks

OctaviaLbMgmtNetworks Settings for Octavia management networks

|===
| Field | Description | Scheme | Required

| manageLbMgmtNetworks
| ManageLbMgmtNetworks - when True, octavia-operator creates the Neutron resources needed for its Management Network
| bool
| true

| createDefaultLbMgmtNetwork
| CreateDefaultLbMgmtNetwork - when True, octavia-operator creates a Management Network for the default Availability Zone of the control plane. Can be set to false when deploying OpenStack in DCN mode.
| bool
| true

| lbMgmtRouterGateway
| LbMgmtRouterGateway is the IP address of the Octavia router on the Provider network, it's optional and used only when the routing informations are not passed through the Network Attachment Definition
| string
| false

| availabilityZones
| Availability zones for the octavia management network resources
| []string
| false

| availabilityZoneCIDRs
| AvailabilityZoneCIDRs are the CIDRs of each management network associated with an Availability Zone (ex: {"az":"172.34.0.0/24", ...})
| map[string]string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#octavialist]
==== OctaviaList

OctaviaList contains a list of Octavia

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<octavia,Octavia>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaspec]
==== OctaviaSpec

OctaviaSpec defines the desired state of Octavia

|===
| Field | Description | Scheme | Required

| octaviaAPI
| OctaviaAPI - Spec definition for the API service of the Octavia deployment
| <<octaviaapispec,OctaviaAPISpec>>
| true

| octaviaHousekeeping
| OctaviaHousekeeping - Spec definition for the Octavia Housekeeping agent for the Octavia deployment
| <<octaviaamphoracontrollerspec,OctaviaAmphoraControllerSpec>>
| true

| octaviaHealthManager
| OctaviaHousekeeping - Spec definition for the Octavia Housekeeping agent for the Octavia deployment
| <<octaviaamphoracontrollerspec,OctaviaAmphoraControllerSpec>>
| true

| octaviaWorker
| OctaviaHousekeeping - Spec definition for the Octavia Housekeeping agent for the Octavia deployment
| <<octaviaamphoracontrollerspec,OctaviaAmphoraControllerSpec>>
| true

| octaviaRsyslog
| OctaviaRsyslog - Spec definition for the Octavia Rsyslog agent for the Octavia deployment
| <<octaviarsyslogspec,OctaviaRsyslogSpec>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaspecbase]
==== OctaviaSpecBase

OctaviaSpecBase -

|===
| Field | Description | Scheme | Required

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - name of MariaDBAccount which will be used to connect for the main octavia database
| string
| true

| persistenceDatabaseAccount
| PersistenceDatabaseAccount - name of MariaDBAccount which will be used to connect for the persistence database
| string
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Octavia
| string
| true

| serviceUser
| ServiceUser - service user name
| string
| true

| secret
| Secret containing OpenStack password information for octavia's keystone password; no longer used for database password
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| tenantName
| TenantName - the name of the OpenStack tenant that controls the Octavia resources
| string
| true

| tenantDomainName
| TenantDomainName - the name of the OpenStack domain associated with the tenant
| string
| true

| lbMgmtNetwork
|
| <<octavialbmgmtnetworks,OctaviaLbMgmtNetworks>>
| true

| sshPubkey
| LoadBalancerSSHPubKey - The name of the ConfigMap containing the pubilc key for connecting to the amphorae via SSH
| string
| false

| sshPrivkeySecret
| LoadBalancerSSHPrivKey - The name of the secret that will be used to store the private key for connecting to amphorae via SSH
| string
| false

| amphoraCustomFlavors
| AmphoraCustomFlavors - User-defined flavors for Octavia
| []<<octaviaamphoraflavor,OctaviaAmphoraFlavor>>
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| amphoraImageContainerImage
| Octavia Container Image URL
| string
| true

| apacheContainerImage
| Apache Container Image URL
| string
| true

| apiTimeout
| Octavia API timeout
| int
| true

| octaviaNetworkAttachment
| OctaviaNetworkAttachment is a NetworkAttachment resource name for the Octavia Management Network
| string
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| redisServiceName
| Name of the Redis database for Jobboard
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octaviaspeccore]
==== OctaviaSpecCore

OctaviaSpecCore - this version has no containerImages and is used by OpenStackControlplane

|===
| Field | Description | Scheme | Required

| octaviaAPI
| OctaviaAPI - Spec definition for the API service of the Octavia deployment
| <<octaviaapispeccore,OctaviaAPISpecCore>>
| true

| octaviaHousekeeping
| OctaviaHousekeeping - Spec definition for the Octavia Housekeeping agent for the Octavia deployment
| <<octaviaamphoracontrollerspeccore,OctaviaAmphoraControllerSpecCore>>
| true

| octaviaHealthManager
| OctaviaHousekeeping - Spec definition for the Octavia Housekeeping agent for the Octavia deployment
| <<octaviaamphoracontrollerspeccore,OctaviaAmphoraControllerSpecCore>>
| true

| octaviaWorker
| OctaviaHousekeeping - Spec definition for the Octavia Housekeeping agent for the Octavia deployment
| <<octaviaamphoracontrollerspeccore,OctaviaAmphoraControllerSpecCore>>
| true

| octaviaRsyslog
| OctaviaRsyslog - Spec definition for the Octavia Rsyslog agent for the Octavia deployment
| <<octaviarsyslogspeccore,OctaviaRsyslogSpecCore>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#octaviastatus]
==== OctaviaStatus

OctaviaStatus defines the observed state of Octavia

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| Octavia Database Hostname
| string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| apireadyCount
| ReadyCount of octavia API instances
| int32
| false

| workerreadyCount
| ReadyCount of octavia Worker instances
| int32
| false

| housekeepingreadyCount
| ReadyCount of octavia Housekeeping instances
| int32
| false

| healthmanagerreadyCount
| ReadyCount of octavia HealthManager instances
| int32
| false

| rsyslogreadyCount
| ReadyCount of octavia Rsyslog instances
| int32
| false

| redisHosts
| List of Redis Hosts
| []string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| database
| Database - Selector to get the octavia Database user password from the Secret
| string
| false

| service
| Service - Selector to get the service user password from the Secret
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#bondconfig]
==== BondConfig

BondConfig defines the bonding configuration for network interfaces

|===
| Field | Description | Scheme | Required

| bondInterfaces
| BondInterfaces - List of physical interfaces to bond
| []string
| true

| bondMode
| BondMode - Bonding mode (e.g., active-backup, 802.3ad)
| string
| false

| bondOptions
| BondOptions - Additional bonding options as key-value pairs
| map[string]string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cpucountreq]
==== CPUCountReq

CPUCountReq defines a specific hardware request for CPU core count

|===
| Field | Description | Scheme | Required

| count
|
| int
| false

| exactMatch
| If ExactMatch == false, actual count > Count will match
| bool
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cpumhzreq]
==== CPUMhzReq

CPUMhzReq defines a specific hardware request for CPU clock speed

|===
| Field | Description | Scheme | Required

| mhz
|
| int
| false

| exactMatch
| If ExactMatch == false, actual mhz > Mhz will match
| bool
| false
|===

<<custom-resources,Back to Custom Resources>>

[#cpureqs]
==== CPUReqs

CPUReqs defines specific CPU hardware requests

|===
| Field | Description | Scheme | Required

| arch
| Arch is a scalar (string) because it wouldn't make sense to give it an "exact-match" option Can be either "x86_64" or "ppc64le" if included
| string
| false

| countReq
|
| <<cpucountreq,CPUCountReq>>
| false

| mhzReq
|
| <<cpumhzreq,CPUMhzReq>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#diskgbreq]
==== DiskGbReq

DiskGbReq defines a specific hardware request for disk size

|===
| Field | Description | Scheme | Required

| gb
|
| int
| false

| exactMatch
| If ExactMatch == false, actual GB > Gb will match
| bool
| false
|===

<<custom-resources,Back to Custom Resources>>

[#diskreqs]
==== DiskReqs

DiskReqs defines specific disk hardware requests

|===
| Field | Description | Scheme | Required

| gbReq
|
| <<diskgbreq,DiskGbReq>>
| false

| ssdReq
| SSD is scalar (bool) because it wouldn't make sense to give it an "exact-match" option
| <<diskssdreq,DiskSSDReq>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#diskssdreq]
==== DiskSSDReq

DiskSSDReq defines a specific hardware request for disk of type SSD (true) or rotational (false)

|===
| Field | Description | Scheme | Required

| ssd
|
| bool
| false

| exactMatch
| We only actually care about SSD flag if it is true or ExactMatch is set to true. This second flag is necessary as SSD's bool zero-value (false) is indistinguishable from it being explicitly set to false
| bool
| false
|===

<<custom-resources,Back to Custom Resources>>

[#hardwarereqs]
==== HardwareReqs

HardwareReqs defines request hardware attributes for the BaremetalHost replicas

|===
| Field | Description | Scheme | Required

| cpuReqs
|
| <<cpureqs,CPUReqs>>
| false

| memReqs
|
| <<memreqs,MemReqs>>
| false

| diskReqs
|
| <<diskreqs,DiskReqs>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#hoststatus]
==== HostStatus

HostStatus represents the IPStatus and provisioning state + deployment information

|===
| Field | Description | Scheme | Required

| provisioningState
|
| ProvisioningState
| true

| annotatedForDeletion
| Host annotated for deletion
| bool
| true

| userDataSecretName
|
| string
| true

| networkDataSecretName
|
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ipstatus]
==== IPStatus

IPStatus represents the hostname and IP info for a specific host

|===
| Field | Description | Scheme | Required

| hostname
|
| string
| true

| bmhRef
|
| string
| true

| ipAddresses
|
| map[string]string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#instancespec]
==== InstanceSpec

InstanceSpec Instance specific attributes

|===
| Field | Description | Scheme | Required

| bmhLabelSelector
| BmhLabelSelector allows for the selection of a particular BaremetalHost based on arbitrary labels
| map[string]string
| false

| ctlPlaneIP
| CtlPlaneIP - Control Plane IP in CIDR notation
| string
| false

| ctlplaneGateway
| CtlplaneGateway - IP of gateway for ctrlplane network (TODO: acquire this is another manner?)
| string
| false

| ctlplaneInterface
| CtlplaneInterface - Interface on the provisioned nodes to use for ctlplane network
| string
| false

| ctlplaneVlan
| CtlplaneVlan - Vlan for ctlplane network
| *int
| false

| userData
| UserData - Host User Data
| *corev1.SecretReference
| false

| networkData
| NetworkData - Host Network Data
| *corev1.SecretReference
| false
|===

<<custom-resources,Back to Custom Resources>>

[#memgbreq]
==== MemGbReq

MemGbReq defines a specific hardware request for memory size

|===
| Field | Description | Scheme | Required

| gb
|
| int
| false

| exactMatch
| If ExactMatch == false, actual GB > Gb will match
| bool
| false
|===

<<custom-resources,Back to Custom Resources>>

[#memreqs]
==== MemReqs

MemReqs defines specific memory hardware requests

|===
| Field | Description | Scheme | Required

| gbReq
|
| <<memgbreq,MemGbReq>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackbaremetalset]
==== OpenStackBaremetalSet

OpenStackBaremetalSet is the Schema for the openstackbaremetalsets API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<openstackbaremetalsetspec,OpenStackBaremetalSetSpec>>
| false

| status
|
| <<openstackbaremetalsetstatus,OpenStackBaremetalSetStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackbaremetalsetlist]
==== OpenStackBaremetalSetList

OpenStackBaremetalSetList contains a list of OpenStackBaremetalSet

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<openstackbaremetalset,OpenStackBaremetalSet>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#openstackbaremetalsetspec]
==== OpenStackBaremetalSetSpec

OpenStackBaremetalSetSpec defines the desired state of OpenStackBaremetalSet

|===
| Field | Description | Scheme | Required

| baremetalHosts
| BaremetalHosts - Map of hostname to Instance Spec for all nodes to provision
| map[string]<<instancespec,InstanceSpec>>
| false

| ctlplaneGateway
| CtlplaneGateway - IP of gateway for ctrlplane network (TODO: acquire this is another manner?)
| string
| false

| ctlplaneVlan
| CtlplaneVlan - Vlan for ctlplane network
| *int
| false

| bootstrapDns
| BootstrapDNS - initial DNS nameserver values to set on the BaremetalHosts when they are provisioned. Note that subsequent deployment will overwrite these values
| []string
| false

| dnsSearchDomains
| DNSSearchDomains - initial DNS nameserver values to set on the BaremetalHosts when they are provisioned. Note that subsequent deployment will overwrite these values
| []string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackbaremetalsetstatus]
==== OpenStackBaremetalSetStatus

OpenStackBaremetalSetStatus defines the observed state of OpenStackBaremetalSet

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| baremetalHosts
| BaremetalHosts that are being processed or have been processed for this OpenStackBaremetalSet
| map[string]<<hoststatus,HostStatus>>
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackbaremetalsettemplatespec]
==== OpenStackBaremetalSetTemplateSpec

|===
| Field | Description | Scheme | Required

| osImage
| OSImage - OS qcow2 image Name
| string
| true

| osContainerImageUrl
| OSContainerImageURL - Container image URL for init with the OS qcow2 image (osImage)
| string
| false

| apacheImageUrl
| ApacheImageURL - Container image URL for the main container that serves the downloaded OS qcow2 image (osImage)
| string
| false

| agentImageUrl
| AgentImageURL - Container image URL for the sidecar container that discovers provisioning network IPs
| string
| false

| automatedCleaningMode
| When set to disabled, automated cleaning will be avoided during provisioning and deprovisioning.
| AutomatedCleaningMode
| true

| provisionServerName
| ProvisionServerName - Optional. Existing OpenStackProvisionServer to use, else one would be created.
| string
| false

| provisionServerNodeSelector
| ProvisonServerNodeSelector to target subset of worker nodes running provision server
| map[string]string
| false

| provisioningInterface
| ProvisioningInterface - Optional. If not provided along with ProvisionServerName, it would be discovered from CBO.  This is the provisioning interface on the OCP masters/workers.
| string
| false

| deploymentSSHSecret
| DeploymentSSHSecret - Name of secret holding the cloud-admin ssh keys
| string
| true

| ctlplaneInterface
| CtlplaneInterface - Interface on the provisioned nodes to use for ctlplane network
| string
| true

| ctlplaneBond
| CtlplaneBond - Bonding configuration for ctlplane network
| *<<bondconfig,BondConfig>>
| false

| bmhNamespace
| BmhNamespace Namespace to look for BaremetalHosts(default: openshift-machine-api)
| string
| true

| bmhLabelSelector
| BmhLabelSelector allows for a sub-selection of BaremetalHosts based on arbitrary labels
| map[string]string
| false

| hardwareReqs
| Hardware requests for sub-selection of BaremetalHosts with certain hardware specs
| <<hardwarereqs,HardwareReqs>>
| false

| passwordSecret
| PasswordSecret the name of the secret used to optionally set the root pwd by adding NodeRootPassword: +++<base64 enc="" pwd="">+++to the secret data+++</base64>+++
| *corev1.SecretReference
| false

| cloudUserName
| CloudUser to be configured for remote access
| string
| true

| domainName
| DomainName is the domain name that will be set on the underlying Metal3 BaremetalHosts (TODO: acquire this is another manner?)
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackprovisionserver]
==== OpenStackProvisionServer

OpenStackProvisionServer used to serve custom images for baremetal provisioning with Metal3

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<openstackprovisionserverspec,OpenStackProvisionServerSpec>>
| false

| status
|
| <<openstackprovisionserverstatus,OpenStackProvisionServerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackprovisionserverdefaults]
==== OpenStackProvisionServerDefaults

OpenStackProvisionServerDefaults -

|===
| Field | Description | Scheme | Required

| OSContainerImageURL
|
| string
| false

| AgentImageURL
|
| string
| false

| ApacheImageURL
|
| string
| false

| OSImage
|
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#openstackprovisionserverlist]
==== OpenStackProvisionServerList

OpenStackProvisionServerList contains a list of OpenStackProvisionServer

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<openstackprovisionserver,OpenStackProvisionServer>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#openstackprovisionserverspec]
==== OpenStackProvisionServerSpec

OpenStackProvisionServerSpec defines the desired state of OpenStackProvisionServer

|===
| Field | Description | Scheme | Required

| port
| Port - The port on which the Apache server should listen
| int32
| false

| interface
| Interface - An optional interface to use instead of the cluster's default provisioning interface (if any)
| string
| false

| osImage
| OSImage - OS qcow2 image (compressed as gz, or uncompressed)
| string
| true

| osImageDir
| OSImageDir - Directory on the container which holds the OS qcow2 image and checksum
| *string
| true

| osContainerImageUrl
| OSContainerImageURL - Container image URL for init with the OS qcow2 image (osImage)
| string
| true

| apacheImageUrl
| ApacheImageURL - Container image URL for the main container that serves the downloaded OS qcow2 image (osImage)
| string
| true

| agentImageUrl
| AgentImageURL - Container image URL for the sidecar container that discovers provisioning network IPs
| string
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this provision server
| map[string]string
| false

| resources
| Resources - Compute Resources required by this provision server (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#openstackprovisionserverstatus]
==== OpenStackProvisionServerStatus

OpenStackProvisionServerStatus defines the observed state of OpenStackProvisionServer

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of provision server Apache instances
| int32
| false

| conditions
| Conditions
| condition.Conditions
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| provisionIp
| IP of the provisioning interface on the node running the ProvisionServer pod
| string
| false

| provisionIpError
| Any error reported by the provisioning agent during provisioning IP acquisition
| string
| false

| localImageUrl
| URL of provisioning image on underlying Apache web server
| string
| false

| osImageChecksumFilename
| Filename of OSImage checksum
| string
| false

| osImageChecksumType
| OSImage checksum type
| metal3v1.ChecksumType
| false

| localImageChecksumUrl
| URL of provisioning image checksum on underlying Apache web server
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#bond]
==== Bond

Bond defines the configuration of each bond interface in the deployment

|===
| Field | Description | Scheme | Required

| mode
|
| string
| false

| mtu
|
| int32
| false

| links
|
| []string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ovncontroller]
==== OVNController

OVNController is the Schema for the ovncontrollers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ovncontrollerspec,OVNControllerSpec>>
| false

| status
|
| <<ovncontrollerstatus,OVNControllerStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovncontrollerlist]
==== OVNControllerList

OVNControllerList contains a list of OVNController

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ovncontroller,OVNController>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ovncontrollerspec]
==== OVNControllerSpec

OVNControllerSpec defines the desired state of OVNController

|===
| Field | Description | Scheme | Required

| ovsContainerImage
| Image used for the ovsdb-server and ovs-vswitchd containers (will be set to environmental default if empty)
| string
| true

| ovnContainerImage
| Image used for the ovn-controller container (will be set to environmental default if empty)
| string
| true

| exporterImage
| ExporterImage - Container Image URL for the openstack-network-exporter metrics daemonset (will be set to environmental default if empty)
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovncontrollerspeccore]
==== OVNControllerSpecCore

OVNControllerSpecCore -

|===
| Field | Description | Scheme | Required

| external-ids
|
| <<ovsexternalids,OVSExternalIDs>>
| true

| nicMappings
|
| map[string]string
| false

| bondConfiguration
| Map of bond names to their configuration
| map[string]<<bond,Bond>>
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| networkAttachment
| NetworkAttachment is a NetworkAttachment resource name to expose the service to the given network. If specified the IP address of this network is used as the OVNEncapIP.
| string
| true

| tls
| TLS - Parameters related to TLS
| tls.SimpleService
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| metricsEnabled
| MetricsEnabled enables the metrics daemonset for collecting OVN metrics
| *bool
| false

| metricsTLS
| MetricsTLS - Parameters related to TLS for metrics daemonset
| tls.SimpleService
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovncontrollerstatus]
==== OVNControllerStatus

OVNControllerStatus defines the observed state of OVNController

|===
| Field | Description | Scheme | Required

| numberReady
| NumberReady of the OVNController instances
| int32
| false

| ovsNumberReady
| ovsNumberReady of ovs instances
| int32
| false

| metricsNumberReady
| MetricsNumberReady of metrics instances
| int32
| false

| desiredNumberScheduled
| DesiredNumberScheduled - total number of the nodes which should be running Daemon
| int32
| false

| conditions
| Conditions
| condition.Conditions
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes.
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovsexternalids]
==== OVSExternalIDs

OVSExternalIDs is a set of configuration options for OVS external-ids table

|===
| Field | Description | Scheme | Required

| system-id
|
| string
| false

| ovn-bridge
|
| string
| false

| ovn-encap-type
|
| string
| false

| ovn-encap-tos
|
| string
| false

| availability-zones
|
| []string
| false

| enable-chassis-as-gateway
| DEPRECATED: To be removed in the next API version Any value set to this field is ignored
| *bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ovndbcluster]
==== OVNDBCluster

OVNDBCluster is the Schema for the ovndbclusters API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ovndbclusterspec,OVNDBClusterSpec>>
| false

| status
|
| <<ovndbclusterstatus,OVNDBClusterStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovndbclusterlist]
==== OVNDBClusterList

OVNDBClusterList contains a list of OVNDBCluster

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ovndbcluster,OVNDBCluster>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ovndbclusteroverridespec]
==== OVNDBClusterOverrideSpec

OVNDBClusterOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster.
| *service.OverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovndbclusterspec]
==== OVNDBClusterSpec

OVNDBClusterSpec defines the desired state of OVNDBCluster

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Container Image URL (will be set to environmental default if empty)
| string
| true

| exporterImage
| ExporterImage - Container Image URL for the openstack-network-exporter metrics sidecar (will be set to environmental default if empty)
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovndbclusterspeccore]
==== OVNDBClusterSpecCore

OVNDBClusterSpecCore -

|===
| Field | Description | Scheme | Required

| dbType
| DBType - NB or SB
| string
| true

| replicas
| Replicas of OVN DBCluster to run
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| logLevel
| LogLevel - Set log level info, dbg, emer etc
| string
| false

| electionTimer
| OVN Northbound and Southbound RAFT db election timer to use on db creation (in milliseconds)
| int32
| true

| inactivityProbe
| Probe interval for the OVSDB session (in milliseconds)
| int32
| true

| probeIntervalToActive
| Active probe interval from standby to active ovsdb-server remote
| int32
| true

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| storageClass
| StorageClass
| string
| false

| storageRequest
| StorageRequest
| string
| true

| networkAttachment
| NetworkAttachment is a NetworkAttachment resource name to expose the service to the given network. If specified the IP address of this network is used as the dbAddress connection.
| string
| true

| tls
| TLS - Parameters related to TLS
| tls.SimpleService
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<ovndbclusteroverridespec,OVNDBClusterOverrideSpec>>
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| metricsEnabled
| MetricsEnabled enables the metrics sidecar container for collecting OVN DB metrics
| *bool
| false

| metricsTLS
| MetricsTLS - Parameters related to TLS for metrics sidecar
| tls.SimpleService
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovndbclusterstatus]
==== OVNDBClusterStatus

OVNDBClusterStatus defines the observed state of OVNDBCluster

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of OVN DBCluster instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| dbAddress
| DBAddress - DB IP address used by external nodes
| string
| false

| internalDbAddress
| InternalDBAddress - DB IP address used by other Pods in the cluster
| string
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes.
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovnnorthd]
==== OVNNorthd

OVNNorthd is the Schema for the ovnnorthds API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ovnnorthdspec,OVNNorthdSpec>>
| false

| status
|
| <<ovnnorthdstatus,OVNNorthdStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovnnorthdlist]
==== OVNNorthdList

OVNNorthdList contains a list of OVNNorthd

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ovnnorthd,OVNNorthd>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ovnnorthdspec]
==== OVNNorthdSpec

OVNNorthdSpec defines the desired state of OVNNorthd

|===
| Field | Description | Scheme | Required

| containerImage
| ContainerImage - Container Image URL (will be set to environmental default if empty)
| string
| true

| exporterImage
| ExporterImage - Container Image URL for the openstack-network-exporter metrics sidecar (will be set to environmental default if empty)
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovnnorthdspeccore]
==== OVNNorthdSpecCore

OVNNorthdSpecCore -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of OVN Northd to run
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| logLevel
| LogLevel - Set log level info, dbg, emer etc
| string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| tls
| TLS - Parameters related to TLS
| tls.SimpleService
| false

| nThreads
| NThreads sets number of threads used for building logical flows
| *int32
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| metricsEnabled
| MetricsEnabled enables the metrics sidecar container for collecting OVN metrics
| *bool
| false

| metricsTLS
| MetricsTLS - Parameters related to TLS for metrics sidecar
| tls.SimpleService
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ovnnorthdstatus]
==== OVNNorthdStatus

OVNNorthdStatus defines the observed state of OVNNorthd

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of OVN Northd instances
| int32
| false

| conditions
| Conditions
| condition.Conditions
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes.
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the service user password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#placementapi]
==== PlacementAPI

PlacementAPI is the Schema for the placementapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<placementapispec,PlacementAPISpec>>
| false

| status
|
| <<placementapistatus,PlacementAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#placementapilist]
==== PlacementAPIList

PlacementAPIList contains a list of PlacementAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<placementapi,PlacementAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#placementapispec]
==== PlacementAPISpec

PlacementAPISpec defines the desired state of PlacementAPI

|===
| Field | Description | Scheme | Required

| containerImage
| PlacementAPI Container Image URL (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#placementapispeccore]
==== PlacementAPISpecCore

PlacementAPISpecCore -

|===
| Field | Description | Scheme | Required

| apiTimeout
| APITimeout for HAProxy, Apache
| int
| true

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - name of MariaDBAccount which will be used to connect.
| string
| true

| replicas
| Replicas of placement API to run
| *int32
| true

| secret
| Secret containing OpenStack password information for placement PlacementPassword
| string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the DB and ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| true

| defaultConfigOverwrite
| DefaultConfigOverwrite - interface to overwrite default config files like policy.yaml.
| map[string]string
| false

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#placementapistatus]
==== PlacementAPIStatus

PlacementAPIStatus defines the observed state of PlacementAPI

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of placement API instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| databaseHostname
| Placement Database Hostname
| string
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes.
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the Swift service password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#proxyoverridespec]
==== ProxyOverrideSpec

ProxyOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#swiftproxy]
==== SwiftProxy

SwiftProxy is the Schema for the swiftproxies API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<swiftproxyspec,SwiftProxySpec>>
| false

| status
|
| <<swiftproxystatus,SwiftProxyStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#swiftproxylist]
==== SwiftProxyList

SwiftProxyList contains a list of SwiftProxy

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<swiftproxy,SwiftProxy>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftproxyspec]
==== SwiftProxySpec

SwiftProxySpec defines the desired state of SwiftProxy

|===
| Field | Description | Scheme | Required

| containerImageProxy
| Swift Proxy Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftproxyspeccore]
==== SwiftProxySpecCore

SwiftProxySpecCore -

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of Swift Proxy
| *int32
| true

| serviceUser
| ServiceUser - optional username used for this service to register in Swift
| string
| true

| secret
| Secret containing OpenStack password information for Swift service user password
| string
| true

| passwordSelectors
| PasswordSelector - Selector to choose the Swift user password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<proxyoverridespec,ProxyOverrideSpec>>
| false

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| memcachedInstance
| Memcached instance name.
| string
| true

| rabbitMqClusterName
| RabbitMQ instance name to request a transportURL for Ceilometer middleware
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| defaultConfigOverwrite
| DefaultConfigOverwrite - can be used to add additionalfiles. Those get added to the service config dir in /etc/+++<servicename>+++-conf.d+++</servicename>+++
| map[string]string
| false

| encryptionEnabled
| Encrypts new objects at rest
| bool
| true

| ceilometerEnabled
| Enables ceilometer in the swift proxy and creates required resources
| bool
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| apiTimeout
| Default APITimeout for HAProxy and Apache, defaults to 60 seconds
| int
| false

| ringConfigMaps
| List of ring ConfigMaps
| []string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftproxystatus]
==== SwiftProxyStatus

SwiftProxyStatus defines the observed state of SwiftProxy

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of SwiftProxy instances
| int32
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#swiftdisk]
==== SwiftDisk

|===
| Field | Description | Scheme | Required

| device
|
| string
| true

| path
|
| string
| true

| weight
|
| int32
| true

| region
|
| int32
| true

| zone
|
| int32
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftring]
==== SwiftRing

SwiftRing is the Schema for the swiftrings API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<swiftringspec,SwiftRingSpec>>
| false

| status
|
| <<swiftringstatus,SwiftRingStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#swiftringlist]
==== SwiftRingList

SwiftRingList contains a list of SwiftRing

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<swiftring,SwiftRing>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftringspec]
==== SwiftRingSpec

SwiftRingSpec defines the desired state of SwiftRing

|===
| Field | Description | Scheme | Required

| containerImage
| Image URL for Swift proxy service
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftringspeccore]
==== SwiftRingSpecCore

SwiftRingSpec defines the desired state of SwiftRing

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether SwiftRing service should be deployed and managed
| bool
| true

| ringReplicas
| Number of Swift data replicas (=copies)
| *int64
| true

| partPower
| Partition power of the Swift rings
| *int64
| true

| minPartHours
| Minimum number of hours to restrict moving a partition more than once
| *int64
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| ringConfigMaps
| List of ring ConfigMaps
| []string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftringstatus]
==== SwiftRingStatus

SwiftRingStatus defines the observed state of SwiftRing

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#swiftstorage]
==== SwiftStorage

SwiftStorage is the Schema for the swiftstorages API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<swiftstoragespec,SwiftStorageSpec>>
| false

| status
|
| <<swiftstoragestatus,SwiftStorageStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#swiftstoragelist]
==== SwiftStorageList

SwiftStorageList contains a list of SwiftStorage

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<swiftstorage,SwiftStorage>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftstoragespec]
==== SwiftStorageSpec

SwiftStorageSpec defines the desired state of SwiftStorage

|===
| Field | Description | Scheme | Required

| containerImageAccount
| Image URL for Swift account service
| string
| true

| containerImageContainer
| Image URL for Swift container service
| string
| true

| containerImageObject
| Image URL for Swift object service
| string
| true

| containerImageProxy
| Image URL for Swift proxy service
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftstoragespeccore]
==== SwiftStorageSpecCore

SwiftStorageSpecCore -

|===
| Field | Description | Scheme | Required

| replicas
|
| *int32
| true

| storageClass
| Name of StorageClass to use for Swift PVs
| string
| true

| storageRequest
| Minimum size for Swift PVs
| string
| true

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| memcachedInstance
| Memcached instance name.
| string
| true

| containerSharderEnabled
| If the container sharder daemon is enabled.
| bool
| true

| defaultConfigOverwrite
| DefaultConfigOverwrite - can be used to add additionalfiles. Those get added to the service config dir in /etc/+++<servicename>+++-conf.d+++</servicename>+++
| map[string]string
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| ringConfigMaps
| List of ring ConfigMaps
| []string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftstoragestatus]
==== SwiftStorageStatus

SwiftStorageStatus defines the observed state of SwiftStorage

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of SwiftStorage instances
| int32
| false

| conditions
| Conditions
| condition.Conditions
| false

| networkAttachments
| NetworkAttachments status of the deployment pods
| map[string][]string
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#swift]
==== Swift

Swift is the Schema for the swifts API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<swiftspec,SwiftSpec>>
| false

| status
|
| <<swiftstatus,SwiftStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#swiftlist]
==== SwiftList

SwiftList contains a list of Swift

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<swift,Swift>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftspec]
==== SwiftSpec

SwiftSpec defines the desired state of Swift

|===
| Field | Description | Scheme | Required

| swiftRing
| SwiftRing - Spec definition for the Ring service of this Swift deployment
| <<swiftringspec,SwiftRingSpec>>
| true

| swiftStorage
| SwiftStorage - Spec definition for the Storage service of this Swift deployment
| <<swiftstoragespec,SwiftStorageSpec>>
| true

| swiftProxy
| SwiftProxy - Spec definition for the Proxy service of this Swift deployment
| <<swiftproxyspec,SwiftProxySpec>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftspecbase]
==== SwiftSpecBase

SwiftSpecBase -

|===
| Field | Description | Scheme | Required

| storageClass
| Storage class. This is passed to SwiftStorage unless storageClass is explicitly set for the SwiftStorage.
| string
| true

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| memcachedInstance
| Memcached instance name.
| string
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| ringConfigMaps
| List of ring ConfigMaps
| []string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftspeccore]
==== SwiftSpecCore

SwiftSpecCore defines the desired state of Swift (this version is used by OpenStackControlplane)

|===
| Field | Description | Scheme | Required

| swiftRing
| SwiftRing - Spec definition for the Ring service of this Swift deployment
| <<swiftringspeccore,SwiftRingSpecCore>>
| true

| swiftStorage
| SwiftStorage - Spec definition for the Storage service of this Swift deployment
| <<swiftstoragespeccore,SwiftStorageSpecCore>>
| true

| swiftProxy
| SwiftProxy - Spec definition for the Proxy service of this Swift deployment
| <<swiftproxyspeccore,SwiftProxySpecCore>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#swiftstatus]
==== SwiftStatus

SwiftStatus defines the observed state of Swift

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#aodh]
==== Aodh

Aodh defines the aodh component spec

|===
| Field | Description | Scheme | Required

| apiImage
|
| string
| true

| evaluatorImage
|
| string
| true

| notifierImage
|
| string
| true

| listenerImage
|
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#aodhcore]
==== AodhCore

Aodh defines the aodh component spec

|===
| Field | Description | Scheme | Required

| apiTimeout
| APITimeout for Route and Apache
| int
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Aodh
| string
| false

| databaseInstance
| MariaDB instance name Right now required by the maridb-operator to get the credentials from the instance to create the DB Might not be required in future
| string
| true

| databaseAccount
| DatabaseAccount - optional MariaDBAccount CR name used for aodh DB, defaults to aodh
| string
| true

| passwordSelector
| PasswordSelectors - Selectors to identify the service from the Secret
| <<passwordsselector,PasswordsSelector>>
| false

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| secret
| Secret containing OpenStack password information for aodh
| string
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| networkAttachmentDefinitions
| NetworkAttachmentDefinitions list of network attachment definitions the service pod gets attached to
| []string
| false

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| memcachedInstance
| Memcached instance name.
| string
| true

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#autoscaling]
==== Autoscaling

Autoscaling is the Schema for the autoscalings API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<autoscalingspec,AutoscalingSpec>>
| false

| status
|
| <<autoscalingstatus,AutoscalingStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#autoscalinglist]
==== AutoscalingList

AutoscalingList contains a list of Autoscaling

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<autoscaling,Autoscaling>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#autoscalingspec]
==== AutoscalingSpec

AutoscalingSpec defines the desired state of Autoscaling

|===
| Field | Description | Scheme | Required

| aodh
| Aodh spec
| <<aodh,Aodh>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#autoscalingspecbase]
==== AutoscalingSpecBase

AutoscalingSpecBase -

|===
| Field | Description | Scheme | Required

| prometheusHost
| Host of user deployed prometheus
| string
| false

| prometheusPort
| Port of user deployed prometheus
| int32
| false

| prometheusTLSCaCertSecret
| If defined, specifies which CA certificate to use for user deployed prometheus
| *corev1.SecretKeySelector
| false

| heatInstance
| Heat instance name.
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#autoscalingspeccore]
==== AutoscalingSpecCore

AutoscalingSpecCore defines the desired state of Autoscaling (this version is used by the OpenStackControlplane no image parameters)

|===
| Field | Description | Scheme | Required

| aodh
| Aodh spec
| <<aodhcore,AodhCore>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#autoscalingstatus]
==== AutoscalingStatus

AutoscalingStatus defines the observed state of Autoscaling

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of autoscaling instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| networks
| Networks in addtion to the cluster network, the service is attached to
| []string
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| databaseHostname
| DatabaseHostname - Hostname for the database
| string
| false

| prometheusHostname
| PrometheusHost - Hostname for prometheus used for autoscaling
| string
| false

| prometheusPort
| PrometheusPort - Port for prometheus used for autoscaling
| int32
| false

| prometheusTLS
| PrometheusTLS - Determines if TLS should be used for accessing prometheus
| bool
| false

| apiEndpoint
| API endpoint
| map[string]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ceilometer]
==== Ceilometer

Ceilometer is the Schema for the ceilometers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ceilometerspec,CeilometerSpec>>
| false

| status
|
| <<ceilometerstatus,CeilometerStatus>>
| false

| ksmStatus
|
| <<ksmstatus,KSMStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ceilometerlist]
==== CeilometerList

CeilometerList contains a list of Ceilometer

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ceilometer,Ceilometer>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ceilometerspec]
==== CeilometerSpec

CeilometerSpec defines the desired state of Ceilometer

|===
| Field | Description | Scheme | Required

| centralImage
|
| string
| true

| notificationImage
|
| string
| true

| sgCoreImage
|
| string
| true

| computeImage
|
| string
| true

| ipmiImage
|
| string
| true

| proxyImage
|
| string
| true

| ksmImage
|
| string
| true

| mysqldExporterImage
|
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ceilometerspeccore]
==== CeilometerSpecCore

CeilometerSpecCore defines the desired state of Ceilometer. This version is used by the OpenStackControlplane (no image parameters)

|===
| Field | Description | Scheme | Required

| apiTimeout
| APITimeout for Apache
| int
| true

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Telemetry
| string
| false

| passwordSelector
| PasswordSelectors - Selectors to identify the service from the Secret
| <<passwordsselector,PasswordsSelector>>
| false

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| string
| true

| secret
| Secret containing OpenStack password information for ceilometer
| string
| true

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as custom.conf file.+++</service>++++++</service>+++
| string
| false

| defaultConfigOverwrite
| ConfigOverwrite - interface to overwrite default config files like e.g. logging.conf or policy.json. But can also be used to add additional files. Those get added to the service config dir in /etc/+++<service>+++.+++</service>+++
| map[string]string
| false

| networkAttachmentDefinitions
| NetworkAttachmentDefinitions list of network attachment definitions the service pod gets attached to
| []string
| false

| ksmEnabled
| Whether kube-state-metrics should be deployed
| *bool
| false

| mysqldExporterEnabled
| Whether mysqld_exporter should be deployed
| *bool
| false

| mysqldExporterDatabaseAccountPrefix
| MysqldExporterDatabaseAccountPrefix - Database account prefix for the mysqld-exporter. A mariadbaccount CR named "+++<mysqldExporterDatabaseAccountPrefix>+++-+++<galera CR="" name="">+++\" for each galera instance needs to be either created by the user or if it's missing, it'll be created by the telemetry-operator automatically.+++</galera>++++++</mysqldExporterDatabaseAccountPrefix>+++
| string
| false

| tls
| TLS - Parameters related to the TLS
| tls.SimpleService
| false

| ksmTls
| KSMTLS - Parameters related to the TLS for kube-state-metrics
| tls.SimpleService
| false

| mysqldExporterTLS
| MysqldExporterTLS - Parameters related to the TLS for mysqld_exporter
| tls.SimpleService
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ceilometerstatus]
==== CeilometerStatus

CeilometerStatus defines the observed state of Ceilometer

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of ceilometer instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| transportURLSecret
| TransportURLSecret - Secret containing RabbitMQ transportURL
| string
| false

| networks
| Networks in addtion to the cluster network, the service is attached to
| []string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| mysqldExporterReadyCount
| ReadyCount of mysqld_exporter instances
| int32
| false

| mysqldExporterHash
| Map of hashes to track e.g. job status
| map[string]string
| false

| mysqldExporterExportedGaleras
| List of galera CRs, which are being exported with mysqld_exporter
| []string
| false

| ksmReadyCount
| ReadyCount of kube-state-metrics instances
| int32
| false

| ksmHash
| Map of hashes to track e.g. job status
| map[string]string
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ksmstatus]
==== KSMStatus

KSMStatus defines the observed state of kube-state-metrics [DEPRECATED, Status is used instead]

|===
| Field | Description | Scheme | Required

| readyCount
| ReadyCount of ksm instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#logging]
==== Logging

Logging is the Schema for the loggings API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<loggingspec,LoggingSpec>>
| false

| status
|
| <<loggingstatus,LoggingStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#logginglist]
==== LoggingList

LoggingList contains a list of Logging

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<logging,Logging>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#loggingspec]
==== LoggingSpec

LoggingSpec defines the desired state of Logging

|===
| Field | Description | Scheme | Required

| port
| Port is the port where the service will listen on
| int32
| true

| targetPort
| TargetPort is the port where the logging syslog receiver is listening
| int
| true

| cloNamespace
| CLONamespace points to the namespace where the cluster-logging-operator is deployed
| string
| true

| annotations
| Annotations is a way to configure certain LoadBalancers, like MetalLB
| map[string]string
| true

| rsyslogRetries
| The number of retries rsyslog will attempt before abandoning
| int32
| true

| rsyslogQueueType
| The type of the local queue of logs
| string
| true

| rsyslogQueueSize
| The size of the local queue of logs
| int32
| true
|===

<<custom-resources,Back to Custom Resources>>

[#loggingstatus]
==== LoggingStatus

LoggingStatus defines the observed state of Logging

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#metricstorage]
==== MetricStorage

MetricStorage is the Schema for the metricstorages API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<metricstoragespec,MetricStorageSpec>>
| false

| status
|
| <<metricstoragestatus,MetricStorageStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#metricstoragelist]
==== MetricStorageList

MetricStorageList contains a list of MetricStorage

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<metricstorage,MetricStorage>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#metricstoragespec]
==== MetricStorageSpec

MetricStorageSpec defines the desired state of MetricStorage

|===
| Field | Description | Scheme | Required

| dashboardsEnabled
| DashboardsEnabled allows to enable or disable dashboards and related artifacts
| bool
| true

| dataplaneNetwork
| DataplaneNetwork defines the network that will be used to scrape dataplane node_exporter endpoints
| *infranetworkv1.NetNameStr
| true

| networkAttachments
| NetworkAttachments is a list of NetworkAttachment resource names to expose the services to the given network
| []string
| false

| monitoringStack
| MonitoringStack allows to define a metric storage with options supported by Red Hat
| *<<monitoringstack,MonitoringStack>>
| false

| customMonitoringStack
| CustomMonitoringStack allows to deploy a custom monitoring stack when the options in "MonitoringStack" aren't enough
| *obov1.MonitoringStackSpec
| false

| prometheusTls
| TLS - Parameters related to the TLS
| tls.SimpleService
| false
|===

<<custom-resources,Back to Custom Resources>>

[#metricstoragestatus]
==== MetricStorageStatus

MetricStorageStatus defines the observed state of MetricStorage

|===
| Field | Description | Scheme | Required

| conditions
|
| condition.Conditions
| false

| prometheusTLSPatched
|
| bool
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| networkAttachments
| NetworkAttachments status of the Prometheus pods
| map[string]string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#monitoringstack]
==== MonitoringStack

MonitoringStack defines the options for a Red Hat supported metric storage

|===
| Field | Description | Scheme | Required

| alertingEnabled
| AlertingEnabled allows to enable or disable alertmanager
| bool
| true

| scrapeInterval
| ScrapeInterval sets the interval between scrapes
| string
| true

| storage
| Storage allows to define options for how to store metrics
| <<storage,Storage>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#persistentstorage]
==== PersistentStorage

PersistentStorage defines storage options used for persistent storage

|===
| Field | Description | Scheme | Required

| pvcStorageRequest
| PvcStorageRequest The amount of storage to request in PVC
| string
| true

| pvcStorageSelector
| PvcStorageSelector The Label selector to specify in PVCs
| metav1.LabelSelector
| false

| pvcStorageClass
| PvcStorageClass The storage class to use for storing metrics
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#storage-2]
==== Storage

Storage defines the options used for storage of metrics

|===
| Field | Description | Scheme | Required

| strategy
| Strategy to use for storage. Can be "persistent", "ephemeral" or empty, in which case a COO default is used
| string
| true

| retention
| Retention time for metrics
| string
| true

| persistent
| Used to specify the options of persistent storage when strategy = "persistent"
| *<<persistentstorage,PersistentStorage>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#autoscalingsection]
==== AutoscalingSection

AutoscalingSection defines the desired state of the autoscaling service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether OpenStack autoscaling service should be deployed and managed
| *bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#autoscalingsectioncore]
==== AutoscalingSectionCore

AutoscalingSectionCore defines the desired state of the autoscaling service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether OpenStack autoscaling service should be deployed and managed
| *bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ceilometersection]
==== CeilometerSection

CeilometerSection defines the desired state of the ceilometer service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether OpenStack Ceilometer service should be deployed and managed
| *bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ceilometersectioncore]
==== CeilometerSectionCore

CeilometerSectionCore defines the desired state of the ceilometer service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether OpenStack Ceilometer service should be deployed and managed
| *bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#loggingsection]
==== LoggingSection

LoggingSection defines the desired state of the logging service

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether OpenStack logging service should be deployed and managed
| *bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#metricstoragesection]
==== MetricStorageSection

MetricStorageSection defines the desired state of the MetricStorage

|===
| Field | Description | Scheme | Required

| enabled
| Enabled - Whether a MetricStorage should be deployed and managed
| *bool
| true
|===

<<custom-resources,Back to Custom Resources>>

[#passwordsselector]
==== PasswordsSelector

PasswordsSelector to identify the Service password from the Secret

|===
| Field | Description | Scheme | Required

| ceilometerService
| CeilometerService - Selector to get the ceilometer service password from the Secret
| string
| true

| aodhService
| AodhService - Selector to get the aodh service password from the Secret
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#telemetry]
==== Telemetry

Telemetry is the Schema for the telemetry API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<telemetryspec,TelemetrySpec>>
| false

| status
|
| <<telemetrystatus,TelemetryStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#telemetrylist]
==== TelemetryList

TelemetryList contains a list of Telemetry

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<telemetry,Telemetry>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#telemetryspec]
==== TelemetrySpec

TelemetrySpec defines the desired state of Telemetry

|===
| Field | Description | Scheme | Required

| autoscaling
| Autoscaling - Parameters related to the autoscaling service
| <<autoscalingsection,AutoscalingSection>>
| false

| ceilometer
| Ceilometer - Parameters related to the ceilometer service
| <<ceilometersection,CeilometerSection>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#telemetryspecbase]
==== TelemetrySpecBase

TelemetrySpecBase -

|===
| Field | Description | Scheme | Required

| metricStorage
| MetricStorage - Parameters related to the metricStorage
| <<metricstoragesection,MetricStorageSection>>
| false

| logging
| Logging - Parameters related to the logging
| <<loggingsection,LoggingSection>>
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#telemetryspeccore]
==== TelemetrySpecCore

TelemetrySpecCore defines the desired state of Telemetry. This version has no image parameters and is used by OpenStackControlplane

|===
| Field | Description | Scheme | Required

| autoscaling
| Autoscaling - Parameters related to the autoscaling service
| <<autoscalingsectioncore,AutoscalingSectionCore>>
| false

| ceilometer
| Ceilometer - Parameters related to the ceilometer service
| <<ceilometersectioncore,CeilometerSectionCore>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#telemetrystatus]
==== TelemetryStatus

TelemetryStatus defines the observed state of Telemetry

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| conditions
| Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#passwordselector-2]
==== PasswordSelector

PasswordSelector to identify the DB and AdminUser password from the Secret

|===
| Field | Description | Scheme | Required

| service
| Service - Selector to get the watcher service user password from the Secret
| *string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watchercommon]
==== WatcherCommon

WatcherCommon defines a spec based reusable for all the CRDs

|===
| Field | Description | Scheme | Required

| serviceUser
| ServiceUser - optional username used for this service to register in keystone
| *string
| true

| passwordSelectors
| PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
| <<passwordselector,PasswordSelector>>
| true

| memcachedInstance
| MemcachedInstance is the name of the Memcached CR that all watcher service will use.
| *string
| true

| preserveJobs
| PreserveJobs - do not delete jobs after they finished e.g. to check logs
| bool
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this component. Setting here overrides any global NodeSelector settings within the Watcher CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| string
| false

| prometheusSecret
| Secret containing prometheus connection parameters
| *string
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherimages]
==== WatcherImages

|===
| Field | Description | Scheme | Required

| apiContainerImageURL
| APIContainerImageURL
| string
| true

| decisionengineContainerImageURL
| DecisionEngineContainerImageURL
| string
| true

| applierContainerImageURL
| ApplierContainerImageURL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watcherspeccore]
==== WatcherSpecCore

WatcherSpecCore defines the fields used from the OpenStackControlPlane CR (does not include images)

|===
| Field | Description | Scheme | Required

| rabbitMqClusterName
| RabbitMQ instance name Needed to request a transportURL that is created and used in Watcher
| *string
| true

| secret
| Secret containing all passwords / keys needed
| *string
| true

| databaseInstance
| MariaDB instance name Required to use the mariadb-operator instance to create the DB and user
| *string
| true

| databaseAccount
| DatabaseAccount - MariaDBAccount CR name used for watcher DB, defaults to watcher
| *string
| true

| apiServiceTemplate
| APIServiceTemplate - define the watcher-api service
| <<watcherapitemplate,WatcherAPITemplate>>
| true

| applierServiceTemplate
| WatcherApplierTemplate - define the watcher-applier service
| <<watcherappliertemplate,WatcherApplierTemplate>>
| true

| decisionengineServiceTemplate
| DecisionEngineServiceTemplate - define the watcher-decision-engine service
| <<watcherdecisionenginetemplate,WatcherDecisionEngineTemplate>>
| true

| dbPurge
| DBPurge defines the parameters for the Watcher DB purging cron job
| <<watcherdbpurge,WatcherDBPurge>>
| true

| apiTimeout
| APITimeout for Route and Apache
| *int
| true

| notificationsBusInstance
| NotificationsBusInstance is the name of the RabbitMqCluster CR to select the Message Bus Service instance used by the Watcher service to publish and consume notifications from other services. If undefined, the value will be inherited from OpenStackControlPlane. An empty value "" leaves the notification drivers unconfigured and emitting no notifications at all. Avoid colocating it with RabbitMqClusterName or other message bus instances used for RPC.
| *string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watchersubcrscommon]
==== WatcherSubCrsCommon

WatcherSubCrsCommon

|===
| Field | Description | Scheme | Required

| containerImage
| The service specific Container Image URL (will be set to environmental default if empty)
| string
| true

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| serviceAccount
| ServiceAccount - service account name used internally to provide Watcher services the default SA name
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watchersubcrstemplate]
==== WatcherSubCrsTemplate

WatcherSubCrsTemplate define de common part of the input parameters specified by the user to create a 2nd CR via higher level CRDs.

|===
| Field | Description | Scheme | Required

| resources
| Resources - Compute Resources required by this service (Limits/Requests). https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
| corev1.ResourceRequirements
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this component. Setting here overrides any global NodeSelector settings within the Watcher CR.
| *map[string]string
| false

| customServiceConfig
| CustomServiceConfig - customize the service config using this parameter to change service defaults, or overwrite rendered information using raw OpenStack config format. The content gets added to /etc/+++<service>+++/+++<service>+++.conf.d directory as a custom config file.+++</service>++++++</service>+++
| string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#apioverridespec-2]
==== APIOverrideSpec

APIOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster. The key must be the endpoint type (public, internal)
| map[service.Endpoint]service.RoutedOverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherapi]
==== WatcherAPI

WatcherAPI is the Schema for the watcherapis API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<watcherapispec,WatcherAPISpec>>
| false

| status
|
| <<watcherapistatus,WatcherAPIStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherapilist]
==== WatcherAPIList

WatcherAPIList contains a list of WatcherAPI

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<watcherapi,WatcherAPI>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watcherapispec]
==== WatcherAPISpec

WatcherAPISpec defines the desired state of WatcherAPI

|===
| Field | Description | Scheme | Required

| secret
| Secret containing all passwords / keys needed
| string
| true

| replicas
| Replicas of Watcher service to run
| *int32
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false

| apiTimeout
| APITimeout for Route and Apache
| int
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watcherapistatus]
==== WatcherAPIStatus

WatcherAPIStatus defines the observed state of WatcherAPI

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| readyCount
| ReadyCount of watcher API instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherapitemplate]
==== WatcherAPITemplate

WatcherAPITemplate defines the input parameters specified by the user to create a WatcherAPI via higher level CRDs.

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of WatcherAPI service to run
| *int32
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<apioverridespec,APIOverrideSpec>>
| false

| tls
| TLS - Parameters related to the TLS
| tls.API
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherapplier]
==== WatcherApplier

WatcherApplier is the Schema for the watcherappliers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<watcherapplierspec,WatcherApplierSpec>>
| false

| status
|
| <<watcherapplierstatus,WatcherApplierStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherapplierlist]
==== WatcherApplierList

WatcherApplierList contains a list of WatcherApplier

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<watcherapplier,WatcherApplier>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watcherapplierspec]
==== WatcherApplierSpec

WatcherApplierSpec defines the desired state of WatcherApplier

|===
| Field | Description | Scheme | Required

| secret
| Secret containing all passwords / keys needed
| string
| true

| replicas
| Replicas of Watcher service to run
| *int32
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherapplierstatus]
==== WatcherApplierStatus

WatcherApplierStatus defines the observed state of WatcherApplier

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| readyCount
| ReadyCount of watcher Applier instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherappliertemplate]
==== WatcherApplierTemplate

WatcherApplierTemplatce defines the input parameters specified by the user to create a WatcherApplier via higher level CRDs.

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of WatcherApplier service to run
| *int32
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watcherdecisionengine]
==== WatcherDecisionEngine

WatcherDecisionEngine is the Schema for the watcherdecisionengines API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<watcherdecisionenginespec,WatcherDecisionEngineSpec>>
| false

| status
|
| <<watcherdecisionenginestatus,WatcherDecisionEngineStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherdecisionenginelist]
==== WatcherDecisionEngineList

WatcherDecisionEngineList contains a list of WatcherDecisionEngine

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<watcherdecisionengine,WatcherDecisionEngine>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watcherdecisionenginespec]
==== WatcherDecisionEngineSpec

WatcherDecisionEngineSpec defines the desired state of WatcherDecisionEngine

|===
| Field | Description | Scheme | Required

| secret
| Secret containing all passwords / keys needed
| string
| true

| replicas
| Replicas of Watcher service to run
| *int32
| true

| tls
| TLS - Parameters related to the TLS
| tls.Ca
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherdecisionenginestatus]
==== WatcherDecisionEngineStatus

WatcherDecisionEngineStatus defines the observed state of WatcherDecisionEngine

|===
| Field | Description | Scheme | Required

| conditions
| INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the openstack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| readyCount
| ReadyCount of WatcherDecisionEngine instances
| int32
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherdecisionenginetemplate]
==== WatcherDecisionEngineTemplate

WatcherDecisionEngineTemplate defines the input parameters specified by the user to create a WatcherDecisionengine via higher level CRDs.

|===
| Field | Description | Scheme | Required

| replicas
| Replicas of WatcherDecisionEngine service to run
| *int32
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watcher]
==== Watcher

Watcher is the Schema for the watchers API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<watcherspec,WatcherSpec>>
| false

| status
|
| <<watcherstatus,WatcherStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#watcherdbpurge]
==== WatcherDBPurge

|===
| Field | Description | Scheme | Required

| schedule
| Schedule defines when to run the Watcher DB Purge job in a cron format. By default it runs everyday at 01:00.
| *string
| true

| purgeAge
| PurgeAge defines the minimum age of soft-deleted records in days that can be deleted from the shadow tables
| *int
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watcherlist]
==== WatcherList

WatcherList contains a list of Watcher

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<watcher,Watcher>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#watcherstatus]
==== WatcherStatus

WatcherStatus defines the observed state of Watcher

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| serviceID
| ServiceID - The ID of the watcher service registered in keystone
| string
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| apiServiceReadyCount
| APIServiceReadyCount defines the number or replicas ready from watcher-api
| int32
| false

| applierServiceReadyCount
| ApplierServiceReadyCount defines the number or replicas ready from watcher-applier
| int32
| false

| decisionengineServiceReadyCount
| DecisionEngineServiceReadyCount defines the number or replicas ready from watcher-decision-engine
| int32
| false
|===

<<custom-resources,Back to Custom Resources>>

[#mtlssection]
==== MTLSSection

|===
| Field | Description | Scheme | Required

| sslVerifyMode
| Used to enforce client side tls cert validation
| string
| false

| authCertSecret
| Name of the secret containing the client cert used to perform mtls auth
| tls.GenericService
| false
|===

<<custom-resources,Back to Custom Resources>>

[#memcached]
==== Memcached

Memcached is the Schema for the memcacheds API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<memcachedspec,MemcachedSpec>>
| false

| status
|
| <<memcachedstatus,MemcachedStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#memcachedlist]
==== MemcachedList

MemcachedList contains a list of Memcached

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<memcached,Memcached>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#memcachedspec]
==== MemcachedSpec

MemcachedSpec defines the desired state of Memcached

|===
| Field | Description | Scheme | Required

| containerImage
| Name of the memcached container image to run (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#memcachedspeccore]
==== MemcachedSpecCore

MemcachedSpecCore - this version is used by the OpenStackControlplane CR (no container images)

|===
| Field | Description | Scheme | Required

| replicas
| Size of the memcached cluster
| *int32
| true

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| tls
| TLS settings for memcached service
| <<tlssection,TLSSection>>
| false

| cacheSize
| Maximum Memcached cache size in MB
| int32
| true

| maxConn
| Maximum number of connections accepted by Memcached
| int32
| true

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| resources
| Resources QoS configuration for pods
| corev1.ResourceRequirements
| false
|===

<<custom-resources,Back to Custom Resources>>

[#memcachedstatus]
==== MemcachedStatus

MemcachedStatus defines the observed state of Memcached

|===
| Field | Description | Scheme | Required

| hash
| Map of hashes to track input changes
| map[string]string
| false

| readyCount
| ReadyCount of Memcached instances
| int32
| false

| conditions
| Conditions
| condition.Conditions
| false

| serverList
| ServerList - List of memcached endpoints without inet(6) prefix
| []string
| false

| serverListWithInet
| ServerListWithInet - List of memcached endpoints with inet(6) prefix
| []string
| false

| tlsSupport
| Whether TLS is supported by the memcached instance
| bool
| false

| mtlsCert
| Name of the certificate used for MTLS
| string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#tlssection-2]
==== TLSSection

TLSSection

|===
| Field | Description | Scheme | Required

| mtls
|
| <<mtlssection,MTLSSection>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#bgpconfiguration]
==== BGPConfiguration

BGPConfiguration is the Schema for the bgpconfigurations API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<bgpconfigurationspec,BGPConfigurationSpec>>
| false

| status
|
| <<bgpconfigurationstatus,BGPConfigurationStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#bgpconfigurationlist]
==== BGPConfigurationList

BGPConfigurationList contains a list of BGPConfiguration

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<bgpconfiguration,BGPConfiguration>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#bgpconfigurationspec]
==== BGPConfigurationSpec

BGPConfigurationSpec defines the desired state of BGPConfiguration

|===
| Field | Description | Scheme | Required

| frrConfigurationNamespace
| FRRConfigurationNamespace - namespace where to create the FRRConfiguration. Defaults to metallb-system.
| string
| true

| frrNodeConfigurationSelector
| FRRNodeConfigurationSelector - per default the FRRConfiguration per node within the FRRConfigurationNamespace gets queried using the FRRConfiguration.spec.NodeSelector `kubernetes.io/hostname: worker-0`. In case a more specific
| []<<frrnodeconfigurationselectortype,FRRNodeConfigurationSelectorType>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#bgpconfigurationstatus]
==== BGPConfigurationStatus

BGPConfigurationStatus defines the observed state of BGPConfiguration

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false
|===

<<custom-resources,Back to Custom Resources>>

[#frrnodeconfigurationselectortype]
==== FRRNodeConfigurationSelectorType

FRRNodeConfigurationSelectorType -

|===
| Field | Description | Scheme | Required

| nodeName
| NodeName -  name of the node object as seen by running the `oc get nodes` command
| string
| false

| nodeSelector
| NodeSelector  to identify the correct FRRConfiguration from spec.nodeSelector
| metav1.LabelSelector
| false
|===

<<custom-resources,Back to Custom Resources>>

[#dnsdata]
==== DNSData

DNSData is the Schema for the dnsdata API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<dnsdataspec,DNSDataSpec>>
| false

| status
|
| <<dnsdatastatus,DNSDataStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#dnsdatalist]
==== DNSDataList

DNSDataList contains a list of DNSData

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<dnsdata,DNSData>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#dnsdataspec]
==== DNSDataSpec

DNSDataSpec defines the desired state of DNSData

|===
| Field | Description | Scheme | Required

| hosts
|
| []<<dnshost,DNSHost>>
| false

| dnsDataLabelSelectorValue
| Value of the DNSDataLabelSelector to set on the created configmaps containing hosts information
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#dnsdatastatus]
==== DNSDataStatus

DNSDataStatus defines the observed state of DNSData

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| hash
| Map of the dns data configmap
| string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#dnshost]
==== DNSHost

DNSHost holds the mapping between IP and hostnames that will be added to dnsmasq hosts file.

|===
| Field | Description | Scheme | Required

| ip
| IP address of the host file entry.
| string
| true

| hostnames
| Hostnames for the IP address.
| []string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#dnsmasq]
==== DNSMasq

DNSMasq is the Schema for the dnsmasqs API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<dnsmasqspec,DNSMasqSpec>>
| false

| status
|
| <<dnsmasqstatus,DNSMasqStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#dnsmasqlist]
==== DNSMasqList

DNSMasqList contains a list of DNSMasq

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<dnsmasq,DNSMasq>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#dnsmasqoption]
==== DNSMasqOption

DNSMasqOption defines allowed options for dnsmasq

|===
| Field | Description | Scheme | Required

| key
|
| string
| true

| values
|
| []string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#dnsmasqoverridespec]
==== DNSMasqOverrideSpec

DNSMasqOverrideSpec to override the generated manifest of several child resources.

|===
| Field | Description | Scheme | Required

| service
| Override configuration for the Service created to serve traffic to the cluster.
| *service.OverrideSpec
| false
|===

<<custom-resources,Back to Custom Resources>>

[#dnsmasqspec]
==== DNSMasqSpec

DNSMasqSpec defines the desired state of DNSMasq

|===
| Field | Description | Scheme | Required

| containerImage
| DNSMasq Container Image URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#dnsmasqspeccore]
==== DNSMasqSpecCore

DNSMasqSpecCore - this version is used by the OpenStackControlplane CR (no container images)

|===
| Field | Description | Scheme | Required

| replicas
| Replicas - DNSMasq Replicas
| *int32
| true

| options
| Options allows to customize the dnsmasq instance
| []<<dnsmasqoption,DNSMasqOption>>
| false

| nodeSelector
| NodeSelector to target subset of worker nodes running this service. Setting NodeSelector here acts as a default value and can be overridden by service specific NodeSelector Settings.
| *map[string]string
| false

| dnsDataLabelSelectorValue
| Value of the DNSDataLabelSelectorKey which was set on the configmaps containing hosts information
| string
| true

| override
| Override, provides the ability to override the generated manifest of several child resources.
| <<dnsmasqoverridespec,DNSMasqOverrideSpec>>
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#dnsmasqstatus]
==== DNSMasqStatus

DNSMasqStatus defines the observed state of DNSMasq

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| hash
| Map of hashes to track e.g. job status
| map[string]string
| false

| readyCount
| ReadyCount of dnsmasq deployment
| int32
| false

| dnsAddresses
| DNSServer Addresses
| []string
| false

| dnsClusterAddresses
| DNSServer Cluster Addresses
| []string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ipset]
==== IPSet

IPSet is the Schema for the ipsets API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<ipsetspec,IPSetSpec>>
| false

| status
|
| <<ipsetstatus,IPSetStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ipsetlist]
==== IPSetList

IPSetList contains a list of IPSet

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<ipset,IPSet>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ipsetnetwork]
==== IPSetNetwork

IPSetNetwork Type

|===
| Field | Description | Scheme | Required

| name
| Network Name
| NetNameStr
| true

| subnetName
| Subnet Name
| NetNameStr
| true

| fixedIP
| Fixed Ip
| *string
| false

| defaultRoute
| Use gateway from subnet as default route. There can only be one default route defined per IPSet.
| *bool
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ipsetreservation]
==== IPSetReservation

IPSetReservation defines reservation status per requested network

|===
| Field | Description | Scheme | Required

| network
| Network name
| NetNameStr
| true

| subnet
| Subnet name
| NetNameStr
| true

| address
| Address contains the IP address
| string
| true

| mtu
| MTU of the network
| int
| false

| cidr
| Cidr the cidr to use for this network
| string
| false

| vlan
| Vlan ID
| *int
| false

| gateway
| Gateway optional gateway for the network
| *string
| false

| routes
| Routes, list of networks that should be routed via network gateway.
| []<<route,Route>>
| false

| dnsDomain
| DNSDomain of the subnet
| string
| true

| serviceNetwork
| ServiceNetwork mapping
| ServiceNetNameStr
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ipsetspec]
==== IPSetSpec

IPSetSpec defines the desired state of IPSet

|===
| Field | Description | Scheme | Required

| immutable
| Immutable, if `true` the validation webhook will block any update to the Spec, except of Spec.Immutable. This allows the caller to add safety mechanism to the object. If a change is required to the object, an extra update needs to be done to make updates possible.
| bool
| true

| networks
| Networks used to request IPs for
| []<<ipsetnetwork,IPSetNetwork>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#ipsetstatus]
==== IPSetStatus

IPSetStatus defines the observed state of IPSet

|===
| Field | Description | Scheme | Required

| reservations
| Reservation
| []<<ipsetreservation,IPSetReservation>>
| false

| conditions
| Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>

[#allocationrange]
==== AllocationRange

AllocationRange definition

|===
| Field | Description | Scheme | Required

| start
| Start IP for the AllocationRange
| string
| true

| end
| End IP for the AllocationRange
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#netconfig]
==== NetConfig

NetConfig is the Schema for the netconfigs API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<netconfigspec,NetConfigSpec>>
| false

| status
|
| <<netconfigstatus,NetConfigStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#netconfiglist]
==== NetConfigList

NetConfigList contains a list of NetConfig

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<netconfig,NetConfig>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#netconfigspec]
==== NetConfigSpec

NetConfigSpec defines the desired state of NetConfig

|===
| Field | Description | Scheme | Required

| networks
| Networks, list of all networks of the deployment
| []<<network,Network>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#network]
==== Network

Network definition

|===
| Field | Description | Scheme | Required

| name
| Name of the network, e.g. External, InternalApi, ...
| NetNameStr
| true

| dnsDomain
| DNSDomain name of the Network
| string
| true

| mtu
| MTU of the network
| int
| true

| subnets
| Subnets of the network
| []<<subnet,Subnet>>
| true

| serviceNetwork
| Service network mapping
| ServiceNetNameStr
| false
|===

<<custom-resources,Back to Custom Resources>>

[#route]
==== Route

Route definition

|===
| Field | Description | Scheme | Required

| destination
| Destination, network CIDR
| string
| true

| nexthop
| Nexthop, gateway for the destination
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#subnet]
==== Subnet

Subnet definition

|===
| Field | Description | Scheme | Required

| name
| Name of the subnet
| NetNameStr
| true

| cidr
| Cidr the cidr to use for this network
| string
| true

| dnsDomain
| DNSDomain name of the subnet, allows to overwrite the DNSDomain of the Network
| *string
| false

| vlan
| Vlan ID
| *int
| false

| allocationRanges
| AllocationRanges a list of AllocationRange for assignment. Allocation will start from first range, first address.
| []<<allocationrange,AllocationRange>>
| true

| excludeAddresses
| ExcludeAddresses a set of IPs that should be excluded from used as reservation, for both dynamic and static via IPSet FixedIP parameter
| []string
| false

| gateway
| Gateway optional gateway for the network
| *string
| false

| routes
| Routes, list of networks that should be routed via network gateway.
| []<<route,Route>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#ipaddress]
==== IPAddress

IPAddress -

|===
| Field | Description | Scheme | Required

| network
| Network name
| NetNameStr
| true

| subnet
| Subnet name
| NetNameStr
| true

| address
| Address contains the IP address
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#reservation]
==== Reservation

Reservation is the Schema for the reservations API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<reservationspec,ReservationSpec>>
| false

| status
|
| <<reservationstatus,ReservationStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#reservationlist]
==== ReservationList

ReservationList contains a list of Reservation

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<reservation,Reservation>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#reservationspec]
==== ReservationSpec

ReservationSpec defines the desired state of Reservation

|===
| Field | Description | Scheme | Required

| ipSetRef
| IPSetRef points to the IPSet object the IPs were created for.
| corev1.ObjectReference
| true

| reservation
| Reservation, map (index network name) with reservation
| map[string]<<ipaddress,IPAddress>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#rabbitmq]
==== RabbitMq

RabbitMq is the Schema for the rabbitmqs API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<rabbitmqspec,RabbitMqSpec>>
| false

| status
|
| <<rabbitmqstatus,RabbitMqStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#rabbitmqlist]
==== RabbitMqList

RabbitMqList contains a list of RabbitMq

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<rabbitmq,RabbitMq>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#rabbitmqspec]
==== RabbitMqSpec

RabbitMqSpec defines the desired state of RabbitMq

|===
| Field | Description | Scheme | Required

| containerImage
| Name of the rabbitmq container image to run (will be set to environmental default if empty)
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#rabbitmqspeccore]
==== RabbitMqSpecCore

RabbitMqSpecCore - this version is used by the OpenStackControlplane CR (no container images)

|===
| Field | Description | Scheme | Required

| nodeSelector
| NodeSelector to target subset of worker nodes running this service
| *map[string]string
| false

| topologyRef
| TopologyRef to apply the Topology defined by the associated CR referenced by name
| *topologyv1.TopoRef
| false

| queueType
| QueueType to eventually apply the ha-all policy or configure default queue type for the cluster
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#rabbitmqstatus]
==== RabbitMqStatus

RabbitMqStatus defines the observed state of RabbitMq

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false

| lastAppliedTopology
| LastAppliedTopology - the last applied Topology
| *topologyv1.TopoRef
| false

| queueType
| QueueType - store whether default ha-all policy is present or not
| string
| false
|===

<<custom-resources,Back to Custom Resources>>

[#transporturl]
==== TransportURL

TransportURL is the Schema for the transporturls API

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ObjectMeta
| false

| spec
|
| <<transporturlspec,TransportURLSpec>>
| false

| status
|
| <<transporturlstatus,TransportURLStatus>>
| false
|===

<<custom-resources,Back to Custom Resources>>

[#transporturllist]
==== TransportURLList

TransportURLList contains a list of TransportURL

|===
| Field | Description | Scheme | Required

| metadata
|
| metav1.ListMeta
| false

| items
|
| []<<transporturl,TransportURL>>
| true
|===

<<custom-resources,Back to Custom Resources>>

[#transporturlspec]
==== TransportURLSpec

TransportURLSpec defines the desired state of TransportURL

|===
| Field | Description | Scheme | Required

| rabbitmqClusterName
| RabbitmqClusterName the name of the Rabbitmq cluster which to configure the transport URL
| string
| true
|===

<<custom-resources,Back to Custom Resources>>

[#transporturlstatus]
==== TransportURLStatus

TransportURLStatus defines the observed state of TransportURL

|===
| Field | Description | Scheme | Required

| conditions
| Conditions
| condition.Conditions
| false

| secretName
| SecretName - name of the secret containing the rabbitmq transport URL
| string
| false

| queueType
| QueueType - the queue type from the associated RabbitMq instance
| string
| false

| observedGeneration
| ObservedGeneration - the most recent generation observed for this service. If the observed generation is less than the spec generation, then the controller has not processed the latest changes injected by the opentack-operator in the top-level CR (e.g. the ContainerImage)
| int64
| false
|===

<<custom-resources,Back to Custom Resources>>