API_Reference_v1.0.0

API Reference

Packages

• rabbitmq.com/v1beta1

rabbitmq.com/v1beta1

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

Resource Types

• RabbitmqCluster

• RabbitmqClusterList

Definitions

EmbeddedLabelsAnnotations

It is used in Service and StatefulSet

Appears In:

• Service

• StatefulSet

Field	Description
labels object (keys:string, values:string)	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
annotations object (keys:string, values:string)	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

EmbeddedObjectMeta

EmbeddedObjectMeta contains a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta Only fields which are relevant to embedded resources are included. It is used in PersistentVolumeClaim and PodTemplate

Appears In:

• PersistentVolumeClaim

• PodTemplateSpec

Field	Description
name string	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
namespace string	Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
labels object (keys:string, values:string)	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
annotations object (keys:string, values:string)	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

PersistentVolumeClaim

PersistentVolumeClaim is an embedded version of k8s.io/api/core/v1.PersistentVolumeClaim. It contains TypeMeta and a reduced ObjectMeta. Field status is omitted.

Appears In:

• StatefulSetSpec

Field	Description
TypeMeta TypeMeta
metadata EmbeddedObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec PersistentVolumeClaimSpec	Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Plugin (string)

Appears In:

• RabbitmqClusterConfigurationSpec

PodTemplateSpec

PodTemplateSpec is an embedded version of k8s.io/api/core/v1.PodTemplateSpec. It contains a reduced ObjectMeta.

Appears In:

• StatefulSetSpec

Field	Description
metadata EmbeddedObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec PodSpec	Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

RabbitmqCluster

RabbitmqCluster is the Schema for the rabbitmqclusters API

Appears In:

• RabbitmqClusterList

Field	Description
apiVersion string	rabbitmq.com/v1beta1
kind string	RabbitmqCluster
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec RabbitmqClusterSpec
status RabbitmqClusterStatus

RabbitmqClusterConfigurationSpec

Rabbitmq related configurations

Appears In:

• RabbitmqClusterSpec

Field	Description
additionalPlugins Plugin array	List of plugins to enable in addition to essential plugins: rabbitmq_management, rabbitmq_prometheus, and rabbitmq_peer_discovery_k8s.
additionalConfig string	Modify to add to the rabbitmq.conf file in addition to default configurations set by the operator. Modifying this property on an existing RabbitmqCluster will trigger a StatefulSet rolling restart and will cause rabbitmq downtime.
advancedConfig string	Specify any rabbitmq advanced.config configurations
envConfig string	Modify to add to the rabbitmq-env.conf file. Modifying this property on an existing RabbitmqCluster will trigger a StatefulSet rolling restart and will cause rabbitmq downtime.

RabbitmqClusterDefaultUser

Appears In:

• RabbitmqClusterStatus

Field	Description
secretReference RabbitmqClusterSecretReference
serviceReference RabbitmqClusterServiceReference

RabbitmqClusterList

RabbitmqClusterList contains a list of RabbitmqCluster

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

RabbitmqClusterOverrideSpec

Appears In:

• RabbitmqClusterSpec

Field	Description
statefulSet StatefulSet
service Service

RabbitmqClusterPersistenceSpec

The settings for the persistent storage desired for each Pod in the RabbitmqCluster.

Appears In:

• RabbitmqClusterSpec

Field	Description
storageClassName string	StorageClassName is the name of the StorageClass to claim a PersistentVolume from.
storage Quantity	The requested size of the persistent volume attached to each Pod in the RabbitmqCluster.

RabbitmqClusterSecretReference

Appears In:

• RabbitmqClusterDefaultUser

Field	Description
name string
namespace string
keys object (keys:string, values:string)

RabbitmqClusterServiceReference

Appears In:

• RabbitmqClusterDefaultUser

Field	Description
name string
namespace string

RabbitmqClusterServiceSpec

Settable attributes for the Service resource.

Appears In:

• RabbitmqClusterSpec

Field	Description
type ServiceType
annotations object (keys:string, values:string)	Annotations to add to the Service.

RabbitmqClusterSpec

Spec is the desired state of the RabbitmqCluster Custom Resource.

Appears In:

• RabbitmqCluster

Field	Description
replicas integer	Replicas is the number of nodes in the RabbitMQ cluster. Each node is deployed as a Replica in a StatefulSet. Only 1, 3, 5 replicas clusters are tested.
image string	Image is the name of the RabbitMQ docker image to use for RabbitMQ nodes in the RabbitmqCluster.
imagePullSecrets LocalObjectReference array	List of Secret resource containing access credentials to the registry for the RabbitMQ image. Required if the docker registry is private.
service RabbitmqClusterServiceSpec
persistence RabbitmqClusterPersistenceSpec
resources ResourceRequirements
affinity Affinity
tolerations Toleration array	Tolerations is the list of Toleration resources attached to each Pod in the RabbitmqCluster.
rabbitmq RabbitmqClusterConfigurationSpec
tls TLSSpec
override RabbitmqClusterOverrideSpec
skipPostDeploySteps boolean	If unset, or set to false, the cluster will run rabbitmq-queues rebalance all whenever the cluster is updated. Has no effect if the cluster only consists of one node. For more information, see https://www.rabbitmq.com/rabbitmq-queues.8.html#rebalance
terminationGracePeriodSeconds integer	TerminationGracePeriodSeconds is the timeout that each rabbitmqcluster pod will have to terminate gracefully. It defaults to 604800 seconds ( a week long) to ensure that the container preStop lifecycle hook can finish running. For more information, see: https://github.com/rabbitmq/cluster-operator/blob/main/docs/design/20200520-graceful-pod-termination.md

RabbitmqClusterStatus

Status presents the observed state of RabbitmqCluster

Appears In:

• RabbitmqCluster

Field	Description
clusterStatus string
conditions RabbitmqClusterCondition array	Set of Conditions describing the current state of the RabbitmqCluster
defaultUser RabbitmqClusterDefaultUser	Identifying information on internal resources

Service

Appears In:

• RabbitmqClusterOverrideSpec

Field	Description
metadata EmbeddedLabelsAnnotations	Refer to Kubernetes API documentation for fields of metadata.
spec ServiceSpec	Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

StatefulSet

Appears In:

• RabbitmqClusterOverrideSpec

Field	Description
metadata EmbeddedLabelsAnnotations	Refer to Kubernetes API documentation for fields of metadata.
spec StatefulSetSpec	Spec defines the desired identities of pods in this set.

StatefulSetSpec

StatefulSetSpec contains a subset of the fields included in k8s.io/api/apps/v1.StatefulSetSpec. Field RevisionHistoryLimit is omitted. Every field is made optional.

Appears In:

• StatefulSet

Field	Description
replicas integer	replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity.
selector LabelSelector	selector is a label query over pods that should match the replica count. It must match the pod template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template PodTemplateSpec	template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
volumeClaimTemplates PersistentVolumeClaim array	volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
serviceName string	serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
podManagementPolicy PodManagementPolicyType	podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
updateStrategy StatefulSetUpdateStrategy	updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

TLSSpec

Appears In:

• RabbitmqClusterSpec

Field	Description
secretName string	Name of a Secret in the same Namespace as the RabbitmqCluster, containing the server’s private key & public certificate for TLS. The Secret must store these as tls.key and tls.crt, respectively.
caSecretName string	Name of a Secret in the same Namespace as the RabbitmqCluster, containing the Certificate Authority’s public certificate for TLS. The Secret must store this as ca.crt. Used for mTLS, and TLS for rabbitmq_web_stomp and rabbitmq_web_mqtt.