第8章 リファレンス

adminUser*

ブローカーおよび管理コンソールの接続に必要な管理者ユーザー名。

値を指定しない場合、値は自動的に生成され、シークレットに保存されます。デフォルトのシークレット名の形式は、<custom_resource_name>-credentials-secret です。例: my-broker-deployment-credentials-secret。

型: String

例: my-user

デフォルト値: 無作為に、自動生成された値

adminPassword*

ブローカーおよび管理コンソールへの接続に必要な管理者パスワード。

値を指定しない場合、値は自動的に生成され、シークレットに保存されます。デフォルトのシークレット名の形式は、<custom_resource_name>-credentials-secret です。例: my-broker-deployment-credentials-secret。

型: String

例: my-password

デフォルト値: 無作為に、自動生成された値

deploymentPlan*

ブローカーのデプロイメント設定

image*

デプロイメントの各ブローカーに使用されるブローカーコンテナーイメージの完全パス。

CR で image の値を明示的に指定する必要はありません。プレースホルダー のデフォルト値は、Operator が使用する適切なイメージをまだ決定していないことを示します。

Operator が使用するブローカーコンテナーイメージを選択する方法は、「Operator によるコンテナーイメージの選択方法」を参照してください。

型: String

例: registry.redhat.io/amq7/amq-broker-rhel8@sha256:982ba18be1ac285722bc0ca8e85d2a42b844ab840b01425e79e3eeee6ee5b9

デフォルト値: placeholder

size*

デプロイメントで作成するブローカー Pod の数。

2 以上の値を指定すると、ブローカーのデプロイメントはデフォルトでクラスター化されます。クラスターのユーザー名とパスワードは自動的に生成され、同じシークレットに保存されます (デフォルトで admin User および admin Password)。

型: int

例: 1

デフォルト値: 2

requireLogin

ブローカーへの接続にログイン認証情報が必要かどうかを指定します。

型: Boolean

例: false

デフォルト値: true

persistenceEnabled

デプロイメントでブローカー Pod ごとにジャーナルストレージを使用するかどうかを指定します。true に設定されている場合には、各ブローカー Pod には、Operator が永続ボリューム要求 (PVC) を使用して要求できる永続ボリューム (PV) に空きがなければなりません。

型: Boolean

例: false

デフォルト値: true

initImage

ブローカーの設定に使用される init コンテナーイメージ。

カスタムイメージを提供する場合を除いて、CR で init Image の値を明示的に指定する必要はありません。

Operator が使用する組み込み init コンテナーイメージを選択する方法については、「Operator によるコンテナーイメージの選択方法」 を参照してください。

カスタム init コンテナーイメージを指定する方法については、「カスタム init コンテナーイメージの指定」 を参照してください。

型: String

例: registry.redhat.io/amq7/amq-broker-init-rhel8@sha256:f37f98c809c6f29a83e3d5a3ac4494e28efe9b25d33c54f533c6a08662244622

デフォルト値: 指定なし

journalType

非同期 I/O (AIO) と非ブロッキング I/O(NIO) のどちらを使用するかを指定します。

型: String

例: aio

デフォルト値: nio

messageMigration

ブローカーデプロイメントの意図的なスケールダウンによりブローカー Pod がシャットダウンした場合、ブローカークラスター内でまだ実行されている別のブローカー Pod にメッセージを移行するかどうかを指定します。

型: Boolean

例: false

デフォルト値: true

resources.limits.cpu

デプロイメントの Pod で実行されている各ブローカーコンテナーが消費できるホストノード CPU の最大量 (ミリコア単位)。

型: String

Example: "500m"

デフォルト値: お使いのバージョンの OpenShift Container Platform と同じデフォルト値を使用します。クラスター管理者に相談してください。

resources.limits.memory

デプロイメント内の Pod で実行されている各ブローカーコンテナーが消費できるホストノードメモリーの最大量 (バイト単位)。バイト表記 (K、M、G など)、または同等のバイナリー (Ki、Mi、Gi) をサポートします。

型: String

Example: "1024M"

デフォルト値: お使いのバージョンの OpenShift Container Platform と同じデフォルト値を使用します。クラスター管理者に相談してください。

resources.requests.cpu

デプロイメント内の Pod で実行されている各ブローカーコンテナーが明示的に要求するホストノードの CPU 量 (ミリコア単位)。

型: String

Example: "250m"

デフォルト値: お使いのバージョンの OpenShift Container Platform と同じデフォルト値を使用します。クラスター管理者に相談してください。

resources.requests.memory

デプロイメント内の Pod で実行されている各ブローカーコンテナーが明示的に要求するホストノードメモリーの量 (バイト単位)。バイト表記 (K、M、G など)、または同等のバイナリー (Ki、Mi、Gi) をサポートします。

型: String

Example: "512M"

デフォルト値: お使いのバージョンの OpenShift Container Platform と同じデフォルト値を使用します。クラスター管理者に相談してください。

storage.size

デプロイメントにある各ブローカーが永続ストレージに必要な Persistent Volume Claim (永続ボリューム要求、PVC) のサイズ (バイト単位)。このプロパティーは、persistenceEnabled が true に設定されている場合にのみ適用されます。指定する値には単位が含まれている必要があります。バイト表記 (K、M、G など)、または同等のバイナリー (Ki、Mi、Gi) をサポートします。

型: String

例: 4Gi

デフォルト値: 2Gi

jolokiaAgentEnabled

デプロイメント内のブローカーに対して Jolokia JVM エージェントを有効にするかどうかを指定します。このプロパティーの値が true に設定されている場合には、Fuse Console はブローカーのランタイムデータを検出して表示できます。

型: Boolean

例: True

デフォルト値: false

managementRBACEnabled

