Itential Automation GatewayDeploy and managePlan

IAG system requirements

Itential Automation Gateway (IAG) requires specific hardware, software, and network configurations before you can install and run it. Review the requirements on this page to prepare your environment.

For the most current version-specific requirements, including third-party software compatibility, refer to the IAG release notes for your release. You can also refer to the IAG Dependencies table for a consolidated list of supported dependencies.

Server specifications

The following table lists the required server specifications for production and development environments.

SpecificationRequirementProductionDevelopment
CPU64-bit x8616 cores4 cores
OSRHEL / Rocky / Amazon Linux8 or 9 / 8 or 9 / 20238 or 9 / 8 or 9 / 2023
RAMDDR5 DRAM 3200 MHz32 GB16 GB
Disk (SSD or NVMe)Total / /opt/automation-gateway50 GB / 50 GBMinimum: 10 GB / Recommended: 20 GB

If you use a large number of custom scripts, content, or logging, you may need to increase CPU, RAM, and disk space allocations beyond these recommendations.

Software requirements

IAG is a pip-installed Python package supported on RHEL, Rocky, and Amazon Linux. You can use any method to install Python or Ansible as long as the versions match the requirements for your IAG release.

The following software is generally required:

  • RHEL 8 or 9 / Rocky 8 or 9 / Amazon Linux 2023
  • Python 3.9
  • Ansible-Core (refer to your release notes for supported versions)

You must also install any integrations you plan to use, such as Ansible, Terraform, or Nornir.

Implementation considerations

IAG resides on the same server as your Ansible implementation. If you have multiple Ansible implementations, you must install IAG on each server. Optionally, you can use Itential adapters to connect each IAG installation to the Itential Automation Platform (IAP) and manage all of your Ansible networks from a single point.

Software repository and registry credentials

You need access to the Itential pip registry to download and install IAG. To get your credentials, contact the Itential Service Desk.

For all IAG installation methods, your customer account is assigned to one of two software repositories: Nexus or JFrog. You’ll receive your repository assignment in a welcome email after Itential grants you access.

To ensure the install reflects the correct REGISTRY_URL for your assigned repository, use the appropriate value from the sections that follow.

Install script

The following script contains a generic placeholder for the REGISTRY_URL variable. Replace it with the value for your assigned repository.

$echo "## CUSTOMIZE THESE VARIABLES BEFORE RUNNING THIS SCRIPT: ##" && \
>export AUTOMATION_GATEWAY_VERSION="" && \
>export REGISTRY_USERNAME="" && \
>export REGISTRY_PASSWORD="" && \
>export REGISTRY_URL=<<your registry specific value>>
$
$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

Customer accounts assigned to JFrog

Set the REGISTRY_URL variable to the following value if your account is assigned to the JFrog repository:

"itential.jfrog.io/artifactory/automation-gateway/"

Customer accounts assigned to Nexus

Set the REGISTRY_URL variable to the following value if your account is assigned to the Nexus repository:

"registry.aws.itential.com/repository/automation-gateway-release/simple"

IAG dependencies

IAG Versionpythonopensslhaproxypipterraformnornirnetmiko
4.33.9.x1.1.0-1.2.02.0.0-3.0.020.2.41.2.93.0.0-4.0.04.1.2
2023.33.9.x1.1.0-1.2.02.0.0-3.0.020.2.41.2.93.0.0-4.0.04.1.2
2023.23.9.x1.1.0-1.2.02.0.0-3.0.020.2.41.2.93.0.0-4.0.04.1.2
2023.13.9.x1.1.0-1.2.02.0.0-3.0.020.2.41.2.93.0.0-4.0.04.1.2
2022.13.9.5-4.0.01.1.0-1.2.02.0.0-3.0.020.2.40.12.0-0.13.03.0.0-4.0.03.0.0-4.0.0

Notes:

  • The following grpc pinned libraries are used to test IAG: pygnmi==0.8.9, grpcio==1.53.0.
  • The gcc-c++ and make packages should be installed from your OS distribution.
  • The gcc is only required for installation and can be safely removed after a successful install. The gcc is not needed for operation.
  • The following development packages are required to install IAG: libffi-dev, openssl-dev, python-dev, sqlite-dev.
  • One or more of the following packages may be required by the specific Ansible modules you’re using: psutil, pycrypto, paramiko, ncclient, lxml, nitrosdk-python, jxmlease.
  • Check the Ansible documentation for the roles you’re planning to use for additional package requirements.