Installing and upgrading Private Automation Hub

Red Hat Ansible Automation Platform 1.2

Installing an instance of Private Automation Hub or upgrading to a new version on online or offline Red Hat Enterprise Linux 7 and 8 physical or virtual machines.

Red Hat Customer Content Services

Abstract

Providing Feedback:
If you have a suggestion to improve this documentation, or find an error, create an issue at http://issues.redhat.com. Select the Automation Hub (AAH) project and use the Documentation component.

Preface

You can install Private Automation Hub or upgrade to a new version on a Red Hat Enterprise Linux 7 or 8 virtual or physical machine with a valid Red Hat Ansible Automation Platform subscription.

Chapter 1. System requirements

Installing a Private Automation Hub instance requires the following:

Table 1.1. System Requirements

 Required

Subscription

Valid Red Hat Ansible Automation Platform

OS

Red Hat Enterprise Linux 7.7 or later 64-bit (x86) or 8.2 or later 64-bit (x86)

Ansible

version 2.9 required

RAM

4Gb minimum

CPUs

2 minimum

Disk

20Gb dedicated hard disk space

Dependent on size of collections stored

Browser

A currently supported version of Mozilla FireFox or Google Chrome

Database

PostgreSQL version 10

Note

You cannot install Ansible Tower and a Private Automation Hub instance on the same node. The inventory file can handle the installation of both Ansible Tower and Automation Hub. These instructions are only for the installation of Automation Hub.

Chapter 2. Installing online or offline

Choose the Ansible Automation Platform installer you need to install Private Automation Hub based on your Red Hat Enterprise Linux environment internet connectivity. Review the scenarios below and determine which Ansible Automation Platform installer meets your needs.

Note

A valid Red Hat customer account is required to access Ansible Automation Platform installer downloads on the Red Hat Customer Portal.

Installing with internet access

Install Private Automation Hub using the Ansible Automation Platform installer if your Red Hat Enterprise Linux environment is connected to the internet. Installing with internet access will retrieve the latest required repositories, packages, and dependencies.

  1. Navigate to https://access.redhat.com/downloads/content/480
  2. Click Download Now for the Ansible Automation Platform <latest-version> Setup.
  3. Extract the files:

    $ tar xvzf ansible-automation-platform-setup-<latest-version>.tar.gz

Installing without internet access

Install Private Automation Hub using the Ansible Automation Platform Bundle installer if you are unable to access the internet, or would prefer not to install separate components and dependencies from online repositories. Access to Red Hat Enterprise Linux repositories is still needed. All other dependencies are included in the tar archive.

  1. Navigate to https://access.redhat.com/downloads/content/480
  2. Click Download Now for the Ansible Automation Platform <latest-version> Setup Bundle.
  3. Extract the files:

    $ tar xvzf ansible-automation-platform-setup-bundle-<latest-version>.tar.gz

Chapter 3. Editing the inventory file

Edit the inventory file to specify an installation of Automation Hub, and update required parameters.

  1. Navigate to the installer

    1. [bundled installer]

      $ cd ansible-automation-platform-setup-bundle-<latest-version>
    2. [online installer]

      $ cd ansible-automation-platform-setup-<latest-version>
  2. Open the inventory file with a text editor.
  3. Edit inventory file parameters to specify an installation of Automaton Hub host only. Follow the example below.

    1. Leave [tower] inventory information empty.
    2. Add [automationhub] group host information.

      Note

      Provide a reachable IP address for the [automationhub] host to ensure users can sync content from Private Automation Hub from a different node.

    3. Update the values for automationhub_admin_password and automation_pg_password and any additional parameters based on your installation specifications:

      Example

      [tower]
      
      
      [automationhub]
      <reachable-ip> ansible_connection=local
      
      [all:vars]
      automationhub_admin_password= <PASSWORD>
      
      automationhub_pg_host=''
      automationhub_pg_port=''
      
      automationhub_pg_database='automationhub'
      automationhub_pg_username='automationhub'
      automationhub_pg_password=<PASSWORD>
      automationhub_pg_sslmode='prefer'
      
      # The default install will deploy a TLS enabled Automation Hub.
      # If for some reason this is not the behavior wanted one can
      # disable TLS enabled deployment.
      #
      # automationhub_disable_https = False
      # The default install will generate self-signed certificates for the Automation
      # Hub service. If you are providing valid certificate via automationhub_ssl_cert
      # and automationhub_ssl_key, one should toggle that value to True.
      #
      # automationhub_ssl_validate_certs = False
      # SSL-related variables
      # If set, this will install a custom CA certificate to the system trust store.
      # custom_ca_cert=/path/to/ca.crt
      # Certificate and key to install in Automation Hub node
      # automationhub_ssl_cert=/path/to/automationhub.cert
      # automationhub_ssl_key=/path/to/automationhub.key

Chapter 4. Running the setup script

You can run the setup script once you finish updated the inventory file with required parameters for installing your Private Automation Hub.

  1. Run the setup.sh script

    $ ./setup.sh

The installation will begin.

Chapter 5. Verifying installation

Once the installation completes, you can verify your Private Automation Hub has been intalled successfully by logging in with the admin credentials you inserted into the inventory file.

  1. Navigate to your Private Automation Hub
  2. Log in with the Admin credentials you set in the inventory file.

Your Private Automation Hub is now ready for initial configuration. See the following administration guides for more:

Chapter 6. Upgrading to the latest version

You can upgrade your Private Automation Hub to the latest version using the Ansible Automation Platform setup bundle installer. Perform this upgrade using the inventory file configured when you installed Private Automation Hub.

  1. Navigate to https://access.redhat.com/downloads/content/480
  2. Click Download Now for the Ansible Automation Platform <latest-version> Setup Bundle.
  3. Extract the files:

    $ tar xvzf ansible-automation-platform-setup-bundle-<latest-version>.tar.gz
  4. Copy configuration information from your initial installation to the inventory file.
  5. Run the setup.sh script

    $ ./setup.sh

Verifying your upgrade

You can verify a successful upgrade to your Private Automation Hub by reviewing the Server version information.

  1. Log in to your Private Automation Hub.
  2. Click the ? icon in the top navigation bar.
  3. Click About.
  4. Verify that the server version matches the version you upgraded to.

Legal Notice

Copyright © 2021 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.