dataplane_resources.adoc

Custom Resources

• OpenStackDataPlaneDeployment

• OpenStackDataPlaneNodeSet

• OpenStackDataPlaneService

Sub Resources

• OpenStackDataPlaneDeploymentList

• OpenStackDataPlaneDeploymentSpec

• OpenStackDataPlaneDeploymentStatus

• OpenStackDataPlaneNodeSetList

• OpenStackDataPlaneNodeSetSpec

• OpenStackDataPlaneNodeSetStatus

• OpenStackDataPlaneServiceList

• OpenStackDataPlaneServiceSpec

• OpenStackDataPlaneServiceStatus

• OpenstackDataPlaneServiceCert

• AnsibleEESpec

• AnsibleOpts

• ConfigMapEnvSource

• DataSource

• LocalObjectReference

• NodeSection

• NodeTemplate

• SecretEnvSource

OpenStackDataPlaneDeployment

OpenStackDataPlaneDeployment is the Schema for the openstackdataplanedeployments API OpenStackDataPlaneDeployment name must be a valid RFC1123 as it is used in labels

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec		OpenStackDataPlaneDeploymentSpec	false
status		OpenStackDataPlaneDeploymentStatus	false

Back to Custom Resources

OpenStackDataPlaneDeploymentList

OpenStackDataPlaneDeploymentList contains a list of OpenStackDataPlaneDeployment

Field	Description	Scheme	Required
metadata		metav1.ListMeta	false
items		[]OpenStackDataPlaneDeployment	true

Back to Custom Resources

OpenStackDataPlaneDeploymentSpec

OpenStackDataPlaneDeploymentSpec defines the desired state of OpenStackDataPlaneDeployment

Field	Description	Scheme	Required
nodeSets	NodeSets is the list of NodeSets deployed	[]string	true
backoffLimit	BackoffLimit allows to define the maximum number of retried executions (defaults to 6).	*int32	false
preserveJobs	PreserveJobs - do not delete jobs after they finished e.g. to check logs PreserveJobs default: true	bool	false
ansibleTags	AnsibleTags for ansible execution	string	false
ansibleLimit	AnsibleLimit for ansible execution	string	false
ansibleSkipTags	AnsibleSkipTags for ansible execution	string	false
ansibleExtraVars	AnsibleExtraVars for ansible execution	map[string]json.RawMessage	false
servicesOverride	ServicesOverride list	[]string	false
deploymentRequeueTime	Time before the deployment is requeued in seconds	int	true
ansibleJobNodeSelector	AnsibleJobNodeSelector to target subset of worker nodes running the ansible jobs	map[string]string	false

Back to Custom Resources

OpenStackDataPlaneDeploymentStatus

OpenStackDataPlaneDeploymentStatus defines the observed state of OpenStackDataPlaneDeployment

Field	Description	Scheme	Required
nodeSetConditions	NodeSetConditions	map[string]condition.Conditions	false
ansibleEEHashes	AnsibleEEHashes	map[string]string	false
configMapHashes	ConfigMapHashes	map[string]string	false
secretHashes	SecretHashes	map[string]string	false
nodeSetHashes	NodeSetHashes	map[string]string	false
bmhRefHashes	BmhRefHashes	map[string]string	false
containerImages	ContainerImages	map[string]string	false
conditions	Conditions	condition.Conditions	false
observedGeneration	ObservedGeneration - the most recent generation observed for this Deployment. If the observed generation is less than the spec generation, then the controller has not processed the latest changes.	int64	false
deployedVersion	DeployedVersion	string	false
deployed	Deployed	bool	false

Back to Custom Resources

OpenStackDataPlaneNodeSet

OpenStackDataPlaneNodeSet is the Schema for the openstackdataplanenodesets API OpenStackDataPlaneNodeSet name must be a valid RFC1123 as it is used in labels

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec		OpenStackDataPlaneNodeSetSpec	false
status		OpenStackDataPlaneNodeSetStatus	false

