Skip to content

AAP-52256-C updated final edits #4308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

AAP-52256-C updated final edits #4308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
786bd64
AAP-52256-C updated final edits
emurtoug Sep 16, 2025
0ac8ff2
AAP-52256-C updated final edits
emurtoug Sep 16, 2025
6bf7e6d
AAP-52256-C updated final edits
emurtoug Sep 17, 2025
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
10 changes: 5 additions & 5 deletions ...mation-dashboard/automation-dashboard/proc-installing-automation-dashboard.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Do not attempt to install {AutomationDashboardName} on the same host(s) as {Plat
* Access to _baseos_ and _{PlatformNameShort}stream_ repo packages for the RHEL 9 host.
* A non-root login account to the RHEL 9 host for installation. This requires passwordless sudo access to root as well. By default, we use the $HOMEDIR of the user account.
* URL details for access to your {PlatformNameShort} instances.
* An {PlatformNameShort} 0Auth2 token, which is used for communication between the {PlatformNameShort} instances and {AutomationDashboardName}.
* An {PlatformNameShort} OAuth2 token, which is used for communication between the {PlatformNameShort} instances and {AutomationDashboardName}.
* Access to download the installation bundle providing installation components for the {AutomationDashboardName}.
* Open firewall access to allow for bi-directional communication between AAP instances and the {AutomationDashboardName}.
** This includes HTTPS/443 (or your {PlatformNameShort} configured port) from the dashboard to the Ansible Automation Platform instance(s).
Expand Down Expand Up @@ -54,11 +54,11 @@ ansible-galaxy collection install -r requirements.yml
.. Create an OAuth2 application using the following steps :
... *For Ansible 2.4*:
+
* Navigate to https://AAP_GATEWAY_FQDN:/#/applications
* Navigate to https://AAP_GATEWAY_FQDN/#/applications
+
... *For Ansible 2.5 and 2.6*:
+
* Navigate to https://AAP_Controller_FQDN:/access/applications
* Navigate to https://AAP_Controller_FQDN/access/applications
+
... Add the following information:
+
Expand All @@ -72,7 +72,7 @@ ansible-galaxy collection install -r requirements.yml
The values for *Name*, *Organization*, and HTTPS port number for {PlatformNameShort} are configurable. The examples provided in this document assume use of port 443.
+
.. Save the `client_id` and `client_secret information` inputs into the inventory file.
.. Next, create an {PlatformNameShort} access token:
.. Create an {PlatformNameShort} access token:
... Navigate to https://AAP_GATEWAY_FQDN/#/users/<id>/tokens, and create a token using the following information:
+
. OAuth application: automation-dashboard-sso
Expand Down Expand Up @@ -110,7 +110,7 @@ aap_auth_provider_name=Ansible Automation Platform
# aap_auth_provider_protocol - http or https
aap_auth_provider_protocol=https
# AAP version - 2.4, 2.5 or 2.6
aap_auth_provider_aap_version=2.5
aap_auth_provider_aap_version=2.6
# aap_auth_provider_host - AAP IP or DNS name, with optional port
aap_auth_provider_host=my-aap.example.com
# aap_auth_provider_check_ssl - enforce TLS check or not.
Expand Down
5 changes: 2 additions & 3 deletions ...ation-dashboard/automation-dashboard/proc-integrating-automation-dashboard.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,15 @@ Integrate your {PlatformNameShort} instances into the {AutomationDashboardName}

.Procedure

. Verify that {AutomationDashboardName} is running on https port 8447 on your RHEL host. This verification will require your login details as defined in the inventory file.
. Verify that {AutomationDashboardName} is running on https port 8447 on your RHEL host. This verification will require your {PlatformNameShort} login details.
+
[NOTE]
====
Port 8447 is enabled by default, but this is configurable.
====
. Enter `admin` as the username and use `dashboard_admin_password` as the password.
. Your {PlatformNameShort} instances are added into `clusters.yml` using the following information:
* Your {PlatformNameShort} URLs/ports for front-end access
* A preconfigured {PlatformNameShort} 0Auth token for _read_ access
* A preconfigured {PlatformNameShort} OAuth token for _read_ access
+
[NOTE]
====
Expand Down
18 changes: 9 additions & 9 deletions ...ashboard/automation-dashboard/ref-automation-dashboard-inventory-variables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,28 +47,28 @@ The following variables control how {AutomationDashboardName} interacts with rem
|Forces regeneration of autogenerated podman secrets. A podman secret is used to store the password for database access. Set `dashboard_update_secret` to true if you changed the `dashboard_pg_password` in inventory.

|`nginx_disable_https`
|Allows using http instead of https for {AutomationDashboardName}.
|Allows using http instead of https for {AutomationDashboardName}

|`nginx_http_port`
|Configures the HTTP port for {AutomationDashboardName}.
|Configures the HTTP port for {AutomationDashboardName}

|`nginx_https_port`
|Configures the HTTPS port for {AutomationDashboardName}.
|Configures the HTTPS port for {AutomationDashboardName}

|`dashboard_tls_cert`
|TLS server certificate for dashboard.
|TLS server certificate for dashboard

|`dashboard_tls_key`
|TLS server certificate key for dashboard.
|TLS server certificate key for dashboard

|`postgresql_admin_username`
|Admin username to access PostgreSQL database.
|Admin username to access PostgreSQL database

|`postgresql_admin_password`
|Admin password to access PostgreSQL database.
|Admin password to access PostgreSQL database

|`registry_username`
|Admin password to access PostgreSQL database.
|Admin password to access PostgreSQL database

|`registry_username`
|Username used to pull container images from `registry.redhat.io`. Currently we distribute only a bundled installer, so the tarball contains required container images, and the end user does not need to pull images from the remote registry. The variable is needed when the bundled installer is being built.
Expand Down Expand Up @@ -98,7 +98,7 @@ End users can omit this variable.
|The `dashboard_pg_*` variables configure additional database user and database schema for {AutomationDashboardName} on the database host `dashboard_pg_host`.

|`bundle_install`
|Indicates the required container images are already included in the installation bundle (tarball). It must be `true`.
|Indicates the required container images are already included in the installation bundle (tarball). It must be set to `true`.

|`bundle_dir`
|This is the directory where the installation bundle was unpacked `+ /bundle` (for example: `/home/<username>/ansible-automation-dashboard-containerized-setup/bundle`). The default value is relative to the current directory (PWD) and should work out of the box.
Expand Down