Skip to content

API_Reference_v1.17.2

Jump to bottom
github-actions[bot] edited this page Jun 27, 2025 · 1 revision

API Reference

rabbitmq.com/v1alpha1

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

Resource Types

Definitions

SuperStream

SuperStream is the Schema for the queues API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1alpha1

kind string

SuperStream

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

SuperStreamList

SuperStreamList contains a list of SuperStreams

Field Description

apiVersion string

rabbitmq.com/v1alpha1

kind string

SuperStreamList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items SuperStream array

SuperStreamSpec

SuperStreamSpec defines the desired state of SuperStream

Appears In:
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:
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

Definitions

Binding

Binding is the Schema for the bindings API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

Binding

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

status BindingStatus

BindingList

BindingList contains a list of Binding

Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

BindingList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Binding array

BindingSpec

BindingSpec defines the desired state of Binding

Appears In:
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:
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

Field Description

Type indicates the scope of the custom resource status addressed by the condition.

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:

Exchange

Exchange is the Schema for the exchanges API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

Exchange

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

ExchangeList

ExchangeList contains a list of Exchange

Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

ExchangeList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Exchange array

ExchangeSpec

ExchangeSpec defines the desired state of Exchange

Appears In:
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:
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:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

Federation

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

FederationList

FederationList contains a list of Federation

Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

FederationList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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:
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.

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

deletionPolicy string

DeletionPolicy defines the behavior of federation in the RabbitMQ cluster when the corresponding custom resource is deleted. Can be set to 'delete' or 'retain'. Default is 'delete'.

queueType string

The queue type of the internal upstream queue used by exchange federation. Defaults to classic (a single replica queue type). Set to quorum to use a replicated queue type. Changing the queue type will delete and recreate the upstream queue by default. This may lead to messages getting lost or not routed anywhere during the re-declaration. To avoid that, set resource-cleanup-mode key to never. This requires manually deleting the old upstream queue so that it can be recreated with the new type.

resourceCleanupMode string

Whether to delete the internal upstream queue when federation links stop. By default, the internal upstream queue is deleted immediately when a federation link stops. Set to never to keep the upstream queue around and collect messages even when changing federation configuration.

FederationStatus

FederationStatus defines the observed state of Federation

Appears In:
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

OperatorPolicy

OperatorPolicy is the Schema for the operator policies API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

OperatorPolicy

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

OperatorPolicyList

OperatorPolicyList contains a list of OperatorPolicy

Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

OperatorPolicyList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items OperatorPolicy array

OperatorPolicySpec

OperatorPolicySpec defines the desired state of OperatorPolicy https://www.rabbitmq.com/parameters.html#operator-policies

Appears In:
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, e.g. "^my-queue$". Required property.

applyTo string

What this operator policy applies to: 'queues', 'classic_queues', 'quorum_queues', 'streams'. Default to 'queues'.

priority integer

Default to '0'. In the event that more than one operator policy can match a given queue, the operator policy with the greatest priority applies.

definition RawExtension

OperatorPolicy definition. Required property.

rabbitmqClusterReference RabbitmqClusterReference

Reference to the RabbitmqCluster that the operator policy will be created in. Required property.

OperatorPolicyStatus

OperatorPolicyStatus defines the observed state of OperatorPolicy

Appears In:
Field Description

observedGeneration integer

observedGeneration is the most recent successful generation observed for this OperatorPolicy. It corresponds to the OperatorPolicy’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:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

Permission

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

PermissionList

PermissionList contains a list of Permission

Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

PermissionList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Permission array

PermissionSpec

PermissionSpec defines the desired state of Permission

Appears In:
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:
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:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

Policy

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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:
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', 'classic_queues', 'quorum_queues', 'streams', '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 policy will be created in. Required property.

PolicyStatus

PolicyStatus defines the observed state of Policy

Appears In:
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:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

Queue

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Queue array

QueueSpec

QueueSpec defines the desired state of Queue

Appears In:
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.

deleteIfEmpty boolean

when set to true, queues are deleted only if empty.

deleteIfUnused boolean

when set to true, queues are delete only if they have no consumer.

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.

deletionPolicy string

DeletionPolicy defines the behavior of queue in the RabbitMQ cluster when the corresponding custom resource is deleted. Can be set to 'delete' or 'retain'. Default is 'delete'.

QueueStatus

QueueStatus defines the observed state of Queue

Appears In:
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

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:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

SchemaReplication

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

SchemaReplicationList

SchemaReplicationList contains a list of SchemaReplication

Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

SchemaReplicationList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items SchemaReplication array

SchemaReplicationSpec

SchemaReplicationSpec defines the desired state of SchemaReplication

Appears In:
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:
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:
Field Description

vault VaultSpec

Shovel

Shovel is the Schema for the shovels API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

Shovel

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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:
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.

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

prefetchCount integer

reconnectDelay integer

addForwardHeaders boolean

deleteAfter string