デプロイメント内のブローカーに対してロールベースのアクセス制御 (RBAC) を有効にするかどうかを指定します。Fuse Console を使用するには、値を false に設定する必要があります。これは、Fuse Console が独自のロールベースのアクセス制御を使用しているためです。

型: Boolean

例: false

デフォルト値: true

affinity

Pod のスケジューリングの制約を指定します。アフィニティープロパティーに関する詳細は、OpenShift Container Platform ドキュメントの properties を参照してください。

tolerations

Pod の容認を指定します。容認のプロパティーに関する詳細は、OpenShift Container Platform ドキュメントの properties を参照してください。

nodeSelector

そのノードでスケジュールされる Pod のノードのラベルと一致するラベルを指定します。

storageClassName

永続ボリューム要求 (PVC) に使用するストレージクラスの名前を指定します。ストレージクラスは、管理者が使用可能なストレージを記述および分類する方法を提供します。たとえば、ストレージクラスには、特定のサービス品質レベル、バックアップポリシー、またはその他の管理ポリシーが関連付けられている場合があります。

型: String

例:gp3

デフォルト値: 指定なし

livenessProbe

実行中のブローカーコンテナーで定期的な可用性チェックを設定して、ブローカーが実行中であることを確認します。liveness プローブのプロパティーについては、OpenShift Container Platform ドキュメントの プロパティー を参照してください。

readinessProbe

実行中のブローカーコンテナーで定期的な可用性チェックを設定して、ブローカーがネットワークトラフィックを受け入れていることを確認します。readiness プローブのプロパティーについては、OpenShift Container Platform ドキュメントの プロパティー を参照してください。

labels

ブローカー Pod にラベルを割り当てます。

型: String

例: 場所: 実稼働

デフォルト値: 指定なし

console

ブローカー管理コンソールの設定。

expose

デプロイメントの各ブローカーの管理コンソールポートを公開するかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

sslEnabled

管理コンソールポートで SSL を使用するかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

sslSecret

ブローカーキーストア、トラストストア、および対応するパスワード (すべて Base64 でエンコードされたもの) が保存されるシークレット。ssl Secret の値を指定しない場合には、コンソールはデフォルトのシークレット名を使用します。デフォルトのシークレット名は、 <custom_resource_name> -console-secret の形式です。このプロパティーは、sslEnabled プロパティーが true に設定されている場合のみ適用されます。

型: String

例: my-broker-deployment-console-secret

デフォルト値: 指定なし

podSecurity.serviceAccountName

ブローカー Pod のサービスアカウント名を指定します。

型: String

例: activemq-artemis-controller-manager

デフォルト値: デフォルト

podSecurityContext

次の Pod レベルのセキュリティー属性と一般的なコンテナー設定を指定します。

* fsGroup

* fsGroupChangePolicy

* runAsGroup

* runAsUser

* runAsNonRoot

* seLinuxOptions

* seccompProfile

* supplementalGroups

* sysctls

* windowsOptions

podSecurityContext プロパティーは、OpenShift Container Platform ドキュメントの プロパティー を参照してください。

useClientAuth

管理コンソールにクライアント承認が必要かどうかを指定します。

型: Boolean

例: True

デフォルト値: false

acceptors.acceptor

単一のアクセプターの設定インスタンス。

name*

アクセプターの名前。

型: String

例: my-acceptor

デフォルト値: 該当なし

ポート

アクセプターインスタンスに使用するポート番号。

型: int

例: 5672

デフォルト値: 61626 (定義する最初のアクセプター)。その後、デフォルト値は、定義する後続のアクセプターごとに 10 ずつ増えます。

protocols

アクセプターインスタンスで有効にするメッセージングプロトコル。

型: String

例: amqp、core

デフォルト値: all

sslEnabled

アクセプターポートで SSL を有効にするかどうかを指定します。true に設定されている場合は、 ssl Secret で指定されているシークレット名を調べて、TLS/SSL に必要な認証情報を探します。

型: Boolean

例: True

デフォルト値: false

sslSecret

ブローカーキーストア、トラストストア、および対応するパスワード (すべて Base64 でエンコードされたもの) が保存されるシークレット。

ssl Secret にカスタムシークレット名を指定しない場合には、アクセプターはデフォルトのシークレット名を想定します。デフォルトのシークレット名の形式は、 <custom_resource_name>- <acceptor_name>-secret です。

アクセプターでデフォルト名が必要であっても、常にこのシークレットを自分で作成する必要があります。

型: String

例: my-broker-deployment-my-acceptor-secret

Default value: <custom_resource_name>-<acceptor_name>-secret

enabledCipherSuites

TLS/SSL 通信に使用する暗号スイートのコンマ区切りリスト。

クライアントアプリケーションでサポートする最も安全な暗号スイートを指定します。コンマ区切りのリストを使用して、ブローカーとクライアントの両方に共通の暗号スイートのセットを指定する場合、または暗号スイートを指定しない場合には、ブローカーとクライアントは、使用する暗号スイートについて相互に交渉します。指定する暗号スイートがわからない場合は、最初にデバッグモードで実行されているクライアントとのブローカークライアント接続を確立して、ブローカーとクライアントの両方に共通の暗号スイートを確認することを推奨します。次に、ブローカーで enabledCipherSuites を設定します。

型: String

デフォルト値: 指定なし

keyStoreProvider

ブローカーが使用するキーストアのプロバイダーの名前。

型: String

例:SunJCE

デフォルト値: 指定なし

trustStoreProvider

ブローカーが使用するトラストストアのプロバイダーの名前。

型: String

例:SunJCE

デフォルト値: 指定なし

trustStoreType

ブローカーが使用するトラストストアのタイプ。

型: String

