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 @@
[id="appendix-troubleshoot-rpm-aap"]
= Troubleshooting RPM installation of {PlatformNameShort}

Use this information to troubleshoot your RPM installation of {PlatformNameShort}.
Use this information to troubleshoot your RPM-based installation of {PlatformNameShort}.

include::platform/ref-rpm-troubleshoot-generating-logs.adoc[leveloffset=+1]
include::platform/proc-rpm-troubleshoot-generating-logs.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:_mod-docs-content-type: ASSEMBLY

[id="diagnosing-the-problem"]

Expand All @@ -6,4 +7,5 @@
To start troubleshooting {PlatformNameShort}, use the `must-gather` command on {OCPShort} or the `sos` utility on a {VMBase} to collect configuration and diagnostic information. You can attach the output of these utilities to your support case.

include::troubleshooting-aap/proc-troubleshoot-must-gather.adoc[leveloffset=+1]
include::troubleshooting-aap/proc-troubleshoot-sosreport.adoc[leveloffset=+1]

include::troubleshooting-aap/proc-troubleshoot-sosreport.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:_mod-docs-content-type: ASSEMBLY

[id="troubleshoot-jobs"]

Expand All @@ -8,6 +9,9 @@ Troubleshoot issues with jobs.
// Michelle - commenting out for now as it refers to upgrade info
// include::troubleshooting-aap/proc-troubleshoot-job-localhost.adoc[leveloffset=+1]
include::troubleshooting-aap/proc-troubleshoot-job-resolve-module.adoc[leveloffset=+1]

include::troubleshooting-aap/proc-troubleshoot-job-timeout.adoc[leveloffset=+1]

include::troubleshooting-aap/proc-troubleshoot-job-pending.adoc[leveloffset=+1]
include::troubleshooting-aap/proc-troubleshoot-job-permissions.adoc[leveloffset=+1]

include::troubleshooting-aap/proc-troubleshoot-job-permissions.adoc[leveloffset=+1]
8 changes: 4 additions & 4 deletions downstream/modules/aap-migration/proc-ocp-target-import.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,9 @@ tar xf artifact.tar && cd artifact && sha256sum --check sha256sum.txt
Example output:
+
----
./controller/controller.pgc: OK
./gateway/gateway.pgc: OK
./hub/hub.pgc: OK
./controller/controller.pgc: OK
./gateway/gateway.pgc: OK
./hub/hub.pgc: OK
----
+
Drop the {ControllerName} database:
Expand Down Expand Up @@ -390,4 +390,4 @@ awx-manage deprovision_instance --host=node2.example.org
+
----
curl -d '{"verify_checksums": true}' -X POST -k https://<aap_url>/api/galaxy/pulp/api/v3/repair/ -u <admin_user>:<restored_admin_password>
----
----
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ When providing custom TLS certificates for each individual service, consider the

[role="_additional-resources"]
.Additional resources
* For more information about using TLS certificates, see link:{BaseURL}/red_hat_enterprise_linux/9/html/securing_networks/index[Securing networks].
* link:{BaseURL}/red_hat_enterprise_linux/9/html/securing_networks/index[Securing networks]
1 change: 0 additions & 1 deletion downstream/modules/platform/con-hs-eda-controller.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
:_mod-docs-content-type: CONCEPT

[id="con-hs-eda-controller"]

= Horizontal scaling in {EDAcontroller}
Expand Down
4 changes: 1 addition & 3 deletions downstream/modules/platform/con-hs-eda-sizing-scaling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@

= Sizing and scaling guidelines

API nodes process user requests (interactions with the UI or API) while worker nodes process the activations and other background tasks required for {EDAName} to function properly. The number of API nodes you require correlates to the desired number of users of the application and the number of worker nodes correlates to the desired number of activations you want to run.
API nodes process user requests (interactions with the UI or API) while worker nodes process the activations and other background tasks required for {EDAName} to function properly. The number of API nodes you require correlates to the required number of users of the application and the number of worker nodes correlates to the required number of activations you want to run.

Since activations are variable and controlled by worker nodes, the supported approach for scaling is to use separate API and worker nodes instead of hybrid nodes due to the efficient allocation of hardware resources by worker nodes. By separating the nodes, you can scale each type independently based on specific needs, leading to better resource utilization and cost efficiency.

An example of an instance in which you might consider scaling up your node deployment is when you want to deploy {EDAName} for a small group of users who will run a large number of activations. In this case, one API node is adequate, but if you require more, you can scale up to three additional worker nodes.

To set up a multi-node deployment, follow the procedure in xref:proc-hs-eda-setup[Setting up horizontal scaling for {EDAcontroller}].
2 changes: 1 addition & 1 deletion downstream/modules/platform/proc-backup-aap-container.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ This backs up the important data deployed by the containerized installer such as
* Configuration files
* Data files

