Skip to content

Commit cca3ad1

Browse files
Update doc changes for HA (#8974)
* Update doc changes Signed-off-by: Rensy Thomas <rensy.cinuthomas@progress.com> * Update doc changes Signed-off-by: Rensy Thomas <rensy.cinuthomas@progress.com> * Editorial improvements to create_amazon_opensearch.md Signed-off-by: Lisa Barry <lbarry@progress.com> * Editorial improvements to create_amazon_opensearch.md Signed-off-by: Lisa Barry <lbarry@progress.com> * Editorial improvements to create_amazon_rds.md Signed-off-by: Lisa Barry <lbarry@progress.com> * Editorial improvements to ha_add_nodes_to_the_deployment.md Signed-off-by: Lisa Barry <lbarry@progress.com> * Editorial improvements to ha_on_premises_deployment_prerequisites.md Signed-off-by: Lisa Barry <lbarry@progress.com> * Editorial improvements to ha_remove_single_node_from_cluster.md Signed-off-by: Lisa Barry <lbarry@progress.com> * Editorial improvements to ha_verification_check.md Signed-off-by: Lisa Barry <lbarry@progress.com> --------- Signed-off-by: Rensy Thomas <rensy.cinuthomas@progress.com> Signed-off-by: Lisa Barry <lbarry@progress.com> Co-authored-by: lbarry316 <118758673+lbarry316@users.noreply.github.com>
1 parent a09cf68 commit cca3ad1

File tree

7 files changed

+95
-64
lines changed

7 files changed

+95
-64
lines changed

components/docs-chef-io/content/automate/create_amazon_opensearch.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,54 +24,54 @@ Below is our guide on the steps required to create an Amazon OpenSearch cluster.
2424

2525
Before proceeding, make sure you have the following prerequisites in place:
2626

27-
- An active AWS account
28-
- Sufficient permissions to create Amazon OpenSearch clusters
27+
1. An active AWS account
28+
2. Sufficient permissions to create Amazon OpenSearch clusters
2929

3030
## Step 1: Sign in to the AWS Management Console
3131

3232
1. Open your preferred web browser and go to the [AWS Management Console](https://console.aws.amazon.com/).
33-
1. Sign in to your AWS account using your credentials.
33+
2. Sign in to your AWS account using your credentials.
3434

3535
## Step 2: Navigate to the Amazon OpenSearch Service Dashboard
3636

3737
1. Once logged in to the AWS Management Console, search for **OpenSearch** in the search bar at the top of the page.
38-
1. Click on the **Amazon OpenSearch Service** service from the search results to open the Amazon OpenSearch Service dashboard.
38+
2. Select the **Amazon OpenSearch Service** service from the search results to open the Amazon OpenSearch Service dashboard.
3939

4040
## Step 3: Create a New Amazon OpenSearch 1.3 Cluster
4141

4242
1. Click on **Create a new domain** button in the Amazon OpenSearch Service dashboard.
43-
1. Enter a new **Domain name** for your OpenSearch cluster.
44-
1. In **Domain creation method**, select **Standard create**.
45-
1. Choose the appropriate deployment configuration, such as development or production, based on your requirements.
46-
1. Under the **Engine options** section, select **1.3** as the version for your cluster.
47-
1. In the **Networks** section, provide the following information:
43+
2. Enter a new **Domain name** for your OpenSearch cluster.
44+
3. In **Domain creation method**, select **Standard create**.
45+
4. Choose the appropriate deployment configuration, such as development or production, based on your requirements.
46+
5. Under the **Engine options** section, select **1.3** as the version for your cluster.
47+
6. In the **Networks** section, provide the following information:
4848
- **VPC**: Select the VPC in which you have your automate cluster.
4949
- **Subnets**: Select all three private subnets available in your VPC.
5050
- **Security groups**: Select a security block with incoming access from your VPC CIDR range.
51-
1. In **Fine-grained access control**,
52-
- Enable **Fine-grained access control**
53-
- Choose **Create master user**
54-
- Enter the **Master username** and **Master password** you want to create
55-
1. In **Access policy**,
56-
- Select **Configure domain level access policy**
57-
- Choose action **Allow**.
58-
1. Configure the remaining settings per your requirements, such as the number of nodes and storage options.
59-
1. Review all the settings and make sure they are accurate.
60-
1. Click the **Confirm** button to start the cluster creation process.
51+
7. In **Fine-grained access control**:
52+
- Enable **Fine-grained access control**.
53+
- Choose **Create master user**.
54+
- Enter the **Master username** and **Master password** you want to create.
55+
8. In **Access policy**:
56+
- Select **Configure domain level access policy**.
57+
- Select **Allow**.
58+
9. Configure the remaining settings per your requirements, such as the number of nodes and storage options.
59+
10. Review all the settings and ensure they are accurate.
60+
11. Select **Confirm** to start the cluster creation process.
6161

6262
## Step 4: Wait for the Amazon OpenSearch Cluster to be Created
6363

6464
1. The Amazon OpenSearch cluster creation process may take several minutes. Wait for the process to complete.
65-
1. You can monitor the progress of the cluster creation on the Amazon OpenSearch Service dashboard.
65+
2. You can monitor the progress of the cluster creation on the Amazon OpenSearch Service dashboard.
6666

6767
## Step 5: Retrieve Connection Details
6868

6969
You can obtain the necessary connection details once the Amazon OpenSearch 1.3 cluster is created successfully.
7070

7171
1. Go to the Amazon OpenSearch Service dashboard.
72-
1. Find and select your newly created cluster from the list.
73-
1. In the cluster details view, navigate to the **Endpoint** tab.
74-
1. Here, you will find the following connection details:
72+
2. Find and select your newly created cluster from the list.
73+
3. In the cluster details view, select the **Endpoint** tab.
74+
4. Here, you will find the following connection details:
7575
- **Domain name**: This is the domain name we gave for this OpenSearch cluster.
7676
- **Domain URL**: This is the endpoint or hostname of your OpenSearch cluster. It will look something like `my-opensearch-cluster-1234567890.us-east-1.es.amazonaws.com`.
7777
- **Username**: The username for accessing your OpenSearch cluster.

components/docs-chef-io/content/automate/create_amazon_rds.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,64 +24,64 @@ Below is our guide on the steps required to create an Amazon RDS PostgreSQL inst
2424

2525
Before proceeding, make sure you have the following prerequisites in place:
2626

27-
- An active AWS account
28-
- Sufficient permissions to create Amazon RDS instances
27+
- An active AWS account.
28+
- Sufficient permissions to create Amazon RDS instances.
2929

3030
## Step 1: Sign in to the AWS Management Console
3131

3232
1. Open your preferred web browser and go to the [AWS Management Console](https://console.aws.amazon.com/).
33-
1. Sign in to your AWS account using your credentials.
33+
2. Sign in to your AWS account using your credentials.
3434

3535
## Step 2: Navigate to the Amazon RDS Dashboard
3636

3737
1. Once logged in to the AWS Management Console, search for **RDS** in the search bar at the top of the page.
38-
1. Click on the **Amazon RDS** service from the search results to open the Amazon RDS dashboard.
38+
2. Select the **Amazon RDS** service from the search results to open the Amazon RDS dashboard.
3939

4040
## Step 3: Create a New Amazon RDS PostgreSQL Instance
4141

4242
1. Click on **Create database** button in the Amazon RDS dashboard.
43-
1. On the **Choose a database creation method** page, select the **Standard Create** option.
44-
1. Under the **Engine options** section, select **PostgreSQL** as the database engine.
45-
1. Choose **PostgreSQL 13.18-R1**.
46-
1. Under the **Templates** section, select the template that suits your needs or choose the default template.
47-
1. In the **Settings** section, provide the following information:
43+
2. On the **Choose a database creation method** page, select the **Standard Create** option.
44+
3. Under the **Engine options** section, select **PostgreSQL** as the database engine.
45+
4. Select **PostgreSQL 13.22-R2**.
46+
5. Under the **Templates** section, select the template that suits your needs or choose the default template.
47+
6. In the **Settings** section, provide the following information:
4848
- **DB instance identifier**: Enter a unique identifier for your RDS instance.
4949
- **Master username**: Specify the username for the master user account.
5050
- **Master password**: Set a secure password for the master user account.
51-
1. In the **Instance configuration** section, select the appropriate instance size for your needs.
52-
1. In the **Connectivity** section,
51+
7. In the **Instance configuration** section, select the appropriate instance size for your needs.
52+
8. In the **Connectivity** section:
5353
- In **Compute resource**, select **Don't connect to an EC2 compute resource**.
5454
- Select **Network type** as per your requirements.
5555
- In **Virtual private cloud**, select the VPC you want to use for your Automate cluster.
5656
- In **DB subnet group**, choose any private subnet available in your VPC.
5757
- In **Public Access** select **NO**
58-
1. Configure the remaining settings as per your requirements.
59-
1. Review all the settings and make sure they are accurate.
60-
1. Click on the **Create database** button to start the creation process.
58+
9. Configure the remaining settings as per your requirements.
59+
10. Review all the settings and ensure they are accurate.
60+
11. Select **Create database** to start the creation process.
6161

6262
## Step 4: Wait for the Amazon RDS Instance to be Created
6363

6464
1. The RDS instance creation process may take a few minutes. Wait for the process to complete.
65-
1. You can monitor the progress of the instance creation on the Amazon RDS dashboard.
65+
2. You can monitor the progress of the instance creation on the Amazon RDS dashboard.
6666

6767
## Step 5: Open the port in the RDS security group
6868

6969
1. Go to the Amazon RDS dashboard.
70-
1. Find and select your newly created PostgreSQL instance from the list.
71-
1. In the instance details view, navigate to the **Connectivity & security** tab.
72-
1. Open the Security Group under **VPC security groups**.
73-
1. Under **Inbound Rules**, edit and select **Type** as **PostgreSQL**.
74-
1. Select **Source** as **custom** and give appropriate cidr block for your VPC.
75-
1. Click on **Save Rules**.
70+
2. Find and select your newly created PostgreSQL instance from the list.
71+
3. In the instance details view, select the **Connectivity & security** tab.
72+
4. Open the Security Group under **VPC security groups**.
73+
5. Under **Inbound Rules**, edit and select **Type** as **PostgreSQL**.
74+
6. Select **Source** as **custom** and give appropriate cidr block for your VPC.
75+
7. Click on **Save Rules**.
7676

7777
## Step 6: Retrieve Connection Details
7878

7979
Once the Amazon RDS PostgreSQL instance is created successfully, you can obtain the necessary connection details.
8080

8181
1. Go to the Amazon RDS dashboard.
82-
1. Find and select your newly created PostgreSQL instance from the list.
83-
1. In the instance details view, navigate to the **Connectivity & security** tab.
84-
1. Here, you will find the following connection details:
82+
2. Find and select your newly created PostgreSQL instance from the list.
83+
3. In the instance details view, select the **Connectivity & security** tab.
84+
4. Here, you will find the following connection details:
8585
- **Instance URL**: This is the endpoint or hostname of your RDS instance. It will look something like `my-rds-instance.abcdefg12345.us-east-1.rds.amazonaws.com`.
8686
- **Port**: The port number your PostgreSQL instance listens to. The default port is usually `5432`.
8787
- **Username**: The username of the master user account you specified during instance creation.

components/docs-chef-io/content/automate/ha_add_nodes_to_the_deployment.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ Eg: `chef-automate node add --postgresql-ips 10.0.1.42 --opensearch-ips 10.0.1.4
9999
Notice, both OpenSearch and PostgreSQL IPs are same
100100
- Similarly for frontend services (Automate and Chef Server), add both services in the same command with the same IPs
101101
Eg: `chef-automate node add --automate-ips 10.0.1.52 --chef-server-ips 10.0.1.52`
102+
- Adding a new PostgreSQL node to the cluster may lead to increased replication lag on follower nodes because multiple nodes will concurrently attempt to sync data from the leader.
102103
{{< /note >}}
103104

104105
Once the command executes, it will add the supplied nodes to your automate setup. The changes might take a while.

components/docs-chef-io/content/automate/ha_aws_deployment_prerequisites.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,17 +70,17 @@ We do not support **Chef Manage** integration in the ongoing Automate version.
7070

7171
Current Automate HA integrates with the following non-Chef tools:
7272

73-
**In AWS Deployment**
73+
#### In AWS Deployment
7474

75-
- **SQL Database:** External not supported
76-
- **NoSQL Database:** External not supported
77-
- **Load Balancer:** External not supported
75+
- **SQL Database:** External not supported
76+
- **NoSQL Database:** External not supported
77+
- **Load Balancer:** External not supported
7878

79-
**In AWS Managed Services**
79+
#### In AWS Managed Services
8080

81-
- **SQL Database:** AWS RDS PostgreSQL: 13.18
82-
- **NoSQL Database:** AWS OpenSearch: 1.3
83-
- **Load Balancer:** External not supported
81+
- **SQL Database:** AWS RDS PostgreSQL: 13.22-R2
82+
- **NoSQL Database:** AWS OpenSearch: 1.3
83+
- **Load Balancer:** External not supported
8484

8585
## Hardware Requirements
8686

components/docs-chef-io/content/automate/ha_on_premises_deployment_prerequisites.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ We do not support **Chef Manage** integration in the ongoing Automate version.
7676

7777
Current Automate HA integrates with the following non-Chef tools:
7878

79-
- **SQL Database:** PostgreSQL: 13.18
80-
- **NoSQL Database:** OpenSearch: 1.3.7
81-
- **Load Balancer:**
82-
- [Kemp LoadMaster](https://kemptechnologies.com/?_gl=1*jfw3dz*_gcl_au*MTIzMDA0NzAwNC4xNzM4NjA3NTQ3*_ga*MTk4NzcyMzc0My4xNzM4NjA3NTQ3*_ga_9JSNBCSF54*MTc0NDYxNTI1MS4xNC4xLjE3NDQ2MzQ4NTcuMzUuMC4w) (Preferred)
79+
- **SQL Database:** PostgreSQL: 13.22
80+
- **NoSQL Database:** OpenSearch: 1.3.20
81+
- **Load Balancer:**
82+
- [Progress Kemp LoadMaster](https://kemptechnologies.com/?_gl=1*jfw3dz*_gcl_au*MTIzMDA0NzAwNC4xNzM4NjA3NTQ3*_ga*MTk4NzcyMzc0My4xNzM4NjA3NTQ3*_ga_9JSNBCSF54*MTc0NDYxNTI1MS4xNC4xLjE3NDQ2MzQ4NTcuMzUuMC4w) (Preferred)
8383
- NGINX: 1.21.3
8484
- HA Proxy: 2.2.18
8585
- AWS Application Load Balancer
@@ -216,15 +216,15 @@ Set up the databases with password-based authentication.
216216

217217
### AWS Managed
218218

219-
- AWS RDS PostgreSQL: 13.14
219+
- AWS RDS PostgreSQL: 13.22-R2
220220
- AWS OpenSearch: 1.3
221221

222222
Configure the backup only with **S3** when using AWS managed databases.
223223

224224
### Customer Managed
225225

226-
- PostgreSQL: 13.14
227-
- OpenSearch: 1.3.7
226+
- PostgreSQL: 13.22
227+
- OpenSearch: 1.3.20
228228

229229
## Upgrade
230230

components/docs-chef-io/content/automate/ha_remove_single_node_from_cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Chef Automate HA comes with five different types of deployment flows. This page
1919

2020
{{< warning >}}
2121

22-
- We do not recommend removing any node from the backend cluster, but replacing it is recommended. To learn more, see the [replace node in automate ha cluster](#replace-node-in-automate-ha-cluster) section.
22+
- We do not recommend removing any node from the backend cluster, but replacing it is recommended. To replace a backend node, first [add a node to the cluster](/automate/ha_add_nodes_to_the_deployment/) and then [remove the relevant node from the cluster](/automate/ha_remove_single_node_from_cluster/).
2323

2424
- Removal of nodes for PostgreSQL or OpenSearch is at your own risk and may result in data loss. Consult your database administrator before trying to delete PostgreSQL or OpenSearch nodes.
2525
- Below process can be done for `chef-server` and `automate`.

components/docs-chef-io/content/automate/ha_verification_check.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ chef-automate verify --config config.toml
3333

3434
The above command will trigger the `config.toml` file with config, the one you want to deploy.
3535

36+
To view detailed debug logs in the console, you can use the debug flag:
37+
38+
```bash
39+
chef-automate verify --config config.toml -d
40+
```
41+
3642
The post deployment CLI command is as follows:
3743

3844
```bash
@@ -75,4 +81,28 @@ An example of a checks performed are shown in the below image:
7581

7682
The above image shows the checks performed for Automate node. The checks in the above image are also performed on all the nodes in Automate HA, i.e., Chef Server, PostgreSQL, OpenSearch, and Chef Automate (the one showed above).
7783

78-
THe verify command checks all the nodes in Automate HA and with that it also provides the remediation steps for failures.
84+
The verify command checks all the nodes in Automate HA and it also provides the remediation steps for failures.
85+
86+
## Additional Verification in System Logs
87+
88+
In addition to running the chef-automate verify command, you can inspect system logs for deeper insights into the verification service.
89+
90+
### On the Bastion Host
91+
92+
To view logs related to the automate-verify service on the bastion host, use:
93+
94+
```bash
95+
journalctl -u automate-verify
96+
```
97+
98+
This helps identify which API checks may have failed during verification.
99+
100+
### On Individual Nodes
101+
102+
Based on the failed API identified from the bastion logs, you can run the same command on the corresponding node to validate the service response:
103+
104+
```bash
105+
journalctl -u automate-verify
106+
```
107+
108+
This provides node-level visibility into the verification process and helps when troubleshooting specific failures.

0 commit comments

Comments
 (0)