API_Reference_v1.7.0

API Reference

Packages

• rabbitmq.com/v1alpha1

• rabbitmq.com/v1beta1

rabbitmq.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the rabbitmq.com v1alpha1 API group

Resource Types

• SuperStream

• SuperStreamList

Definitions

SuperStream

SuperStream is the Schema for the queues API

Appears In:

• SuperStreamList

Field	Description
apiVersion string	rabbitmq.com/v1alpha1
kind string	SuperStream
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec SuperStreamSpec
status SuperStreamStatus

SuperStreamList

SuperStreamList contains a list of SuperStreams

Field	Description
apiVersion string	rabbitmq.com/v1alpha1
kind string	SuperStreamList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items SuperStream array

SuperStreamSpec

SuperStreamSpec defines the desired state of SuperStream

Appears In:

• SuperStream

Field	Description
name string	Name of the queue; required property.
vhost string	Default to vhost '/'; cannot be updated
partitions integer	Number of partitions to create within this super stream. Defaults to '3'.
routingKeys string array	Routing keys to use for each of the partitions in the SuperStream If unset, the routing keys for the partitions will be set to the index of the partitions
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that the SuperStream will be created in. Required property.

SuperStreamStatus

SuperStreamStatus defines the observed state of SuperStream

Appears In:

• SuperStream

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this SuperStream. It corresponds to the SuperStream’s generation, which is updated on mutation by the API Server.
conditions Condition array
partitions string array	Partitions are a list of the stream queue names which form the partitions of this SuperStream.

rabbitmq.com/v1beta1

Package v1beta1 contains API Schema definitions for the rabbitmq.com v1beta1 API group

Resource Types

• Binding

• BindingList

• Exchange

• ExchangeList

• Federation

• FederationList

• Permission

• PermissionList

• Policy

• PolicyList

• Queue

• QueueList

• SchemaReplication

• SchemaReplicationList

• Shovel

• ShovelList

• User

• UserList

• Vhost

• VhostList

Definitions

Binding

Binding is the Schema for the bindings API

Appears In:

• BindingList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	Binding
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec BindingSpec
status BindingStatus

BindingList

BindingList contains a list of Binding

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	BindingList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Binding array

BindingSpec

BindingSpec defines the desired state of Binding

Appears In:

• Binding

Field	Description
vhost string	Default to vhost '/'; cannot be updated
source string	Cannot be updated
destination string	Cannot be updated
destinationType string	Cannot be updated
routingKey string	Cannot be updated
arguments RawExtension	Cannot be updated
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that the binding will be created in. Required property.

BindingStatus

BindingStatus defines the observed state of Binding

Appears In:

• Binding

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this Binding. It corresponds to the Binding’s generation, which is updated on mutation by the API Server.
conditions Condition array

Condition

Appears In:

• BindingStatus

• ExchangeStatus

• FederationStatus

• PermissionStatus

• PolicyStatus

• QueueStatus

• SchemaReplicationStatus

• ShovelStatus

• SuperStreamStatus

• UserStatus

• VhostStatus

Field	Description
type ConditionType	Type indicates the scope of the custom resource status addressed by the condition.
status ConditionStatus	True, False, or Unknown
lastTransitionTime Time	The last time this Condition status changed.
reason string	One word, camel-case reason for current status of the condition.
message string	Full text reason for current status of the condition.

ConditionType (string)

Appears In:

• Condition

Exchange

Exchange is the Schema for the exchanges API

Appears In:

• ExchangeList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	Exchange
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ExchangeSpec
status ExchangeStatus

ExchangeList

ExchangeList contains a list of Exchange

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	ExchangeList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Exchange array

ExchangeSpec

ExchangeSpec defines the desired state of Exchange

Appears In:

• Exchange

Field	Description
name string	Required property; cannot be updated
vhost string	Default to vhost '/'; cannot be updated
type string	Cannot be updated
durable boolean	Cannot be updated
autoDelete boolean	Cannot be updated
arguments RawExtension
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that the exchange will be created in. Required property.

ExchangeStatus

ExchangeStatus defines the observed state of Exchange

Appears In:

• Exchange

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this Exchange. It corresponds to the Exchange’s generation, which is updated on mutation by the API Server.
conditions Condition array

Federation

Federation is the Schema for the federations API

Appears In:

• FederationList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	Federation
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec FederationSpec
status FederationStatus

FederationList

FederationList contains a list of Federation

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	FederationList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Federation array

FederationSpec

FederationSpec defines the desired state of Federation For how to configure federation upstreams, see: https://www.rabbitmq.com/federation-reference.html.

Appears In:

• Federation

Field	Description
name string	Required property; cannot be updated
vhost string	Default to vhost '/'; cannot be updated
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that this federation upstream will be created in. Required property.
uriSecret LocalObjectReference	Secret contains the AMQP URI(s) for the upstream. The Secret must contain the key uri or operator will error. uri should be one or multiple uris separated by ','. Required property.
prefetch-count integer
ackMode string
expires integer
messageTTL integer
maxHops integer
reconnectDelay integer
trustUserId boolean
exchange string
queue string