By default, the backup directory is set to `./backups`. You can change this by using the `backup_dir` variable in your `inventory` file.
. By default, the backup directory is set to `./backups`. You can change this by using the `backup_dir` variable in your `inventory` file.
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ hub_azure_extra_settings:

[role="_additional-resources"]
.Additional resources
* For more information about the list of parameters, see link:https://django-storages.readthedocs.io/en/latest/backends/azure.html#settings[django-storages documentation - Azure Storage].
* link:https://django-storages.readthedocs.io/en/latest/backends/azure.html#settings[django-storages documentation - Azure Storage]
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ hub_s3_extra_settings:

[role="_additional-resources"]
.Additional resources
* For more information about the list of parameters, see link:https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html#settings[django-storages documentation - Amazon S3].
* link:https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html#settings[django-storages documentation - Amazon S3]
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ $ ansible-playbook -i <path_to_inventory_file> ansible.containerized_installer.l
[role="_additional-resources"]
.Additional resources

* For more information about the `sos` report tool, see link:https://access.redhat.com/solutions/3592[What is an sos report and how to create one in {RHEL}?]
* link:https://access.redhat.com/solutions/3592[What is an sos report and how to create one in {RHEL}?]
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ $ tar xfvz ansible-automation-platform-containerized-setup-bundle-<version>-<arc
[role="_additional-resources"]
.Additional resources

* For more information about using `scp`, see link:https://man7.org/linux/man-pages/man1/scp.1.html[scp(1) - Linux manual page].
* link:https://man7.org/linux/man-pages/man1/scp.1.html[scp(1) - Linux manual page]
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
:_newdoc-version: 2.15.1
:_template-generated: 2024-01-12

:_mod-docs-content-type: PROCEDURE

[id="enabling-automation-hub-collection-and-container-signing_{context}"]
Expand Down Expand Up @@ -152,4 +149,4 @@ hub_container_signing_pass=<password>
[role="_additional-resources"]
.Additional resources

* For more information on working with signed containers following an installation, see link:{URLHubManagingContent}/managing-containers-hub#working-with-signed-containers[Working with signed containers] in the {TitleHubManagingContent} guide.
* link:{URLHubManagingContent}/managing-containers-hub#working-with-signed-containers[Working with signed containers]
1 change: 0 additions & 1 deletion downstream/modules/platform/proc-hs-eda-setup.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
:_mod-docs-content-type: PROCEDURE

[id="proc-hs-eda-setup"]

= Setting up horizontal scaling for {EDAcontroller}
Expand Down
54 changes: 29 additions & 25 deletions downstream/modules/platform/proc-installing-containerized-aap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,68 +10,72 @@ After you prepare the {RHEL} host, download {PlatformNameShort}, and configure t

You have done the following:

* xref:preparing-the-rhel-host-for-containerized-installation[Prepared the {RHEL} host]
* xref:preparing-the-managed-nodes-for-containerized-installation[Prepared the managed nodes]
* xref:downloading-ansible-automation-platform[Downloaded {PlatformNameShort}]
* xref:configuring-inventory-file[Configured the inventory file]
* link:{URLContainerizedInstall}/aap-containerized-installation#preparing-the-rhel-host-for-containerized-installation[Prepared the {RHEL} host]
* link:{URLContainerizedInstall}/aap-containerized-installation#preparing-the-managed-nodes-for-containerized-installation[Prepared the managed nodes]
* link:{URLContainerizedInstall}/aap-containerized-installation#downloading-ansible-automation-platform[Downloaded {PlatformNameShort}]
* link:{URLContainerizedInstall}/aap-containerized-installation#configuring-inventory-file[Configured the inventory file]
* Logged in to the {RHEL} host as your non-root user

.Procedure

* Go to the installation directory on your {RHEL} host.
* Run the `install` playbook:
+
----
ansible-playbook -i <inventory_file_name> ansible.containerized_installer.install
----

+
For example:
+
----
ansible-playbook -i inventory ansible.containerized_installer.install
----

+
You can add additional parameters to the installation command as needed:
+
----
ansible-playbook -i <inventory_file_name> -e @<vault_file_name> --ask-vault-pass -K -v ansible.containerized_installer.install
----

+
For example:
+
----
ansible-playbook -i inventory -e @vault.yml --ask-vault-pass -K -v ansible.containerized_installer.install
----

