[OpenShift Container Platform][IBM Cloud Pak for Integration]

API reference for QueueManager (mq.ibm.com/v1beta1)

QueueManager

A QueueManager is an IBM MQ server which provides queuing and publish/subscribe services to applications. IBM MQ Documentation: https://ibm.biz/BdPZqj. License reference: https://ibm.biz/BdPZfq..

Field Description
apiVersion string APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.
kind string Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.
metadata  
spec QueueManagerSpec The desired state of the QueueManager.
status QueueManagerStatus The observed state of the QueueManager.

.spec

The desired state of the QueueManager.

Appears in:
Field Description
affinity Standard Kubernetes affinity rules. For more information, see https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#affinity-v1-core.
annotations Annotations The annotations field serves as a pass-through for Pod annotations. Users can add any annotation to this field and have it apply to the Pod. The annotations here overwrite the default annotations if provided. Requires MQ Operator 1.3.0 or higher.
imagePullSecrets LocalObjectReference array An optional list of references to secrets in the same namespace to use for pulling any of the images used by this QueueManager. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. For more information, see https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod.
labels Labels The labels field serves as a pass-through for Pod labels. Users can add any label to this field and have it apply to the Pod. The labels here overwrite the default labels if provided. Requires MQ Operator 1.3.0 or higher.
license License Settings that control your acceptance of the license, and which license metrics to use.
pki PKI Public Key Infrastructure settings, for defining keys and certificates for use with Transport Layer Security (TLS) or MQ Advanced Message Security (AMS).
queueManager QueueManagerConfig Settings for the Queue Manager container and underlying Queue Manager.
securityContext SecurityContext Security settings to add to the Queue Manager Pod's securityContext.
telemetry Telemetry Settings for Open Telemetry configuration. Requires MQ Operator 2.2.0 or higher.
template Template Advanced templating for Kubernetes resources. The template allows users to override how IBM MQ generates the underlying Kubernetes resources, such as StatefulSet, Pods and Services. This is for advanced users only, as it has the potential to disrupt normal operation of MQ if used incorrectly. Any values specified anywhere else in the QueueManager resource will be overridden by settings in the template.
terminationGracePeriodSeconds integer Optional duration in seconds the Pod needs to terminate gracefully. Value must be non-negative integer. The value zero indicates delete immediately. The target time in which ending the queue manager is attempted, escalating the phases of application disconnection. Essential queue manager maintenance tasks are interrupted if necessary. Defaults to 30 seconds.
tracing TracingConfig Settings for tracing integration with the Cloud Pak for Integration Operations Dashboard.
version string Setting that controls the version of MQ that will be used (required). For example: 9.1.5.0-r2 would specify MQ version 9.1.5.0, using the second revision of the container image. Container-specific fixes are often applied in revisions, such as fixes to the base image.
web WebServerConfig Settings for the MQ web server.

.spec.annotations

The annotations field serves as a pass-through for Pod annotations. Users can add any annotation to this field and have it apply to the Pod. The annotations here overwrite the default annotations if provided. Requires MQ Operator 1.3.0 or higher.

Appears in:

.spec.imagePullSecrets

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Appears in:
Field Description
name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?.

.spec.labels

The labels field serves as a pass-through for Pod labels. Users can add any label to this field and have it apply to the Pod. The labels here overwrite the default labels if provided. Requires MQ Operator 1.3.0 or higher.

Appears in:

.spec.license

Settings that control your acceptance of the license, and which license metrics to use.

Appears in:
Field Description
accept boolean Whether or not you accept the license associated with this software (required).
license string The identifier of the license you are accepting. This must be the correct license identifier for the version of MQ you are using. See https://ibm.biz/BdPZfq for valid values.
metric string Setting that specifies which license metric to use. For example, ProcessorValueUnit, VirtualProcessorCore or ManagedVirtualServer. Defaults to ProcessorValueUnit when using an MQ license and VirtualProcessorCore when using a Cloud Pak for Integration license.
use string Setting that controls how the software will to be used, where the license supports multiple uses. See https://ibm.biz/BdPZfq for valid values.

.spec.pki

Public Key Infrastructure settings, for defining keys and certificates for use with Transport Layer Security (TLS) or MQ Advanced Message Security (AMS).

