Maximo Application Suite CLI Documentation Ansible CLI
Image Mirroring Install Update Upgrade Uninstall EAM Migration Mirror Db2 Images install update upgrade uninstall must-gather configure-airgap mirror-images mirror-redhat-images setup-registry teardown-registry provision-fyre provision-roks provision-rosa configtool-oidc Overview Dec 05 2024 Nov 07 2024 Oct 03 2024 Aug 27 2024 Dependencies Topology Cluster Extensions

IBM Maximo Operator Catalog¤

This catalog is a curated catalog, the Maximo Application Suite team take a snapshot of the online IBM Operator Catalog and test compatibility of all dependent IBM operators with supported releases of Maximo Application Suite; this allows the team to intercept any breaking changes that may have evaded other teams' testing before they reach your cluster.

Availability¤

All versions of the catalog are available indefinitely, but they have a useful lifespan limited by the support statements of the packages available in the catalog and the OCP release the catalog is certified on. We never remove catalog images from the IBM Container Registry (ICR); even the first Maximo Operator Catalog ever published is still available today, however it's usefulness is questionable due to the end of life of all compatible OCP releases.

CLI Support¤

The MAS CLI maintains a rolling window of approximately four months worth of supported catalogs for the install, mirror-images, and update functions. When using an older catalog it is recommended to use a version of the CLI that was released around the same time as the catalog, refer to the table below for the recommended version of the CLI to use with older versions of the operator catalog.

Known Issues¤

Architecture¤

Catalog Directory¤

2024 Catalogs 2023 Catalogs 2022 Catalogs

FAQ¤

User-Controlled Updates¤

I want to control when updates are introduced into my cluster

The packages available in the Maximo Operator Catalog are fixed. Multiple installations at different times will always result in exactly the same version of all IBM-provided operators being installed. To receive security updates and bug fixes you must periodically update the version of the static catalog that you have installed in the cluster. Once you do this all operators that you have installed from the catalog will automatically update to the newer version. We aim to release a catalog update monthly. When you are ready to apply updates you simply modify the CatalogSource installed in your cluster, changing it from e.g. v9-241107-amd64 to v9-241205-amd64.

We strongly discourage the use of manual update approval strategy for operator subscriptions and all IBM-provided automation is designed to work with the automatic update approval strategy only. In our experience the use of manual subscription approvals leads to overly complicated updates requiring significant administrative effort when taking into account the range of operators running in a cluster across numerous namespaces. We promote a model of controling when updates are introduced to a cluster at the catalog level.

Updating the operators is only one aspect of keeping a system up to date, when using the MAS CLI update function many other additional actions will be performed autoamtically, if you are not using the MAS CLI to drive updates then you should implement your own processes for the non-operator update actions that are part of the MAS update pipeline.

Repeatable Install¤

I want repeatable installs across multiple OpenShift clusters, for instance in a development, staging, production setup

The packages available in these catalogs are fixed. Multiple installations at different times will always result in exactly the same version of all operators being installed. By choosing the same version of the catalog across multiple clusters the user is guaranteed that their installations are identical, right down to the patch level of the operators installed. Updates can be rolled out in a controlled manner, and the upgrade path between two catalog versions will always be identical regardless of how much time passes between upgrades in different clusters.

Disconnected Install¤

I want to run a disconnected environment using a private mirror registry

The MAS CLI mirror-images function is the easiest way to mirror the content from a specific version of the Maximo Operator Catalog. Once the images are mirrored simply run the configure-airgap function to add the IBM Maximo Application Suite ImageContentSourcePolicy to your cluster before starting the installation.

Dynamic Catalog¤

The legacy dynamic operator catalog is only supported for Maximo Application Suite v8 releases, if you use the dynamic catalog you will always have access to the latest operator updates without updating the CatalogSource on your OpenShift cluster.

Manual Installation¤

oc apply -f https://raw.githubusercontent.com/ibm-mas/cli/master/catalogs/v8-amd64.yaml

Source¤

apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-operator-catalog
  namespace: openshift-marketplace
spec:
  displayName: IBM Maximo Operators (v8-amd64)
  publisher: IBM
  description: Dynamic Catalog Source for IBM Maximo Application Suite
  sourceType: grpc
  image: icr.io/cpopen/ibm-maximo-operator-catalog:v8-amd64
  priority: 90