FederationStatus

FederationStatus defines the observed state of Federation

Appears In:

• Federation

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this Federation. It corresponds to the Federation’s generation, which is updated on mutation by the API Server.
conditions Condition array

Permission

Permission is the Schema for the permissions API

Appears In:

• PermissionList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	Permission
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec PermissionSpec
status PermissionStatus

PermissionList

PermissionList contains a list of Permission

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	PermissionList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Permission array

PermissionSpec

PermissionSpec defines the desired state of Permission

Appears In:

• Permission

Field	Description
user string	Name of an existing user; must provide user or userReference, else create/update will fail; cannot be updated
userReference LocalObjectReference	Reference to an existing user.rabbitmq.com object; must provide user or userReference, else create/update will fail; cannot be updated
vhost string	Name of an existing vhost; required property; cannot be updated
permissions VhostPermissions	Permissions to grant to the user in the specific vhost; required property. See RabbitMQ doc for more information: https://www.rabbitmq.com/access-control.html#user-management
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that both the provided user and vhost are. Required property.

PermissionStatus

PermissionStatus defines the observed state of Permission

Appears In:

• Permission

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this Permission. It corresponds to the Permission’s generation, which is updated on mutation by the API Server.
conditions Condition array

Policy

Policy is the Schema for the policies API

Appears In:

• PolicyList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	Policy
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec PolicySpec
status PolicyStatus

PolicyList

PolicyList contains a list of Policy

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	PolicyList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Policy array

PolicySpec

PolicySpec defines the desired state of Policy https://www.rabbitmq.com/parameters.html#policies

Appears In:

• Policy

Field	Description
name string	Required property; cannot be updated
vhost string	Default to vhost '/'; cannot be updated
pattern string	Regular expression pattern used to match queues and exchanges, e.g. "^amq.". Required property.
applyTo string	What this policy applies to: 'queues', 'exchanges', or 'all'. Default to 'all'.
priority integer	Default to '0'. In the event that more than one policy can match a given exchange or queue, the policy with the greatest priority applies.
definition RawExtension	Policy definition. Required property.
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that the exchange will be created in. Required property.

PolicyStatus

PolicyStatus defines the observed state of Policy

Appears In:

• Policy

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this Policy. It corresponds to the Policy’s generation, which is updated on mutation by the API Server.
conditions Condition array

Queue

Queue is the Schema for the queues API

Appears In:

• QueueList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	Queue
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec QueueSpec
status QueueStatus

QueueList

QueueList contains a list of Queue

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	QueueList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Queue array

QueueSpec

QueueSpec defines the desired state of Queue

Appears In:

• Queue

Field	Description
name string	Name of the queue; required property.
vhost string	Default to vhost '/'
type string
durable boolean	When set to false queues does not survive server restart.
autoDelete boolean	when set to true, queues that have had at least one consumer before are deleted after the last consumer unsubscribes.
arguments RawExtension	Queue arguments in the format of KEY: VALUE. e.g. x-delivery-limit: 10000. Configuring queues through arguments is not recommended because they cannot be updated once set; we recommend configuring queues through policies instead.
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that the queue will be created in. Required property.

QueueStatus

QueueStatus defines the observed state of Queue

Appears In:

• Queue

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this Queue. It corresponds to the Queue’s generation, which is updated on mutation by the API Server.
conditions Condition array

RabbitmqClusterReference

Appears In:

• BindingSpec

• ExchangeSpec

• FederationSpec

• PermissionSpec

• PolicySpec

• QueueSpec

• SchemaReplicationSpec

• ShovelSpec

• SuperStreamSpec

• UserSpec

• VhostSpec

Field	Description
name string	The name of the RabbitMQ cluster to reference. Have to set either name or connectionSecret, but not both.
namespace string	The namespace of the RabbitMQ cluster to reference. Defaults to the namespace of the requested resource if omitted.
connectionSecret LocalObjectReference	Secret contains the http management uri for the RabbitMQ cluster. The Secret must contain the key uri, username and password or operator will error. Have to set either name or connectionSecret, but not both.

SchemaReplication

SchemaReplication is the Schema for the schemareplications API This feature requires Tanzu RabbitMQ with schema replication plugin. For more information, see: https://tanzu.vmware.com/rabbitmq and https://www.rabbitmq.com/definitions-standby.html.

Appears In:

• SchemaReplicationList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	SchemaReplication
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec SchemaReplicationSpec
status SchemaReplicationStatus

SchemaReplicationList

SchemaReplicationList contains a list of SchemaReplication

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	SchemaReplicationList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items SchemaReplication array

SchemaReplicationSpec

SchemaReplicationSpec defines the desired state of SchemaReplication

Appears In:

• SchemaReplication

