 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package v1alpha1 contains API Schema definitions for the rabbitmq.com v1alpha1 API group +kubebuilder:object:generate=true +groupName=rabbitmq.com
Index ¶
- Variables
- type Binding
- type BindingList
- type BindingSpec
- type BindingStatus
- type Exchange
- type ExchangeList
- type ExchangeSpec
- type ExchangeStatus
- type Queue
- type QueueList
- type QueueSpec
- type QueueStatus
- type RabbitmqClusterReference
- type User
- type UserList
- type UserSpec
- type UserStatus
- type UserTag
- type Vhost
- type VhostList
- type VhostSpec
- type VhostStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "rabbitmq.com", Version: "v1alpha1"} // 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 ¶
This section is empty.
Types ¶
type Binding ¶ added in v0.2.0
type Binding struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec   BindingSpec   `json:"spec,omitempty"`
	Status BindingStatus `json:"status,omitempty"`
}
    Binding is the Schema for the bindings API
func (*Binding) DeepCopy ¶ added in v0.2.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Binding.
func (*Binding) DeepCopyInto ¶ added in v0.2.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Binding) DeepCopyObject ¶ added in v0.2.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BindingList ¶ added in v0.2.0
type BindingList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Binding `json:"items"`
}
    BindingList contains a list of Binding
func (*BindingList) DeepCopy ¶ added in v0.2.0
func (in *BindingList) DeepCopy() *BindingList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BindingList.
func (*BindingList) DeepCopyInto ¶ added in v0.2.0
func (in *BindingList) DeepCopyInto(out *BindingList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BindingList) DeepCopyObject ¶ added in v0.2.0
func (in *BindingList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BindingSpec ¶ added in v0.2.0
type BindingSpec struct {
	// Default to vhost '/'
	// +kubebuilder:default:=/
	Vhost string `json:"vhost,omitempty"`
	// +kubebuilder:validation:Optional
	Source string `json:"source,omitempty"`
	// +kubebuilder:validation:Optional
	Destination string `json:"destination,omitempty"`
	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:Enum=exchange;queue
	DestinationType string `json:"destinationType,omitempty"`
	// +kubebuilder:validation:Optional
	RoutingKey string `json:"routingKey,omitempty"`
	// +kubebuilder:validation:Type=object
	// +kubebuilder:pruning:PreserveUnknownFields
	Arguments *runtime.RawExtension `json:"arguments,omitempty"`
	// Reference to the RabbitmqCluster that the exchange will be created in
	// Required property
	// +kubebuilder:validation:Required
	RabbitmqClusterReference RabbitmqClusterReference `json:"rabbitmqClusterReference"`
}
    BindingSpec defines the desired state of Binding
func (*BindingSpec) DeepCopy ¶ added in v0.2.0
func (in *BindingSpec) DeepCopy() *BindingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BindingSpec.
func (*BindingSpec) DeepCopyInto ¶ added in v0.2.0
func (in *BindingSpec) DeepCopyInto(out *BindingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BindingStatus ¶ added in v0.2.0
type BindingStatus struct {
}
    BindingStatus defines the observed state of Binding
func (*BindingStatus) DeepCopy ¶ added in v0.2.0
func (in *BindingStatus) DeepCopy() *BindingStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BindingStatus.
func (*BindingStatus) DeepCopyInto ¶ added in v0.2.0
func (in *BindingStatus) DeepCopyInto(out *BindingStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Exchange ¶ added in v0.2.0
type Exchange struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec   ExchangeSpec   `json:"spec,omitempty"`
	Status ExchangeStatus `json:"status,omitempty"`
}
    Exchange is the Schema for the exchanges API
func (*Exchange) DeepCopy ¶ added in v0.2.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Exchange.
func (*Exchange) DeepCopyInto ¶ added in v0.2.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Exchange) DeepCopyObject ¶ added in v0.2.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ExchangeList ¶ added in v0.2.0
type ExchangeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Exchange `json:"items"`
}
    ExchangeList contains a list of Exchange