Appears in:
Field Description
keys PKISource array Private keys to add to the Queue Manager's key repository.
trust PKISource array Certificates to add to the Queue Manager's key repository.

.spec.pki.keys

PKISource defines a source of Public Key Infrastructure information, such as keys or certificates.

Appears in:
Field Description
name string Name is used as the label for the key or certificate. Must be a lowercase alphanumeric string.
secret Secret Supply a key using a Kubernetes Secret.

.spec.pki.keys.secret

Supply a key using a Kubernetes Secret.

Appears in:
Field Description
items array Keys inside the Kubernetes secret which should be added to the Queue Manager container.
secretName string The name of the Kubernetes secret.

.spec.pki.trust

PKISource defines a source of Public Key Infrastructure information, such as keys or certificates.

Appears in:
Field Description
name string Name is used as the label for the key or certificate. Must be a lowercase alphanumeric string.
secret Secret Supply a key using a Kubernetes Secret.

.spec.pki.trust.secret

Supply a key using a Kubernetes Secret.

Appears in:
Field Description
items array Keys inside the Kubernetes secret which should be added to the Queue Manager container.
secretName string The name of the Kubernetes secret.

.spec.queueManager

Settings for the Queue Manager container and underlying Queue Manager.

Appears in:
Field Description
availability Availability Availability settings for the Queue Manager, such as whether or not to use an active-standby pair or native high availability.
debug boolean Whether or not to log debug messages from the container-specific code, to the container log. Defaults to false.
image string The container image that will be used.
imagePullPolicy string Setting that controls when the kubelet attempts to pull the specified image. Defaults to IfNotPresent.
ini INISource array Settings for supplying INI for the Queue Manager. Requires MQ Operator 1.1.0 or higher.
livenessProbe QueueManagerLivenessProbe Settings that control the liveness probe.
logFormat string Which log format to use for this container. Use JSON for JSON-formatted logs from the container. Use Basic for text-formatted messages. Defaults to Basic.
metrics QueueManagerMetrics Settings for Prometheus-style metrics.
mqsc MQSCSource array Settings for supplying MQSC for the Queue Manager. Requires MQ Operator 1.1.0 or higher.
name string Name of the underlying MQ Queue Manager, if different from metadata.name. Use this field if you want a Queue Manager name which does not conform to the Kubernetes rules for names (for example, a name which includes capital letters).
readinessProbe QueueManagerReadinessProbe Settings that control the readiness probe.
recoveryLogs RecoveryLogs Settings for MQ recovery logs. Requires MQ Operator 2.4.0 or higher.
resources Resources Settings that control resource requirements.
route Route Settings for the Queue Manager route. Requires MQ Operator 1.4.0 or higher.
startupProbe StartupProbe Settings that control the startup probe. Only applies to MultiInstance and NativeHA deployments. Requires MQ Operator 1.5.0 or higher.
storage QueueManagerStorage Storage settings to control the Queue Manager's use of persistent volumes and storage classes.

.spec.queueManager.availability

Availability settings for the Queue Manager, such as whether or not to use an active-standby pair or native high availability.

Appears in:
Field Description
tls Tls Optional TLS settings for configuring secure communication between NativeHA replicas. Requires MQ Operator 1.5.0 or higher.
type string The type of availability to use. Use SingleInstance for a single Pod, which will be restarted automatically (in some cases) by Kubernetes. Use MultiInstance for a pair of Pods, one of which is the active Queue Manager, and the other of which is a standby. Use NativeHA for native high availability replication (requires MQ Operator 1.5.0 or higher). Defaults to SingleInstance. See http://ibm.biz/BdqAQa for more details.
updateStrategy string The update strategy to use for MultiInstance and NativeHA Queue Managers. Use RollingUpdate to enable automatic rolling updates whenever the Queue Manager configuration changes. Use OnDelete to disable automatic rolling updates, Queue Manager changes will only be applied when Pods are deleted (including Pod deletions triggered by external factors). Defaults to RollingUpdate. Requires MQ Operator 1.6.0 or higher.

.spec.queueManager.availability.tls

