Release notesDeprecations and breaking changesBreaking changes

Gateway container image changes

To improve the Gateway image, Itential made several breaking changes that apply to Gateway maintenance release versions:

  • 2023.2.7
  • 2023.1.10
  • 2022.1.19

Python packages in Gateway image

Gateway installation via wheel file now includes additional Python packages. Consequently, required third-party dependencies come pre-installed in the Gateway image as well. This includes: Nornir, Netmiko, Netconf, GRPC, LDAP Authentication, and Vault packages.

Update the Gateway image

  • Create a dockerFile that builds a new customized Gateway image using the Itential provided Gateway image as a base image.
  • Move the logic for any scripts that are being mounted to /docker-entrypoint-init-iag.d/* into the new dockerFile.
  • Remove any logic that mounts any files to the /docker-entrypoint-init-iag.d/* location.

Ansible

  • Ansible is now preinstalled in Gateway version 2023.2+.
  • Ansible is not preinstalled in Gateway versions 2023.1 or earlier.

Virtual environment removed from Docker image

Gateway is no longer installed in a virtual environment (VENV) inside the Docker image. As a result:

  • If you customized the container (either by Dockerfile that extended the Gateway image, or another means such as a compose file), then some customizations might have to be adjusted.

  • If you customized the “CMD” of the container, the CMD statement needs to be updated to automation-gateway instead of /opt/itential/automation-gateway/bin/automation-gateway.

  • The following paths no longer exist in the image:

    • /opt/itential/automation-gateway/bin (aka ~/automation-gateway/bin)
    • /opt/itential/automation-gateway/includes (aka ~/automation-gateway/includes)
    • /opt/itential/automation-gateway/lib (aka ~/automation-gateway/lib)
    • /opt/itential/automation-gateway/lib64 (aka ~/automation-gateway/lib64)
    • /opt/itential/automation-gateway/share (aka ~/automation-gateway/share)

  • Gateway (along with required packages like Ansible) is now installed at /usr/local/lib/python3.9/site-packages instead of /opt/itential/automation-gateway/.

  • The source /opt/itential/automation-gateway/bin/activate command is no longer needed to activate the Python virtual environment when installing pip packages inside the Dockerfile. The deactivate command should also be removed from the Dockerfile if present.

WAIT_FOR feature removal

  • The WAIT_FOR package and references have been removed from the Gateway image.
  • The WAIT_FOR and WAIT_FOR_TIMEOUT environment variables no longer work in the image.

Contact the Product Support Team if you require more information or need additional support.