Back to Custom Resources

OpenStackDataPlaneNodeSetList

OpenStackDataPlaneNodeSetList contains a list of OpenStackDataPlaneNodeSets

Field	Description	Scheme	Required
metadata		metav1.ListMeta	false
items		[]OpenStackDataPlaneNodeSet	true

Back to Custom Resources

OpenStackDataPlaneNodeSetSpec

OpenStackDataPlaneNodeSetSpec defines the desired state of OpenStackDataPlaneNodeSet

Field	Description	Scheme	Required
baremetalSetTemplate	BaremetalSetTemplate Template for BaremetalSet for the NodeSet	*baremetalv1.OpenStackBaremetalSetTemplateSpec	false
nodeTemplate	NodeTemplate - node attributes specific to nodes defined by this resource. These attributes can be overriden at the individual node level, else take their defaults from valus in this section.	NodeTemplate	true
nodes	Nodes - Map of Node Names and node specific data. Values here override defaults in the upper level section.	map[string]NodeSection	true
env	Env is a list containing the environment variables to pass to the pod Variables modifying behavior of AnsibleEE can be specified here.	[]corev1.EnvVar	false
networkAttachments	NetworkAttachments is a list of NetworkAttachment resource names to pass to the ansibleee resource which allows to connect the ansibleee runner to the given network	[]string	false
services	Services list	[]string	true
tags	Tags - Additional tags for NodeSet	[]string	false
secretMaxSize	SecretMaxSize - Maximum size in bytes of a Kubernetes secret. This size is currently situated around 1 MiB (nearly 1 MB).	int	true
preProvisioned	\n\nPreProvisioned - Set to true if the nodes have been Pre Provisioned.	bool	false
tlsEnabled	TLSEnabled - Whether the node set has TLS enabled.	bool	true

Back to Custom Resources

OpenStackDataPlaneNodeSetStatus

OpenStackDataPlaneNodeSetStatus defines the observed state of OpenStackDataPlaneNodeSet

Field	Description	Scheme	Required
conditions	Conditions	condition.Conditions	false
deploymentStatuses	DeploymentStatuses	map[string]condition.Conditions	false
allHostnames	AllHostnames	map[string]map[infranetworkv1.NetNameStr]string	false
allIPs	AllIPs	map[string]map[infranetworkv1.NetNameStr]string	false
configMapHashes	ConfigMapHashes	map[string]string	false
secretHashes	SecretHashes	map[string]string	false
dnsClusterAddresses	DNSClusterAddresses	[]string	false
containerImages	ContainerImages	map[string]string	false
ctlplaneSearchDomain	CtlplaneSearchDomain	string	false
configHash	ConfigHash - holds the curret hash of the NodeTemplate and Node sections of the struct. This hash is used to determine when new Ansible executions are required to roll out config changes.	string	false
deployedConfigHash	DeployedConfigHash - holds the hash of the NodeTemplate and Node sections of the struct that was last deployed. This hash is used to determine when new Ansible executions are required to roll out config changes.	string	false
inventorySecretName	InventorySecretName Name of a secret containing the ansible inventory	string	false
observedGeneration	ObservedGeneration - the most recent generation observed for this NodeSet. If the observed generation is less than the spec generation, then the controller has not processed the latest changes.	int64	false
deployedVersion	DeployedVersion	string	false
bmhRefHash	bmhRefHash - Current hash of the BMHs	string	false
deployedBmhHash	DeployedBmhHash - Hash of BMHs deployed	string	false

Back to Custom Resources

OpenStackDataPlaneService

OpenStackDataPlaneService defines the Schema for the openstackdataplaneservices API. OpenStackDataPlaneService name must be a valid RFC1123 as it is used in labels

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec		OpenStackDataPlaneServiceSpec	false
status		OpenStackDataPlaneServiceStatus	false

Back to Custom Resources

OpenStackDataPlaneServiceList

OpenStackDataPlaneServiceList contains a list of OpenStackDataPlaneService

