Skip to content

Commit d45401d

Browse files
Ansible DITA readiness (#3818) (#3832)
Correcting issues flagged by the asciidoctor-dita-vale tool. Affected titles: - `titles/aap-containerized-install` - `titles/troubleshooting-aap` - `titles/aap-migration` Ansible DITA readiness (2025-07-09) - Michelle https://issues.redhat.com/browse/AAP-49393
1 parent 21eb4b8 commit d45401d

29 files changed

+202
-203
lines changed

downstream/assemblies/platform/assembly-appendix-troubleshoot-rpm-aap.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
[id="appendix-troubleshoot-rpm-aap"]
44
= Troubleshooting RPM installation of {PlatformNameShort}
55

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

8-
include::platform/ref-rpm-troubleshoot-generating-logs.adoc[leveloffset=+1]
8+
include::platform/proc-rpm-troubleshoot-generating-logs.adoc[leveloffset=+1]
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
:_mod-docs-content-type: ASSEMBLY
12

23
[id="diagnosing-the-problem"]
34

@@ -6,4 +7,5 @@
67
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.
78

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

downstream/assemblies/troubleshooting-aap/assembly-troubleshoot-jobs.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
:_mod-docs-content-type: ASSEMBLY
12

23
[id="troubleshoot-jobs"]
34

@@ -8,6 +9,9 @@ Troubleshoot issues with jobs.
89
// Michelle - commenting out for now as it refers to upgrade info
910
// include::troubleshooting-aap/proc-troubleshoot-job-localhost.adoc[leveloffset=+1]
1011
include::troubleshooting-aap/proc-troubleshoot-job-resolve-module.adoc[leveloffset=+1]
12+
1113
include::troubleshooting-aap/proc-troubleshoot-job-timeout.adoc[leveloffset=+1]
14+
1215
include::troubleshooting-aap/proc-troubleshoot-job-pending.adoc[leveloffset=+1]
13-
include::troubleshooting-aap/proc-troubleshoot-job-permissions.adoc[leveloffset=+1]
16+
17+
include::troubleshooting-aap/proc-troubleshoot-job-permissions.adoc[leveloffset=+1]

downstream/modules/aap-migration/proc-ocp-target-import.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -206,9 +206,9 @@ tar xf artifact.tar && cd artifact && sha256sum --check sha256sum.txt
206206
Example output:
207207
+
208208
----
209-
./controller/controller.pgc: OK
210-
./gateway/gateway.pgc: OK
211-
./hub/hub.pgc: OK
209+
./controller/controller.pgc: OK
210+
./gateway/gateway.pgc: OK
211+
./hub/hub.pgc: OK
212212
----
213213
+
214214
Drop the {ControllerName} database:
@@ -390,4 +390,4 @@ awx-manage deprovision_instance --host=node2.example.org
390390
+
391391
----
392392
curl -d '{"verify_checksums": true}' -X POST -k https://<aap_url>/api/galaxy/pulp/api/v3/repair/ -u <admin_user>:<restored_admin_password>
393-
----
393+
----

downstream/modules/platform/con-certs-per-service-considerations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ When providing custom TLS certificates for each individual service, consider the
1111

1212
[role="_additional-resources"]
1313
.Additional resources
14-
* For more information about using TLS certificates, see link:{BaseURL}/red_hat_enterprise_linux/9/html/securing_networks/index[Securing networks].
14+
* link:{BaseURL}/red_hat_enterprise_linux/9/html/securing_networks/index[Securing networks]

downstream/modules/platform/con-hs-eda-controller.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
:_mod-docs-content-type: CONCEPT
2-
32
[id="con-hs-eda-controller"]
43

54
= Horizontal scaling in {EDAcontroller}

downstream/modules/platform/con-hs-eda-sizing-scaling.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@
44

55
= Sizing and scaling guidelines
66

7-
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.
7+
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.
88

99
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.
1010

1111
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.
12-
13-
To set up a multi-node deployment, follow the procedure in xref:proc-hs-eda-setup[Setting up horizontal scaling for {EDAcontroller}].

downstream/modules/platform/proc-backup-aap-container.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ This backs up the important data deployed by the containerized installer such as
5959
* Configuration files
6060
* Data files
6161

62-
By default, the backup directory is set to `./backups`. You can change this by using the `backup_dir` variable in your `inventory` file.
62+
. By default, the backup directory is set to `./backups`. You can change this by using the `backup_dir` variable in your `inventory` file.

downstream/modules/platform/proc-configure-hub-azure-storage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ hub_azure_extra_settings:
2727

2828
[role="_additional-resources"]
2929
.Additional resources
30-
* 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].
30+
* link:https://django-storages.readthedocs.io/en/latest/backends/azure.html#settings[django-storages documentation - Azure Storage]

downstream/modules/platform/proc-configure-hub-s3-storage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ hub_s3_extra_settings:
2727

2828
[role="_additional-resources"]
2929
.Additional resources
30-
* 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].
30+
* link:https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html#settings[django-storages documentation - Amazon S3]

0 commit comments

Comments
 (0)