例:JCEKS

デフォルト値:JKS

enabledProtocols

TLS/SSL 通信に使用するプロトコルのコンマ区切りリスト。

型: String

例: TLSv1、TLSv1.1、TLSv1.2

デフォルト値: 指定なし

needClientAuth

ブローカーがアクセプターで双方向 TLS が必要であることをクライアントに通知するかどうかを指定します。このプロパティーは、wantClientAuth をオーバーライドします。

型: Boolean

例: True

デフォルト値: 指定なし

wantClientAuth

アクセプターで双方向 TLS が要求されていることを通知するかどうかを指定します。ただし、必須ではありません。このプロパティーは needClientAuth にオーバーライドされます。

型: Boolean

例: True

デフォルト値: 指定なし

verifyHost

クライアントの証明書のコモンネーム (CN) をホスト名と比較して一致することを確認するかどうかを指定します。このオプションは、双方向 TLS が使用されている場合にのみ適用されます。

型: Boolean

例: True

デフォルト値: 指定なし

sslProvider

SSL プロバイダーが JDK であるか OPENSSL であるかを指定します。

型: String

例: OPENSSL

デフォルト値: JDK

sniHost

受信接続の server_name の拡張子と照合するための正規表現。名前が一致しない場合には、アクセプターへの接続は拒否されます。

型: String

例: some_regular_expression

デフォルト値: 指定なし

expose

Open Shift Container Platform の外部のクライアントにアクセプターを公開するかどうかを指定します。

OpenShift 外部にあるクライアントにアクセプターを公開すると、Operator はデプロイメント内のブローカー Pod ごとに専用のサービスとルートを自動作成します。

型: Boolean

例: True

デフォルト値: false

anycastPrefix

anycast ルーティングタイプを使用することを指定するためにクライアントが使用する接頭辞。

型: String

例: jms.queue

デフォルト値: 指定なし

multicastPrefix

multicast ルーティングタイプを使用する必要があることを指定するためにクライアントが使用する接頭辞。

型: String

例: /topic /

デフォルト値: 指定なし

connectionsAllowed

アクセプターで許可されている接続の数。この制限に達すると、DEBUG メッセージがログに出力され、接続は拒否されました。使用中のクライアントのタイプによって、接続が拒否されたときに何が起こるかが決まります。

型: integer

例: 2

デフォルト値: 0 (無制限の接続)

amqpMinLargeMessageSize

ブローカーが AMQP メッセージを大きなメッセージとして処理するために必要な最小メッセージサイズ (バイト単位)。AMQ メッセージのサイズがこの値以上の場合は、ブローカーはメッセージを、メッセージストレージ用にブローカーが使用する永続ボリューム (PV) の永続ボリューム (デフォルトでは /opt/<custom_resource_name>/data/large-messages) にメッセージを保存します。値を -1 に設定すると、AMQP メッセージの大きなメッセージ処理が無効になります。

型: integer

例: 204800

デフォルト値: 102400(100 KB)

BindToAllInterfaces

true に設定すると、Pod の内部 IP アドレスではなく 0.0.0.0 IP アドレスを使用してブローカーアクセプターを設定します。ブローカーアクセプターが 0.0.0.0 IP アドレスを持っている場合、Pod 用に設定されたすべてのインターフェイスにバインドし、クライアントは OpenShift Container Platform ポート転送を使用してトラフィックをブローカーに転送できます。通常、この設定を使用してサービスをデバッグします。ポート転送の詳細は、OpenShift Container Platform ドキュメントの ポート転送を使用してコンテナー内のアプリケーションにアクセスする を参照してください。

型: Boolean

例: True

デフォルト値: false

connectors.connector

単一のコネクター設定インスタンス。

name*

コネクターの名前。

型: String

例: my-connector

デフォルト値: 該当なし

type

作成するコネクターのタイプ。 tcp または vm。

型: String

例: vm

デフォルト値: tcp

host*

接続するホスト名または IP アドレス。

型: String

例: 192.168.0.58

デフォルト値: 指定なし

port*

コネクターインスタンスに使用されるポート番号。

型: int

例: 22222

デフォルト値: 指定なし

sslEnabled

コネクターポートで SSL を有効にするかどうかを指定します。true に設定されている場合は、 ssl Secret で指定されているシークレット名を調べて、TLS/SSL に必要な認証情報を探します。

型: Boolean

例: True

デフォルト値: false

sslSecret

ブローカーキーストア、トラストストア、および対応するパスワード (すべて Base64 でエンコードされたもの) が保存されるシークレット。

ssl Secret にカスタムシークレット名を指定しない場合には、コネクターはデフォルトのシークレット名を想定します。デフォルトのシークレット名の形式は、 <custom_resource_name>- <connector_name>-secret です。

コネクターでデフォルト名が必要であっても、このシークレットは常に自分で作成する必要があります。

型: String

例: my-broker-deployment-my-connector-secret

Default value: <custom_resource_name>-<connector_name>-secret

enabledCipherSuites

TLS/SSL 通信に使用する暗号スイートのコンマ区切りリスト。

型: String

注: コネクターの場合、暗号スイートのリストを指定しないことを推奨します。

デフォルト値: 指定なし

keyStoreProvider

ブローカーが使用するキーストアのプロバイダーの名前。

型: String

例:SunJCE

デフォルト値: 指定なし

trustStoreProvider

ブローカーが使用するトラストストアのプロバイダーの名前。

型: String

例:SunJCE

デフォルト値: 指定なし

trustStoreType

ブローカーが使用するトラストストアのタイプ。

型: String

例:JCEKS

デフォルト値:JKS

enabledProtocols

TLS/SSL 通信に使用するプロトコルのコンマ区切りリスト。

型: String

