Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@

= Resources for troubleshooting {ControllerName}

* For information about troubleshooting {ControllerName}, see link:{URLControllerAdminGuide}/controller-troubleshooting[Troubleshooting automation controller] in _{TitleControllerAdminGuide}_.
* For information about troubleshooting {ControllerName}, see link:{URLControllerAdminGuide}/controller-troubleshooting[Troubleshooting {ControllerName}] in _{TitleControllerAdminGuide}_.

* For information about troubleshooting the performance of {ControllerName}, see link:{URLControllerAdminGuide}/assembly-controller-improving-performance#ref-controller-performance-troubleshooting[Performance troubleshooting for automation controller] in _{TitleControllerAdminGuide}_.
* For information about troubleshooting the performance of {ControllerName}, see link:{URLControllerAdminGuide}/assembly-controller-improving-performance#ref-controller-performance-troubleshooting[Performance troubleshooting for {ControllerName}] in _{TitleControllerAdminGuide}_.
3 changes: 1 addition & 2 deletions downstream/modules/platform/con-hs-eda-controller.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ The following example shows how you can set up an inventory file for horizontal
-----
[automationedacontroller]

3.88.116.111
routable_hostname=automationedacontroller-api.example.com eda_node_type=api
3.88.116.111 routable_hostname=automationedacontroller-api.example.com eda_node_type=api

# worker node
3.88.116.112 routable_hostname=automationedacontroller-api.example.com eda_node_type=worker
Expand Down
4 changes: 2 additions & 2 deletions downstream/modules/platform/proc-backup-aap-container.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

= Backing up container-based {PlatformNameShort}

Perform a back up of your {ContainerBase} of {PlatformNameShort}.
Perform a backup of your {ContainerBase} of {PlatformNameShort}.

.Procedure

. Go to the {PlatformName} installation directory on your {RHEL} host.

. Run the `backup` playbook command:
. Run the `backup` playbook:
+
----
$ ansible-playbook -i inventory ansible.containerized_installer.backup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

= Downloading {PlatformNameShort}

Choose the installer you need based on your {RHEL} environment internet connectivity and download the installer to your {RHEL} host.
Choose the installation program you need based on your {RHEL} environment internet connectivity and download the installation program to your {RHEL} host.

.Procedure

. Download the latest installer .tar file from the link:{PlatformDownloadUrl}[{PlatformNameShort} download page].
.. For online installations: *{PlatformNameShort} {PlatformVers} Containerized Setup*
.. For offline or bundled installations: *{PlatformNameShort} {PlatformVers} Containerized Setup Bundle*

. Copy the installer .tar file and the optional manifest .zip file onto your {RHEL} host.
. Copy the installation program .tar file and the optional manifest .zip file onto your {RHEL} host.

. Decide where you want the installer to reside on the file system. Installation related files are created under this location and require at least 10 GB for the initial installation.
. Decide where you want the installation program to reside on the file system. Installation related files are created under this location and require at least 10 GB for the initial installation.

. Unpack the installer .tar file into your installation directory, and go to the unpacked directory.
. Unpack the installation program .tar file into your installation directory, and go to the unpacked directory.
+
.. To unpack the online installer:
+
Expand Down
2 changes: 1 addition & 1 deletion downstream/modules/platform/proc-hs-eda-setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[role=_abstract]

To scale up (add more nodes) or scale down (remove nodes), you must update the content of the inventory to add or remove nodes and rerun the installer.
To scale up (add more nodes) or scale down (remove nodes), you must update the content of the inventory file to add or remove nodes and rerun the installation program.


// Procedure for RPM installer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ sudo dnf install -y ansible-core
sudo dnf install -y wget git-core rsync vim
----

. Optional: To have the installer automatically pick up and apply your {PlatformNameShort} subscription manifest license, follow the steps in link:{URLCentralAuth}/assembly-gateway-licensing#assembly-aap-obtain-manifest-files[Obtaining a manifest file].
. Optional: To have the installation program automatically pick up and apply your {PlatformNameShort} subscription manifest license, follow the steps in link:{URLCentralAuth}/assembly-gateway-licensing#assembly-aap-obtain-manifest-files[Obtaining a manifest file].

[role="_additional-resources"]
.Additional resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

[role="_abstract"]

To reinstall a containerized deployment after uninstalling and preserving the database, run the `install` playbook command and include the existing secret key value:
To reinstall a containerized deployment after uninstalling and preserving the database, run the `install` playbook and include the existing secret key value:
----
$ ansible-playbook -i inventory ansible.containerized_installer.install -e controller_secret_key=<secret_key_value>
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

When performing a reinstall following an uninstall that preserves the databases, you must use the previously generated {PlatformNameShort} secret key values to access the preserved databases.

