Chapter 2. System requirements

Procedure

1. Install and then connect to a PostgreSQL compliant database server with superuser privileges.

   # psql -h <db.example.com> -U superuser -p 5432 -d postgres <Password for user superuser>:

2. Where the default value for <hostname> is hostname:

   -h hostname
   --host=hostname

3. Specify the hostname of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the UNIX-domain socket.

   -d dbname
   --dbname=dbname

4. Specify the name of the database to connect to. This is equal to specifying dbname as the first non-option argument on the command line. The dbname can be a connection string. If so, connection string parameters override any conflicting command line options.

   -U username
   --username=username

5. Connect to the database as the user username instead of the default (you must have permission to do so).
6. Create the user, database, and password with the createDB or administrator role assigned to the user. For further information, see Database Roles.

7. Add the database credentials and host details to the installation program’s inventory file under the [all:vars] group.

   Without mutual TLS (mTLS) authentication to the database

   Use the following inventory file snippet to configure each component’s database without mTLS authentication. Uncomment the configuration you need.

   [all:vars]
   # Automation controller database variables
   
   # awx_install_pg_host=data.example.com
   # awx_install_pg_port=<port_number>
   # awx_install_pg_database=<database_name>
   # awx_install_pg_username=<username>
   # awx_install_pg_password=<password> # This is not required if you enable mTLS authentication to the database
   # pg_sslmode=prefer # Set to verify-ca or verify-full to enable mTLS authentication to the database
   
   
   # Event-Driven Ansible database variables
   
   # automationedacontroller_install_pg_host=data.example.com
   # automationedacontroller_install_pg_port=<port_number>
   # automationedacontroller_install_pg_database=<database_name>
   # automationedacontroller_install_pg_username=<username>
   # automationedacontroller_install_pg_password=<password> # This is not required if you enable mTLS authentication to the database
   # automationedacontroller_pg_sslmode=prefer # Set to verify-full to enable mTLS authentication to the database
   
   
   # Automation hub database variables
   
   # automationhub_pg_host=data.example.com
   # automationhub_pg_port=<port_number>
   # automationhub_pg_database=<database_name>
   # automationhub_pg_username=<username>
   # automationhub_pg_password=<password> # This is not required if you enable mTLS authentication to the database
   # automationhub_pg_sslmode=prefer # Set to verify-ca or verify-full to enable mTLS authentication to the database
   
   
   # Platform gateway database variables
   
   # automationgateway_install_pg_host=data.example.com
   # automationgateway_install_pg_port=<port_number>
   # automationgateway_install_pg_database=<database_name>
   # automationgateway_install_pg_username=<username>
   # automationgateway_install_pg_password=<password> # This is not required if you enable mTLS authentication to the database
   # automationgateway_pg_sslmode=prefer # Set to verify-ca or verify-full to enable mTLS authentication to the database

   With mTLS authentication to the database

   Use the following inventory file snippet to configure each component’s database with mTLS authentication. Uncomment the configuration you need.

   [all:vars]
   # Automation controller database variables
   
   # awx_install_pg_host=data.example.com
   # awx_install_pg_port=<port_number>
   # awx_install_pg_database=<database_name>
   # awx_install_pg_username=<username>
   # pg_sslmode=verify-full # This can be either verify-ca or verify-full
   # pgclient_sslcert=/path/to/cert # Path to the certificate file
   # pgclient_sslkey=/path/to/key # Path to the key file
   
   
   # Event-Driven Ansible database variables
   
   # automationedacontroller_install_pg_host=data.example.com
   # automationedacontroller_install_pg_port=<port_number>
   # automationedacontroller_install_pg_database=<database_name>
   # automationedacontroller_install_pg_username=<username>
   # automationedacontroller_pg_sslmode=verify-full # EDA does not support verify-ca
   # automationedacontroller_pgclient_sslcert=/path/to/cert # Path to the certificate file
   # automationedacontroller_pgclient_sslkey=/path/to/key # Path to the key file
   
   
   # Automation hub database variables
   
   # automationhub_pg_host=data.example.com
   # automationhub_pg_port=<port_number>
   # automationhub_pg_database=<database_name>
   # automationhub_pg_username=<username>
   # automationhub_pg_sslmode=verify-full # This can be either verify-ca or verify-full
   # automationhub_pgclient_sslcert=/path/to/cert # Path to the certificate file
   # automationhub_pgclient_sslkey=/path/to/key # Path to the key file
   
   
   # Platform gateway database variables
   
   # automationgateway_install_pg_host=data.example.com
   # automationgateway_install_pg_port=<port_number>
   # automationgateway_install_pg_database=<database_name>
   # automationgateway_install_pg_username=<username>
   # automationgateway_pg_sslmode=verify-full # This can be either verify-ca or verify-full
   # automationgateway_pgclient_sslcert=/path/to/cert # Path to the certificate file
   # automationgateway_pgclient_sslkey=/path/to/key # Path to the key file