例: TLSv1、TLSv1.1、TLSv1.2

デフォルト値: 指定なし

needClientAuth

コネクターに双方向 TLS が必要であることをブローカがクライアントに通知するかどうかを指定します。このプロパティーは、wantClientAuth をオーバーライドします。

型: Boolean

例: True

デフォルト値: 指定なし

wantClientAuth

コネクターで双方向 TLS が要求されていることを通知するかどうかを指定します。ただし、必須ではありません。このプロパティーは needClientAuth にオーバーライドされます。

型: Boolean

例: True

デフォルト値: 指定なし

verifyHost

クライアントの証明書のコモンネーム (CN) をホスト名と比較して一致することを確認するかどうかを指定します。このオプションは、双方向 TLS が使用されている場合にのみ適用されます。

型: Boolean

例: True

デフォルト値: 指定なし

sslProvider

SSL プロバイダーが JDK であるか OPENSSL であるかを指定します。

型: String

例: OPENSSL

デフォルト値: JDK

sniHost

送信接続の server_name 拡張子と照合するための正規表現。名前が一致しない場合には、コネクター接続は拒否されます。

型: String

例: some_regular_expression

デフォルト値: 指定なし

expose

OpenShift Container Platform 外のクライアントにコネクターを公開するかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

addressSettings.applyRule

Operator を一致するアドレスまたはアドレスのセットごとに CR に追加する設定を適用する方法を指定します。

指定できる値は次のとおりです。

型: String

例: replace_all

デフォルト値: merge_all

addressSettings.addressSetting

一致するアドレスまたはアドレスの セット の設定。

addressFullPolicy

maxSizeBytes で設定されたアドレスがいっぱいになったときにどうなるかを指定します。利用可能なポリシーは以下のとおりです。

型: String

例: DROP

デフォルト値: PAGE

autoCreateAddresses

クライアントが、存在しないアドレスにバインドされているキューにメッセージを送信するとき、またはキューからメッセージを消費しようとするときに、ブローカーが自動的にアドレスを作成するかどうかを指定します。

型: Boolean

例: false

デフォルト値: true

autoCreateDeadLetterResources

ブローカーがデッドレターアドレスおよびキューを自動的に作成し、未配信メッセージを受信するかどうかを指定します。

パラメーターが true に設定されている場合には、ブローカはデッドレターアドレスと関連するデッドレターキューを自動的に作成します。自動的に作成されたアドレスの名前は、 dead Letter Address に指定した値と一致します。

型: Boolean

例: True

デフォルト値: false

autoCreateExpiryResources

期限切れのメッセージを受信するため、ブローカーがアドレスとキューを自動的に作成するかどうかを指定します。

パラメーターが true に設定されている場合、ブローカーは自動的に有効期限アドレスと関連する有効期限キューを作成します。自動的に作成されたアドレスの名前は、 expiry Address に指定した値と一致します。

型: Boolean

例: True

デフォルト値: false

autoCreateJmsQueues

このプロパティーは非推奨にされています。代わりに autoCreateQueues を使用してください。

autoCreateJmsTopics

このプロパティーは非推奨にされています。代わりに autoCreateQueues を使用してください。

autoCreateQueues

クライアントがまだ存在していないキューにメッセージを送信するとき、またはキューからメッセージを消費しようとするときに、ブローカーが自動的にキューを作成するかどうかを指定します。

型: Boolean

例: false

デフォルト値: true

autoDeleteAddresses

ブローカーにキューがなくなったときに、ブローカーが自動的に作成されたアドレスを自動的に削除するかどうかを指定します。

型: Boolean

例: false

デフォルト値: true

autoDeleteAddressDelay

アドレスにキューがない場合に、ブローカーが自動作成されたアドレスを自動削除するまで待機する時間 (ミリ秒単位)。

型: integer

例: 100

デフォルト値: 0

autoDeleteJmsQueues

このプロパティーは非推奨にされています。代わりに autoDeleteQueues を使用してください。

autoDeleteJmsTopics

このプロパティーは非推奨にされています。代わりに autoDeleteQueues を使用してください。

autoDeleteQueues

キューにコンシューマーとメッセージがない場合に、ブローカーが自動作成されたキューを自動削除するかどうかを指定します。

型: Boolean

例: false

デフォルト値: true

autoDeleteCreatedQueues

キューにコンシューマーとメッセージがない場合に、ブローカーが手動で作成されたキューを自動削除するかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

autoDeleteQueuesDelay

キューにコンシューマーがない場合に、ブローカーが自動作成されたキューを自動削除するまで待機する時間 (ミリ秒単位)。

型: integer

例: 10

デフォルト値: 0

autoDeleteQueuesMessageCount

ブローカーがキューを自動的に削除できるかどうかを評価する前に、キューに入れることができるメッセージの最大数。

型: integer

例: 5

デフォルト値: 0

configDeleteAddresses

設定ファイルを再読み込みすると、このパラメーターで、設定ファイルから削除されたアドレス (とそのキュー) を処理する方法を指定します。以下の値を指定できます。

型: String

例: FORCE

デフォルト値: OFF

configDeleteQueues

設定ファイルを再読み込みすると、この設定は、ブローカーが設定ファイルから削除されたキューを処理する方法を指定します。以下の値を指定できます。

型: String

例: FORCE

デフォルト値: OFF

deadLetterAddress

ブローカーが未達の (未配信) メッセージを送信するアドレス。

型: String

例: DLA

デフォルト値: None

deadLetterQueuePrefix

ブローカーにより、自動作成された dead letter キューの名前に適用される接頭辞。

型: String

例: my DLQ。

デフォルト値: DLQ.

deadLetterQueueSuffix