Before running the uninstall, collect the existing secret keys by running the following command:
Before performing an uninstall, collect the existing secret keys by running the following command:
----
$ podman secret inspect --showsecret <secret_key_variable> | jq -r .[].SecretData
----
Expand All @@ -18,7 +18,7 @@ $ podman secret inspect --showsecret controller_secret_key | jq -r .[].SecretDat

For more information about the `*_secret_key` variables, see link:{URLContainerizedInstall}/appendix-inventory-files-vars[Inventory file variables].

To uninstall a containerized deployment, run the `uninstall` playbook command:
To uninstall a containerized deployment, run the `uninstall` playbook:
----
$ ansible-playbook -i inventory ansible.containerized_installer.uninstall
----
Expand Down
10 changes: 6 additions & 4 deletions downstream/modules/platform/proc-update-aap-container.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Perform a patch update for a {ContainerBase} of {PlatformNameShort} from 2.5 to 2.5.x.

include::snippets/container-upgrades.adoc[]

.Prerequisites

You have done the following:
Expand All @@ -20,11 +22,11 @@ You have done the following:

.. For offline or bundled installations: *{PlatformNameShort} {PlatformVers} Containerized Setup Bundle*

. Copy the installer `.tar` file onto your {RHEL} host.
. Copy the installation program `.tar` file onto your {RHEL} host.

. Decide where you want the installer to reside on the filesystem. Installation related files will be created under this location and require at least 10 GB for the initial installation.
. Decide where you want the installation program to reside on the filesystem. Installation related files will be created under this location and require at least 10 GB for the initial installation.

. Unpack the installer `.tar` file into your installation directory, and go to the unpacked directory.
. Unpack the installation program `.tar` file into your installation directory, and go to the unpacked directory.

.. To unpack the online installer:
+
Expand All @@ -40,7 +42,7 @@ $ tar xfvz ansible-automation-platform-containerized-setup-bundle-<version>-<arc
+
. Edit the `inventory` file to match your required configuration. You can keep the same parameters from your existing {PlatformNameShort} deployment or you can change the parameters to match any modifications to your environment.

. Run the `install` command:
. Run the `install` playbook:
+
----
$ ansible-playbook -i inventory ansible.containerized_installer.install
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ PostgreSQL admin password.

| | `postgresql_effective_cache_size` | PostgreSQL effective cache size.

| | `postgresql_keep_databases` | Keep databases during uninstall. This variable applies to databases managed by the installer only, and not for external customer-created databases.
| | `postgresql_keep_databases` | Keep databases during uninstall. This variable applies to databases managed by the installation program only, and not for external customer-created databases.

Default = `false`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Default = `false`

Default = `false`

| |`ca_tls_cert` | Define a Certification Authority certificate here along with a matching key in `ca_tls_key` when you want the installer to create leaf certificates for each product for you.
| |`ca_tls_cert` | Define a Certification Authority certificate here along with a matching key in `ca_tls_key` when you want the installation program to create leaf certificates for each product for you.

| |`ca_tls_key` | Define the key for a Certification Authority certificate here for the matching certificate in `ca_tls_cert` when you want the installer to create leaf certificates for each product for you.
| |`ca_tls_key` | Define the key for a Certification Authority certificate here for the matching certificate in `ca_tls_cert` when you want the installation program to create leaf certificates for each product for you.

| |`ca_tls_remote` |TLS CA remote files.

Expand Down Expand Up @@ -109,7 +109,7 @@ ifdef::container-install[]
For more information, see link:{URLContainerizedInstall}/aap-containerized-installation#proc-set-registry-username-password[Setting registry_username and registry_password].
endif::container-install[]

| `routable_hostname` |`routable_hostname` | This variable is used if the machine running the installer can only route to the target host through a specific URL. For example, if you use short names in your inventory, but the node running the installer can only resolve that host by using a FQDN.
| `routable_hostname` |`routable_hostname` | This variable is used if the machine running the installation program can only route to the target host through a specific URL. For example, if you use short names in your inventory, but the node running the installation program can only resolve that host by using a FQDN.

If `routable_hostname` is not set, it should default to `ansible_host`. If you do not set `ansible_host`, `inventory_hostname` is used as a last resort.

Expand Down
14 changes: 7 additions & 7 deletions downstream/modules/platform/ref-hub-variables.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Required passwords must be enclosed in quotes when they are provided in plain te

Use of special characters for this variable is limited. The password can include any printable ASCII character except `/`, `”`, or `@`.

| `automationhub_api_token` | | This variable can be used to provide the installer with an existing token.
| `automationhub_api_token` | | This variable can be used to provide the installation program with an existing token.