Optional TLS settings for configuring secure communication between NativeHA replicas. Requires MQ Operator 1.5.0 or higher.

Appears in:
Field Description
cipherSpec string The name of the CipherSpec for NativeHA TLS.
secretName string The name of the Kubernetes secret.

.spec.queueManager.ini

Source of INI configuration files.

Appears in:
Field Description
configMap ConfigMapINISource ConfigMap represents a Kubernetes ConfigMap that contains INI information.
secret SecretINISource Secret represents a Kubernetes Secret that contains INI information.

.spec.queueManager.ini.configMap

ConfigMap represents a Kubernetes ConfigMap that contains INI information.

Appears in:
Field Description
items array Keys inside the Kubernetes source which should be applied.
name string The name of the Kubernetes source.

.spec.queueManager.ini.secret

Secret represents a Kubernetes Secret that contains INI information.

Appears in:
Field Description
items array Keys inside the Kubernetes source which should be applied.
name string The name of the Kubernetes source.

.spec.queueManager.livenessProbe

Settings that control the liveness probe.

Appears in:
Field Description
failureThreshold integer Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 1.
initialDelaySeconds integer Number of seconds after the container has started before the probe is initiated. Defaults to 90 seconds for SingleInstance. Defaults to 0 seconds for MultiInstance and NativeHA deployments. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.
periodSeconds integer How often (in seconds) to perform the probe. Defaults to 10 seconds.
successThreshold integer Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.
timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 5 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

.spec.queueManager.metrics

Settings for Prometheus-style metrics.

Appears in:
Field Description
enabled boolean Whether or not to enable an endpoint for Prometheus-compatible metrics. Defaults to true.

.spec.queueManager.mqsc

Source of MQSC configuration files.

Appears in:
Field Description
configMap ConfigMapMQSCSource ConfigMap represents a Kubernetes ConfigMap that contains MQSC information.
secret SecretMQSCSource Secret represents a Kubernetes Secret that contains MQSC information.

.spec.queueManager.mqsc.configMap

ConfigMap represents a Kubernetes ConfigMap that contains MQSC information.

Appears in:
Field Description
items array Keys inside the Kubernetes source which should be applied.
name string The name of the Kubernetes source.

.spec.queueManager.mqsc.secret

Secret represents a Kubernetes Secret that contains MQSC information.

Appears in:
Field Description
items array Keys inside the Kubernetes source which should be applied.
name string The name of the Kubernetes source.

.spec.queueManager.readinessProbe

Settings that control the readiness probe.

Appears in:
Field Description
failureThreshold integer Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 1.
initialDelaySeconds integer Number of seconds after the container has started before the probe is initiated. Defaults to 10 seconds for SingleInstance. Defaults to 0 for MultiInstance and NativeHA deployments. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.
periodSeconds integer How often (in seconds) to perform the probe. Defaults to 5 seconds.
successThreshold integer Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.
timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 3 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

.spec.queueManager.recoveryLogs

Settings for MQ recovery logs. Requires MQ Operator 2.4.0 or higher.

Appears in:
Field Description
logFilePages integer The recovery log data is held in a series of files. The log file size is specified in units of 4 KB pages.

.spec.queueManager.resources

Settings that control resource requirements.

Appears in:
Field Description
limits Limits CPU & memory settings.
requests Requests CPU & memory settings.

.spec.queueManager.resources.limits

CPU & memory settings.

Appears in:
Field Description
cpu  
memory  

.spec.queueManager.resources.requests

CPU & memory settings.

Appears in:
Field Description
cpu  
memory  

.spec.queueManager.route

Settings for the Queue Manager route. Requires MQ Operator 1.4.0 or higher.

Appears in:
Field Description
enabled boolean Whether or not to enable the route. Defaults to true.

.spec.queueManager.startupProbe

Settings that control the startup probe. Only applies to MultiInstance and NativeHA deployments. Requires MQ Operator 1.5.0 or higher.

Appears in:
Field Description
failureThreshold integer Minimum consecutive failures for the probe to be considered failed. Defaults to 24.
initialDelaySeconds integer Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.
periodSeconds integer How often (in seconds) to perform the probe. Defaults to 5 seconds.
successThreshold integer Minimum consecutive successes for the probe to be considered successful. Defaults to 1.
timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 5 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