ブローカーにより、自動作成された dead letter キューに適用される接尾辞。

型: String

例: .DLQ

デフォルト値: None

defaultAddressRoutingType

自動作成されたアドレスで使用されるルーティングタイプ。

型: String

例: ANYCAST

デフォルト値: MULTICAST

defaultConsumersBeforeDispatch

アドレスのキューに対してメッセージディスパッチを開始する前に必要なコンシューマーの数。

型: integer

例: 5

デフォルト値: 0

defaultConsumerWindowSize

コンシューマーのデフォルトのウィンドウサイズ (バイト単位)。

型: integer

例: 300000

デフォルト値: 1048576 (1024*1024)

defaultDelayBeforeDispatch

defaultConsumersBeforeDispatch に指定された値に達していない場合に、ブローカーがメッセージをディスパッチするまで待機するデフォルトの時間 (ミリ秒単位)。

型: integer

例: 5

デフォルト値: -1(遅延なし)

defaultExclusiveQueue

アドレス上のすべてのキューがデフォルトで独占キューであるかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

defaultGroupBuckets

メッセージのグループ化に使用するバケットの数。

型: integer

例: 0(メッセージのグループ化は無効)

デフォルト値: -1(制限なし)

defaultGroupFirstKey

グループ内のどのメッセージが最初であるかをコンシューマーに示すために使用されるキー。

型: String

Example: firstMessageKey

デフォルト値: None

defaultGroupRebalance

新しいコンシューマーがブローカーに接続するときにグループのリバランスするかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

defaultGroupRebalancePauseDispatch

ブローカーがグループのリバランスをしている間、メッセージのディスパッチを一時停止するかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

defaultLastValueQueue

アドレス上のすべてのキューがデフォルトで最後の値のキューであるかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

defaultLastValueKey

最後の値のキューに使用するデフォルトのキー。

型: String

例: stock_ticker

デフォルト値: None

defaultMaxConsumers

任意のタイミングでキューで許可されるコンシューマーの最大数。

型: integer

例: 100

デフォルト値: -1(制限なし)

defaultNonDestructive

アドレス上のすべてのキューがデフォルトで non-destructive であるかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

defaultPurgeOnNoConsumers

コンシューマーがなくなったときにブローカーがキューの内容をパージするかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

defaultQueueRoutingType

自動作成されたキューで使用されるルーティングタイプ。デフォルト値は MULTICAST です。

型: String

例: ANYCAST

デフォルト値: MULTICAST

defaultRingSize

リングサイズが明示的に設定されていない、一致するキューのデフォルトのリングサイズ。

型: integer

例: 3

デフォルト値: -1(サイズ制限なし)

enableMetrics

Prometheus プラグインなどの設定されたメトリックプラグインが一致するアドレスまたはアドレスのセットのメトリックを収集するかどうかを指定します。

型: Boolean

例: false

デフォルト値: true

expiryAddress

期限切れのメッセージを受信するアドレス。

型: String

Example: myExpiryAddress

デフォルト値: None

expiryDelay

デフォルトの有効期限を使用しているメッセージに適用される有効期限 (ミリ秒単位)。

型: integer

例: 100

デフォルト値: -1(有効期限は適用されません)

expiryQueuePrefix

ブローカーが自動作成された期限切れキューの名前に適用される接頭辞。

型: String

Example: myExp.

デフォルト値: EXP.

expiryQueueSuffix

ブローカーが自動作成された期限切れキューの名前に適用される接尾辞。

型: String

例: .EXP

デフォルト値: None

lastValueQueue

キューが最後の値のみを使用するかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

managementBrowsePageSize

管理リソースが参照できるメッセージの数を指定します。

型: integer

例: 100

デフォルト値: 200

match*

アドレス設定と、ブローカーで設定されたアドレスとを照合する文字列。正確なアドレス名を指定するか、ワイルドカード式を使用してアドレス設定をアドレスのセットと照合できます。

ワイルドカード式を match プロパティーの値として使用する場合には、値を単一引用符で囲む必要があります (例: 'myOAddresses*')。

型: String

Example: 'myAddresses*'

デフォルト値: None

maxDeliveryAttempts

設定されたデッドレターアドレスにメッセージを送信するまでに、ブローカがメッセージの配信を試行する回数を指定します。

型: integer

例: 20

デフォルト値: 10

maxExpiryDelay

この値より大きい有効期限を使用しているメッセージに適用される有効期限 (ミリ秒単位)。

型: integer

例: 20

デフォルト値: -1(最大有効期限は適用されません)

maxRedeliveryDelay

ブローカーによるメッセージの再配信試行間の最大値 (ミリ秒単位)。

型: integer

例: 100

デフォルト値: デフォルト値は、redelivery Delay の値の 10 倍です。デフォルト値は 0。

maxSizeBytes

アドレスの最大メモリーサイズ (バイト単位)。address Full Policy が PAGING、BLOCK、または FAIL に設定されている場合に使用されます。K、Mb、GB などのバイト表記もサポートしています。

型: String

例: 10Mb

デフォルト値: -1(制限なし)

maxSizeBytesRejectThreshold

ブローカーがメッセージを拒否する前にアドレスが到達できる最大サイズ (バイト単位)。address-full-policy が BLOCK に設定されている場合に使用されます。AMQP プロトコルの場合のみ maxSizeBytes と組み合わせて動作します。

型: integer

例: 500

デフォルト値: -1(最大サイズなし)

messageCounterHistoryDayLimit

ブローカーがアドレスのメッセージカウンター履歴を保持する日数。

型: integer

例: 5

デフォルト値: 0

minExpiryDelay

この値よりも短い有効期限を使用しているメッセージに適用される有効期限 (ミリ秒単位)。

型: integer

例: 20