Field	Description	Scheme	Required
metadata		metav1.ListMeta	false
items		[]OpenStackDataPlaneService	true

Back to Custom Resources

OpenStackDataPlaneServiceSpec

OpenStackDataPlaneServiceSpec defines the desired state of OpenStackDataPlaneService

Field	Description	Scheme	Required
dataSources	DataSources list of DataSource objects to mount as ExtraMounts for the OpenStackAnsibleEE	[]DataSource	false
tlsCerts	TLSCerts tls certs to be generated	map[string]OpenstackDataPlaneServiceCert	false
playbookContents	PlaybookContents is an inline playbook contents that ansible will run on execution.	string	false
playbook	Playbook is a path to the playbook that ansible will run on this execution	string	false
role	Role is a path to the role that ansible will run on this execution	string	false
caCerts	CACerts - Secret containing the CA certificate chain	string	true
openStackAnsibleEERunnerImage	OpenStackAnsibleEERunnerImage image to use as the ansibleEE runner image	string	false
certsFrom	CertsFrom - Service name used to obtain TLSCert and CACerts data. If both CertsFrom and either TLSCert or CACerts is set, then those fields take precedence. DEPRECATED: Will be removed in a future release. Use EDPMServiceType instead.	string	false
addCertMounts	AddCertMounts - Whether to add cert mounts	bool	true
deployOnAllNodeSets	DeployOnAllNodeSets - should the service be deploy across all nodesets This will override default target of a service play, setting it to 'all'.	bool	false
containerImageFields	ContainerImageFields - list of container image fields names that this service deploys. The field names should match the ContainerImages struct field names from github.com/openstack-k8s-operators/openstack-operator/apis/core/v1beta1	[]string	false
edpmServiceType	EDPMServiceType - service type, which typically corresponds to one of the default service names (such as nova, ovn, etc). Also typically corresponds to the ansible role name (without the "edpm_" prefix) used to manage the service. If not set, will default to the OpenStackDataPlaneService name.	string	false

Back to Custom Resources

OpenStackDataPlaneServiceStatus

OpenStackDataPlaneServiceStatus defines the observed state of OpenStackDataPlaneService

Field	Description	Scheme	Required
conditions	Conditions	condition.Conditions	false

Back to Custom Resources

OpenstackDataPlaneServiceCert

OpenstackDataPlaneServiceCert defines the property of a TLS cert issued for a dataplane service

Field	Description	Scheme	Required
contents	Contents of the certificate This is a list of strings for properties that are needed in the cert	[]string	true
networks	Networks to include in SNI for the cert	[]infranetworkv1.NetNameStr	false
issuer	Issuer is the label for the issuer to issue the cert Only one issuer should have this label	string	false
keyUsages	KeyUsages to be added to the issued cert	[]certmgrv1.KeyUsage	false
edpmRoleServiceName	EDPMRoleServiceName is the value of the _service_name variable from the edpm-ansible role where this certificate is used. For example if the certificate is for edpm_ovn from edpm-ansible, EDPMRoleServiceName must be ovn, which matches the edpm_ovn_service_name variable from the role. If not set, OpenStackDataPlaneService.Spec.EDPMServiceType is used. If OpenStackDataPlaneService.Spec.EDPMServiceType is not set, then OpenStackDataPlaneService.Name is used. DEPRECATED: Will be removed in a future release. Use EDPMServiceType instead.	string	false

Back to Custom Resources

AnsibleEESpec

AnsibleEESpec is a specification of the ansible EE attributes

