Chapter 4. Preparing for your AMQ Streams deployment
Chapter 4. Preparing for your AMQ Streams deployment Prepare for a deployment of AMQ Streams by completing any necessary pre-deployment tasks. Take the necessary preparatory steps according to your specific requirements, such as the following: Ensuring you have the necessary prerequisites before deploying AMQ Streams Downloading the AMQ Streams release artifacts to facilitate your deployment Pushing the AMQ Streams container images into your own registry (if required) Setting up admin roles to enable configuration of custom resources used in the deployment Note To run the commands in this guide, your cluster user must have the rights to manage role-based access control (RBAC) and CRDs. 4.1. Deployment prerequisites To deploy AMQ Streams, you will need the following: An OpenShift 4.12 and later cluster. AMQ Streams is based on Strimzi 0.36.x. The oc command-line tool is installed and configured to connect to the running cluster. 4.2. Downloading AMQ Streams release artifacts To use deployment files to install AMQ Streams, download and extract the files from the AMQ Streams software downloads page . AMQ Streams release artifacts include sample YAML files to help you deploy the components of AMQ Streams to OpenShift, perform common operations, and configure your Kafka cluster. Use oc to deploy the Cluster Operator from the install/cluster-operator folder of the downloaded ZIP file. For more information about deploying and configuring the Cluster Operator, see Section 6.2, "Deploying the Cluster Operator" . In addition, if you want to use standalone installations of the Topic and User Operators with a Kafka cluster that is not managed by the AMQ Streams Cluster Operator, you can deploy them from the install/topic-operator and install/user-operator folders. Note AMQ Streams container images are also available through the Red Hat Ecosystem Catalog . However, we recommend that you use the YAML files provided to deploy AMQ Streams. 4.3. Pushing container images to your own registry Container images for AMQ Streams are available in the Red Hat Ecosystem Catalog . The installation YAML files provided by AMQ Streams will pull the images directly from the Red Hat Ecosystem Catalog . If you do not have access to the Red Hat Ecosystem Catalog or want to use your own container repository, do the following: Pull all container images listed here Push them into your own registry Update the image names in the installation YAML files Note Each Kafka version supported for the release has a separate image. Container image Namespace/Repository Description Kafka registry.redhat.io/amq-streams/kafka-35-rhel8:2.5.2 registry.redhat.io/amq-streams/kafka-34-rhel8:2.5.2 AMQ Streams image for running Kafka, including: Kafka Broker Kafka Connect Kafka MirrorMaker ZooKeeper TLS Sidecars Cruise Control Operator registry.redhat.io/amq-streams/strimzi-rhel8-operator:2.5.2 AMQ Streams image for running the operators: Cluster Operator Topic Operator User Operator Kafka Initializer Kafka Bridge registry.redhat.io/amq-streams/bridge-rhel8:2.5.2 AMQ Streams image for running the AMQ Streams Kafka Bridge AMQ Streams Drain Cleaner registry.redhat.io/amq-streams/drain-cleaner-rhel8:2.5.2 AMQ Streams image for running the AMQ Streams Drain Cleaner 4.4. Creating a pull secret for authentication to the container image registry The installation YAML files provided by AMQ Streams pull container images directly from the Red Hat Ecosystem Catalog . If an AMQ Streams deployment requires authentication, configure authentication credentials in a secret and add it to the installation YAML. Note Authentication is not usually required, but might be requested on certain platforms. Prerequisites You need your Red Hat username and password or the login details from your Red Hat registry service account. Note You can use your Red Hat subscription to create a registry service account from the Red Hat Customer Portal . Procedure Create a pull secret containing your login details and the container registry where the AMQ Streams image is pulled from: oc create secret docker-registry <pull_secret_name> \ --docker-server=registry.redhat.io \ --docker-username=<user_name> \ --docker-password=<password> \ --docker-email=<email> Add your user name and password. The email address is optional. Edit the install/cluster-operator/060-Deployment-strimzi-cluster-operator.yaml deployment file to specify the pull secret using the STRIMZI_IMAGE_PULL_SECRET environment variable: apiVersion: apps/v1 kind: Deployment metadata: name: strimzi-cluster-operator spec: # ... template: spec: serviceAccountName: strimzi-cluster-operator containers: # ... env: - name: STRIMZI_IMAGE_PULL_SECRETS value: "<pull_secret_name>" # ... The secret applies to all pods created by the Cluster Operator. 4.5. Designating AMQ Streams administrators AMQ Streams provides custom resources for configuration of your deployment. By default, permission to view, create, edit, and delete these resources is limited to OpenShift cluster administrators. AMQ Streams provides two cluster roles that you can use to assign these rights to other users: strimzi-view allows users to view and list AMQ Streams resources. strimzi-admin allows users to also create, edit or delete AMQ Streams resources. When you install these roles, they will automatically aggregate (add) these rights to the default OpenShift cluster roles. strimzi-view aggregates to the view role, and strimzi-admin aggregates to the edit and admin roles. Because of the aggregation, you might not need to assign these roles to users who already have similar rights. The following procedure shows how to assign a strimzi-admin role that allows non-cluster administrators to manage AMQ Streams resources. A system administrator can designate AMQ Streams administrators after the Cluster Operator is deployed. Prerequisites The AMQ Streams Custom Resource Definitions (CRDs) and role-based access control (RBAC) resources to manage the CRDs have been deployed with the Cluster Operator . Procedure Create the strimzi-view and strimzi-admin cluster roles in OpenShift. oc create -f install/strimzi-admin If needed, assign the roles that provide access rights to users that require them. oc create clusterrolebinding strimzi-admin --clusterrole=strimzi-admin --user= user1 --user= user2
create secret docker-registry <pull_secret_name> --docker-server=registry.redhat.io --docker-username=<user_name> --docker-password=<password> --docker-email=<email> apiVersion: apps/v1 kind: Deployment metadata: name: strimzi-cluster-operator spec: # template: spec: serviceAccountName: strimzi-cluster-operator containers: # env: - name: STRIMZI_IMAGE_PULL_SECRETS value: "<pull_secret_name>" create -f install/strimzi-admin create clusterrolebinding strimzi-admin --clusterrole=strimzi-admin --user= user1 --user= user2