5.3.2 Updating the AWX execution environment

AWX for Ops I has OpsI Automation EE (for execution on Ops I’s SaaS infrastructure) and OpsI Outpost EE (for execution of relay servers) registered. In addition, the base image for the custom execution environment is registered in GitLab by default.
When upgrading Ops I, a new version of the OpsI Automation EE execution environment is added to the [Execution Environment] of AWX displayed from the automation application.
The sample project “system/awx-ee” for the custom execution environment and the base image for the custom execution environment defined in that project may be updated when Ops I is upgraded.

The versions of OpsI Automation EE and custom execution environment base images provided at the time of Ops I release are supported for three years from the release date.

(Table) AWX execution environment lifecycle

OpsI Outpost EE supports the same version as Ops I and the next version. For details, refer to the agent support policy in “(Table) Prerequisites for installing RPM package”.
Follow the procedure in “Checking the version of the AWX execution environment” to confirm whether the existing execution environment is within the support period. If necessary, follow the procedure in “Actions when upgrading the version of the AWX execution environment”.

(1) Checking the version of the AWX execution environment

The procedure for checking the version of the AWX execution environment is as follows.

[Ops I Automation EE]

1. From the Automation application, select "Execution Environments" in the "Administration" category on the AWX window displayed in the contents area.
2. Check the version from the "Image" of the execution environment you want to check.
   

   registry/dx-tool/dx-iac/quay.io/ansible/awx-ee:Execution Environment Version

   
   

[Base image of the custom execution environment]

For details on the custom execution environment, see “Extending the environment for automatic execution”.

1. From the Automation application, select "Execution Environments" in the "Administration" category on the AWX window displayed in the contents area.
2. Check the version from the "Image" of the execution environment you want to check.
   

   registry.Ops I Domain/ops-i-system-engineer/project name:Execution Environment Version

   
   
3. From the Git application, open the GitLab project that built the custom execution environment in the GitLab window displayed in the content area.
   

   ops-i-system-engineer/project name

   
   
4. From [Code] - [Tags], navigate to the tag with the same name as the custom execution environment version.
5. Get the version of the base image for the custom execution environment from the EE_BASE_IMAGE variable in the Dockerfile directly under the repository.
   

   ARG EE_BASE_IMAGE="quay.io/ansible/awx-ee:Base Image Version"

   
   

(2) Upgrading the version of the custom execution environment

For details on the custom execution environment, see “Extending the environment for automatic execution”.
The following procedure describes how to build an upgraded custom execution environment image and register the built image with AWX.
If you are not using a custom execution environment, this procedure is not necessary.

1. Update the fork for custom projects. For details on how to update, see the following.
   https://archives.docs.gitlab.com/17.3/ee/user/project/repository/forking_workflow.html#update-your-fork
   • The versions of Python and ansible-core packages may change by upgrading the AWX execution environment. For the OSS version, see "(Table) Versions of OSS installed in the container images of the execution environments"
   • If changing the package version affects custom configuration files, update the custom configuration files. (Example: dependencies)
2. Set tags for custom projects and build updated custom execution environment images.
   For the procedure, see step 5 of "Developing custom execution environments".
3. Create a new custom execution environment based on the built image, or update the "image" of an existing custom execution environment.
   For the procedure, see "Registering custom execution environments with AWX".

(3) Actions when upgrading the version of the AWX execution environment

The following procedure shows how to register the upgraded AWX execution environment in the job template.
To change job templates, you must be assigned the role of “Job Template Admin” or “Admin” within your organization. For information on roles within organizations, see “Organization management”.

1. Check whether the following packages have been updated by upgrading the AWX execution environment.
   • Python
   • ansible-core (including ansible.builtin collection)
   • Ansible collection
   For the OSS version, see "(Table) Versions of OSS installed in the container images of the execution environments".
2. If the package version has changed, check the change log for the relevant package. If there are changes in the change log that affect the Playbook, update the Playbook. (Examples: Breaking Changes, Deprecated Features)
3. Update the execution environment registered in the job template to the new version of the execution environment.
   From the Automation application, select "Templates" in the "Resources" category on the AWX window displayed in the contents area. Check the job template you want to change, click the [Edit] button, and set the new execution environment.
   OpsI Automation EE has the following names depending on the version.
   • OpsI Automation EE: Released in Ops I v2.5
   • OpsI Automation EE Ops I Version: Released in Ops I v2.7 or later