Skip to content

API_Reference_v0.6.0

github-actions edited this page Apr 15, 2021 · 1 revision

API Reference

rabbitmq.com/v1alpha2

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

Definitions

Binding

Binding is the Schema for the bindings API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1alpha2

kind string

Binding

TypeMeta TypeMeta

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/v1alpha2

kind string

BindingList

TypeMeta TypeMeta

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Binding

BindingSpec

BindingSpec defines the desired state of Binding

Appears In:
Field Description

vhost string

Default to vhost '/'

source string

destination string

destinationType string

routingKey string

arguments RawExtension

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 RabbitmqCluster status addressed by the condition.

True, False, or Unknown

lastTransitionTime Time

The last time this Condition type 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/v1alpha2

kind string

Exchange

TypeMeta TypeMeta

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

ExchangeList

ExchangeList contains a list of Exchange

Field Description

apiVersion string

rabbitmq.com/v1alpha2

kind string

ExchangeList

TypeMeta TypeMeta

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Exchange

ExchangeSpec

ExchangeSpec defines the desired state of Exchange

Appears In:
Field Description

name string

vhost string

Default to vhost '/'

type string

durable boolean

autoDelete boolean

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

Permission

Permission is the Schema for the permissions API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1alpha2

kind string

Permission

TypeMeta TypeMeta

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

PermissionList

PermissionList contains a list of Permission

Field Description

apiVersion string

rabbitmq.com/v1alpha2

kind string

PermissionList

TypeMeta TypeMeta

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Permission

PermissionSpec

PermissionSpec defines the desired state of Permission

Appears In:
Field Description

user string

Name of an existing user; required property.

vhost string

Name of an existing vhost; required property.

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

Policy

Policy is the Schema for the policies API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1alpha2

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/v1alpha2

kind string

PolicyList

TypeMeta TypeMeta

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Policy

PolicySpec

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

Appears In:
Field Description

name string

vhost string

Default to vhost '/'

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

Queue

Queue is the Schema for the queues API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1alpha2

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/v1alpha2

kind string

QueueList

TypeMeta TypeMeta

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Queue

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 has at least one consumer before, are deleted after last consumer unsubscribes

arguments RawExtension

Queue arguments in the format of KEY: VALUE. e.g. x-delivery-limit: 10000

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

RabbitmqClusterReference

Field Description

name string

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/v1alpha2

kind string

SchemaReplication

TypeMeta TypeMeta

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

SchemaReplicationList

SchemaReplicationList contains a list of SchemaReplication

Field Description

apiVersion string

rabbitmq.com/v1alpha2

kind string

SchemaReplicationList

TypeMeta TypeMeta

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

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 endpoints, username and password in its Data field, or operator will error. endpoints should be one or multiple endpoints separated by ','.

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

User

User is the Schema for the users API.

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1alpha2

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/v1alpha2

kind string

UserList

TypeMeta TypeMeta

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items User

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

credentials LocalObjectReference

Provides a reference to a Secret object containing the user credentials.

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:

Vhost

Vhost is the Schema for the vhosts API

Appears In:
Field Description

apiVersion string

rabbitmq.com/v1alpha2

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/v1alpha2

kind string

VhostList

TypeMeta TypeMeta

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Vhost

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

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

Clone this wiki locally