.spec.queueManager.storage

Storage settings to control the Queue Manager's use of persistent volumes and storage classes.

Appears in:
Field Description
allowVolumeExpansion boolean Whether or not to allow volumes to be expanded.
defaultClass string Storage class to apply to all persistent volumes of this Queue Manager by default. Specific persistent volumes can define their own storage class which will override this default storage class setting. If type of availability is SingleInstance or NativeHA, storage class can be of type ReadWriteOnce or ReadWriteMany. If type of availability is MultiInstance, storage class must be of type ReadWriteMany.
defaultDeleteClaim boolean Whether or not all the volumes should be deleted when the Queue Manager is deleted. Specific persistent volumes can define their own value for deleteClaim which will override this defaultDeleteClaim setting. Defaults to false.
persistedData QueueManagerOptionalVolume PersistentVolume details for MQ persisted data, including configuration, queues and messages. Required when using multi-instance Queue Manager.
queueManager QueueManagerVolume Default PersistentVolume for any data normally under /var/mqm. Will contain all persisted data and recovery logs, if no other volumes are specified.
recoveryLogs QueueManagerOptionalVolume Persistent volume details for MQ recovery logs. Required when using multi-instance Queue Manager.
scratch Scratch Settings for the Queue Manager's Scratch ephemeral volume. This volume will be mounted as the '/run' folder on the container. Only applicable if the root filesystem is set to read-only. Requires MQ Operator 3.0.0 or higher.
tmp Tmp Settings for the Queue Manager's Tmp ephemeral volume. This volume will be mounted on the container as the '/tmp' folder. The diagnostic data files, such as the zip file produced by the runmqras command, will be created in this volume. Only applicable if the root filesystem is set to read-only. Requires MQ Operator 3.0.0 or higher.

.spec.queueManager.storage.persistedData

PersistentVolume details for MQ persisted data, including configuration, queues and messages. Required when using multi-instance Queue Manager.

Appears in:
Field Description
class string Storage class to use for this volume. Only valid if type is persistent-claim. If type of availability is SingleInstance or NativeHA, storage class can be of type ReadWriteOnce or ReadWriteMany. If type of availability is MultiInstance, storage class must be of type ReadWriteMany.
deleteClaim boolean Whether or not this volume should be deleted when the Queue Manager is deleted.
enabled boolean Whether or not this volume should be enabled as a separate volume, or be placed on the default queueManager volume. Defaults to false.
size string Size of the PersistentVolume to pass to Kubernetes, including SI units. Only valid if type is persistent-claim. For example, 2Gi. Defaults to 2Gi.
sizeLimit string Size limit when using an ephemeral volume. Files are still written to a temporary directory, so you can use this option to limit the size. Only valid if type is ephemeral and root filesystem is set to read-only. Requires MQ Operator 3.0.0 or higher.
type string Type of volume to use. Choose ephemeral to use non-persistent storage, or persistent-claim to use a persistent volume. Defaults to persistent-claim.

.spec.queueManager.storage.queueManager

Default PersistentVolume for any data normally under /var/mqm. Will contain all persisted data and recovery logs, if no other volumes are specified.

Appears in:
Field Description
class string Storage class to use for this volume. Only valid if type is persistent-claim. If type of availability is SingleInstance or NativeHA, storage class can be of type ReadWriteOnce or ReadWriteMany. If type of availability is MultiInstance, storage class must be of type ReadWriteMany.
deleteClaim boolean Whether or not this volume should be deleted when the Queue Manager is deleted.
size string Size of the PersistentVolume to pass to Kubernetes, including SI units. Only valid if type is persistent-claim. For example, 2Gi. Defaults to 2Gi.
sizeLimit string Size limit when using an ephemeral volume. Files are still written to a temporary directory, so you can use this option to limit the size. Only valid if type is ephemeral and root filesystem is set to read-only. Requires MQ Operator 3.0.0 or higher.
type string Type of volume to use. Choose ephemeral to use non-persistent storage, or persistent-claim to use a persistent volume. Defaults to persistent-claim.

.spec.queueManager.storage.recoveryLogs

Persistent volume details for MQ recovery logs. Required when using multi-instance Queue Manager.