デフォルト値: -1(最小有効期限は適用されません)

pageMaxCacheSize

ページングナビゲーション中に I/O を最適化するためにメモリー内に保持するページファイルの数。

型: integer

例: 10

デフォルト値: 5

pageSizeBytes

ページングサイズ (バイト単位)。K、Mb、GB などのバイト表記もサポートします。

型: String

例: 20971520

デフォルト値: 10485760(約 10.5 MB)

redeliveryDelay

キャンセルされたメッセージを再配信する前にブローカーが待機する時間 (ミリ秒単位)。

型: integer

例: 100

デフォルト値: 0

redeliveryDelayMultiplier

redelivery Delay の値に適用する倍率。

型: number

例: 5

デフォルト値: 1

redeliveryCollisionAvoidanceFactor

競合を回避するために redelivery Delay の値に適用する倍率。

型: number

例: 1.1

デフォルト値: 0

redistributionDelay

キューの最後のコンシューマーが閉じられてから残りのメッセージを再分配するまでブローカーが待機する時間 (ミリ秒単位) を定義します。

型: integer

例: 100

デフォルト値: -1(未設定)

retroactiveMessageCount

アドレスに今後作成されるキューに対して保持するメッセージの数。

型: integer

例: 100

デフォルト値: 0

sendToDlaOnNoRoute

キューにルーティングされないメッセージは、設定済みのデッドレターアドレスアドレスに送信されます。

型: Boolean

例: True

デフォルト値: false

slowConsumerCheckPeriod

コンシューマーが遅いかどうかをブローカーがチェックする頻度 (秒単位)。

型: integer

例: 15

デフォルト値: 5

slowConsumerPolicy

低速なコンシューマーが特定されたときにどうするのかを指定します。有効なオプションは KILL または NOTIFY です。KILL はコンシューマーの接続を強制終了します。これは、同じ接続を使用するすべてのクライアントスレッドに影響を与えます。NOTIFY は CONSUMER_SLOW 管理通知をクライアントに送信します。

型: String

例: KILL

デフォルト値: NOTIFY

slowConsumerThreshold

最小限許可されるメッセージ消費速度 (秒単位)。この値を下回るとコンシューマーは遅いと見なされます。

型: integer

例: 100

デフォルト値: -1(未設定)

brokerProperties

ブローカーのカスタムリソース定義 (CRD) で公開されていないブローカープロパティーを設定します。それ以外の場合は、カスタムリソース (CR) で設定できません。

<property name>=<value>

ブローカー用に設定するプロパティー名と値のリスト。現在、1 つのプロパティー globalMaxSize は、brokerProperties セクションで設定できます。globalMaxSize プロパティーを設定すると、ブローカーに割り当てられたデフォルトのメモリー量がオーバーライドされます。デフォルトでは、ブローカーには、ブローカーの Java 仮想マシンで使用可能な最大メモリーの半分が割り当てられます。

globalMaxSize プロパティーのデフォルトの単位は bytes です。デフォルトの単位を変更するには、値に m (MB の場合) または g (GB の場合) の接尾辞を追加します。

型: String

例: globalMaxSize=512m

デフォルト値: 該当なし

upgrades

enabled

version の値を更新して、AMQ Broker の新しいターゲットを指定する場合は、Operator が deployment Plan.image の値をそのバージョンの AMQ Broker に対応するブローカーコンテナーイメージに自動更新できるようにするかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

minor

version の値を AMQ Broker の マイナー バージョンから別の バージョン (7.store から 7.10.7 など)に更新するときに、Operator が deploymentPlan.image の値を自動更新できるようにするかどうかを指定します。

型: Boolean

例: True

デフォルト値: false

version

対応するブローカーコンテナーイメージを使用するように Operator が CR を自動更新する先の AMQ Broker のマイナーバージョンを指定します。たとえば、version の値を 7.6.0 から 7.7.0 に変更した場合 (および upgrades.enabled と upgrades.minor の両方が true に設定されている場合)、Operator は deployment Plan.image を registry.redhat.io/amq7/amq-broker-rhel8:7.8-x の形式のブローカーイメージに更新します

型: String

例: 7.7.0

デフォルト値: AMQ Broker の現在のバージョン

addressName*

ブローカーで作成されるアドレス名。

型: String

例: address0

デフォルト値: 指定なし

queueName

ブローカーで作成されるキュー名。queueName が指定されていない場合、CR はアドレスのみを作成します。

型: String

例: queue0

デフォルト値: 指定なし

removeFromBrokerOnDelete*

デプロイメントのアドレス CR インスタンスを削除するときに、Operator がデプロイメント内のすべてのブローカーの既存のアドレスを削除するかどうかを指定します。デフォルト値は false です。これは、CR を削除するときに Operator が既存のアドレスを削除しないことを意味します。

型: Boolean

例: True

デフォルト値: false

routingType*

使用するルーティングタイプ。anycast または multicast。

型: String

例: anycast

デフォルト値: multicast

loginModules

1 つ以上のログインモジュール設定。

ログインモジュールは、次のいずれかのタイプになります。

propertiesLoginModule

name*

ログインモジュールの名前。

型: String

例: my-login

デフォルト値: 該当なし

users.name*

ユーザーの名前。

型: String

例: jdoe

デフォルト値: 該当なし

users.password*

ユーザーのパスワード。

型: String

例: パスワード

デフォルト値: 該当なし

users.roles

ロールの名前。

型: String

例: viewer

デフォルト値: 該当なし

guestLoginModule

name*

ゲストログインモジュールの名前。

型: String

例: guest-login

デフォルト値: 該当なし

guestUser

ゲストユーザーの名前。

型: String

例: myguest

デフォルト値: 該当なし

guestRole