func (*ExchangeList) DeepCopy ¶ added in v0.2.0
func (in *ExchangeList) DeepCopy() *ExchangeList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExchangeList.
func (*ExchangeList) DeepCopyInto ¶ added in v0.2.0
func (in *ExchangeList) DeepCopyInto(out *ExchangeList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ExchangeList) DeepCopyObject ¶ added in v0.2.0
func (in *ExchangeList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ExchangeSpec ¶ added in v0.2.0
type ExchangeSpec struct {
	// +kubebuilder:validation:Required
	Name string `json:"name"`
	// Default to vhost '/'
	// +kubebuilder:default:=/
	Vhost string `json:"vhost,omitempty"`
	// +kubebuilder:validation:Enum=direct;fanout;headers;topic
	// +kubebuilder:default:=direct
	Type       string `json:"type,omitempty"`
	Durable    bool   `json:"durable,omitempty"`
	AutoDelete bool   `json:"autoDelete,omitempty"`
	// +kubebuilder:validation:Type=object
	// +kubebuilder:pruning:PreserveUnknownFields
	Arguments *runtime.RawExtension `json:"arguments,omitempty"`
	// Reference to the RabbitmqCluster that the exchange will be created in
	// Required property
	// +kubebuilder:validation:Required
	RabbitmqClusterReference RabbitmqClusterReference `json:"rabbitmqClusterReference"`
}
    ExchangeSpec defines the desired state of Exchange
func (*ExchangeSpec) DeepCopy ¶ added in v0.2.0
func (in *ExchangeSpec) DeepCopy() *ExchangeSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExchangeSpec.
func (*ExchangeSpec) DeepCopyInto ¶ added in v0.2.0
func (in *ExchangeSpec) DeepCopyInto(out *ExchangeSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExchangeStatus ¶ added in v0.2.0
type ExchangeStatus struct {
}
    ExchangeStatus defines the observed state of Exchange
func (*ExchangeStatus) DeepCopy ¶ added in v0.2.0
func (in *ExchangeStatus) DeepCopy() *ExchangeStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExchangeStatus.
func (*ExchangeStatus) DeepCopyInto ¶ added in v0.2.0
func (in *ExchangeStatus) DeepCopyInto(out *ExchangeStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Queue ¶ added in v0.2.0
type Queue struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec   QueueSpec   `json:"spec,omitempty"`
	Status QueueStatus `json:"status,omitempty"`
}
    Queue is the Schema for the queues API
func (*Queue) DeepCopy ¶ added in v0.2.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Queue.
func (*Queue) DeepCopyInto ¶ added in v0.2.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Queue) DeepCopyObject ¶ added in v0.2.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type QueueList ¶ added in v0.2.0
type QueueList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Queue `json:"items"`
}
    QueueList contains a list of Queue
func (*QueueList) DeepCopy ¶ added in v0.2.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new QueueList.
func (*QueueList) DeepCopyInto ¶ added in v0.2.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*QueueList) DeepCopyObject ¶ added in v0.2.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type QueueSpec ¶ added in v0.2.0
type QueueSpec struct {
	// Name of the queue; required property
	// +kubebuilder:validation:Required
	Name string `json:"name"`
	// Default to vhost '/'
	// +kubebuilder:default:=/
	Vhost string `json:"vhost,omitempty"`
	Type  string `json:"type,omitempty"`
	// When set to false queues does not survive server restart
	Durable bool `json:"durable,omitempty"`
	// when set to true, queues that has at least one consumer before, are deleted after last consumer unsubscribes
	AutoDelete bool `json:"autoDelete,omitempty"`
	// Queue arguments in the format of KEY: VALUE. e.g. x-delivery-limit: 10000
	// +kubebuilder:validation:Type=object
	// +kubebuilder:pruning:PreserveUnknownFields
	Arguments *runtime.RawExtension `json:"arguments,omitempty"`
	// Reference to the RabbitmqCluster that the queue will be created in
	// Required property
	// +kubebuilder:validation:Required
	RabbitmqClusterReference RabbitmqClusterReference `json:"rabbitmqClusterReference"`
}
    QueueSpec defines the desired state of Queue
func (*QueueSpec) DeepCopy ¶ added in v0.2.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new QueueSpec.
func (*QueueSpec) DeepCopyInto ¶ added in v0.2.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type QueueStatus ¶ added in v0.2.0
type QueueStatus struct {
}
    QueueStatus defines the observed state of Queue
func (*QueueStatus) DeepCopy ¶ added in v0.2.0
func (in *QueueStatus) DeepCopy() *QueueStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new QueueStatus.
func (*QueueStatus) DeepCopyInto ¶ added in v0.2.0
func (in *QueueStatus) DeepCopyInto(out *QueueStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RabbitmqClusterReference ¶ added in v0.2.0
type RabbitmqClusterReference struct {
	// +kubebuilder:validation:Required
	Name string `json:"name"`
	// +kubebuilder:validation:Required
	Namespace string `json:"namespace"`
}
    func (*RabbitmqClusterReference) DeepCopy ¶ added in v0.2.0
func (in *RabbitmqClusterReference) DeepCopy() *RabbitmqClusterReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RabbitmqClusterReference.
func (*RabbitmqClusterReference) DeepCopyInto ¶ added in v0.2.0
func (in *RabbitmqClusterReference) DeepCopyInto(out *RabbitmqClusterReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type User ¶ added in v0.3.0
type User struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Spec configures the desired state of the User object.
	Spec UserSpec `json:"spec,omitempty"`
	// Status exposes the observed state of the User object.
	Status UserStatus `json:"status,omitempty"`
}
    User is the Schema for the users API. +kubebuilder:subresource:status
func (*User) DeepCopy ¶ added in v0.3.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new User.
func (*User) DeepCopyInto ¶ added in v0.3.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*User) DeepCopyObject ¶ added in v0.3.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UserList ¶ added in v0.3.0
type UserList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []User `json:"items"`
}
    UserList contains a list of Users.
