-
Notifications
You must be signed in to change notification settings - Fork 65
API_Reference_v0.10.0
Package v1beta1 contains API Schema definitions for the rabbitmq.com v1beta1 API group
Binding is the Schema for the bindings API
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
|
|
BindingList contains a list of Binding
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
BindingSpec defines the desired state of Binding
Field | Description |
---|---|
|
Default to vhost '/'; cannot be updated |
|
Cannot be updated |
|
Cannot be updated |
|
Cannot be updated |
|
Cannot be updated |
|
Cannot be updated |
|
Reference to the RabbitmqCluster that the binding will be created in. Required property. |
BindingStatus defines the observed state of Binding
Field | Description |
---|---|
|
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. |
|
Field | Description |
---|---|
|
Type indicates the scope of RabbitmqCluster status addressed by the condition. |
|
True, False, or Unknown |
|
The last time this Condition type changed. |
|
One word, camel-case reason for current status of the condition. |
|
Full text reason for current status of the condition. |
Exchange is the Schema for the exchanges API
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
|
|
ExchangeList contains a list of Exchange
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
ExchangeSpec defines the desired state of Exchange
Field | Description |
---|---|
|
Required property; cannot be updated |
|
Default to vhost '/'; cannot be updated |
|
Cannot be updated |
|
Cannot be updated |
|
Cannot be updated |
|
|
|
Reference to the RabbitmqCluster that the exchange will be created in. Required property. |
ExchangeStatus defines the observed state of Exchange
Field | Description |
---|---|
|
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. |
|
Federation is the Schema for the federations API
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
|
|
FederationList contains a list of Federation
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
FederationSpec defines the desired state of Federation For how to configure federation upstreams, see: https://www.rabbitmq.com/federation-reference.html.
Field | Description |
---|---|
|
Required property; cannot be updated |
|
Default to vhost '/'; cannot be updated |
|
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 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
FederationStatus defines the observed state of Federation
Field | Description |
---|---|
|
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. |
|
Permission is the Schema for the permissions API
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
|
|
PermissionList contains a list of Permission
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
PermissionSpec defines the desired state of Permission
Field | Description |
---|---|
|
Name of an existing user; must provide user or userReference, else create/update will fail; cannot be updated |
|
Reference to an existing user.rabbitmq.com object; must provide user or userReference, else create/update will fail; cannot be updated |
|
Name of an existing vhost; required property; cannot be updated |
|
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 |
|
Reference to the RabbitmqCluster that both the provided user and vhost are. Required property. |
PermissionStatus defines the observed state of Permission
Field | Description |
---|---|
|
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. |
|
Policy is the Schema for the policies API
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
|
|
PolicyList contains a list of Policy
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
PolicySpec defines the desired state of Policy https://www.rabbitmq.com/parameters.html#policies
Field | Description |
---|---|
|
Required property; cannot be updated |
|
Default to vhost '/'; cannot be updated |
|
Regular expression pattern used to match queues and exchanges, e.g. "^amq.". Required property. |
|
What this policy applies to: 'queues', 'exchanges', or 'all'. Default to 'all'. |
|
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. |
|
Policy definition. Required property. |
|
Reference to the RabbitmqCluster that the exchange will be created in. Required property. |
PolicyStatus defines the observed state of Policy
Field | Description |
---|---|
|
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. |
|
Queue is the Schema for the queues API
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
|
|
QueueList contains a list of Queue
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
QueueSpec defines the desired state of Queue
Field | Description |
---|---|
|
Name of the queue; required property. |
|
Default to vhost '/' |
|
|
|
When set to false queues does not survive server restart. |
|
when set to true, queues that have had at least one consumer before are deleted after the last consumer unsubscribes. |
|
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. |
|
Reference to the RabbitmqCluster that the queue will be created in. Required property. |
QueueStatus defines the observed state of Queue
Field | Description |
---|---|
|
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. |
|
Field | Description |
---|---|
|
Cannot be updated |
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.
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
SchemaReplicationList contains a list of SchemaReplication
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
SchemaReplicationSpec defines the desired state of SchemaReplication
Field | Description |
---|---|
|
Reference to the RabbitmqCluster that schema replication would be set for. Must be an existing cluster. |
|
Defines a Secret which contains credentials to be used for schema replication. The Secret must contain the keys |
SchemaReplicationStatus defines the observed state of SchemaReplication
Field | Description |
---|---|
|
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. |
|
Shovel is the Schema for the shovels API
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
|
|
ShovelList contains a list of Shovel
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
ShovelSpec defines the desired state of Shovel For how to configure Shovel, see: https://www.rabbitmq.com/shovel.html.
Field | Description |
---|---|
|
Required property; cannot be updated |
|
Default to vhost '/'; cannot be updated |
|
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 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ShovelStatus defines the observed state of Shovel
Field | Description |
---|---|
|
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. |
|
User is the Schema for the users API.
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
Spec configures the desired state of the User object. |
|
Status exposes the observed state of the User object. |
UserList contains a list of Users.
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
UserSpec defines the desired state of User.
Field | Description |
---|---|
|
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. |
|
Reference to the RabbitmqCluster that the user will be created for. This cluster must exist for the User object to be created. |
|
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 |
UserStatus defines the observed state of User.
Field | Description |
---|---|
|
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. |
|
|
|
Provides a reference to a Secret object containing the user credentials. |
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.
Vhost is the Schema for the vhosts API
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
|
|
VhostList contains a list of Vhost
Field | Description |
---|---|
|
|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
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.
Field | Description |
---|---|
|
|
|
|
|
VhostSpec defines the desired state of Vhost
Field | Description |
---|---|
|
Name of the vhost; see https://www.rabbitmq.com/vhosts.html. |
|
|
|
Reference to the RabbitmqCluster that the vhost will be created in. Required property. |
VhostStatus defines the observed state of Vhost
Field | Description |
---|---|
|
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. |
|