ゲストユーザーのロールの名前。

型: String

例: guest

デフォルト値: 該当なし

keycloakLoginModule

name

KeycloakLoginModule の名前

型: String

例: sso

デフォルト値: 該当なし

moduleType

KeycloakLoginModule のタイプ (directAccess または bearerToken)

型: String

例: bearerToken

デフォルト値: 該当なし

configuration

以下の設定項目は Red Hat シングルサインオンに関連しており、詳細情報は Open IDConnect のドキュメントから入手できます。

configuration.realm*

KeycloakLoginModule のレルム

型: String

例: myrealm

デフォルト値: 該当なし

configuration.realmPublicKey

レルムの公開鍵

型: String

デフォルト値: 該当なし

configuration.authServerUrl*

keycloak 認証サーバーの URL

型: String

デフォルト値: 該当なし

configuration.sslRequired

SSL が必要かどうかを指定します

型: String

有効な値は、all、external、および none です。

configuration.resource*

リソース名

アプリケーションの client-id各アプリケーションには、アプリケーションを識別するために使用される client-id があります。

configuration.publicClient

パブリッククライアントかどうかを指定します。

型: Boolean

デフォルト値: false

例: false

configuration.credentials.key

認証情報キーを指定します。

型: String

デフォルト値: 該当なし

型: String

デフォルト値: 該当なし

configuration.credentials.value

認証情報の値を指定します

型: String

デフォルト値: 該当なし

configuration.useResourceRoleMappings

リソースロールマッピングを使用するかどうかを指定します

型: Boolean

例: false

configuration.enableCors

CORS(Cross-Origin Resource Sharing) を有効にするかどうかを指定します。

CORS プリフライトリクエストを処理します。また、アクセストークンを調べて、有効な発信元を判別します。

型: Boolean

デフォルト値: false

configuration.corsMaxAge

CORS 最大有効期限

CORS が有効な場合は、Access-Control-Max-Age ヘッダーの値が設定されます。

configuration.corsAllowedMethods

CORS で利用可能なメソッド

CORS が有効な場合は、Access-Control-Allow-Methods ヘッダーの値が設定されます。これはコンマ区切りの文字列である必要があります。

configuration.corsAllowedHeaders

CORS で利用可能なヘッダー

CORS が有効な場合は、Access-Control-Allow-Headers ヘッダーの値を設定します。これはコンマ区切りの文字列である必要があります。

configuration.corsExposedHeaders

CORS 公開ヘッダー

CORS が有効な場合は、Access-Control-Expose-Headers ヘッダーの値を設定します。これはコンマ区切りの文字列である必要があります。

configuration.exposeToken

アクセストークンを公開するかどうかを指定します

型: Boolean

デフォルト値: false

configuration.bearerOnly

ベアラートークンを検証するかどうかを指定します

型: Boolean

デフォルト値: false

configuration.autoDetectBearerOnly

ベアラートークンのみを自動検出するかどうかを指定します

型: Boolean

デフォルト値: false

configuration.connectionPoolSize

接続プールのサイズ

型: Integer

デフォルト値: 20

configuration.allowAnyHostName

ホスト名を許可するかどうかを指定します

型: Boolean

デフォルト値: false

configuration.disableTrustManager

トラストマネージャーを無効にするかどうかを指定します

型: Boolean

デフォルト値: false

configuration.trustStore*

トラストストアのパス

これは、ssl-required が none、または disable-trust-manager が true でない限り、必須です。

configuration.trustStorePassword*

トラストストアのパスワード

これは、トラストストアが設定され、トラストストアにパスワードが必要な場合は必須です。

configuration.clientKeyStore

クライアントキーストアのパス

型: String

デフォルト値: 該当なし

configuration.clientKeyStorePassword

クライアントのキーストアパスワード

型: String

デフォルト値: 該当なし

configuration.clientKeyPassword

クライアントキーのパスワード

型: String

デフォルト値: 該当なし

configuration.alwaysRefreshToken

トークンを常に更新するかどうかを指定します

型: Boolean

例: false

configuration.registerNodeAtStartup

起動時にノードを登録するかどうかを指定します

型: Boolean

例: false

configuration.registerNodePeriod

ノードの再登録期間

型: String

デフォルト値: 該当なし

configuration.tokenStore

トークンストアのタイプ (session または Cookie)

型: String

デフォルト値: 該当なし

configuration.tokenCookiePath

クッキーストアのクッキーパス

型: String

デフォルト値: 該当なし

configuration.principalAttribute

UserPrincipal 名を入力する OpenID Connect ID Token 属性。

UserPrincipal 名を入力する OpenID Connect ID Token 属性。トークン属性が null の場合、デフォルトは sub に設定されます。使用できる値は sub、preferred_username、email、name、nickname、given_name、family_name です。

configuration.proxyUrl

プロキシー URL

configuration.turnOffChangeSessionIdOnLogin

ログインに成功したときにセッション ID を変更するかどうかを指定します

型: Boolean

例: false

configuration.tokenMinimumTimeToLive

アクティブなアクセストークンを更新するまでの最小時間

型: Integer

デフォルト値: 0

configuration.minTimeBetweenJwksRequests

新しい公開鍵取得の Keycloak への要求 2 件の間で最小限あける間隔

型: Integer

デフォルト値: 10

configuration.publicKeyCacheTtl

新しい公開鍵取得の Keycloak への要求 2 件の間で最大あけることのできる間隔

型: Integer

デフォルト値: 86400

configuration.ignoreOauthQueryParameter

ベアラートークン処理の access_token クエリーパラメーターの処理をオフにするかどうか

型: Boolean

例: false

configuration.verifyTokenAudience

トークンにオーディエンスとしてこのクライアント名 (リソース) が含まれているかどうかを検証します

