doc improvements 01 (#8634)

* doc improvements 01 Signed-off-by: punitmundra <[email protected]> * update the migration page Signed-off-by: punitmundra <[email protected]> * update bkp pages Signed-off-by: punitmundra <[email protected]> * minor fixes Signed-off-by: Dishank Tiwari <[email protected]> --------- Signed-off-by: punitmundra <[email protected]> Signed-off-by: Dishank Tiwari <[email protected]> Co-authored-by: Dishank Tiwari <[email protected]>
chef · Nov 12, 2024 · 44d0cdd · 44d0cdd
1 parent 11cc5e5
commit 44d0cdd
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 32 deletions.
diff --git a/components/docs-chef-io/content/automate/ha_aws_deployment_prerequisites.md b/components/docs-chef-io/content/automate/ha_aws_deployment_prerequisites.md
@@ -89,7 +89,8 @@ Current Automate HA integrates with the following non-Chef tools:
 - Refer to [Performance Benchmarks](/automate/ha_performance_benchmarks) for more details on the hardware requirements.
 - Make sure the hardware requirement in not lesser than the recommended [Minimum Hardware Requirement](/automate/ha_aws_deployment_prerequisites/#minimum-hardware-requirement)
 - Contact your network manager to set up the above pre-requisites.
-
+- We recommended that all hardware/VMs be in the same region/data center.
+
 {{< /note >}}
 
 ### Minimum Hardware Requirement

diff --git a/components/docs-chef-io/content/automate/ha_backup_restore_aws_efs.md b/components/docs-chef-io/content/automate/ha_backup_restore_aws_efs.md
@@ -64,6 +64,11 @@ Configure the OpenSearch `path.repo` attribute.
 - Above command will restart the OpenSearch cluster.
 
 #### Healthcheck commands
+- Get the OpenSearch Cluster status
+
+    ```sh
+    chef-automate status --os
+    ```
 
 - Following command can be run in the OpenSearch node
 

diff --git a/components/docs-chef-io/content/automate/ha_chef_backend_to_automate_ha.md b/components/docs-chef-io/content/automate/ha_chef_backend_to_automate_ha.md
@@ -51,7 +51,7 @@ Check the [AWS Deployment Prerequisites](/automate/ha_aws_deployment_prerequisit
 2. Execute the below command to install the habitat package for `knife-ec-backup`
 
     ```sh
-        hab pkg install chef/knife-ec-backup
+        hab pkg install chef/knife-ec-backup -bf
     ```
 
 3. Execute the below command to generate a knife tidy server report to examine the stale node, data, etc.

diff --git a/components/docs-chef-io/content/automate/ha_disaster_recovery_setup.md b/components/docs-chef-io/content/automate/ha_disaster_recovery_setup.md
@@ -126,10 +126,11 @@ Configure backups for both clusters using either [file system](/automate/ha_back
             password = "admin"
         ```
 
-        - Stop all the services on all Automate and Chef Infra frontend nodes using the following command:
+        - Stop all the services on all Automate and Chef Infra frontend nodes using the following command, use the below command from the bastion.
 
         ```sh
-            systemctl stop chef-automate
+            chef-automate systemctl --a2
+            chef-automate systemctl --cs
         ```
 
         - In the disaster recovery cluster, use the following sample command to restore the latest backup from any Chef Automate frontend instance.

diff --git a/components/docs-chef-io/content/automate/ha_existing_a2ha_to_automate_ha.md b/components/docs-chef-io/content/automate/ha_existing_a2ha_to_automate_ha.md
@@ -79,11 +79,10 @@ done
 
 1. Configure the backup at Automate HA cluster. If you have not configured it, please refer to this [Doc: Pre Backup Configuration for File System Backup](/automate/ha_backup_restore_file_system/#setting-up-the-backup-configuration)
 
-1. From Step 3, you will get the backup mount path.
+1. From the above Step, you will get the backup mount path.
 
-1. Stop all the services at frontend nodes in Automate HA Cluster.
-
-1. Get the Automate version from the location `/var/tmp/` in Automate instance. Example: `frontend-4.x.y.aib`.
+1. To run the restore command, we need the airgap bundle. Get the Automate HA airgap bundle from the location `/var/tmp/` in Automate instance. Example: `frontend-4.x.y.aib`.
+    - In case of airgap bundle is not present at `/var/tmp`, in that case, we can copy the bundle from the bastion node to the Automate node.
 
 1. Run the command at the Chef-Automate node of Automate HA cluster to get the applied config:
 
@@ -97,18 +96,9 @@ done
     sudo chef-automate stop
     ```
 
-1. To run the restore command, we need the airgap bundle. Get the Automate HA airgap bundle from the location `/var/tmp/` in Automate instance. Example: `frontend-4.x.y.aib`.
-    - In case of airgap bundle is not present at `/var/tmp`, in that case, we can copy the bundle from the bastion node to the Automate node.
-
-1. Run the command at the Chef-Automate node of Automate HA cluster to get the applied config
-
-    ```bash
-    sudo chef-automate config show > current_config.toml
-    ```
-
 1. Add the OpenSearch credentials to the applied config.
 
-    - If using Chef Managed OpenSearch, add the config below into `current_config.toml` (without any changes).
+    - If using Chef Managed OpenSearch, add the config below into `current_config.toml` (unless you have changed the credentials).
 
         ```bash
         [global.v1.external.opensearch.auth.basic_auth]
@@ -136,40 +126,41 @@ done
 {{% automate/char-warn %}}
 {{< /warning >}}
 
-```bash
-[global.v1.external.opensearch.auth]
-    scheme = "aws_os"
-[global.v1.external.opensearch.auth.aws_os]
-    username = "THIS YOU GET IT FROM AWS Console"
-    password = "THIS YOU GET IT FROM AWS Console"
-    access_key = "<YOUR AWS ACCESS KEY>"
-    secret_key = "<YOUR AWS SECRET KEY>"
+```sh
+    [global.v1.external.opensearch.auth]
+        scheme = "aws_os"
+    [global.v1.external.opensearch.auth.aws_os]
+        username = "THIS YOU GET IT FROM AWS Console"
+        password = "THIS YOU GET IT FROM AWS Console"
+        access_key = "<YOUR AWS ACCESS KEY>"
+        secret_key = "<YOUR AWS SECRET KEY>"
 ```
 
 1. Copy the `bootstrap.abb` bundle to all the Frontend nodes of the Chef Automate HA cluster. Unpack the bundle using the below command on all the Frontend nodes.
 
     ```sh
     sudo chef-automate bootstrap bundle unpack bootstrap.abb
     ```
-2. Stop the Service in all the frontend nodes with the below command.
+
+1. Stop the Service in all the frontend nodes with the below command.
 
     ``` bash
     sudo chef-automate stop
     ```
 
-3. To restore the A2HA backup on Chef Automate HA, run the following command from any Chef Automate instance of the Chef Automate HA cluster:
+1. To restore the A2HA backup on Chef Automate HA, run the following command from any Chef Automate instance of the Chef Automate HA cluster:
 
     ```sh
     sudo chef-automate backup restore /mnt/automate_backups/backups/20210622065515/ --patch-config current_config.toml --airgap-bundle /var/tmp/frontend-4.x.y.aib --skip-preflight
     ```
 
-4. After successfully executing the restore, you will see the below message:
+1. After successfully executing the restore, you will see the below message:
 
     ```bash
     Success: Restored backup 20210622065515
     ```
 
-5. Start the Service in all the frontend nodes with the below command.
+1. Start the Service in all the frontend nodes with the below command.
 
     ``` bash
     sudo chef-automate start

diff --git a/components/docs-chef-io/content/automate/ha_inplace_migration.md b/components/docs-chef-io/content/automate/ha_inplace_migration.md
@@ -190,7 +190,7 @@ OR
 chef-automate config show > applied_config.toml
 ```
 
-Modify `applied_config.toml`, remove the elastic search config, and set the config. Set `applied_config.toml` on all the frontend nodes manually. As the removal of config is not supported from the bastion. Use the below command to set the config manually.
+Modify `applied_config.toml`, remove the elastic search config, and set the config. Set `applied_config.toml` on all the frontend nodes manually. As the removal of config is not supported from the bastion. Use the below command to set the config manually on each Frontend node.
 
 ```bash
 chef-automate config set applied_config.toml

diff --git a/...onents/docs-chef-io/content/automate/ha_on_premises_deployment_prerequisites.md b/...onents/docs-chef-io/content/automate/ha_on_premises_deployment_prerequisites.md
@@ -87,7 +87,7 @@ Current Automate HA integrates with the following non-Chef tools:
 - Refer to [Performance Benchmarks](/automate/ha_performance_benchmarks) for more details on the hardware requirements.
 - Make sure the hardware requirement is not less than the recommended [Minimum Hardware Requirement](/automate/ha_on_premises_deployment_prerequisites/#minimum-hardware-requirement)
 - Contact your network manager to set up the above pre-requisites.
-
+- We recommended that all the hardware/VMs be in the same region/data center.
 {{< /note >}}
 
 ### Minimum Hardware Requirement

diff --git a/components/docs-chef-io/content/automate/reusable/md/opensearch_health_check.md b/components/docs-chef-io/content/automate/reusable/md/opensearch_health_check.md
@@ -1,5 +1,11 @@
 Use the following commands on OpenSearch nodes to verify their health status.
 
+1. Get the OpenSearch Cluster status from the bastion
+
+    ```sh
+    chef-automate status --os
+    ```
+
 1. Verify that the Habitat service is running.
 
     ```sh