General Prerequisites
  • 06 Jun 2023
  • Dark
    Light
  • PDF

General Prerequisites

  • Dark
    Light
  • PDF

Article Summary

Overview

Itential Automation Gateway (IAG) is compatible with several third-party software products for network operating environments. All third-party software version compatibility is documented in Release Notes. To get the most up-to-date requirements for any third-party software, including open source, first identify which IAG release you’re using and then refer to the respective release notes.

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

Important

Access to the Itential pip registry is required to download and install the Automation Gateway software. To obtain your credentials, contact the Itential Service Desk.

General Requirements

Note: Please refer to IAG Release Notes for a more exhaustive list of requirements.

  • RHEL 8 / RHEL 9
  • Rocky 8 / Rocky 9
  • Python 3.9
  • Ansible-Core 2.8-2.10, 2.13, 2.14
Note:

See the consolidated Itential Dependencies page for a complete and updated list of supported dependencies and requirements.

Automation Gateway is a pip-installed Python package which is supported on a RHEL/CentOS base due to compatibility, security, and scaling considerations regarding the tools that it integrates with (Ansible, Nornir, Terraform, etc). In general, you can use any method to install Python or Ansible as long as the versions match the requirements for your particular Automation Gateway package.

Generally speaking, the steps to install Automation Gateway on a fresh server are:

  • Ensure the system has the correct, updated repositories and packages.
  • Ensure the system has the correct version of Python installed and available to the non-root user (eg. itential).
  • Install the Automation Gateway with pip via the Itential Pip Registry and your credentials.
  • Ensure you have installed all applicable integrations that you wish to use such as Ansible, Terraform, etc.
  • Supply the correct properties to Automation Gateway which describe enabled integrations, content locations, etc.
  • Ensure your server has the correct ports open and security settings (selinux, ssl, etc) in place for web traffic.
  • Startup Automation Gateway.

Software Repository & Registry Credentials

For all IAG installation methods, a customer account is 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 install reflects the correct REGISTRY_URL for your assigned software repository, use the appropriate variable that reflects your assigned software repository.

Install Script

Note:

The script below contains a generic placeholder for the REGISTRY_URL variable.

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

Update the REGISTRY_URL variable with the following if assigned to the JFrog repository.

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

Customer Accounts Assigned to Nexus

Update the REGISTRY_URL variable with the following if assigned to the Nexus repository.

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


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.