Skip to content

Commit 792f503

Browse files
authored
Editing controller files for DITA (#4037) (#4040)
Configuring automation execution modular compliance chapter 17 https://issues.redhat.com/browse/AAP-46737 Affects titles/controller-admin-guide
1 parent c4c797b commit 792f503

File tree

4 files changed

+9
-6
lines changed

4 files changed

+9
-6
lines changed

downstream/assemblies/platform/assembly-ag-controller-backup-and-restore.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
= Backup and restore
66

7-
You can backup and restore your system using the {PlatformNameShort} setup playbook.
7+
You can backup and restore your system by using the {PlatformNameShort} setup playbook.
88

99
For more information, see the link:{URLControllerAdminGuide}/index#controller-backup-restore-clustered-environments[Backup and restore clustered environments] section.
1010

@@ -18,7 +18,7 @@ Backup and restore functionality only works with the PostgreSQL versions support
1818
For more information, see link:{URLPlanningGuide}/platform-system-requirements[System requirements] in _{TitlePlanningGuide}_.
1919
====
2020

21-
The {PlatformNameShort} setup playbook is invoked as `setup.sh` from the path where you unpacked the platform installer tarball.
21+
The {PlatformNameShort} setup playbook is invoked as `setup.sh` from the path where you unpacked the platform installer tar file.
2222
It uses the same inventory file used by the install playbook.
2323
The setup script takes the following arguments for backing up and restoring:
2424

@@ -56,6 +56,9 @@ setup.sh -i <inventory file>
5656
----
5757

5858
include::platform/con-controller-backup-restore-playbooks.adoc[leveloffset=+1]
59+
5960
include::platform/ref-controller-backup-restore-considerations.adoc[leveloffset=+1]
61+
6062
include::platform/ref-controller-backup-restore-clustered-environments.adoc[leveloffset=+1]
63+
6164
include::platform/con-controller-restore-different-cluster.adoc[leveloffset=+2]

downstream/modules/platform/con-controller-backup-restore-playbooks.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ These playbooks serve to backup and restore.
1616
** Manual projects
1717
* The restore backup restores the backed up files and data to a freshly installed and working second instance of {ControllerName}.
1818

19-
When restoring your system, the installer checks to see that the backup file exists before beginning the restoration.
19+
When restoring your system, installation program checks to see that the backup file exists before beginning the restoration.
2020
If the backup file is not available, your restoration fails.
2121

2222
[NOTE]

downstream/modules/platform/ref-controller-backup-restore-clustered-environments.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ The procedure for backup and restore for a clustered environment is similar to a
88

99
[NOTE]
1010
====
11-
For more information on installing clustered environments, see the xref:controller-cluster-install[Install and configure] section.
11+
For more information about installing clustered environments, see the xref:controller-cluster-install[Install and configure] section.
1212
====
1313

1414
* If restoring to a new cluster, ensure that the old cluster is shut down before proceeding because they can conflict with each other when accessing the database.
1515
* Per-node backups are only restored to nodes bearing the same hostname as the backup.
16-
* When restoring to an existing cluster, the restore contains the following:
16+
* When restoring to an existing cluster, the restore has the following:
1717

1818
** A dump of the PostgreSQL database
1919
** UI artifacts, included in the database dump

downstream/modules/platform/ref-controller-backup-restore-considerations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The {PlatformNameShort} database backups are staged on each node at `/var/backup
2020
Version:: You must always use the most recent minor version of a release to backup or restore your {PlatformNameShort} installation version.
2121
For example, if the current platform version you are on is 2.0.x, only use the latest 2.0 installer.
2222

23-
File path:: When using `setup.sh` in order to do a restore from the default restore file path, `/var/lib/awx`, `-r` is still required in order to do the restore, but it no longer accepts an argument.
23+
File path:: When using `setup.sh` to do a restore from the default restore file path, `/var/lib/awx`, `-r` is still required to do the restore, but it no longer accepts an argument.
2424
If a non-default restore file path is needed, you must provide this as an extra_var (`root@localhost:~# ./setup.sh -e 'restore_backup_file=/path/to/nondefault/backup.tar.gz' -r`).
2525

2626
Directory:: If the backup file is placed in the same directory as the `setup.sh` installer, the restore playbook automatically locates the restore files.

0 commit comments

Comments
 (0)