srcDeleteAfter string

srcPrefetchCount integer

destAddForwardHeaders boolean

destAddTimestampHeader boolean

srcQueueArgs RawExtension

destQueueArgs RawExtension

destProtocol string

destQueue string

amqp091 configuration

destExchange string

amqp091 configuration

destExchangeKey string

amqp091 configuration

destPublishProperties RawExtension

amqp091 configuration

destAddress string

amqp10 configuration; required if destProtocol is amqp10

destApplicationProperties RawExtension

amqp10 configuration

destProperties RawExtension

amqp10 configuration

destMessageAnnotations RawExtension

amqp10 configuration

srcProtocol string

srcQueue string

amqp091 configuration

srcExchange string

amqp091 configuration

srcExchangeKey string

amqp091 configuration

srcConsumerArgs RawExtension

amqp091 configuration

srcAddress string

amqp10 configuration; required if srcProtocol is amqp10

deletionPolicy string

DeletionPolicy defines the behavior of shovel in the RabbitMQ cluster when the corresponding custom resource is deleted. Can be set to 'delete' or 'retain'. Default is 'delete'.

ShovelStatus

ShovelStatus defines the observed state of Shovel

Appears In:
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

TopicPermission

TopicPermission is the Schema for the topicpermissions API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

TopicPermission

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

TopicPermissionConfig

Appears In:
Field Description

exchange string

Name of a topic exchange; required property; cannot be updated.

read string

write string

TopicPermissionList

TopicPermissionList contains a list of TopicPermission

Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

TopicPermissionList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items TopicPermission array

TopicPermissionSpec

TopicPermissionSpec defines the desired state of TopicPermission

Appears In:
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 TopicPermissionConfig

Permissions to grant to the user to a topic exchange; required property.

rabbitmqClusterReference RabbitmqClusterReference

Reference to the RabbitmqCluster that both the provided user and vhost are. Required property.

TopicPermissionStatus

TopicPermissionStatus defines the observed state of TopicPermission

Appears In:
Field Description

observedGeneration integer

observedGeneration is the most recent successful generation observed for this TopicPermission. It corresponds to the TopicPermission’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:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

User

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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.

UserLimits

Limits to apply to a user to restrict the number of connections and channels the user can create. These limits can be used as guard rails in environments where applications cannot be trusted and monitored in detail, for example, when RabbitMQ clusters are offered as a service. See https://www.rabbitmq.com/docs/user-limits.

Appears In:
Field Description

connections integer

Limits how many connections the user can open.

channels integer

Limits how many AMQP 0.9.1 channels the user can open.

UserList

UserList contains a list of Users.

Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

UserList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items User array

UserSpec

UserSpec defines the desired state of User.

Appears In:
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 containing the credentials for the User. If this field is omitted, random a username and password will be generated. The Secret must have the following keys in its Data field:

  • username – Must be present or the import will fail.

  • passwordHash – The SHA-512 hash of the password. If the hash is an empty string, a passwordless user will be created. For more information, see https://www.rabbitmq.com/docs/passwords.

  • password – Plain-text password. Will be used only if the passwordHash key is missing.

Note that this import only occurs at creation time, and is ignored once a password has been set on a User.

limits UserLimits

Limits to apply to a user to restrict the number of connections and channels the user can create. These limits can be used as guard rails in environments where applications cannot be trusted and monitored in detail, for example, when RabbitMQ clusters are offered as a service. See https://www.rabbitmq.com/docs/user-limits.

UserStatus

UserStatus defines the observed state of User.

Appears In:
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:

VaultSpec

Appears In:
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:
Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

Vhost

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec VhostSpec

status VhostStatus

VhostLimits

VhostLimits defines limits to be applied to the vhost.

Appears In:
Field Description

connections integer

queues integer

VhostList

VhostList contains a list of Vhost

Field Description

apiVersion string

rabbitmq.com/v1beta1

kind string

VhostList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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:
Field Description

configure string

write string

read string

VhostSpec

VhostSpec defines the desired state of Vhost

Appears In:
Field Description

name string

Name of the vhost; see https://www.rabbitmq.com/vhosts.html.

tracing boolean

tags string array

defaultQueueType string

Default queue type for this vhost; can be set to quorum, classic or stream. Supported in RabbitMQ 3.11.12 or above.

rabbitmqClusterReference RabbitmqClusterReference

Reference to the RabbitmqCluster that the vhost will be created in. Required property.

deletionPolicy string

DeletionPolicy defines the behavior of vhost in the RabbitMQ cluster when the corresponding custom resource is deleted. Can be set to 'delete' or 'retain'. Default is 'delete'.

limits VhostLimits

Limits defines limits to be applied to the vhost. Supported limits include max-connections and max-queues. See https://www.rabbitmq.com/docs/vhosts#limits

VhostStatus

VhostStatus defines the observed state of Vhost

Appears In:
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
Clone this wiki locally