* `-i <inventory_file_name>` - The inventory file to use for the installation.
* `-e @<vault_file_name> --ask-vault-pass` - (Optional) If you are using a vault to store sensitive variables, add this to the installation command.
* `-K` - (Optional) If your privilege escalation requires you to enter a password, add this to the installation command. You are then prompted for the BECOME password.
* `-v` - (Optional) You can use increasing verbosity, up to 4 v’s (`-vvvv`) to see the details of the installation process. However, it is important to note that this can significantly increase installation time, so use it only as needed or requested by Red Hat support.
** `-i <inventory_file_name>` - The inventory file to use for the installation.
** `-e @<vault_file_name> --ask-vault-pass` - (Optional) If you are using a vault to store sensitive variables, add this to the installation command.
** `-K` - (Optional) If your privilege escalation requires you to enter a password, add this to the installation command. You are then prompted for the BECOME password.
** `-v` - (Optional) You can use increasing verbosity, up to 4 v’s (`-vvvv`) to see the details of the installation process. However, it is important to note that this can significantly increase installation time, so use it only as needed or requested by Red Hat support.

The installation of containerized {PlatformNameShort} begins.
* The installation of containerized {PlatformNameShort} begins.

.Verification

* After the installation completes, verify that you can access the platform UI which is available by default at the following URL:

+
----
https://<gateway_node>:443
----

Log in as the admin user with the credentials you created for `gateway_admin_username` and `gateway_admin_password`.

The default ports and protocols used for {PlatformNameShort} are 80 (HTTP) and 443 (HTTPS). You can customize the ports with the following variables:

+
* Log in as the admin user with the credentials you created for `gateway_admin_username` and `gateway_admin_password`.
+
* The default ports and protocols used for {PlatformNameShort} are 80 (HTTP) and 443 (HTTPS). You can customize the ports with the following variables:
+
----
envoy_http_port=80
envoy_https_port=443
----

If you want to disable HTTPS, set `envoy_disable_https` to `true`:

+
* If you want to disable HTTPS, set `envoy_disable_https` to `true`:
+
----
envoy_disable_https: true
----

[role="_additional-resources"]
.Additional resources
* For more information about privilege escalation, see link:https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_privilege_escalation.html[Understanding privilege escalation: become].
* For more information about securing sensitive variables, see link:{URLHardening}/hardening-aap#ref-sensitive-variables-install-inventory_hardening-aap[Sensitive variables in the installation inventory] in _{TitleHardening}_.
* For more information about post installation instructions see link:{LinkGettingStarted}
* For more information about troubleshooting your containerized {PlatformNameShort} installation, see link:{URLContainerizedInstall}/troubleshooting-containerized-ansible-automation-platform[Troubleshooting containerized {PlatformNameShort}].
* link:https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_privilege_escalation.html[Understanding privilege escalation: become]
* link:{URLHardening}/hardening-aap#ref-sensitive-variables-install-inventory_hardening-aap[Sensitive variables in the installation inventory]
* link:{URLGettingStarted}[Getting started with {PlatformNameShort}]
* link:{URLContainerizedInstall}/troubleshooting-containerized-ansible-automation-platform[Troubleshooting containerized {PlatformNameShort}]
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ To ensure a consistent and secure setup of containerized {PlatformNameShort}, cr

Once configured, you can define the dedicated user for each host by adding `ansible_user=<username>` in your inventory file, for example: `aap.example.org ansible_user=aap`.

.Procedure

Complete the following steps for each host:

.Procedure

. Log in to the host as the root user.
. Create a new user. Replace `<username>` with the username you want, for example `aap`.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ sudo dnf install -y wget git-core rsync vim

[role="_additional-resources"]
.Additional resources
* For more information about registering your {RHEL} host and attaching a subscription, see link:{URLCentralAuth}/assembly-gateway-licensing#proc-attaching-subscriptions[Attaching your {PlatformName} Subscription].
* For information about configuring unbound DNS, see link:{BaseURL}/red_hat_enterprise_linux/9/html/managing_networking_infrastructure_services/assembly_setting-up-an-unbound-dns-server_networking-infrastructure-services[Setting up an unbound DNS server].
* For information about configuring DNS using BIND, see link:{BaseURL}/red_hat_enterprise_linux/9/html/managing_networking_infrastructure_services/assembly_setting-up-and-configuring-a-bind-dns-server_networking-infrastructure-services[Setting up and configuring a BIND DNS server].
* For more information about `ansible-core`, see link:https://docs.ansible.com/ansible/latest/[Ansible Core Documentation].
* link:{URLCentralAuth}/assembly-gateway-licensing#proc-attaching-subscriptions[Attaching your {PlatformName} Subscription]
* link:{BaseURL}/red_hat_enterprise_linux/9/html/managing_networking_infrastructure_services/assembly_setting-up-an-unbound-dns-server_networking-infrastructure-services[Setting up an unbound DNS server]
* link:{BaseURL}/red_hat_enterprise_linux/9/html/managing_networking_infrastructure_services/assembly_setting-up-and-configuring-a-bind-dns-server_networking-infrastructure-services[Setting up and configuring a BIND DNS server]
* link:https://docs.ansible.com/ansible/latest/[Ansible Core Documentation]
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
:_mod-docs-content-type: REFERENCE
:_mod-docs-content-type: PROCEDURE

