Resources / MessageBroker

MessageBroker

A message broker for MQTT, AMQP and STOMP clients on a VPC, keeping all its state in Etorm storage. It accepts connections once its engine is available on the platform; until then it stays Pending with reason EngineNotAvailable. The password is shown once, when the broker is created.

Overview

APIqueues.etorm.com/v1alpha1
Resourcemessagebrokers (cluster-scoped inside its cluster)
Short namesmq
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: queues.etorm.com/v1alpha1
kind: MessageBroker
metadata:
  name: example
spec:
  vpcRef:
    name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
vpcRefreference to VPCyesThe VPC the broker's addresses are on. Cannot be changed.
protocolslist of stringup to 3 itemsWhich protocols to accept: mqtt (MQTT 5.0 and 3.1.1, port 1883), amqp (AMQP 0-9-1, port 5672), stomp (STOMP 1.2, port 61613). All three by default.
nodesinteger11 to 5How many broker nodes share the work; any node accepts any client.
userstringup to 63 charactersThe user clients log in as. Defaults to app. Cannot be changed.
passwordGenerationintegerat least 0Raise it to set a new password for the user: the new password is shown once, in the response to that change, and the old one stops working. It cannot be lowered.
monitoringRefreference to MonitoringWorkspaceOptional MonitoringWorkspace to export queue depth, publish/consume rates, and lag to.
resourcesobject{}What each node may use.
resources.memoryPowerinteger60 to 10Memory per node: 64 KiB times two to this power (6 is 4 MiB).
resources.cpuMillicoresinteger2501 to 1000Processor time per node on average, in thousandths of a core.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending, Ready, Degraded (some nodes are not running) or Failed.
endpointslist of objectWhere clients connect: one entry per node.
endpoints[].addressstringIts IPv6 address on the VPC.
endpoints[].mqttintegerMQTT port, when enabled.
endpoints[].amqpintegerAMQP port, when enabled.
endpoints[].stompintegerSTOMP port, when enabled.
endpoints[].servingbooleanTrue on the node that accepts clients now (it holds the broker's state); the others are standbys that take over on failure.
usageobjectWhat it has used, as billed (spec 0006): CPU time and the bytes it holds now.
usage.cpuSecondsnumberCPU time used since `since`, for queries and housekeeping, in seconds.
usage.storageBytesintegerBytes it holds now (billed as GiB-seconds while they are held).
usage.sincestringWhen metering started (RFC 3339).
usage.fuelTotalintegerInternal: all fuel counted so far (2 000 000 000 per CPU-second).
usage.fuelSeenobjectInternal: the last fuel count seen per instance.
passwordVerifierstringThe salted verifier of the user's password (SCRAM-SHA-256), never the password.
passwordstringThe user's password: present only in the response that created the broker, never stored.
conditionslist of objectDetailed state, one entry per aspect; Ready says whether the broker accepts connections.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Nodes.spec.nodes
Address.status.endpoints[0].address
Phase.status.phase
Detail.status.conditions[0].message

All resources