Documentation
¶
Overview ¶
Package v1beta1 contains API Schema definitions for the rabbitmq v1beta1 API group +kubebuilder:object:generate=true +groupName=rabbitmq.openstack.org
Index ¶
- Constants
- Variables
- func SetupDefaults()
- func SetupRabbitMqDefaults(defaults RabbitMqDefaults)
- type RabbitMq
- func (in *RabbitMq) DeepCopy() *RabbitMq
- func (in *RabbitMq) DeepCopyInto(out *RabbitMq)
- func (in *RabbitMq) DeepCopyObject() runtime.Object
- func (r *RabbitMq) Default()
- func (instance RabbitMq) GetLastAppliedTopologyRef() *topologyv1.TopoRef
- func (instance RabbitMq) IsReady() bool
- func (instance RabbitMq) RbacConditionsSet(c *condition.Condition)
- func (instance RabbitMq) RbacNamespace() string
- func (instance RabbitMq) RbacResourceName() string
- func (r *RabbitMq) SetupWebhookWithManager(mgr ctrl.Manager) error
- func (r *RabbitMq) ValidateCreate() (admission.Warnings, error)
- func (r *RabbitMq) ValidateDelete() (admission.Warnings, error)
- func (r *RabbitMq) ValidateUpdate(_ runtime.Object) (admission.Warnings, error)
- type RabbitMqDefaults
- type RabbitMqList
- type RabbitMqSpec
- type RabbitMqSpecCore
- func (in *RabbitMqSpecCore) DeepCopy() *RabbitMqSpecCore
- func (in *RabbitMqSpecCore) DeepCopyInto(out *RabbitMqSpecCore)
- func (spec *RabbitMqSpecCore) Default()
- func (r *RabbitMqSpecCore) ValidateCreate(basePath *field.Path, namespace string) field.ErrorList
- func (r *RabbitMqSpecCore) ValidateUpdate(old RabbitMqSpecCore, basePath *field.Path, namespace string) field.ErrorList
- type RabbitMqStatus
- type TransportURL
- type TransportURLList
- type TransportURLSpec
- type TransportURLStatus
Constants ¶
const ( // TransportURLReadyErrorMessage TransportURLReadyErrorMessage = "TransportURL error occured %s" // TransportURLReadyInitMessage TransportURLReadyInitMessage = "TransportURL not configured" // TransportURLReadyMessage TransportURLReadyMessage = "TransportURL completed" // TransportURLInProgressMessage TransportURLInProgressMessage = "TransportURL in progress" )
Common Messages used by API objects.
const ( // RabbitMqContainerImage is the fall-back container image for RabbitMQ RabbitMqContainerImage = "quay.io/podified-antelope-centos9/openstack-rabbitmq:current-podified" // CrMaxLengthCorrection - DNS1123LabelMaxLength (63) - CrMaxLengthCorrection used in validation to // omit issue with statefulset pod label "controller-revision-hash": "<statefulset_name>-<hash>" // Int32 is a 10 character + hyphen = 11 CrMaxLengthCorrection = 11 )
const ( // TransportURLReadyCondition Status=True condition which indicates if TransportURL is configured and operational TransportURLReadyCondition condition.Type = "TransportURLReady" )
TransportURL Condition Types used by API objects.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "rabbitmq.openstack.org", Version: "v1beta1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func SetupDefaults ¶ added in v0.6.0
func SetupDefaults()
SetupDefaults - initializes any CRD field defaults based on environment variables (the defaulting mechanism itself is implemented via webhooks)
func SetupRabbitMqDefaults ¶ added in v0.6.0
func SetupRabbitMqDefaults(defaults RabbitMqDefaults)
SetupRabbitMqDefaults - initialize RabbitMq spec defaults for use with either internal or external webhooks
Types ¶
type RabbitMq ¶ added in v0.6.0
type RabbitMq struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec RabbitMqSpec `json:"spec,omitempty"` Status RabbitMqStatus `json:"status,omitempty"` }
RabbitMq is the Schema for the rabbitmqs API
func (*RabbitMq) DeepCopy ¶ added in v0.6.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RabbitMq.
func (*RabbitMq) DeepCopyInto ¶ added in v0.6.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RabbitMq) DeepCopyObject ¶ added in v0.6.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*RabbitMq) Default ¶ added in v0.6.0
func (r *RabbitMq) Default()
Default implements webhook.Defaulter so a webhook will be registered for the type
func (RabbitMq) GetLastAppliedTopologyRef ¶ added in v0.6.0
func (instance RabbitMq) GetLastAppliedTopologyRef() *topologyv1.TopoRef
GetLastAppliedTopologyRef - Returns the lastAppliedTopologyName that can be processed by the handle topology logic
func (RabbitMq) IsReady ¶ added in v0.6.0
IsReady - returns true if service is ready to serve requests
func (RabbitMq) RbacConditionsSet ¶ added in v0.6.0
RbacConditionsSet - set the conditions for the rbac object
func (RabbitMq) RbacNamespace ¶ added in v0.6.0
RbacNamespace - return the namespace
func (RabbitMq) RbacResourceName ¶ added in v0.6.0
RbacResourceName - return the name to be used for rbac objects (serviceaccount, role, rolebinding)
func (*RabbitMq) SetupWebhookWithManager ¶ added in v0.6.0
SetupWebhookWithManager sets up the webhook with the Manager
func (*RabbitMq) ValidateCreate ¶ added in v0.6.0
ValidateCreate implements webhook.Validator so a webhook will be registered for the type
func (*RabbitMq) ValidateDelete ¶ added in v0.6.0
ValidateDelete implements webhook.Validator so a webhook will be registered for the type
type RabbitMqDefaults ¶ added in v0.6.0
type RabbitMqDefaults struct {
ContainerImageURL string
}
RabbitMqDefaults -
func (*RabbitMqDefaults) DeepCopy ¶ added in v0.6.0
func (in *RabbitMqDefaults) DeepCopy() *RabbitMqDefaults
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RabbitMqDefaults.
func (*RabbitMqDefaults) DeepCopyInto ¶ added in v0.6.0
func (in *RabbitMqDefaults) DeepCopyInto(out *RabbitMqDefaults)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RabbitMqList ¶ added in v0.6.0
type RabbitMqList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []RabbitMq `json:"items"` }
RabbitMqList contains a list of RabbitMq
func (*RabbitMqList) DeepCopy ¶ added in v0.6.0
func (in *RabbitMqList) DeepCopy() *RabbitMqList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RabbitMqList.
func (*RabbitMqList) DeepCopyInto ¶ added in v0.6.0
func (in *RabbitMqList) DeepCopyInto(out *RabbitMqList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RabbitMqList) DeepCopyObject ¶ added in v0.6.0
func (in *RabbitMqList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RabbitMqSpec ¶ added in v0.6.0
type RabbitMqSpec struct { RabbitMqSpecCore `json:",inline"` // +kubebuilder:validation:Required // Name of the rabbitmq container image to run (will be set to environmental default if empty) ContainerImage string `json:"containerImage"` }
RabbitMqSpec defines the desired state of RabbitMq
func (*RabbitMqSpec) DeepCopy ¶ added in v0.6.0
func (in *RabbitMqSpec) DeepCopy() *RabbitMqSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RabbitMqSpec.
func (*RabbitMqSpec) DeepCopyInto ¶ added in v0.6.0
func (in *RabbitMqSpec) DeepCopyInto(out *RabbitMqSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RabbitMqSpec) Default ¶ added in v0.6.0
func (spec *RabbitMqSpec) Default()
Default - set defaults for this RabbitMq spec
func (*RabbitMqSpec) MarshalInto ¶ added in v0.6.0
func (in *RabbitMqSpec) MarshalInto(out *rabbitmqv2.RabbitmqClusterSpec) error
Method to convert RabbitMqSpec to RabbitmqClusterSpec Need to Marshal/Unmarshal to convert rabbitmqv2.RabbitmqClusterSpecCore to rabbitmqv2.RabbitmqClusterSpec as they are distinct types instead of inlined.
type RabbitMqSpecCore ¶ added in v0.6.0
type RabbitMqSpecCore struct { // +kubebuilder:validation:Required // +operator-sdk:csv:customresourcedefinitions:type=spec // Overrides to use when creating the Rabbitmq clusters rabbitmqv2.RabbitmqClusterSpecCore `json:",inline"` // +kubebuilder:validation:Optional // +operator-sdk:csv:customresourcedefinitions:type=spec // NodeSelector to target subset of worker nodes running this service NodeSelector *map[string]string `json:"nodeSelector,omitempty"` // +kubebuilder:validation:Optional // TopologyRef to apply the Topology defined by the associated CR referenced // by name TopologyRef *topologyv1.TopoRef `json:"topologyRef,omitempty"` }
RabbitMqSpecCore - this version is used by the OpenStackControlplane CR (no container images)
func (*RabbitMqSpecCore) DeepCopy ¶ added in v0.6.0
func (in *RabbitMqSpecCore) DeepCopy() *RabbitMqSpecCore
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RabbitMqSpecCore.
func (*RabbitMqSpecCore) DeepCopyInto ¶ added in v0.6.0
func (in *RabbitMqSpecCore) DeepCopyInto(out *RabbitMqSpecCore)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RabbitMqSpecCore) Default ¶ added in v0.6.0
func (spec *RabbitMqSpecCore) Default()
Default - common validations go here (for the OpenStackControlplane which uses this one)
func (*RabbitMqSpecCore) ValidateCreate ¶ added in v0.6.0
func (*RabbitMqSpecCore) ValidateUpdate ¶ added in v0.6.0
func (r *RabbitMqSpecCore) ValidateUpdate(old RabbitMqSpecCore, basePath *field.Path, namespace string) field.ErrorList
type RabbitMqStatus ¶ added in v0.6.0
type RabbitMqStatus struct { // Conditions Conditions condition.Conditions `json:"conditions,omitempty" optional:"true"` // 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) ObservedGeneration int64 `json:"observedGeneration,omitempty"` // LastAppliedTopology - the last applied Topology LastAppliedTopology *topologyv1.TopoRef `json:"lastAppliedTopology,omitempty"` }
RabbitMqStatus defines the observed state of RabbitMq
func (*RabbitMqStatus) DeepCopy ¶ added in v0.6.0
func (in *RabbitMqStatus) DeepCopy() *RabbitMqStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RabbitMqStatus.
func (*RabbitMqStatus) DeepCopyInto ¶ added in v0.6.0
func (in *RabbitMqStatus) DeepCopyInto(out *RabbitMqStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportURL ¶
type TransportURL struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec TransportURLSpec `json:"spec,omitempty"` Status TransportURLStatus `json:"status,omitempty"` }
TransportURL is the Schema for the transporturls API
func (*TransportURL) DeepCopy ¶
func (in *TransportURL) DeepCopy() *TransportURL
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportURL.
func (*TransportURL) DeepCopyInto ¶
func (in *TransportURL) DeepCopyInto(out *TransportURL)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TransportURL) DeepCopyObject ¶
func (in *TransportURL) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (TransportURL) IsReady ¶
func (instance TransportURL) IsReady() bool
IsReady - returns true if service is ready to serve requests
type TransportURLList ¶
type TransportURLList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []TransportURL `json:"items"` }
TransportURLList contains a list of TransportURL
func (*TransportURLList) DeepCopy ¶
func (in *TransportURLList) DeepCopy() *TransportURLList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportURLList.
func (*TransportURLList) DeepCopyInto ¶
func (in *TransportURLList) DeepCopyInto(out *TransportURLList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TransportURLList) DeepCopyObject ¶
func (in *TransportURLList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TransportURLSpec ¶
type TransportURLSpec struct { // +kubebuilder:validation:Required // RabbitmqClusterName the name of the Rabbitmq cluster which to configure the transport URL RabbitmqClusterName string `json:"rabbitmqClusterName"` }
TransportURLSpec defines the desired state of TransportURL
func (*TransportURLSpec) DeepCopy ¶
func (in *TransportURLSpec) DeepCopy() *TransportURLSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportURLSpec.
func (*TransportURLSpec) DeepCopyInto ¶
func (in *TransportURLSpec) DeepCopyInto(out *TransportURLSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportURLStatus ¶
type TransportURLStatus struct { // Conditions Conditions condition.Conditions `json:"conditions,omitempty" optional:"true"` // SecretName - name of the secret containing the rabbitmq transport URL SecretName string `json:"secretName,omitempty"` // 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) ObservedGeneration int64 `json:"observedGeneration,omitempty"` }
TransportURLStatus defines the observed state of TransportURL
func (*TransportURLStatus) DeepCopy ¶
func (in *TransportURLStatus) DeepCopy() *TransportURLStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportURLStatus.
func (*TransportURLStatus) DeepCopyInto ¶
func (in *TransportURLStatus) DeepCopyInto(out *TransportURLStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.