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.
Field | Description |
---|---|
spec QueueManagerSpec | The desired state of the QueueManager. |
status QueueManagerStatus | The observed state of the QueueManager. |
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
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. |
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. |
version string | Set 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 | Sets for the MQ web server. |
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. |
license License | Sets 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 | Sets for the Queue Manager container and underlying Queue Manager. |
securityContext SecurityContext | Security settings to add to the Queue Manager Pod's securityContext. |
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. |
tracing TracingConfig | Sets for tracing integration with the Cloud Pak for Integration Operations Dashboard. |
.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.license
Sets 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 we are accepting. This must be the correct license identifier for the version of MQ we are using. See http://ibm.biz/BdqvCF for valid values. |
metric string | Set that specifies which license metric to use. For example, ProcessorValueUnit, VirtualProcessorCore or ManagedVirtualServer. |
use string | Set that controls how the software will to be used, where the license supports multiple uses. See http://ibm.biz/BdqvCF 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
Sets for the Queue Manager container and underlying Queue Manager.
Appears in:
Field | Description |
---|---|
ini INISource array | Sets for supplying INI for the Queue Manager. Requires MQ Operator 1.1.0 or higher. |
metrics QueueManagerMetrics | Sets for Prometheus-style metrics. |
name string | Name of the underlying MQ Queue Manager, if different from metadata.name. Use this field if we want a Queue Manager name which does not conform to the Kubernetes rules for names (for example, a name which includes captial letters). |
readinessProbe QueueManagerReadinessProbe | Sets that control the readiness probe. |
image string | The container image that will be used. |
imagePullPolicy string | Set that controls when the kubelet attempts to pull the specified image. |
livenessProbe QueueManagerLivenessProbe | Sets 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. |
mqsc MQSCSource array | Sets for supplying MQSC for the Queue Manager. Requires MQ Operator 1.1.0 or higher. |
resources Resources | Sets that control resource requirements. |
storage QueueManagerStorage | Storage settings to control the Queue Manager's use of Persistent Volumes and Storage Classes. |
availability Availability | Availability settings for the Queue Manager, such as whether or not to use an active-standby pair. |
debug boolean | Whether or not to log debug messages from the container-specific code, to the container log. |
.spec.queueManager.availability
Availability settings for the Queue Manager, such as whether or not to use an active-standby pair.
Appears in:
Field | Description |
---|---|
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. See http://ibm.biz/BdqAQa for more details. |
.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
Sets that control the liveness probe.
Appears in:
Field | Description |
---|---|
failureThreshold integer | Minimum consecutive failures for the probe to be considered failed after having succeeded. |
initialDelaySeconds integer | Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
periodSeconds integer | How often (in seconds) to perform the probe. |
successThreshold integer | Minimum consecutive successes for the probe to be considered successful after having failed. |
timeoutSeconds integer | Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
.spec.queueManager.metrics
Sets for Prometheus-style metrics.
Appears in:
Field | Description |
---|---|
enabled boolean | Whether or not to enable an endpoint for Prometheus-compatible metrics. |
.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
Sets that control the readiness probe.
Appears in:
Field | Description |
---|---|
initialDelaySeconds integer | Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
periodSeconds integer | How often (in seconds) to perform the probe. |
successThreshold integer | Minimum consecutive successes for the probe to be considered successful after having failed. |
timeoutSeconds integer | Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
failureThreshold integer | Minimum consecutive failures for the probe to be considered failed after having succeeded. |
.spec.queueManager.resources
Sets 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.storage
Storage settings to control the Queue Manager's use of Persistent Volumes and Storage Classes.
Appears in:
Field | Description |
---|---|
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 | PersistentVolume details for MQ recovery logs. Required when using multi-instance Queue Manager. |
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. |
persistedData QueueManagerOptionalVolume | PersistentVolume details for MQ persisted data, including configuration, queues and messages. Required when using multi-instance Queue Manager. |
.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 |
---|---|
enabled boolean | Whether or not this volume should be enabled as a separate volume, or be placed on the default queueManager volume. |
size string | Size of the PersistentVolume to pass to Kubernetes, including SI units. Only valid if type is persistent-claim. For example, 2Gi. |
sizeLimit string | Size limit when using an ephemeral volume. Files are still written to a temporary directory, so we can use this option to limit the size. Only valid if type is ephemeral. |
type string | Type of volume to use. Choose ephemeral to use non-persistent storage, or persistent-claim to use a persistent volume. |
class string | Storage class to use for this volume. Only valid if type is 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 |
---|---|
type string | Type of volume to use. Choose ephemeral to use non-persistent storage, or persistent-claim to use a persistent volume. |
class string | Storage class to use for this volume. Only valid if type is persistent-claim. |
size string | Size of the PersistentVolume to pass to Kubernetes, including SI units. Only valid if type is persistent-claim. For example, 2Gi. |
sizeLimit string | Size limit when using an ephemeral volume. Files are still written to a temporary directory, so we can use this option to limit the size. Only valid if type is ephemeral. |
.spec.queueManager.storage.recoveryLogs
PersistentVolume details for MQ recovery logs. Required when using multi-instance Queue Manager.
Appears in:
Field | Description |
---|---|
enabled boolean | Whether or not this volume should be enabled as a separate volume, or be placed on the default queueManager volume. |
size string | Size of the PersistentVolume to pass to Kubernetes, including SI units. Only valid if type is persistent-claim. For example, 2Gi. |
sizeLimit string | Size limit when using an ephemeral volume. Files are still written to a temporary directory, so we can use this option to limit the size. Only valid if type is ephemeral. |
type string | Type of volume to use. Choose ephemeral to use non-persistent storage, or persistent-claim to use a persistent volume. |
class string | Storage class to use for this volume. Only valid if type is persistent-claim. |
.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 we 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 we can use, and the Queue Manager may fail to start if we are not authorized to use an SCC which allows the root user. For more information, see https://docs.openshift.com/container-platform/latest/authentication/managing-security-context-constraints.html. |
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.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
Sets for tracing integration with the Cloud Pak for Integration Operations Dashboard.
Appears in:
Field | Description |
---|---|
agent TracingAgent | In Cloud Pak for Integration only, we can configure settings for the optional Tracing Agent. |
collector TracingCollector | In Cloud Pak for Integration only, we 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. |
namespace string | Namespace where the Cloud Pak for Integration Operations Dashboard is installed. |
.spec.tracing.agent
In Cloud Pak for Integration only, we can configure settings for the optional Tracing Agent.
Appears in:
Field | Description |
---|---|
image string | The container image that will be used. |
imagePullPolicy string | Set that controls when the kubelet attempts to pull the specified image. |
livenessProbe TracingProbe | Sets that control the liveness probe. |
readinessProbe TracingProbe | Sets that control the readiness probe. |
.spec.tracing.agent.livenessProbe
Sets that control the liveness probe.
Appears in:
Field | Description |
---|---|
periodSeconds integer | How often (in seconds) to perform the probe. |
successThreshold integer | Minimum consecutive successes for the probe to be considered successful after having failed. |
timeoutSeconds integer | Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
failureThreshold integer | Minimum consecutive failures for the probe to be considered failed after having succeeded. |
initialDelaySeconds integer | Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
.spec.tracing.agent.readinessProbe
Sets that control the readiness probe.
Appears in:
Field | Description |
---|---|
initialDelaySeconds integer | Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
periodSeconds integer | How often (in seconds) to perform the probe. |
successThreshold integer | Minimum consecutive successes for the probe to be considered successful after having failed. |
timeoutSeconds integer | Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
failureThreshold integer | Minimum consecutive failures for the probe to be considered failed after having succeeded. |
.spec.tracing.collector
In Cloud Pak for Integration only, we can configure settings for the optional Tracing Collector.
Appears in:
Field | Description |
---|---|
image string | The container image that will be used. |
imagePullPolicy string | Set that controls when the kubelet attempts to pull the specified image. |
livenessProbe TracingProbe | Sets that control the liveness probe. |
readinessProbe TracingProbe | Sets that control the readiness probe. |
.spec.tracing.collector.livenessProbe
Sets that control the liveness probe.
Appears in:
Field | Description |
---|---|
periodSeconds integer | How often (in seconds) to perform the probe. |
successThreshold integer | Minimum consecutive successes for the probe to be considered successful after having failed. |
timeoutSeconds integer | Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
failureThreshold integer | Minimum consecutive failures for the probe to be considered failed after having succeeded. |
initialDelaySeconds integer | Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
.spec.tracing.collector.readinessProbe
Sets that control the readiness probe.
Appears in:
Field | Description |
---|---|
initialDelaySeconds integer | Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
periodSeconds integer | How often (in seconds) to perform the probe. |
successThreshold integer | Minimum consecutive successes for the probe to be considered successful after having failed. |
timeoutSeconds integer | Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
failureThreshold integer | Minimum consecutive failures for the probe to be considered failed after having succeeded. |
.spec.web
Sets for the MQ web server.
Appears in:
Field | Description |
---|---|
enabled boolean | Whether or not to enable the web server. |
.status
The observed state of the QueueManager.
Appears in:
Field | Description |
---|---|
endpoints QueueManagerStatusEndpoint array | Information on the endpoints that this Queue Manager is exposing, such as API or UI endpoints. |
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. |
adminUiUrl string | URL for the Admin UI. |
conditions QueueManagerStatusCondition array | Conditions represent the latest available observations of the Queue Manager's state. |
.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 |
---|---|
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. |
name string | Name of the endpoint. |
.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 |
---|---|
name string | Version name for this version of QueueManager. These are valid values for the spec.version field. |