8. Run the installer. If you are using a PostgreSQL database, the database is owned by the connecting user and must have a createDB or administrator role assigned to it.
9. Check that you can connect to the created database with the credentials provided in the inventory file.
10. Check the permission of the user. The user should have the createDB or administrator role.

Procedure

1. Check if the extension is available on the PostgreSQL server (automation hub database).

   $ psql -d <automation hub database> -c "SELECT * FROM pg_available_extensions WHERE name='hstore'"

2. Where the default value for <automation hub database> is automationhub.

   Example output with hstore available:

   name  | default_version | installed_version |comment
   ------+-----------------+-------------------+---------------------------------------------------
    hstore | 1.7           |                   | data type for storing sets of (key, value) pairs
   (1 row)

   Example output with hstore not available:

    name | default_version | installed_version | comment
   ------+-----------------+-------------------+---------
   (0 rows)

3. On a RHEL based server, the hstore extension is included in the postgresql-contrib RPM package, which is not installed automatically when installing the PostgreSQL server RPM package.

   To install the RPM package, use the following command:

   dnf install postgresql-contrib

4. Create the hstore PostgreSQL extension on the automation hub database with the following command:

   $ psql -d <automation hub database> -c "CREATE EXTENSION hstore;"

   The output of which is:

   CREATE EXTENSION

   In the following output, the installed_version field contains the hstore extension used, indicating that hstore is enabled.

   name | default_version | installed_version | comment
   -----+-----------------+-------------------+------------------------------------------------------
   hstore  |     1.7      |       1.7         | data type for storing sets of (key, value) pairs
   (1 row)

Procedure

1. Run a random write test:

   $ fio --name=write_iops --directory=/tmp --numjobs=3 --size=10G \
   --time_based --runtime=60s --ramp_time=2s --ioengine=libaio --direct=1 \
   --verify=0 --bs=4K --iodepth=64 --rw=randwrite \
   --group_reporting=1 > /tmp/fio_benchmark_write_iops.log \
   2>> /tmp/fio_write_iops_error.log

2. Run a random read test:

   $ fio --name=read_iops --directory=/tmp \
   --numjobs=3 --size=10G --time_based --runtime=60s --ramp_time=2s \
   --ioengine=libaio --direct=1 --verify=0 --bs=4K --iodepth=64 --rw=randread \
   --group_reporting=1 > /tmp/fio_benchmark_read_iops.log \
   2>> /tmp/fio_read_iops_error.log

3. Review the results:

   In the log files written by the benchmark commands, search for the line beginning with iops. This line shows the minimum, maximum, and average values for the test.

   The following example shows the line in the log file for the random read test:

   $ cat /tmp/fio_benchmark_read_iops.log
   read_iops: (g=0): rw=randread, bs=(R) 4096B-4096B, (W) 4096B-4096B, (T) 4096B-4096B, ioengine=libaio, iodepth=64
   […]
      iops        : min=50879, max=61603, avg=56221.33, stdev=679.97, samples=360
   […]

   Note

   The above is a baseline to help evaluate the best case performance on your systems. Systems can and will change and performance may vary depending on what else is happening on your systems, storage or network at the time of testing. You must review, monitor, and revisit the log files according to your own business requirements, application workloads, and new demands.