Appears in:
Field Description
class string Storage class to use for this volume. Only valid if type is persistent-claim. If type of availability is SingleInstance or NativeHA, storage class can be of type ReadWriteOnce or ReadWriteMany. If type of availability is MultiInstance, storage class must be of type ReadWriteMany.
deleteClaim boolean Whether or not this volume should be deleted when the Queue Manager is deleted.
enabled boolean Whether or not this volume should be enabled as a separate volume, or be placed on the default queueManager volume. Defaults to false.
size string Size of the PersistentVolume to pass to Kubernetes, including SI units. Only valid if type is persistent-claim. For example, 2Gi. Defaults to 2Gi.
sizeLimit string Size limit when using an ephemeral volume. Files are still written to a temporary directory, so you can use this option to limit the size. Only valid if type is ephemeral and root filesystem is set to read-only. Requires MQ Operator 3.0.0 or higher.
type string Type of volume to use. Choose ephemeral to use non-persistent storage, or persistent-claim to use a persistent volume. Defaults to persistent-claim.

.spec.queueManager.storage.scratch

Settings for the Queue Manager's Scratch ephemeral volume. This volume will be mounted as the '/run' folder on the container. Only applicable if the root filesystem is set to read-only. Requires MQ Operator 3.0.0 or higher.

Appears in:
Field Description
sizeLimit string Size limit of the ephemeral volume, including SI units. For example, 2Gi. Valid only when root filesystem is set to read-only. Requires MQ Operator 3.0.0 or higher.

.spec.queueManager.storage.tmp

Settings for the Queue Manager's Tmp ephemeral volume. This volume will be mounted on the container as the '/tmp' folder. The diagnostic data files, such as the zip file produced by the runmqras command, will be created in this volume. Only applicable if the root filesystem is set to read-only. Requires MQ Operator 3.0.0 or higher.

Appears in:
Field Description
sizeLimit string Size limit of the ephemeral volume, including SI units. For example, 2Gi. Valid only when root filesystem is set to read-only. Requires MQ Operator 3.0.0 or higher.

.spec.securityContext

Security settings to add to the Queue Manager Pod's securityContext.

Appears in:
Field Description
fsGroup integer A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.
initVolumeAsRoot boolean This affects the securityContext used by the container which initializes the PersistentVolume. Set this to true if you are using a storage provider which requires you to be the root user to access newly provisioned volumes. Setting this to true affects which Security Context Constraints (SCC) object you can use, and the Queue Manager may fail to start if you are not authorized to use an SCC which allows the root user. Defaults to false. For more information, see https://docs.openshift.com/container-platform/latest/authentication/managing-security-context-constraints.html.
readOnlyRootFilesystem boolean Whether or not to enable read-only root filesystem settings for the Queue Manager. Defaults to false. Requires MQ Operator 3.0.0 or higher.
supplementalGroups array A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.

.spec.telemetry

Settings for Open Telemetry configuration. Requires MQ Operator 2.2.0 or higher.

Appears in:
Field Description
tracing Tracing Settings for Open Telemetry tracing.

.spec.telemetry.tracing

Settings for Open Telemetry tracing.

Appears in:
Field Description
instana Instana Settings for Instana tracing.

.spec.telemetry.tracing.instana

Settings for Instana tracing.

Appears in:
Field Description
agentHost string The hostname of the Instana agent to send tracing data to. This should not include a protocol.
enabled boolean Whether or not to enable Instana tracing. Defaults to false.
protocol string The protocol to be used in communication with the Instana agent. http and https are supported.

.spec.template

Advanced templating for Kubernetes resources. The template allows users to override how IBM MQ generates the underlying Kubernetes resources, such as StatefulSet, Pods and Services. This is for advanced users only, as it has the potential to disrupt normal operation of MQ if used incorrectly. Any values specified anywhere else in the QueueManager resource will be overridden by settings in the template.

Appears in:
Field Description
pod Overrides for the template used for the Pod. See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#podspec-v1-core.

.spec.tracing

Settings for tracing integration with the Cloud Pak for Integration Operations Dashboard.