Field	Description	Scheme	Required
extraMounts	ExtraMounts containing files which can be mounted into an Ansible Execution Pod	[]storage.VolMounts	false
env	Env is a list containing the environment variables to pass to the pod	[]corev1.EnvVar	false
extraVars	ExtraVars for ansible execution	map[string]json.RawMessage	false
dnsConfig	DNSConfig for setting dnsservers	*corev1.PodDNSConfig	false
networkAttachments	NetworkAttachments is a list of NetworkAttachment resource names to pass to the ansibleee resource which allows to connect the ansibleee runner to the given network	[]string	true
openStackAnsibleEERunnerImage	OpenStackAnsibleEERunnerImage image to use as the ansibleEE runner image	string	false
ansibleTags	AnsibleTags for ansible execution	string	false
ansibleLimit	AnsibleLimit for ansible execution	string	false
ansibleSkipTags	AnsibleSkipTags for ansible execution	string	false
ServiceAccountName	ServiceAccountName allows to specify what ServiceAccountName do we want the ansible execution run with. Without specifying, it will run with default serviceaccount	string	false

Back to Custom Resources

AnsibleOpts

AnsibleOpts defines a logical grouping of Ansible related configuration options.

Field	Description	Scheme	Required
ansibleUser	AnsibleUser SSH user for Ansible connection	string	false
ansibleHost	AnsibleHost SSH host for Ansible connection	string	false
ansibleVars	AnsibleVars for configuring ansible	map[string]json.RawMessage	false
ansibleVarsFrom	AnsibleVarsFrom is a list of sources to populate ansible variables from. Values defined by an AnsibleVars with a duplicate key take precedence.	[]DataSource	false
ansiblePort	AnsiblePort SSH port for Ansible connection	int	false

Back to Custom Resources

ConfigMapEnvSource

ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap’s Data field will represent the key-value pairs as environment variables.

Field	Description	Scheme	Required
optional	Specify whether the ConfigMap must be defined	*bool	false

Back to Custom Resources

DataSource

DataSource represents the source of a set of ConfigMaps/Secrets

Field	Description	Scheme	Required
prefix	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	string	false
configMapRef	The ConfigMap to select from	*ConfigMapEnvSource	false
secretRef	The Secret to select from	*SecretEnvSource	false

Back to Custom Resources

LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Field	Description	Scheme	Required
name	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	string	false

Back to Custom Resources

NodeSection

NodeSection defines the top level attributes inherited by nodes in the CR.

Field	Description	Scheme	Required
networks	Networks - Instance networks	[]infranetworkv1.IPSetNetwork	false
bmhLabelSelector	BmhLabelSelector allows for a sub-selection of BaremetalHosts based on arbitrary labels for a node.	map[string]string	false
userData	UserData node specific user-data	*corev1.SecretReference	false
networkData	NetworkData node specific network-data	*corev1.SecretReference	false
ansible	Ansible is the group of Ansible related configuration options.	AnsibleOpts	false
hostName	HostName - node name	string	false
managementNetwork	ManagementNetwork - Name of network to use for management (SSH/Ansible)	string	false
ctlplaneInterface	CtlplaneInterface - Interface on the provisioned nodes to use for ctlplane network	string	false

Back to Custom Resources

NodeTemplate

NodeTemplate is a specification of the node attributes that override top level attributes.

Field	Description	Scheme	Required
extraMounts	ExtraMounts containing files which can be mounted into an Ansible Execution Pod	[]storage.VolMounts	false
networks	Networks - Instance networks	[]infranetworkv1.IPSetNetwork	false
userData	UserData node specific user-data	*corev1.SecretReference	false
networkData	NetworkData node specific network-data	*corev1.SecretReference	false
ansibleSSHPrivateKeySecret	AnsibleSSHPrivateKeySecret Name of a private SSH key secret containing private SSH key for connecting to node. The named secret must be of the form: Secret.data.ssh-privatekey: https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets	string	true
managementNetwork	ManagementNetwork - Name of network to use for management (SSH/Ansible)	string	true
ansible	Ansible is the group of Ansible related configuration options.	AnsibleOpts	false

Back to Custom Resources

SecretEnvSource

SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret’s Data field will represent the key-value pairs as environment variables.

Field	Description	Scheme	Required
optional	Specify whether the Secret must be defined	*bool	false

Back to Custom Resources