Important: Do not install this operator directly. Only install this operator using the IBM Common Services Operator. For more information about installing this operator and other Common Services operators, see Installer documentation. If you are using this operator as part of an IBM Cloud Pak, see the documentation for that IBM Cloud Pak to learn more about how to install and use the operator service. For more information about IBM Cloud Paks, see IBM Cloud Paks that use Common Services.
You can use the ibm-monitoring-prometheus-extension-operator to install Prometheus and Alertmanager by extending the community prometheus operator.
This operator is part of the IBM Monitoring Operator stack. It provides a way to install Prometheus and Alertmanager with RBAC and TLS enabled. The IBM Monitoring Operator stack is integrated in IBM Cloud Paks and installed as part of IBM Cloud Platform Common Services. You can also use the Operand Deployment Lifecycle Manager Operator to install IBM Cloud Platform Common Services in your cluster. See the following documentation for prerequisites required to run the stand-alone Operator.
Red Hat OpenShift Container Platform 4.x or newer installed on one of the following platforms:
- Linux x86_64
- Linux on Power (ppc64le)
- Linux on IBM Z and LinuxONE
- 1.8.0
- 1.9.0
Before you install this operator, you need to first install the operator dependencies and prerequisites:
-
For the list of operator dependencies, see the IBM Knowledge Center Common Services dependencies documentation.
-
For the list of prerequisites for installing the operator, see the IBM Knowledge Center Preparing to install services documentation.
The operator requires PVs for data persistence for Prometheus and Alertmanager. It support both ReadWriteOnce (RWO) and ReadWriteMany (RWX) modes. RWO mode is recommended.
The operator will find available StorageClass in the cluser automatically. It will use the default StorageClass if defined. If no default StorageClass defined, it will find available one randomly.
You can also specify StorageClass in CR use storageClassName parameter.
To install the operator with the IBM Common Services Operator follow the installation and configuration instructions within the IBM Knowledge Center.
- If you are using the operator as part of an IBM Cloud Pak, see the documentation for that IBM Cloud Pak. For a list of IBM Cloud Paks, see IBM Cloud Paks that use Common Services.
- If you are using the operator with an IBM Containerized Software, see the IBM Cloud Platform Common Services Knowledge Center Installer documentation.
The ibm-monitoring-prometheus-extension-operator supports running under the OpenShift Container Platform default restricted security context constraints. The prometheus runs under privileged security constraints. For more information about the OpenShift Container Platform Security Context Constraints, see Managing Security Context Constraints.
As a developer, if you want to build and test this operator to try out and learn more about the operator and its capabilities, you can use the following developer guide. The guide provides commands for a quick installation and initial validation for running the operator.
Important: The following developer guide is provided as-is and only for trial and education purposes. IBM and IBM Support does not provide any support for the usage of the operator with this developer guide. For the official supported installation and usage guide for the operator, see the IBM Knowledge Center documentation for your IBM Cloud Pak or for IBM Cloud Platform Common Services.
For more instructions on how to run end-to-end testing with the Operand Deployment Lifecycle Manager, see ODLM guide.
