Jump To Close Expand all Collapse all Table of contents Deploying and Upgrading AMQ Streams on OpenShift Making open source more inclusive 1. Deployment overview Expand section "1. Deployment overview" Collapse section "1. Deployment overview" 1.1. How AMQ Streams supports Kafka 1.2. AMQ Streams Operators Expand section "1.2. AMQ Streams Operators" Collapse section "1.2. AMQ Streams Operators" 1.2.1. Cluster Operator 1.2.2. Topic Operator 1.2.3. User Operator 1.3. AMQ Streams custom resources Expand section "1.3. AMQ Streams custom resources" Collapse section "1.3. AMQ Streams custom resources" 1.3.1. AMQ Streams custom resource example 1.4. AMQ Streams installation methods 2. What is deployed with AMQ Streams Expand section "2. What is deployed with AMQ Streams" Collapse section "2. What is deployed with AMQ Streams" 2.1. Order of deployment 2.2. Additional deployment configuration options Expand section "2.2. Additional deployment configuration options" Collapse section "2.2. Additional deployment configuration options" 2.2.1. Securing Kafka 2.2.2. Monitoring your deployment 3. Preparing for your AMQ Streams deployment Expand section "3. Preparing for your AMQ Streams deployment" Collapse section "3. Preparing for your AMQ Streams deployment" 3.1. Deployment prerequisites 3.2. Downloading AMQ Streams release artifacts 3.3. Authenticating with the container registry for Kafka Connect S2I 3.4. Pushing container images to your own registry 3.5. Designating AMQ Streams administrators 4. Deploying AMQ Streams from the OperatorHub Expand section "4. Deploying AMQ Streams from the OperatorHub" Collapse section "4. Deploying AMQ Streams from the OperatorHub" 4.1. Using the Red Hat Integration Operator to install the AMQ Streams Operator 4.2. Deploying the AMQ Streams Operator from the OperatorHub 4.3. Deploying Kafka components using the AMQ Streams Operator 5. Deploying AMQ Streams using installation artifacts Expand section "5. Deploying AMQ Streams using installation artifacts" Collapse section "5. Deploying AMQ Streams using installation artifacts" 5.1. Create the Kafka cluster Expand section "5.1. Create the Kafka cluster" Collapse section "5.1. Create the Kafka cluster" 5.1.1. Deploying the Cluster Operator Expand section "5.1.1. Deploying the Cluster Operator" Collapse section "5.1.1. Deploying the Cluster Operator" 5.1.1.1. Watch options for a Cluster Operator deployment 5.1.1.2. Deploying the Cluster Operator to watch a single namespace 5.1.1.3. Deploying the Cluster Operator to watch multiple namespaces 5.1.1.4. Deploying the Cluster Operator to watch all namespaces 5.1.2. Deploying Kafka Expand section "5.1.2. Deploying Kafka" Collapse section "5.1.2. Deploying Kafka" 5.1.2.1. Deploying the Kafka cluster 5.1.2.2. Deploying the Topic Operator using the Cluster Operator 5.1.2.3. Deploying the User Operator using the Cluster Operator 5.1.3. Alternative standalone deployment options for AMQ Streams Operators Expand section "5.1.3. Alternative standalone deployment options for AMQ Streams Operators" Collapse section "5.1.3. Alternative standalone deployment options for AMQ Streams Operators" 5.1.3.1. Deploying the standalone Topic Operator 5.1.3.2. Deploying the standalone User Operator 5.2. Deploy Kafka Connect Expand section "5.2. Deploy Kafka Connect" Collapse section "5.2. Deploy Kafka Connect" 5.2.1. Deploying Kafka Connect to your OpenShift cluster 5.2.2. Kafka Connect configuration for multiple instances 5.2.3. Extending Kafka Connect with connector plug-ins Expand section "5.2.3. Extending Kafka Connect with connector plug-ins" Collapse section "5.2.3. Extending Kafka Connect with connector plug-ins" 5.2.3.1. Creating a new container image automatically using AMQ Streams 5.2.3.2. Creating a Docker image from the Kafka Connect base image 5.2.3.3. Creating a container image using OpenShift builds and Source-to-Image 5.2.4. Creating and managing connectors Expand section "5.2.4. Creating and managing connectors" Collapse section "5.2.4. Creating and managing connectors" 5.2.4.1. KafkaConnector resources 5.2.4.2. Availability of the Kafka Connect REST API 5.2.5. Deploying the example KafkaConnector resources 5.2.6. Performing a restart of a Kafka connector 5.2.7. Performing a restart of a Kafka connector task 5.3. Deploy Kafka MirrorMaker Expand section "5.3. Deploy Kafka MirrorMaker" Collapse section "5.3. Deploy Kafka MirrorMaker" 5.3.1. Deploying Kafka MirrorMaker to your OpenShift cluster 5.4. Deploy Kafka Bridge Expand section "5.4. Deploy Kafka Bridge" Collapse section "5.4. Deploy Kafka Bridge" 5.4.1. Deploying Kafka Bridge to your OpenShift cluster 6. Setting up client access to the Kafka cluster Expand section "6. Setting up client access to the Kafka cluster" Collapse section "6. Setting up client access to the Kafka cluster" 6.1. Deploying example clients 6.2. Setting up access for clients outside of OpenShift 7. Setting up metrics and dashboards for AMQ Streams Expand section "7. Setting up metrics and dashboards for AMQ Streams" Collapse section "7. Setting up metrics and dashboards for AMQ Streams" 7.1. Example metrics files Expand section "7.1. Example metrics files" Collapse section "7.1. Example metrics files" 7.1.1. Example Grafana dashboards 7.1.2. Example Prometheus metrics configuration 7.2. Deploying Prometheus metrics configuration Expand section "7.2. Deploying Prometheus metrics configuration" Collapse section "7.2. Deploying Prometheus metrics configuration" 7.2.1. Copying Prometheus metrics configuration to a custom resource 7.2.2. Deploying a Kafka cluster with Prometheus metrics configuration 7.3. Viewing Kafka metrics and dashboards in OpenShift 4 Expand section "7.3. Viewing Kafka metrics and dashboards in OpenShift 4" Collapse section "7.3. Viewing Kafka metrics and dashboards in OpenShift 4" 7.3.1. Deploying the Prometheus resources 7.3.2. Creating a Service Account for Grafana 7.3.3. Deploying Grafana with a Prometheus datasource 7.3.4. Creating a Route to the Grafana Service 7.3.5. Importing the example Grafana dashboards 7.4. Viewing Kafka metrics and dashboards in OpenShift 3.11 Expand section "7.4. Viewing Kafka metrics and dashboards in OpenShift 3.11" Collapse section "7.4. Viewing Kafka metrics and dashboards in OpenShift 3.11" 7.4.1. Prometheus support 7.4.2. Setting up Prometheus Expand section "7.4.2. Setting up Prometheus" Collapse section "7.4.2. Setting up Prometheus" 7.4.2.1. Prometheus configuration 7.4.2.2. Prometheus resources 7.4.2.3. Deploying Prometheus 7.4.3. Setting up Prometheus Alertmanager Expand section "7.4.3. Setting up Prometheus Alertmanager" Collapse section "7.4.3. Setting up Prometheus Alertmanager" 7.4.3.1. Alertmanager configuration 7.4.3.2. Alerting rules 7.4.3.3. Alerting rule examples 7.4.3.4. Deploying Alertmanager 7.4.4. Setting up Grafana Expand section "7.4.4. Setting up Grafana" Collapse section "7.4.4. Setting up Grafana" 7.4.4.1. Deploying Grafana 7.4.4.2. Enabling the example Grafana dashboards 7.5. Add Kafka Exporter Expand section "7.5. Add Kafka Exporter" Collapse section "7.5. Add Kafka Exporter" 7.5.1. Monitoring Consumer lag 7.5.2. Example Kafka Exporter alerting rules 7.5.3. Exposing Kafka Exporter metrics 7.5.4. Configuring Kafka Exporter 7.5.5. Enabling the Kafka Exporter Grafana dashboard 7.6. Monitor Kafka Bridge Expand section "7.6. Monitor Kafka Bridge" Collapse section "7.6. Monitor Kafka Bridge" 7.6.1. Configuring Kafka Bridge 7.6.2. Enabling the Kafka Bridge Grafana dashboard 7.7. Monitor Cruise Control Expand section "7.7. Monitor Cruise Control" Collapse section "7.7. Monitor Cruise Control" 7.7.1. Configuring Cruise Control 7.7.2. Enabling the Cruise Control Grafana dashboard 8. Upgrading AMQ Streams Expand section "8. Upgrading AMQ Streams" Collapse section "8. Upgrading AMQ Streams" 8.1. AMQ Streams and Kafka upgrades Expand section "8.1. AMQ Streams and Kafka upgrades" Collapse section "8.1. AMQ Streams and Kafka upgrades" 8.1.1. Kafka versions 8.1.2. Upgrading the Cluster Operator Expand section "8.1.2. Upgrading the Cluster Operator" Collapse section "8.1.2. Upgrading the Cluster Operator" 8.1.2.1. Upgrading the Cluster Operator 8.1.3. Upgrading Kafka Expand section "8.1.3. Upgrading Kafka" Collapse section "8.1.3. Upgrading Kafka" 8.1.3.1. Kafka version and image mappings 8.1.3.2. Upgrading Kafka brokers and client applications 8.1.4. Updating listeners to the generic listener configuration 8.1.5. Strategies for upgrading clients 8.2. AMQ Streams custom resource upgrades Expand section "8.2. AMQ Streams custom resource upgrades" Collapse section "8.2. AMQ Streams custom resource upgrades" 8.2.1. API versioning 8.2.2. Converting custom resources configuration files using the API conversion tool 8.2.3. Converting custom resources directly using the API conversion tool 8.2.4. Upgrading CRDs to v1beta2 using the API conversion tool 8.2.5. Upgrading Kafka resources to support v1beta2 8.2.6. Upgrading ZooKeeper to support v1beta2 8.2.7. Upgrading the Topic Operator to support v1beta2 8.2.8. Upgrading the Entity Operator to support v1beta2 8.2.9. Upgrading Cruise Control to support v1beta2 8.2.10. Upgrading the API version of Kafka resources to v1beta2 8.2.11. Upgrading Kafka Connect resources to v1beta2 8.2.12. Upgrading Kafka Connect S2I resources to v1beta2 8.2.13. Upgrading Kafka MirrorMaker resources to v1beta2 8.2.14. Upgrading Kafka MirrorMaker 2.0 resources to v1beta2 8.2.15. Upgrading Kafka Bridge resources to v1beta2 8.2.16. Upgrading Kafka User resources to v1beta2 8.2.17. Upgrading Kafka Topic resources to v1beta2 8.2.18. Upgrading Kafka Connector resources to v1beta2 8.2.19. Upgrading Kafka Rebalance resources to v1beta2 8.3. Upgrading consumers to cooperative rebalancing 9. Downgrading AMQ Streams Expand section "9. Downgrading AMQ Streams" Collapse section "9. Downgrading AMQ Streams" 9.1. Downgrading the Cluster Operator to a previous version 9.2. Downgrading Kafka Expand section "9.2. Downgrading Kafka" Collapse section "9.2. Downgrading Kafka" 9.2.1. Kafka version compatibility for downgrades 9.2.2. Downgrading Kafka brokers and client applications A. Using your subscription Legal Notice Settings Close Language: 日本語 English Language: 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 日本語 English Language: 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Deploying and Upgrading AMQ Streams on OpenShift Red Hat AMQ 2021.q2For use with AMQ Streams 1.7 on OpenShift Container PlatformLegal NoticeAbstract This guide provides instructions for deploying and upgrading AMQ Streams Next