[id="ref-rpm-troubleshoot-generating-logs"]
[id="rpm-troubleshoot-generating-logs"]

= Gathering {PlatformNameShort} logs

With the `sos` utility, you can collect configuration, diagnostic, and troubleshooting data, and provide those files to Red Hat Technical Support. An `sos` report is a common starting point for Red Hat technical support engineers when performing analysis of a service request for the {PlatformNameShort}.

As part of the troubleshooting with Red Hat Support, you can collect the `sos` report for each node in your RPM installation of {PlatformNameShort} using the installation inventory and the installer.
As part of the troubleshooting with Red Hat Support, you can collect the `sos` report for each node in your RPM-based installation of {PlatformNameShort} using the installation inventory and the installation program.

.Procedure

. Access the installer folder with the inventory file and run the installer setup script the following command:
. Access the installation program folder with the inventory file and run the installation program setup script the following command:
+
`$ ./setup.sh -s`
+
Expand Down Expand Up @@ -56,8 +56,4 @@ $ ./setup.sh -e 'case_number=0000000' -e 'clean=true' -e 'upload=true' -s
`upload`| Automatically uploads the `sos` report data to Red Hat. | `false` |
|===

To know more about the `sos` report tool, see the KCS article: link:https://access.redhat.com/solutions/3592[What is an sos report and how to create one in Red Hat Enterprise Linux?]




To know more about the `sos` report tool, see the KCS article: link:https://access.redhat.com/solutions/3592[What is an sos report and how to create one in {RHEL}?]
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,3 @@ To keep PostgreSQL databases, set the `postgresql_keep_databases` parameter to `
----
$ ansible-playbook -i inventory ansible.containerized_installer.uninstall -e postgresql_keep_databases=true
----

6 changes: 2 additions & 4 deletions downstream/modules/platform/proc-update-aap-container.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
:_mod-docs-content-type: PROCEDURE

[id="updating-containerized-ansible-automation-platform"]

= Updating containerized {PlatformNameShort}
Expand All @@ -14,7 +13,7 @@ You have done the following:

* Reviewed the release notes for the associated patch release. For more information, see the link:{URLReleaseNotes}[{PlatformNameShort} {TitleReleaseNotes}].

* Created a backup of your {PlatformNameShort} deployment. For more information, see xref:backing-up-containerized-ansible-automation-platform[Backing up container-based {PlatformNameShort}].
* Created a backup of your {PlatformNameShort} deployment. For more information, see link:{URLContainerizedInstall}/aap-containerized-installation#backing-up-containerized-ansible-automation-platform[Backing up container-based {PlatformNameShort}]

* Logged in to the {RHEL} host as your dedicated non-root user.

Expand All @@ -32,5 +31,4 @@ $ ansible-playbook -i inventory ansible.containerized_installer.install
+
* If your privilege escalation requires a password to be entered, append `-K` to the command. You will then be prompted for the `BECOME` password.
* You can use increasing verbosity, up to 4 v’s (`-vvvv`) to see the details of the installation process. However it is important to note that this can significantly increase installation time, so it is recommended that you use it only as needed or requested by Red Hat support.

The update begins.
* The update begins.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ include::snippets/inventory-cont-a-env-a.adoc[]

[role="_additional-resources"]
.Additional resources
* For more information about the container {GrowthTopology} (all-in-one), see link:{URLTopologies}/container-topologies#infrastructure_topology_5[Container {GrowthTopology}] in _{TitleTopologies}_.
* link:{URLTopologies}/container-topologies#infrastructure_topology_5[Container {GrowthTopology}]

== Inventory file for online installation for containerized {EnterpriseTopology}

Expand All @@ -39,8 +39,8 @@ include::snippets/inventory-cont-b-env-a.adoc[]

[role="_additional-resources"]
.Additional resources
* For more information about the container {EnterpriseTopology}, see link:{URLTopologies}/container-topologies#infrastructure_topology_6[Container {EnterpriseTopology}] in _{TitleTopologies}_.
* For more information about Redis, see link:{URLPlanningGuide}/ha-redis_planning[Caching and queueing system] in _{TitlePlanningGuide}_.
* link:{URLTopologies}/container-topologies#infrastructure_topology_6[Container {EnterpriseTopology}]
* link:{URLPlanningGuide}/ha-redis_planning[Caching and queueing system]


== Performing an offline or bundled installation
Expand Down
Loading