Upgrading IAG
  • 22 Mar 2024
  • Dark
    Light
  • PDF

Upgrading IAG

  • Dark
    Light
  • PDF

Article Summary

To manage updates of Itential Automation Gateway:

  1. Specify the appropriate upgrade version.
  2. Specify the registry credentials to collect the package.
  3. Utilize pip3 install --upgrade with the appropriate pip/python versions for your intended installation.
Click here for IAG 2023.2

Python Packages for Optional Integrations

IAG 2023.2 will no longer install Python packages for the following optional integrations:

• GRPC
• Hashicorp Vault
• LDAP
• Netconf
• Netmiko
• Nornir

Note: This should only impact upgrades if gRPC is enabled as the other required packages should already be installed

If gRPC is enabled and the user has not installed the proper package, the server will not start and will present the user with an error message for the packages required. Enabling the integrations will require the user to install the packages below within the Virtual Environment (VENV) that IAG is running in.

GRPC

python3 -m pip install pygnmi==0.8.9 grpcio==1.53.0

Software Repository & Registry Credentials

Customer accounts are assigned to one of two software repositories: Nexus or JFrog. Customers are informed which repository their account is assigned to in a welcome email that is sent once customer access is granted to the Itential software.

To ensure the IAG upgrade reflects the correct REGISTRY_URL for your assigned software repository, use the applicable set of instructions presented below.

Customer Accounts Assigned to JFrog

Run this script to upgrade if assigned to the JFrog repository.

echo "## CUSTOMIZE THESE VARIABLES BEFORE RUNNING THIS SCRIPT: ##" && \
export AUTOMATION_GATEWAY_VERSION="" && \
export REGISTRY_USERNAME="" && \
export REGISTRY_PASSWORD="" && \
export REGISTRY_URL="itential.jfrog.io/artifactory/automation-gateway/"

echo "## UPGRADE THE AUTOMATION GATEWAY PIP PACKAGE: ##" && \
sudo pip3 install --upgrade -v automation-gateway==$AUTOMATION_GATEWAY_VERSION --extra-index-url https://$REGISTRY_USERNAME:$REGISTRY_PASSWORD@$REGISTRY_URL

Upgrade Output Example (JFrog)

The output of the above commands should roughly match the following codeblock for customers assigned to JFrog.

Created temporary directory: /tmp/pip-ephem-wheel-cache-hpp3436z
Created temporary directory: /tmp/pip-req-tracker-m18dli2n
Created requirements tracker '/tmp/pip-req-tracker-m18dli2n'
Created temporary directory: /tmp/pip-install-k11d6prh
Looking in indexes: https://pypi.org/simple,  https://itential.jfrog.io/artifactory/automation-gateway/
Collecting automation-gateway==...
    ...
    ...
Successfully installed automation-gateway-...
Cleaning up...
Removed build tracker '/tmp/pip-req-tracker-m18dli2n'

Customer Accounts Assigned to Nexus

Run this script to upgrade if assigned to the Nexus repository.

echo "## CUSTOMIZE THESE VARIABLES BEFORE RUNNING THIS SCRIPT: ##" && \
export AUTOMATION_GATEWAY_VERSION="" && \
export REGISTRY_USERNAME="" && \
export REGISTRY_PASSWORD="" && \
export REGISTRY_URL="registry.aws.itential.com/repository/automation-gateway-release/simple"

echo "## UPGRADE THE AUTOMATION GATEWAY PIP PACKAGE: ##" && \
sudo pip3 install --upgrade -v automation-gateway==$AUTOMATION_GATEWAY_VERSION --extra-index-url https://$REGISTRY_USERNAME:$REGISTRY_PASSWORD@$REGISTRY_URL

Upgrade Output Example (Nexus)

The output of the above commands should roughly match the following codeblock for customers assigned to Nexus.

Created temporary directory: /tmp/pip-ephem-wheel-cache-hpp3436z
Created temporary directory: /tmp/pip-req-tracker-m18dli2n
Created requirements tracker '/tmp/pip-req-tracker-m18dli2n'
Created temporary directory: /tmp/pip-install-k11d6prh
Looking in indexes: https://pypi.org/simple, https://registry.aws.itential.com/repository/automation-gateway-release/simple
Collecting automation-gateway==...
    ...
    ...
Successfully installed automation-gateway-...
Cleaning up...
Removed build tracker '/tmp/pip-req-tracker-m18dli2n'

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.