型: Boolean

例: false

configuration.enableBasicAuth

Basic 認証をサポートするかどうか

型: Boolean

デフォルト値: false

configuration.confidentialPort

SSL/TLS を介した安全な接続で Keycloak サーバーが使用する機密ポート

型: Integer

例: 8443

configuration.redirectRewriteRules.key

リダイレクト URI の照合に使用される正規表現。

型: String

デフォルト値: 該当なし

configuration.redirectRewriteRules.value

置換文字列

型: String

デフォルト値: 該当なし

configuration.scope

Direct Access Grants Login Module の OAuth2 スコープパラメーター

型: String

デフォルト値: 該当なし

securityDomains

ブローカーのセキュリティードメイン

brokerDomain.name

ブローカードメイン名

型: String

例: activemq

デフォルト値: 該当なし

brokerDomain.loginModules

1 つ以上のログインモジュール。各エントリーは、上記の login Modules セクションで事前に定義されている必要があります。

brokerDomain.loginModules.name

ログインモジュールの名前

型: String

例: prop-module

デフォルト値: 該当なし

brokerDomain.loginModules.flag

PropertiesLoginModule と同じように、required、requisite、sufficient および optional が有効な値です。

型: String

例: sufficient

デフォルト値: 該当なし

brokerDomain.loginModules.debug

デバッグ

brokerDomain.loginModules.reload

Reload

consoleDomain.name

ブローカードメイン名

型: String

例: activemq

デフォルト値: 該当なし

consoleDomain.loginModules

シングルログインモジュール設定。

consoleDomain.loginModules.name

ログインモジュールの名前

型: String

例: prop-module

デフォルト値: 該当なし

consoleDomain.loginModules.flag

PropertiesLoginModule と同じように、required、requisite、sufficient および optional が有効な値です。

型: String

例: sufficient

デフォルト値: 該当なし

consoleDomain.loginModules.debug

デバッグ

型: Boolean

例: false

consoleDomain.loginModules.reload

Reload

型: Boolean

例: True

デフォルト: false

securitySettings

broker.xml または management.xml に追加する別のセキュリティー設定

broker.match

セキュリティー設定セクションのアドレス一致パターン。一致パターンの構文の詳細は、AMQ Broker wildcard syntax を参照してください。

broker.permissions.operationType

Setting permissions で説明されているように、セキュリティー設定の操作タイプです。

型: String

例: createAddress

デフォルト値: 該当なし

broker.permissions.roles

Setting permissions で説明されているように、セキュリティー設定はこれらのロールに適用されます。

型: String

例: root

デフォルト値: 該当なし

securitySettings.management

management.xml を設定するためのオプション。

hawtioRoles

ブローカーコンソールへのログインを許可されたロール。

型: String

例: root

デフォルト値: 該当なし

connector.host

管理 API に接続するためのコネクターホスト。

型: String

例: myhost

デフォルト値: localhost

connector.port

管理 API に接続するためのコネクターポート。

型: integer

例: 1099

デフォルト値: 1099

connector.jmxRealm

管理 API の JMX レルム。

型: String

例: activemq

デフォルト値: activemq

connector.objectName

管理 API の JMX オブジェクト名。

型: String

例: connector:name = rmi

デフォルト: connector:name = rmi

connector.authenticatorType

管理 API 認証タイプ。

型: String

例: パスワード

デフォルト: password

connector.secured

管理 API 接続が保護されているかどうか。

型: Boolean

例: True

デフォルト値: false

connector.keyStoreProvider

管理コネクターのキーストアプロバイダー。Connector.secured = "true" を設定した場合に必要です。デフォルト値は JKS です。

connector.keyStorePath

キーストアの場所。Connector.secured = "true" を設定した場合に必要です。

connector.keyStorePassword

管理コネクターのキーストアパスワード。Connector.secured = "true" を設定した場合に必要です。

connector.trustStoreProvider

管理コネクターのトラストストアプロバイダー connector.secured = "true"を設定した場合に必要です。

型: String

例: JKS

デフォルト: JKS

connector.trustStorePath

管理コネクターのトラストストアの場所。Connector.secured = "true" を設定した場合に必要です。

型: String

デフォルト値: 該当なし

connector.trustStorePassword

管理コネクターのトラストストアパスワード。Connector.secured = "true" を設定した場合に必要です。

型: String

デフォルト値: 該当なし

connector.passwordCodec

管理コネクターのパスワードコーデック。Encrypting a password in a configuration file で説明されているように、使用するパスワードコーデックの完全修飾クラス名。

authorisation.allowedList.domain

allowedList のドメイン

型: String

デフォルト値: 該当なし

authorisation.allowedList.key

allowedList のキー

型: String

デフォルト値: 該当なし

authorisation.defaultAccess.method

defaultAccessList のメソッド

型: String

デフォルト値: 該当なし

authorisation.defaultAccess.roles

defaultAccess リストのロール

型: String

デフォルト値: 該当なし

authorisation.roleAccess.domain

roleAccess リストのドメイン

型: String

デフォルト値: 該当なし

authorisation.roleAccess.key

roleAccess リストのキー

型: String

デフォルト値: 該当なし

authorisation.roleAccess.accessList.method

roleAccess リストの方法

型: String

デフォルト値: 該当なし

authorisation.roleAccess.accessList.roles

roleAccess リストのロール

型: String

デフォルト値: 該当なし

applyToCrNames

このセキュリティー設定を、現在の名前空間の指定された CR で定義したブローカーに適用します。* または空の文字列の値は、すべてのブローカーに適用することを意味します。

型: String

例: my-broker

デフォルト値: 現在の名前空間の CR で定義したすべてのブローカー。