Appears in:
Field Description
agent TracingAgent In Cloud Pak for Integration only, you can configure settings for the optional Tracing Agent.
collector TracingCollector In Cloud Pak for Integration only, you can configure settings for the optional Tracing Collector.
enabled boolean Whether or not to enable integration with the Cloud Pak for Integration Operations Dashboard, via tracing. Defaults to false.
namespace string Namespace where the Cloud Pak for Integration Operations Dashboard is installed.

.spec.tracing.agent

In Cloud Pak for Integration only, you can configure settings for the optional Tracing Agent.

Appears in:
Field Description
image string The container image that will be used.
imagePullPolicy string Setting that controls when the kubelet attempts to pull the specified image. Defaults to IfNotPresent.
livenessProbe TracingProbe Settings that control the liveness probe.
readinessProbe TracingProbe Settings that control the readiness probe.

.spec.tracing.agent.livenessProbe

Settings that control the liveness probe.

Appears in:
Field Description
failureThreshold integer Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 1.
initialDelaySeconds integer Number of seconds after the container has started before liveness probes are initiated. Defaults to 10 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.
periodSeconds integer How often (in seconds) to perform the probe. Defaults to 10 seconds.
successThreshold integer Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.
timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 2 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

.spec.tracing.agent.readinessProbe

Settings that control the readiness probe.

Appears in:
Field Description
failureThreshold integer Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 1.
initialDelaySeconds integer Number of seconds after the container has started before liveness probes are initiated. Defaults to 10 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.
periodSeconds integer How often (in seconds) to perform the probe. Defaults to 10 seconds.
successThreshold integer Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.
timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 2 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

.spec.tracing.collector

In Cloud Pak for Integration only, you can configure settings for the optional Tracing Collector.

Appears in:
Field Description
image string The container image that will be used.
imagePullPolicy string Setting that controls when the kubelet attempts to pull the specified image. Defaults to IfNotPresent.
livenessProbe TracingProbe Settings that control the liveness probe.
readinessProbe TracingProbe Settings that control the readiness probe.

.spec.tracing.collector.livenessProbe

Settings that control the liveness probe.

Appears in:
Field Description
failureThreshold integer Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 1.
initialDelaySeconds integer Number of seconds after the container has started before liveness probes are initiated. Defaults to 10 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.
periodSeconds integer How often (in seconds) to perform the probe. Defaults to 10 seconds.
successThreshold integer Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.
timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 2 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

.spec.tracing.collector.readinessProbe

Settings that control the readiness probe.

Appears in:
Field Description
failureThreshold integer Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 1.
initialDelaySeconds integer Number of seconds after the container has started before liveness probes are initiated. Defaults to 10 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.
periodSeconds integer How often (in seconds) to perform the probe. Defaults to 10 seconds.
successThreshold integer Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.
timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 2 seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

.spec.web

Settings for the MQ web server.

Appears in:
Field Description
console Console Settings for the MQ web console. Requires MQ Operator 3.0.0 or higher.
enabled boolean Whether or not to enable the web server. Defaults to false.
manualConfig ManualConfig Settings for supplying web server XML configuration. Requires MQ Operator 3.0.0 or higher.

.spec.web.console

Settings for the MQ web console. Requires MQ Operator 3.0.0 or higher.

Appears in:
Field Description
authentication Authentication Authentication settings for the MQ web console. Requires MQ Operator 3.0.0 or higher.
authorization Authorization Authorization settings for the MQ web console. Requires MQ Operator 3.0.0 or higher.

.spec.web.console.authentication

Authentication settings for the MQ web console. Requires MQ Operator 3.0.0 or higher.

Appears in:
Field Description
provider string The authentication provider to use for the MQ web console. Use integration-keycloak to use single sign-on with the Cloud Pak for Integration Platform UI (Keycloak). Defaults to integration-keycloak if you use a Cloud Pak for Integration license, or manual if you use an MQ license. Use manual if you want to provide your own configuration.

.spec.web.console.authorization

Authorization settings for the MQ web console. Requires MQ Operator 3.0.0 or higher.

Appears in:
Field Description
provider string The authorization provider to use for the MQ web console. Use integration-keycloak to use roles provided by the Cloud Pak for Integration Keycloak. Use manual if you want to provide your own configuration. Defaults to integration-keycloak if you use a Cloud Pak for Integration license, or manual if you use an MQ license.

