Chapter 6. Upgrading an Operator-based broker deployment
Chapter 6. Upgrading an Operator-based broker deployment The procedures in this section show how to upgrade: The AMQ Broker Operator version, using both the OpenShift command-line interface (CLI) and OperatorHub The broker container image for an Operator-based broker deployment 6.1. Before you begin This section describes some important considerations before you upgrade the Operator and broker container images for an Operator-based broker deployment. Upgrading the Operator using either the OpenShift command-line interface (CLI) or OperatorHub requires cluster administrator privileges for your OpenShift cluster. If you originally used the CLI to install the Operator, you should also use the CLI to upgrade the Operator. If you originally used OperatorHub to install the Operator (that is, it appears under Operators Installed Operators for your project in the OpenShift Container Platform web console), you should also use OperatorHub to upgrade the Operator. For more information about these upgrade methods, see: Section 6.2, "Upgrading the Operator using the CLI" Section 6.3, "Upgrading the Operator using OperatorHub" If the redeliveryDelayMultiplier and the redeliveryCollisionAvoidanceFactor attributes are configured in the main broker CR in a 7.8.x or 7.9.x deployment, the new Operator is unable to reconcile any CR after you upgrade to 7.10.x. The reconcile fails because the data type of both attributes changed from float to string in 7.10.x. You can work around this issue by deleting the redeliveryDelayMultiplier and the redeliveryCollisionAvoidanceFactor attributes from the spec.deploymentPlan.addressSettings.addressSetting attribute. Then, configure the attributes under the brokerProperties attribute. For example: spec: ... brokerProperties: - "addressSettings.#.redeliveryMultiplier=2.1" - "addressSettings.#.redeliveryCollisionAvoidanceFactor=1.2" Note Under the brokerProperties attribute, use the redeliveryMultiplier attribute name instead of the redeliveryDelayMultiplier attribute name that you deleted. 6.2. Upgrading the Operator using the CLI The procedures in this section show how to use the OpenShift command-line interface (CLI) to upgrade different versions of the Operator to the latest version available for AMQ Broker 7.11. 6.2.1. Prerequisites You should use the CLI to upgrade the Operator only if you originally used the CLI to install the Operator. If you originally used OperatorHub to install the Operator (that is, the Operator appears under Operators Installed Operators for your project in the OpenShift Container Platform web console), you should use OperatorHub to upgrade the Operator. To learn how to upgrade the Operator using OperatorHub, see Section 6.3, "Upgrading the Operator using OperatorHub" . 6.2.2. Upgrading the Operator using the CLI You can use the OpenShift command-line interface (CLI) to upgrade the Operator to the latest version for AMQ Broker 7.11. Procedure In your web browser, navigate to the Software Downloads page for AMQ Broker 7.11.7 . Ensure that the value of the Version drop-down list is set to 7.11.7 and the Patches tab is selected. to AMQ Broker 7.11.7 Operator Installation and Example Files , click Download . Download of the amq-broker-operator-7.11.7-ocp-install-examples.zip compressed archive automatically begins. When the download has completed, move the archive to your chosen installation directory. The following example moves the archive to a directory called ~/broker/operator . USD mkdir ~/broker/operator USD mv amq-broker-operator-7.11.7-ocp-install-examples.zip ~/broker/operator In your chosen installation directory, extract the contents of the archive. For example: USD cd ~/broker/operator USD unzip amq-broker-operator-operator-7.11.7-ocp-install-examples.zip Log in to OpenShift Container Platform as an administrator for the project that contains your existing Operator deployment. USD oc login -u <user> Switch to the OpenShift project in which you want to upgrade your Operator version. USD oc project <project-name> In the deploy directory of the latest Operator archive that you downloaded and extracted, open the operator.yaml file. Note In the operator.yaml file, the Operator uses an image that is represented by a Secure Hash Algorithm (SHA) value. The comment line, which begins with a number sign ( # ) symbol, denotes that the SHA value corresponds to a specific container image tag. Open the operator.yaml file for your Operator deployment. Check that any non-default values that you specified in your configuration are replicated in the new operator.yaml configuration file. In the new operator.yaml file, the Operator is named amq-broker-controller-manager by default. If the name of the Operator in your deployment is not amq-broker-controller-manager , replace all instances of amq-broker-controller-manager with the Operator name. For example: spec: ... selector matchLabels name: amq-broker-operator ... In the new operator.yaml file, the service account for the Operator is named amq-broker-controller-manager . In versions, the service account for the Operator was named amq-broker-operator . If you want to use the service account name in your deployment, replace the name of the service account in the new operator.yaml file with the name used in the deployment. For example: spec: ... serviceAccountName: amq-broker-operator ... If you want to use the new service account name, amq-broker-controller-manager for the Operator, update the service account, role, and role binding in your project. USD oc apply -f deploy/service_account.yaml USD oc apply -f deploy/role.yaml USD oc apply -f deploy/role_binding.yaml Update the CRDs that are included with the Operator. Update the main broker CRD. USD oc apply -f deploy/crds/broker_activemqartemis_crd.yaml Update the address CRD. USD oc apply -f deploy/crds/broker_activemqartemisaddress_crd.yaml Update the scaledown controller CRD. USD oc apply -f deploy/crds/broker_activemqartemisscaledown_crd.yaml Update the security CRD. USD oc apply -f deploy/crds/broker_activemqartemissecurity_crd.yaml If you are upgrading from AMQ Broker Operator 7.10.0 only, delete the Operator and the StatefulSet. By default, the new Operator deletes the StatefulSet to remove custom and Operator metering labels, which were incorrectly added to the StatefulSet selector by the Operator in 7.10.0. When the Operator deletes the StatefulSet, it also deletes the existing broker Pods, which causes a temporary broker outage. If you want to avoid an outage, complete the following steps to delete the Operator and the StatefulSet without deleting the broker Pods. Delete the Operator. USD oc delete -f deploy/operator.yaml Delete the StatefulSet with the --cascade=orphan option to orphan the broker Pods. The orphaned broker Pods continue to run after the StatefulSet is deleted. USD oc delete statefulset <statefulset-name> --cascade=orphan If you are upgrading from AMQ Broker Operator 7.10.0 or 7.10.1, check if your main broker CR has labels called application or ActiveMQArtemis configured in the deploymentPlan.labels attribute. These labels are reserved for the Operator to assign labels to Pods and are not permitted as custom labels after 7.10.1. If these custom labels were configured in the main broker CR, the Operator-assigned labels on the Pods were overwritten by the custom labels. If either of these custom labels are configured in the main broker CR, complete the following steps to restore the correct labels on the Pods and remove the labels from the CR. If you are upgrading from 7.10.0, you deleted the Operator in the step. If you are upgrading from 7.10.1, delete the Operator. USD oc delete -f deploy/operator.yaml Run the following command to restore the correct Pod labels. In the following example, 'ex-aao' is the name of the StatefulSet deployed. USD for pod in USD(oc get pods | grep -o '^ex-aao[^ ]*'); do oc label --overwrite pods USDpod ActiveMQArtemis=ex-aao application=ex-aao-app; done Delete the application and ActiveMQArtemis labels from the deploymentPlan.labels attribute in the CR. Log in to OpenShift as a user that has privileges to deploy CRs in the project for the broker deployment. Open the sample CR file called broker_activemqartemis_cr.yaml that was included in the deploy/crs directory of the Operator installation archive that you downloaded and extracted. In the deploymentPlan.labels attribute in the CR, delete any custom labels called application or ActiveMQArtemis . Save the CR file. Deploy the CR instance. Switch to the project for the broker deployment. Apply the CR. If you deleted the Operator, deploy the new Operator. USD oc create -f deploy/operator.yaml Apply the updated Operator configuration. USD oc apply -f deploy/operator.yaml The new Operator can recognize and manage your broker deployments. If you set values in the image or version field in the CR, the Operator's reconciliation process upgrades the broker Pods to the corresponding images when the Operator starts. For more information, see Section 6.4, "Restricting automatic upgrades of broker container images" . Otherwise, the Operator upgrades each broker Pod to the latest container image. Note If the reconciliation process does not start, you can start the process by scaling the deployment. For more information, see Section 3.4.1, "Deploying a basic broker instance" . Add attributes to the CR for the new features that are available in the upgraded broker, as required. 6.3. Upgrading the Operator using OperatorHub This section describes how to use OperatorHub to upgrade the Operator for AMQ Broker. 6.3.1. Prerequisites Use OperatorHub to upgrade the Operator only if you originally used OperatorHub to install the Operator (that is, the Operator appears under Operators Installed Operators for your project in the OpenShift Container Platform web console). By contrast, if you originally used the OpenShift command-line interface (CLI) to install the Operator, you should also use the CLI to upgrade the Operator. To learn how to upgrade the Operator using the CLI, see Section 6.2, "Upgrading the Operator using the CLI" . Upgrading the AMQ Broker Operator using OperatorHub requires cluster administrator privileges for your OpenShift cluster. 6.3.2. Before you begin This section describes some important considerations before you use OperatorHub to upgrade an instance of the AMQ Broker Operator. The Operator Lifecycle Manager automatically updates the CRDs in your OpenShift cluster when you install the latest Operator version from OperatorHub. You do not need to remove existing CRDs. If you remove existing CRDs, all CRs and broker instances are also removed. When you update your cluster with the CRDs for the latest Operator version, this update affects all projects in the cluster. Any broker Pods deployed from versions of the Operator might become unable to update their status in the OpenShift Container Platform web console. When you click the Logs tab of a running broker Pod, you see messages indicating that 'UpdatePodStatus' has failed. However, the broker Pods and Operator in that project continue to work as expected. To fix this issue for an affected project, you must also upgrade that project to use the latest version of the Operator. The procedure to follow depends on the Operator version that you are upgrading from. Ensure that you follow the upgrade procedure that is for your current version. 6.3.3. Upgrading the Operator from pre-7.10.0 to 7.11.x You must uninstall and reinstall the Operator to upgrade from pre-7.10.0 to 7.11.x. Procedure Log in to the OpenShift Container Platform web console as a cluster administrator. Uninstall the existing AMQ Broker Operator from your project. In the left navigation menu, click Operators Installed Operators . From the Project drop-down menu at the top of the page, select the project in which you want to uninstall the Operator. Locate the Red Hat Integration - AMQ Broker instance that you want to uninstall. For your Operator instance, click the More Options icon (three vertical dots) on the right-hand side. Select Uninstall Operator . On the confirmation dialog box, click Uninstall . Use OperatorHub to install the latest version of the Operator for AMQ Broker 7.11. For more information, see Section 3.3.2, "Deploying the Operator from OperatorHub" . The new Operator can recognize and manage your broker deployments. If you set values in the image or version field in the CR, the Operator's reconciliation process upgrades the broker Pods to the corresponding container images when the Operator starts. For more information, see Section 6.4, "Restricting automatic upgrades of broker container images" . Otherwise, the Operator upgrades each broker Pod to the latest container image. Note If the reconciliation process does not start, you can start the process by scaling the deployment. For more information, see Section 3.4.1, "Deploying a basic broker instance" . 6.3.4. Upgrading the Operator from 7.10.0 to 7.11.x You must uninstall and reinstall the Operator to upgrade from 7.10.0 to 7.11.x. Procedure Log in to the OpenShift Container Platform web console as a cluster administrator. Uninstall the existing AMQ Broker Operator from your project. In the left navigation menu, click Operators Installed Operators . From the Project drop-down menu at the top of the page, select the project in which you want to uninstall the Operator. Locate the Red Hat Integration - AMQ Broker instance that you want to uninstall. For your Operator instance, click the More Options icon (three vertical dots) on the right-hand side. Select Uninstall Operator . On the confirmation dialog box, click Uninstall . When you upgrade a 7.10.0 Operator, the new Operator deletes the StatefulSet to remove custom and Operator metering labels, which were incorrectly added to the StatefulSet selector by the Operator in 7.10.0. When the Operator deletes the StatefulSet, it also deletes the existing broker pods, which causes a temporary broker outage. If you want to avoid the outage, complete the following steps to delete the StatefulSet and orphan the broker pods so that they continue to run. Log in to OpenShift Container Platform CLI as an administrator for the project that contains your existing Operator deployment: USD oc login -u <user> Switch to the OpenShift project in which you want to upgrade your Operator version. USD oc project <project-name> Delete the StatefulSet with the --cascade=orphan option to orphan the broker Pods. The orphaned broker Pods continue to run after the StatefulSet is deleted. USD oc delete statefulset <statefulset-name> --cascade=orphan Check if your main broker CR has labels called application or ActiveMQArtemis configured in the deploymentPlan.labels attribute. In 7.10.0, it was possible to configure these custom labels in the CR. These labels are reserved for the Operator to assign labels to Pods and cannot be added as custom labels after 7.10.0. If these custom labels were configured in the main broker CR in 7.10.0, the Operator-assigned labels on the Pods were overwritten by the custom labels. If the CR has either of these labels, complete the following steps to restore the correct labels on the Pods and remove the labels from the CR. In the OpenShift command-line interface (CLI), run the following command to restore the correct Pod labels. In the following example, 'ex-aao' is the name of the StatefulSet deployed. USD for pod in USD(oc get pods | grep -o '^ex-aao[^ ]*'); do oc label --overwrite pods USDpod ActiveMQArtemis=ex-aao application=ex-aao-app; done Delete the application and ActiveMQArtemis labels from the deploymentPlan.labels attribute in the CR. Using the OpenShift command-line interface: Log in to OpenShift as a user that has privileges to deploy CRs in the project for the broker deployment. Edit the CR for your deployment. In the deploymentPlan.labels element in the CR, delete any custom labels called application or ActiveMQArtemis . Save the CR. Using the OpenShift Container Platform web console: Log in to the console as a user that has privileges to deploy CRs in the project for the broker deployment. In the left pane, click Administration Custom Resource Definitions . Click the ActiveMQArtemis CRD. Click the Instances tab. Click the instance for your broker deployment. Click the YAML tab. Within the console, a YAML editor opens, enabling you to configure a CR instance. In the deploymentPlan.labels element in the CR, delete any custom labels called application or ActiveMQArtemis . Click Save . Use OperatorHub to install the latest version of the Operator for AMQ Broker 7.11. For more information, see Section 3.3.2, "Deploying the Operator from OperatorHub" . The new Operator can recognize and manage your broker deployments. If you set values in the image or version field in the CR, the Operator's reconciliation process upgrades the broker Pods to the corresponding images when the Operator starts. For more information, see Section 6.4, "Restricting automatic upgrades of broker container images" . Otherwise, the Operator upgrades each broker Pod to the latest container image. Note If the reconciliation process does not start, you can start the process by scaling the deployment. For more information, see Section 3.4.1, "Deploying a basic broker instance" . Add attributes to the CR for the new features that are available in the upgraded broker, as required. 6.3.5. Upgrading the Operator from 7.10.1 to 7.11.x You must uninstall and reinstall the Operator to upgrade from 7.10.1 to 7.11.x. Procedure Log in to the OpenShift Container Platform web console as a cluster administrator. Check if your main broker CR has labels called application or ActiveMQArtemis configured in the deploymentPlan.labels attribute. These labels are reserved for the Operator to assign labels to Pods and cannot be used after 7.10.1. If these custom labels were configured in the main broker CR, the Operator-assigned labels on the Pods were overwritten by the custom labels. If these custom labels are not configured in the main broker CR, use OperatorHub to install the latest version of the Operator for AMQ Broker 7.11. For more information, see Section 3.3.2, "Deploying the Operator from OperatorHub" . If either of these custom labels are configured in the main broker CR, complete the following steps to uninstall the existing Operator, restore the correct Pod labels and remove the labels from the CR, before you install the new Operator. Note By uninstalling the Operator, you can remove the custom labels without the Operator deleting the StatefulSet, which also deletes the existing broker pods and causes a temporary broker outage. Uninstall the existing AMQ Broker Operator from your project. In the left navigation menu, click Operators Installed Operators . From the Project drop-down menu at the top of the page, select the project from which you want to uninstall the Operator. Locate the Red Hat Integration - AMQ Broker instance that you want to uninstall. For your Operator instance, click the More Options icon (three vertical dots) on the right-hand side. Select Uninstall Operator . On the confirmation dialog box, click Uninstall . In the OpenShift command-line interface (CLI), run the following command to restore the correct Pod labels. In the following example, 'ex-aao' is the name of the StatefulSet deployed. USD for pod in USD(oc get pods | grep -o '^ex-aao[^ ]*'); do oc label --overwrite pods USDpod ActiveMQArtemis=ex-aao application=ex-aao-app; done Delete the application and ActiveMQArtemis labels from the deploymentPlan.labels attribute in the CR. Using the OpenShift command-line interface: Log in to OpenShift as a user that has privileges to deploy CRs in the project for the broker deployment. Edit the CR for your deployment. In the deploymentPlan.labels attribute in the CR, delete any custom labels called application or ActiveMQArtemis . Save the CR file. Using the OpenShift Container Platform web console: Log in to the console as a user that has privileges to deploy CRs in the project for the broker deployment. In the left pane, click Administration Custom Resource Definitions . Click the ActiveMQArtemis CRD. Click the Instances tab. Click the instance for your broker deployment. Click the YAML tab. Within the console, a YAML editor opens, enabling you to configure a CR instance. In the deploymentPlan.labels attribute in the CR, delete any custom labels called application or ActiveMQArtemis . Click Save . Use OperatorHub to install the latest version of the Operator for AMQ Broker 7.11. For more information, see Section 3.3.2, "Deploying the Operator from OperatorHub" . The new Operator can recognize and manage your broker deployments. If you set values in the image or version field in the CR, the Operator's reconciliation process upgrades the broker Pods to the corresponding images when the Operator starts. For more information, see Section 6.4, "Restricting automatic upgrades of broker container images" . Otherwise, the Operator upgrades each broker Pod to the latest container image. Note If the reconciliation process does not start, you can start the process by scaling the deployment. For more information, see Section 3.4.1, "Deploying a basic broker instance" . Add attributes to the CR for the new features that are available in the upgraded broker, as required. 6.3.6. Upgrading the Operator from 7.10.2 or later to 7.11.x You must uninstall and reinstall the Operator to upgrade from 7.10.2 or later to 7.11.x. Procedure Log in to the OpenShift Container Platform web console as a cluster administrator. Uninstall the existing AMQ Broker Operator from your project. In the left navigation menu, click Operators Installed Operators . From the Project drop-down menu at the top of the page, select the project in which you want to uninstall the Operator. Locate the Red Hat Integration - AMQ Broker instance that you want to uninstall. For your Operator instance, click the More Options icon (three vertical dots) on the right-hand side. Select Uninstall Operator . On the confirmation dialog box, click Uninstall . Use OperatorHub to install the latest version of the Operator for AMQ Broker 7.11. For more information, see Section 3.3.2, "Deploying the Operator from OperatorHub" . The new Operator can recognize and manage your broker deployments. If you set values in the image or version field in the CR, the Operator's reconciliation process upgrades the broker Pods to the corresponding images when the Operator starts. For more information, see Section 6.4, "Restricting automatic upgrades of broker container images" . Otherwise, the Operator upgrades each broker Pod to the latest container image. Note If the reconciliation process does not start, you can start the process by scaling the deployment. For more information, see Section 3.4.1, "Deploying a basic broker instance" . 6.4. Restricting automatic upgrades of broker container images By default, the Operator automatically upgrades each broker in the deployment to use the latest available container images. In the Custom Resource (CR) for your deployment, you can restrict the ability of the Operator to upgrade the images by specifying a version number or the URLs of specific container images. Note If you want to restrict automatic upgrades of broker container images, ensure that your CR has either a version number or the combined URLs of the broker and init container images. 6.4.1. Restricting automatic upgrades of images by using version numbers You can restrict the version of the container images to which the brokers are automatically upgraded as new versions become available. Note When you restrict upgrades based on version numbers, the Operator continues to automatically upgrade the brokers to use any new images that contain security fixes for the version deployed. Procedure Edit the main broker CR instance for the broker deployment. Using the OpenShift command-line interface: Log in to OpenShift as a user that has privileges to edit and deploy CRs in the project for the broker deployment. Edit the CR. Using the OpenShift Container Platform web console: Log in to the console as a user that has privileges to deploy CRs in the project for the broker deployment. In the left pane, click Operators Installed Operator . Click the Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) operator. Click the AMQ Broker tab. Click the name of the ActiveMQArtemis instance name. Click the YAML tab. Within the console, a YAML editor opens, enabling you to edit the CR instance. Note In the status section of the CR, the .status.version.brokerVersion field shows the version of AMQ Broker that is currently deployed. In the spec.version attribute, specify the version to which the Operator can upgrade the broker and init container images in your deployment. The following are examples of values that you can specify. Examples In the following example, the Operator upgrades the current container images in your deployment to 7.11.0. spec: version: '7.11.0' ... In the following example, the Operator upgrades the current container images in your deployment to the latest available 7.10.x images. For example, if your deployment is using 7.10.1 container images, the Operator automatically upgrades the images to 7.10.2 but not to 7.11.7. spec: version: '7.10' ... In the following example, the Operator upgrades the current container images in your deployment to the latest 7.x.x images. For example, if your deployment is using 7.10.2 images, the Operator automatically upgrades the images to 7.11.7. spec: version: '7' ... Note To upgrade between minor versions of the container images, for example, from 7.10.x to 7.11.x, you require an Operator that has the same minor version as that of the new container images. For example, to upgrade from 7.10.2 to 7.11.7, a 7.11.x Operator must be installed. Save the CR. Important Ensure that the CR does not contain a spec.deploymentPlan.image or a spec.deploymentPlan.initImage attribute in addition to a spec.version attribute. Both of these attributes override the spec.version attribute. If the CR has one of these attributes as well as the spec.version attribute, the versions of the broker and init images deployed can diverge, which might prevent the broker from running. When you save the CR, the Operator first validates that an upgrade to the AMQ Broker version specified for spec.version is available for your existing deployment. If you specified an invalid version of AMQ Broker to which to upgrade, for example, a version that is not yet available, the Operator logs a warning message, and takes no further action. However, if an upgrade to the specified version is available, then the Operator upgrades each broker in the deployment to use the broker container images that correspond to the new AMQ Broker version. The broker container image that the Operator uses is defined in an environment variable in the operator.yaml configuration file of the Operator deployment. The environment variable name includes an identifier for the AMQ Broker version. For example, the environment variable RELATED_IMAGE_ActiveMQ_Artemis_Broker_Kubernetes_7117 corresponds to AMQ Broker 7.11.7. When the Operator has applied the CR change, it restarts each broker Pod in your deployment so that each Pod uses the specified image version. If you have multiple brokers in your deployment, only one broker Pod shuts down and restarts at a time. Additional resources To learn how the Operator uses environment variables to choose a broker container image, see Section 2.6, "How the Operator chooses container images" . To view the status of the deployment, see Section 6.4.3, "Validation of restrictions applied to automatic upgrades" 6.4.2. Restricting automatic upgrades of images by using image URLs If you want to upgrade the brokers in your deployment to use specific container images, you can specify the registry URLs of the images in the CR. After the Operator upgrades the brokers to the specified container images, no further upgrades occur until you replace the image URLs in the CR. For example, the Operator does not automatically upgrade the brokers to use newer images that contain security fixes for the images deployed. Important If you want to restrict automatic upgrades by using image URLs, specify URLs for both the spec.deploymentPlan.image and the spec.deploymentPlan.initImage attributes in the CR to ensure that the broker and init container images match. If you specify the URL of one container image only, the broker and init container image can diverge, which might prevent the broker from running. Note If a CR has a spec.version attribute in addition to spec.deploymentPlan.image and spec.deploymentPlan.initImage attributes, the Operator ignores the spec.version attribute. Procedure Obtain the URLs of the broker and init container images to which the Operator can upgrade the current images. In the Red Hat Catalog, open the broker container component page: AMQ Broker for RHEL 8 (Multiarch) . In the Architecture drop-down, select your architecture. In the Tag drop-down, select the tag that corresponds to the image you want to install. Tags are displayed in chronological order based on the release date. A tag consists of the release version and an assigned tag. Open the Get this image tab. In the Manifest field , click the Copy icon. Paste the URL into a text file. In the Red Hat Catalog, open the init container component page: AMQ Broker Init for RHEL 8 (Multiarch) To obtain the URL of the init container image, repeat the steps that you followed to obtain the URL of the broker container image. Edit the main broker CR instance for the broker deployment. Using the OpenShift command-line interface: Log in to OpenShift as a user that has privileges to edit and deploy CRs in the project for the broker deployment. Edit the CR. Using the OpenShift Container Platform web console: Log in to the console as a user that has privileges to deploy CRs in the project for the broker deployment. In the left pane, click Operators Installed Operator . Click the Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) operator. Click the AMQ Broker tab. Click the name of the ActiveMQArtemis instance name. Click the YAML tab. Within the console, a YAML editor opens, which enables you to configure the CR instance Copy the URLs of the broker and init container images that you recorded in the text file and insert them in the spec.deploymentPlan.image and spec.deploymentPlan.initImage fields in the CR. For example: spec: ... deploymentPlan: image: registry.redhat.io/amq7/amq-broker-rhel8@137b893ad15e0cd5353bae134c8fae833257a12641b12d0f774f1565ce66f63c initImage: registry.redhat.io/amq7/amq-broker-init-rhel8@b0b3684ef1ebf8b44d3a4c46391984173792dde1bd7363ea06d43a8f95a717d0 ... Save the CR. When you save the CR, the Operator upgrades the brokers to use the new images and uses these images until you update the values of the spec.deploymentPlan.image and spec.deploymentPlan.initImage attributes again. Note If you already deployed AMQ Broker without setting image URLs, you can set the image URLs retrospectively to prevent the Operator from upgrading the current images deployed. You can find the registry URLs for the images deployed in the .status.version.image and .status.version.initImage attributes, which are in the status section of the CR. If you copy the image URLs from the .status.version.image and .status.version.initImage attributes and insert them in the spec.deploymentPlan.image and the spec.deploymentPlan.initImage attributes respectively, the Operator does not upgrade the images currently deployed. Additional Resources To view the status of the deployment, see Section 6.4.3, "Validation of restrictions applied to automatic upgrades" . 6.4.3. Validation of restrictions applied to automatic upgrades After you save a CR, the Operator validates that the CR does not contain either of the following: A spec.deploymentPlan.image attribute without a spec.deploymentPlan.initImage attribute or vice versa. A spec.version attribute with either a spec.deploymentPlan.image and a spec.deploymentPlan.initImage attribute, or both. Either of these configurations can result in different versions of the broker and init container images after an upgrade, which might prevent your broker from starting. If a CR has either of these configurations, the Operator sets the status of the Valid condition to Unknown as a warning. For example, if a CR has a spec.deploymentPlan.image attribute without a spec.deploymentPlan.initImage attribute or vice versa, the Operator displays the following status information for the Valid condition in the CR. status: conditions: - lastTransitionTime: "2023-05-18T15:17:22Z" message: Init image and broker image must both be configured as an interdependent pair observedGeneration: 1 reason: InitImageMustBePairedWithBrokerImage status: "Unknown" type: Valid A Valid condition that has a status value of Unknown does not prevent the Operator from updating the StatefulSet. However, Red Hat recommends that you fix the status of the Valid condition by specifying the combined spec.deploymentPlan.image `and `spec.deploymentPlan.initImage attributes or the spec.version attribute , but not both, in the CR. Note If a CR has a spec.version attribute, the Operator also validates that the version format is correct and that the version is within the valid range that the Operator supports.
spec: brokerProperties: - "addressSettings.#.redeliveryMultiplier=2.1" - "addressSettings.#.redeliveryCollisionAvoidanceFactor=1.2" mkdir ~/broker/operator mv amq-broker-operator-7.11.7-ocp-install-examples.zip ~/broker/operator cd ~/broker/operator unzip amq-broker-operator-operator-7.11.7-ocp-install-examples.zip oc login -u <user> oc project <project-name> spec: selector matchLabels name: amq-broker-operator spec: serviceAccountName: amq-broker-operator oc apply -f deploy/service_account.yaml oc apply -f deploy/role.yaml oc apply -f deploy/role_binding.yaml oc apply -f deploy/crds/broker_activemqartemis_crd.yaml oc apply -f deploy/crds/broker_activemqartemisaddress_crd.yaml oc apply -f deploy/crds/broker_activemqartemisscaledown_crd.yaml oc apply -f deploy/crds/broker_activemqartemissecurity_crd.yaml oc delete -f deploy/operator.yaml oc delete statefulset <statefulset-name> --cascade=orphan oc delete -f deploy/operator.yaml for pod in USD(oc get pods | grep -o '^ex-aao[^ ]*'); do oc label --overwrite pods USDpod ActiveMQArtemis=ex-aao application=ex-aao-app; done login -u <user> -p <password> --server= <host:port> oc project <project_name> oc apply -f <path/to/broker_custom_resource_instance> .yaml oc create -f deploy/operator.yaml oc apply -f deploy/operator.yaml oc login -u <user> oc project <project-name> oc delete statefulset <statefulset-name> --cascade=orphan for pod in USD(oc get pods | grep -o '^ex-aao[^ ]*'); do oc label --overwrite pods USDpod ActiveMQArtemis=ex-aao application=ex-aao-app; done login -u <user> -p <password> --server= <host:port> edit ActiveMQArtemis < statefulset name > -n < namespace > for pod in USD(oc get pods | grep -o '^ex-aao[^ ]*'); do oc label --overwrite pods USDpod ActiveMQArtemis=ex-aao application=ex-aao-app; done login -u <user> -p <password> --server= <host:port> edit ActiveMQArtemis < statefulset name > -n < namespace > oc login -u <user> -p <password> --server= <host:port> edit ActiveMQArtemis < CR instance name > -n < namespace > spec: version: '7.11.0' spec: version: '7.10' spec: version: '7' oc login -u <user> -p <password> --server= <host:port> edit ActiveMQArtemis < CR instance name > -n < namespace > spec: deploymentPlan: image: registry.redhat.io/amq7/amq-broker-rhel8@137b893ad15e0cd5353bae134c8fae833257a12641b12d0f774f1565ce66f63c initImage: registry.redhat.io/amq7/amq-broker-init-rhel8@b0b3684ef1ebf8b44d3a4c46391984173792dde1bd7363ea06d43a8f95a717d0 status: conditions: - lastTransitionTime: "2023-05-18T15:17:22Z" message: Init image and broker image must both be configured as an interdependent pair observedGeneration: 1 reason: InitImageMustBePairedWithBrokerImage status: "Unknown" type: Valid