Chapter 9. Reference

adminUser*

string

my_user

Automatically-generated, random value

Password required for connecting to broker and management console.

If you do not specify a value, the value is automatically generated and stored in a secret. The default secret name has a format of <Custom Resource name>-credentials-secret. For example, ex-aao-credentials-secret.

adminPassword*

string

my_password

Automatically-generated, random value

Password required for connecting to broker and management console.

If you do not specify a value, the value is automatically generated and stored in a secret. The default secret name has a format of <Custom Resource name>-credentials-secret. For example, ex-aao-credentials-secret.

deploymentPlan*

Broker deployment configuration

image*

string

registry.redhat.io/amq7/amq-broker:latest

registry.redhat.io/amq7/amq-broker:7.5

URL of broker container image to pull from Red Hat Container Registry. The default tag matches the broker Operator version.

size*

int

2

2

Number of broker Pods to create in deployment.

If you a specify a value of 2 or greater, your broker deployment is clustered by default. The cluster user name and password are automatically generated and stored in the same secret as adminUser and adminPassword, by default.

requireLogin

Boolean

true

true

Specify whether login credentials are required to connect to broker.

persistenceEnabled

Boolean

false

true

Specify whether to use journal storage via a persistent volume (PV) created with a persistent volume claim (PVC).

journalType

string

aio

aio

Specify whether to use asynchronous I/O (AIO) or non-blocking I/O (NIO).

messageMigration

Boolean

true

true

Specify whether to migrate messages upon broker scaledown.

acceptors.acceptor

object

A single acceptor configuration instance.

name*

string

my_acceptor

Not specified

Name of acceptor.

port

int

5672

61626 for the first acceptor that you define. Default value increments by 10 for every subsequent acceptor that you define.

Port number to be used for acceptor instance.

protocols

string

amqp,core

all

Messaging protocols to enable on acceptor instance.

sslEnabled

Boolean

false

false

Specify whether SSL is enabled on acceptor port. If set to true, look in secret for data required to enable SSL on acceptor.

sslSecret

string

ex-aao-my_acceptor-secret

Not specified

Secret where client truststore and broker keystore (base64-encoded) and keyStorePassword and trustStorePassword (non-encoded) are stored. If you do not specify a value for sslSecret, the acceptor uses the default secret. The default secret name has a format of <Custom Resource name>-<acceptor name>-secret.

enabledCipherSuites

string

SSL_RSA_WITH_RC4_128_SHA, SSL_DH_anon_WITH_3DES_EDE_CBC_SHA

Not specified

Comma-separated list of cipher suites to use for SSL communication.

enabledProtocols

string

TLSv1,TLSv1.1,TLSv1.2

Not specified

Comma-separated list of protocols to use for SSL communication.

needClientAuth

Boolean

true

Not specified

Specify whether broker informs client that two-way SSL is required on acceptor. This property overrides wantClientAuth.

wantClientAuth

Boolean

true

Not specified

Specify whether broker tells client that two-way SSL is requested on acceptor, but not required. Overridden by needClientAuth.

verifyHost

Boolean

true

Not specified

Specify whether to compare the Common Name (CN) of client’s SSL certificate to its host name, to verify that they match. This option applies only when two-way SSL is used.

sslProvider

string

JDK

JDK

Specify whether SSL provider is JDK or OPENSSL.

sniHost

string

some_regular_expression

Not specified

Regular expression to match against server_name extension on incoming SSL connections. If the names don’t match, connection to the acceptor is rejected.

expose

Boolean

true

false

Specify whether to expose acceptor outside OpenShift Container Platform

anycastPrefix

string

jms.topic.

Not specified

Prefix used by client to specify that the anycast routing type should be used.

multicastPrefix

string

/queue/

Not specified

Prefix used by client to specify that the multicast routing type should be used.

connectionsAllowed

integer

2

0

Number of connections allowed on acceptor. When this limit is reached, a DEBUG message is issued to the log, and the connection is refused. The type of client in use determines what happens when the connection is refused.

connectors.connector

object

A single connector configuration instance.

name*

string

my_connector

N/A

Name of connector

type

string

tcp

tcp

The type of connector to create, tcp or vm.

host*

string

localhost

Not specified

Host name or IP address to connect to.

port*

int

22222

Not specified

Port number to be used for connector instance.

sslEnabled

Boolean

false

false

Specify whether SSL is enabled on connector port. If set to true, look in secret for data required to enable SSL on connector.

sslSecret

string

ex-aao-my_connector-secret

Not specified

Secret where client truststore and broker keystore (base64-encoded) and keyStorePassword and trustStorePassword (non-encoded) are stored. If you do not specify a value for sslSecret, the connector uses the default secret. The default secret name has a format of <Custom Resource name>-<connector name>-secret.

enabledCipherSuites

string

SSL_RSA_WITH_RC4_128_SHA, SSL_DH_anon_WITH_3DES_EDE_CBC_SHA

Not specified

Comma-separated list of cipher suites to use for SSL communication.

enabledProtocols

string

TLSv1,TLSv1.1,TLSv1.2

Not specified

Comma-separated list of protocols to use for SSL communication.

needClientAuth

Boolean

true

Not specified

Specify whether broker informs client that two-way SSL is required on connector. This property overrides wantClientAuth.

wantClientAuth

Boolean

true

Not specified

Specify whether broker informs client that two-way SSL is requested on connector, but not required. Overridden by needClientAuth.

verifyHost

Boolean

true

Not specified

Specify whether to compare Common Name (CN) of client’s SSL certificate to its host name, to verify that they match. This option applies only when two-way SSL is used.

sslProvider

string

JDK

JDK

Specify whether SSL provider is JDK or OPENSSL.

sniHost

string

some_regular_expression

Not specified

Regular expression to match against server_name extension on SSL connection. If the names don’t match, the connector connection is rejected.

expose

Boolean

true

false

Specify whether to expose connector outside OpenShift Container Platform.

console

Configuration of broker management console.

expose

Boolean

true

false

Specify whether to expose management console port.

sslEnabled

Boolean

true

false

Specify whether to use SSL on management console port.

sslSecret

string

ex-aao-my_console-secret

Not specified

Secret where client truststore and broker keystore (base64-encoded) and keyStorePassword and trustStorePassword (non-encoded) are stored. If you do not specify a value for sslSecret, the console uses the default secret. The default secret name has a format of <Custom Resource name>-console-secret.

useClientAuth

Boolean

true

false

Specify whether management console requires client authorization.

addressName*

string

address0

Not specified

Address name to be created in broker.

queueName*

string

queue0

Not specified

Queue name to be created in broker.

routingType*

string

anycast

Not specified

Routing type to be used - anycast or multicast.