func (*UserList) DeepCopy ¶ added in v0.3.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserList.
func (*UserList) DeepCopyInto ¶ added in v0.3.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UserList) DeepCopyObject ¶ added in v0.3.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UserSpec ¶ added in v0.3.0
type UserSpec struct {
	// Username of the user to create on a RabbitmqCluster.
	// +kubebuilder:validation:Required
	Name string `json:"name"`
	// List of permissions tags to associate with the user. This determines the level of
	// access to the RabbitMQ management UI granted to the user. Omitting this field will
	// lead to a user than can still connect to the cluster through messaging protocols,
	// but cannot perform any management actions.
	// For more information, see https://www.rabbitmq.com/management.html#permissions.
	Tags []UserTag `json:"tags,omitempty"`
	// Reference to the RabbitmqCluster that the user will be created for. This cluster must
	// exist for the User object to be created.
	// +kubebuilder:validation:Required
	RabbitmqClusterReference RabbitmqClusterReference `json:"rabbitmqClusterReference"`
}
    UserSpec defines the desired state of User.
func (*UserSpec) DeepCopy ¶ added in v0.3.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserSpec.
func (*UserSpec) DeepCopyInto ¶ added in v0.3.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UserStatus ¶ added in v0.3.0
type UserStatus struct {
	// Provides a reference to a Secret object containing the user credentials.
	Credentials *corev1.LocalObjectReference `json:"credentials,omitempty"`
}
    UserStatus defines the observed state of User.
func (*UserStatus) DeepCopy ¶ added in v0.3.0
func (in *UserStatus) DeepCopy() *UserStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserStatus.
func (*UserStatus) DeepCopyInto ¶ added in v0.3.0
func (in *UserStatus) DeepCopyInto(out *UserStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UserTag ¶ added in v0.3.0
type UserTag string
UserTag defines the level of access to the management UI allocated to the user. For more information, see https://www.rabbitmq.com/management.html#permissions. +kubebuilder:validation:Enum=management;policymaker;monitoring;administrator
type Vhost ¶ added in v0.3.0
type Vhost struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec   VhostSpec   `json:"spec,omitempty"`
	Status VhostStatus `json:"status,omitempty"`
}
    Vhost is the Schema for the vhosts API
func (*Vhost) DeepCopy ¶ added in v0.3.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Vhost.
func (*Vhost) DeepCopyInto ¶ added in v0.3.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Vhost) DeepCopyObject ¶ added in v0.3.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type VhostList ¶ added in v0.3.0
type VhostList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Vhost `json:"items"`
}
    VhostList contains a list of Vhost
func (*VhostList) DeepCopy ¶ added in v0.3.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VhostList.
func (*VhostList) DeepCopyInto ¶ added in v0.3.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VhostList) DeepCopyObject ¶ added in v0.3.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type VhostSpec ¶ added in v0.3.0
type VhostSpec struct {
	// Name of the vhost; see https://www.rabbitmq.com/vhosts.html.
	// +kubebuilder:validation:Required
	Name    string `json:"name"`
	Tracing bool   `json:"tracing,omitempty"`
	// Reference to the RabbitmqCluster that the vhost will be created in
	// Required property
	// +kubebuilder:validation:Required
	RabbitmqClusterReference RabbitmqClusterReference `json:"rabbitmqClusterReference"`
}
    VhostSpec defines the desired state of Vhost
func (*VhostSpec) DeepCopy ¶ added in v0.3.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VhostSpec.
func (*VhostSpec) DeepCopyInto ¶ added in v0.3.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VhostStatus ¶ added in v0.3.0
type VhostStatus struct {
}
    VhostStatus defines the observed state of Vhost
func (*VhostStatus) DeepCopy ¶ added in v0.3.0
func (in *VhostStatus) DeepCopy() *VhostStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VhostStatus.
func (*VhostStatus) DeepCopyInto ¶ added in v0.3.0
func (in *VhostStatus) DeepCopyInto(out *VhostStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.