Field	Description
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that schema replication would be set for. Must be an existing cluster.
upstreamSecret LocalObjectReference	Defines a Secret which contains credentials to be used for schema replication. The Secret must contain the keys username and password in its Data field, or operator will error. Have to set either secretBackend.vault.secretPath or spec.upstreamSecret, but not both.
endpoints string	endpoints should be one or multiple endpoints separated by ','. Must provide either spec.endpoints or endpoints in spec.upstreamSecret. When endpoints are provided in both spec.endpoints and spec.upstreamSecret, spec.endpoints takes precedence.
secretBackend SecretBackend	Set to fetch user credentials from K8s external secret stores to be used for schema replication.

SchemaReplicationStatus

SchemaReplicationStatus defines the observed state of SchemaReplication

Appears In:

• SchemaReplication

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this Queue. It corresponds to the Queue’s generation, which is updated on mutation by the API Server.
conditions Condition array

SecretBackend

SecretBackend configures a single secret backend. Today, only Vault exists as supported secret backend.

Appears In:

• SchemaReplicationSpec

Field	Description
vault VaultSpec

Shovel

Shovel is the Schema for the shovels API

Appears In:

• ShovelList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	Shovel
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ShovelSpec
status ShovelStatus

ShovelList

ShovelList contains a list of Shovel

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	ShovelList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Shovel array

ShovelSpec

ShovelSpec defines the desired state of Shovel For how to configure Shovel, see: https://www.rabbitmq.com/shovel.html.

Appears In:

• Shovel

Field	Description
name string	Required property; cannot be updated
vhost string	Default to vhost '/'; cannot be updated
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that this Shovel will be created in. Required property.
uriSecret LocalObjectReference	Secret contains the AMQP URI(s) to configure Shovel destination and source. The Secret must contain the key destUri and srcUri or operator will error. Both fields should be one or multiple uris separated by ','. Required property.
ackMode string
addForwardHeaders boolean
deleteAfter string
destAddForwardHeaders boolean
destAddTimestampHeader boolean
destAddress string
destApplicationProperties string
destExchange string
destExchangeKey string
destProperties string
destProtocol string
destPublishProperties string
destQueue string
prefetchCount integer
reconnectDelay integer
srcAddress string
srcDeleteAfter string
srcExchange string
srcExchangeKey string
srcPrefetchCount integer
srcProtocol string
srcQueue string

ShovelStatus

ShovelStatus defines the observed state of Shovel

Appears In:

• Shovel

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this Shovel. It corresponds to the Shovel’s generation, which is updated on mutation by the API Server.
conditions Condition array

User

User is the Schema for the users API.

Appears In:

• UserList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	User
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec UserSpec	Spec configures the desired state of the User object.
status UserStatus	Status exposes the observed state of the User object.

UserList

UserList contains a list of Users.

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	UserList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items User array

UserSpec

UserSpec defines the desired state of User.

Appears In:

• User

Field	Description
tags UserTag array	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.
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that the user will be created for. This cluster must exist for the User object to be created.
importCredentialsSecret LocalObjectReference	Defines a Secret used to pre-define the username and password set for this User. User objects created with this field set will not have randomly-generated credentials, and will instead import the username/password values from this Secret. The Secret must contain the keys username and password in its Data field, or the import will fail. Note that this import only occurs at creation time, and is ignored once a password has been set on a User.

UserStatus

UserStatus defines the observed state of User.

Appears In:

• User

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this User. It corresponds to the User’s generation, which is updated on mutation by the API Server.
conditions Condition array
credentials LocalObjectReference	Provides a reference to a Secret object containing the user credentials.
username string	Provide rabbitmq Username

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.

Appears In:

• UserSpec

VaultSpec

Appears In:

• SecretBackend

Field	Description
secretPath string	Path in Vault to access a KV (Key-Value) secret with the fields username and password to be used for replication. For example "secret/data/rabbitmq/config". Optional; if not provided, username and password will come from upstreamSecret instead. Have to set either secretBackend.vault.secretPath or upstreamSecret, but not both.

Vhost

Vhost is the Schema for the vhosts API

Appears In:

• VhostList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	Vhost
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec VhostSpec
status VhostStatus

VhostList

VhostList contains a list of Vhost

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	VhostList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Vhost array

VhostPermissions

Set of RabbitMQ permissions: configure, read and write. By not setting a property (configure/write/read), it result in an empty string which does not not match any permission.

Appears In:

• PermissionSpec

Field	Description
configure string
write string
read string

VhostSpec

VhostSpec defines the desired state of Vhost

Appears In:

• Vhost

Field	Description
name string	Name of the vhost; see https://www.rabbitmq.com/vhosts.html.
tracing boolean
tags string array
rabbitmqClusterReference RabbitmqClusterReference	Reference to the RabbitmqCluster that the vhost will be created in. Required property.

VhostStatus

VhostStatus defines the observed state of Vhost

Appears In:

• Vhost

Field	Description
observedGeneration integer	observedGeneration is the most recent successful generation observed for this Vhost. It corresponds to the Vhost’s generation, which is updated on mutation by the API Server.
conditions Condition array