.spec.web.manualConfig

Settings for supplying web server XML configuration. Requires MQ Operator 3.0.0 or higher.

Appears in:
Field Description
configMap ConfigMap ConfigMap represents a Kubernetes ConfigMap that contains web server XML configuration.
secret Secret Secret represents a Kubernetes Secret that contains web server XML configuration. Using a Secret protects any credentials in the Kubernetes layer, but it’s possible that monitoring or troubleshooting tools might expose the underlying file insecurely. For improved security, encode credentials using “securityUtility”.

.spec.web.manualConfig.configMap

ConfigMap represents a Kubernetes ConfigMap that contains web server XML configuration.

Appears in:
Field Description
name string The name of the Kubernetes source.

.spec.web.manualConfig.secret

Secret represents a Kubernetes Secret that contains web server XML configuration. Using a Secret protects any credentials in the Kubernetes layer, but it’s possible that monitoring or troubleshooting tools might expose the underlying file insecurely. For improved security, encode credentials using “securityUtility”.

Appears in:
Field Description
name string The name of the Kubernetes source.

.status

The observed state of the QueueManager.

Appears in:
Field Description
adminUiUrl string URL for the Admin UI.
availability Availability Availability status for the Queue Manager.
conditions QueueManagerStatusCondition array Conditions represent the latest available observations of the Queue Manager's state.
endpoints QueueManagerStatusEndpoint array Information on the endpoints that this Queue Manager is exposing, such as API or UI endpoints.
metadata Metadata Metadata represents additional information for the Queue Manager, including Integration-Keycloak status.
name string The name of the Queue Manager.
phase string Phase of the Queue Manager's state.
versions QueueManagerStatusVersion Version of MQ being used, and other versions available from the IBM Entitled Registry.

.status.availability

Availability status for the Queue Manager.

Appears in:
Field Description
initialQuorumEstablished boolean Whether or not an initial quorum has been established for NativeHA.

.status.conditions

QueueManagerStatusCondition defines the conditions of the Queue Manager.

Appears in:
Field Description
lastTransitionTime string Last time the condition transitioned from one status to another.
message string Human-readable message indicating details about last transition.
reason string Reason for last transition of this status.
status string Status of the condition.
type string Type of condition.

.status.endpoints

QueueManagerStatusEndpoint defines the endpoints for the QueueManager.

Appears in:
Field Description
name string Name of the endpoint.
type string The type of the endpoint, for example 'UI' for a UI endpoint, 'API' for an API endpoint, 'OpenAPI' for API documentation.
uri string URI for the endpoint.

.status.metadata

Metadata represents additional information for the Queue Manager, including Integration-Keycloak status.

Appears in:
Field Description
integrationKeycloak IntegrationKeycloak QueueManagerStatusIntegrationKeycloak defines the Integration-Keycloak status for the QueueManager.

.status.metadata.integrationKeycloak

QueueManagerStatusIntegrationKeycloak defines the Integration-Keycloak status for the QueueManager.

Appears in:
Field Description
clientName string  

.status.versions

Version of MQ being used, and other versions available from the IBM Entitled Registry.

Appears in:
Field Description
available QueueManagerStatusVersionAvailable Other versions of MQ available from the IBM Entitled Registry.
reconciled string The specific version of IBM MQ being used. If a custom image is specified, then this may not match the version of MQ actually being used.

.status.versions.available

Other versions of MQ available from the IBM Entitled Registry.

Appears in:
Field Description
channels array Channels which are available for automatically updating the MQ version.
versions Versions array Specific versions of MQ which are available.

.status.versions.available.versions

QueueManagerStatusVersion defines a version of MQ.

Appears in:
Field Description
licenses Licenses array Licenses that are applicable for this version of QueueManager.
name string Version name for this version of QueueManager. These are valid values for the spec.version field.

.status.versions.available.versions.licenses

QueueManagerStatusLicense defines a license.

Appears in:
Field Description
displayName string Display name for the license.
link string Link to the license content.
matchesCurrentType boolean Whether or not the license matches the type of license currently used.
name string Name of the license.