Skip to content

Home

CI E2E Docs
Release License: MIT Go Container

MKurator is a Kubernetes operator that declaratively manages IBM MQ administrative objects on an existing queue manager — queues, topics, channels, channel auth rules, and authority records — via the mqweb REST API.

messaging.mkurator.dev/v1beta1 (recommended) · event-driven · TLS-first · Helm-ready

Quick start Install guide Upgrade

What MKurator does

You declare desired MQ state in Kubernetes custom resources. The operator reconciles that state against your queue manager through HTTPS mqweb, reports conditions on each CR, and removes MQ objects when you delete a resource (finalizers).

Requires an existing queue manager with mqweb

MKurator does not install or scale queue managers. Point a QueueManagerConnection at a QM that already exposes the Administrative REST API (mqweb) over HTTPS.

How it works

Custom Resource  →  controller reconcile  →  mqweb REST (MQSC)  →  IBM MQ Queue Manager
       ↑                                                              |
       └──────────── status conditions / Events ←──────────────────────┘
Custom resource MQ objects
QueueManagerConnection Connectivity + credential reference
Queue QLOCAL, QALIAS, QREMOTE
Topic TOPIC
Channel CHLTYPE(SVRCONN)
ChannelAuthRule SET CHLAUTH
AuthorityRecord SET AUTHREC (OAM)

API version

Manifests use apiVersion: messaging.mkurator.dev/v1beta1 — the only served and stored version. The earlier v1alpha1 was removed in v0.15.0 (see ADR-0029 and the removal runbook). Release tags are on GitHub Releases (see also the badge above). Roadmap: ROADMAP.md.

Documentation map

Audience Start here
Operators Quick start · Install and use · Upgrade · Observability · FAQ
Developers Development setup · Developer guide · CI/CD
Architects Architecture · Attribute reconciliation · ADRs
Contributors Contributing · Code of Conduct · Governance

Examples

Sample YAML with field notes: config/samples README.