For example, a regenerated token in Hub UI will invalidate an existing token. Use `automationhub_api_token` to use that token in the installer the next time you run the installer.
For example, a regenerated token in Hub UI will invalidate an existing token. Use `automationhub_api_token` to use that token in the installation program the next time you run the installation program.

| `automationhub_auto_sign_collections` | `hub_collection_auto_sign` | If a collection signing service is enabled, collections are not signed automatically by default.

Expand Down Expand Up @@ -115,7 +115,7 @@ For example, \https://<load balancer host>.

Use `automationhub_main_url` to specify the main {HubName} URL that clients connect to if you are implementing {RHSSO} on your {HubName} environment.

If not specified, the first node in the [automationhub] group is used.
If not specified, the first node in the `[automationhub]` group is used.

| `automationhub_pg_cert_auth` | `hub_pg_cert_auth` | Set this variable to `true` to enable client certificate authentication.

Expand Down Expand Up @@ -195,21 +195,21 @@ Same as `web_server_ssl_cert` but for {HubName} UI and API.

Same as `web_server_ssl_key` but for {HubName} UI and API.

| `automationhub_user_headers` | | List of nginx headers for {HubNameMain}'s web server.
| `automationhub_user_headers` | | List of NGINX headers for {HubNameMain}'s web server.

Each element in the list is provided to the web server's nginx configuration as a separate line.
Each element in the list is provided to the web server's NGINX configuration as a separate line.

Default = empty list

| `ee_from_hub_only` | | When deployed with {HubName}, the installer pushes {ExecEnvShort} images to {HubName} and configures {ControllerName} to pull images from the {HubName} registry.
| `ee_from_hub_only` | | When deployed with {HubName}, the installation program pushes {ExecEnvShort} images to {HubName} and configures {ControllerName} to pull images from the {HubName} registry.

To make {HubName} the only registry to pull {ExecEnvShort} images from, set this variable to `true`.

If set to `false`, {ExecEnvShort} images are also taken directly from Red Hat.

Default = `true` when the bundle installer is used.

|`generate_automationhub_token` | | When performing a fresh installation, a new token will automatically be generated by default. If you want the installer to regenerate a new token, set `generate_automationhub_token=true` and the installer will use it in the installation process.
|`generate_automationhub_token` | | When performing a fresh installation, a new token will automatically be generated by default. If you want the installation program to regenerate a new token, set `generate_automationhub_token=true` and the installation program will use it in the installation process.

| `nginx_hsts_max_age` | `hub_nginx_hsts_max_age` | This variable specifies how long, in seconds, the system should be considered as an _HTTP Strict Transport Security_ (HSTS) host. That is, how long HTTPS is used exclusively for communication.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
= Using custom Receptor signing keys

[role="_abstract"]
Receptor signing is enabled by default unless `receptor_disable_signing=true` is set, and an RSA key pair (public and private) is generated by the installer. However, you can give custom RSA public and private keys by setting the path variables:
Receptor signing is enabled by default unless `receptor_disable_signing=true` is set, and an RSA key pair (public and private) is generated by the installation program. However, you can set custom RSA public and private keys by using the following variables:

----
receptor_signing_private_key=<full_path_to_private_key>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

[role="_abstract"]

By default, the installer generates TLS certificates and keys for all services that are signed by a custom Certificate Authority (CA). You can provide a custom TLS certificate and key for each service. If that certificate is signed by a custom CA, you must provide the CA TLS certificate and key.
By default, the installation program generates TLS certificates and keys for all services that are signed by a custom Certificate Authority (CA). You can provide a custom TLS certificate and key for each service. If that certificate is signed by a custom CA, you must provide the CA TLS certificate and key.

* Certificate Authority
----
Expand Down
2 changes: 1 addition & 1 deletion downstream/modules/topologies/ref-ocp-b-env-a.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The following diagram outlines the infrastructure topology that Red{nbsp}Hat has
.Infrastructure topology diagram
image::ocp-b-env-a.png[Operator enterprise topology diagram]

The following infrastructure topology describes an OpenShift Cluster with 3 master nodes and 2 worker nodes.
The following infrastructure topology describes an OpenShift Cluster with 3 primary nodes and 2 worker nodes.

Each OpenShift Worker node has been tested with the following component requirements: 16 GB RAM, 4 CPUs, 128 GB local disk, and 3000 IOPS.

Expand Down
2 changes: 1 addition & 1 deletion downstream/snippets/container-upgrades.adoc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Upgrades from 2.4 Containerized {PlatformNameShort} Tech Preview to 2.5 Containerized {PlatformNameShort} are unsupported at this time.
Upgrades from 2.4 Containerized {PlatformNameShort} Tech Preview to 2.5 Containerized {PlatformNameShort} are not supported at this time.