Skip to content

Commit 6f62171

Browse files
dishanktiwari2501IanMadd
andauthoredMar 17, 2025··
Automate HA Document Fixes (#8814)
* minor changes to ha docs Signed-off-by: Dishank Tiwari <[email protected]> * minor fixes Signed-off-by: Dishank Tiwari <[email protected]> * fixes indentation Signed-off-by: Dishank Tiwari <[email protected]> * review fixes Signed-off-by: Dishank Tiwari <[email protected]> * final fixes Signed-off-by: Dishank Tiwari <[email protected]> * review changes Signed-off-by: Dishank Tiwari <[email protected]> * Editing Signed-off-by: Ian Maddaus <[email protected]> * minor fixes Signed-off-by: Dishank Tiwari <[email protected]> * updated the docs Signed-off-by: Dishank Tiwari <[email protected]> * added the content fixes again Signed-off-by: Dishank Tiwari <[email protected]> * fixed changes Signed-off-by: Dishank Tiwari <[email protected]> --------- Signed-off-by: Dishank Tiwari <[email protected]> Signed-off-by: Ian Maddaus <[email protected]> Co-authored-by: Ian Maddaus <[email protected]>
1 parent bd60037 commit 6f62171

File tree

3 files changed

+25
-24
lines changed

3 files changed

+25
-24
lines changed
 

‎components/docs-chef-io/content/automate/ha.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The Chef Automate HA equates to reliability, efficiency, and productivity, built
2828

2929
HA architecture includes the cluster of the *Chef Automate*, *Chef Server*, *PostgreSQL*, and *OpenSearch*.
3030

31-
### Chef Automate HA Architecture for OnPremise / Cloud Non-Managed
31+
### Chef Automate HA Architecture for On Premises / Cloud Non-Managed
3232

3333
![High Availability Architecture](/images/automate/ha_arch_onprem.png)
3434

@@ -40,7 +40,9 @@ HA architecture includes the cluster of the *Chef Automate*, *Chef Server*, *Pos
4040
Chef Automate HA for Managed Services has default port 5432 for Managed PostgreSQL and 9200 for Managed OpenSearch. You can also change to your custom port.
4141
{{< /note >}}
4242

43-
### Chef Automate HA Architecture for OnPremise Non-Managed Minimum Node Cluster
43+
### Chef Automate HA Architecture for On-Premises Non-Managed Minimum Node Cluster
44+
45+
The following shows a five-node cluster, which is a supported deployment pattern. Work with your Progress technical teams to determine the appropriate cluster configuration for optimal performance based on parameters such as node count and data size.
4446

4547
![High Availability Architecture](/images/automate/ha_arch_minnode_cluster.png)
4648

@@ -67,38 +69,39 @@ The Chef Automate HA Architecture involves the following clusters as part of the
6769

6870
## Provisioning
6971

70-
Chef Automate's high availability solution can run on cloud providers and on-premise infrastructure systems. Appropriately provisioned backend, frontend, and bastion systems will help ensure a smooth deployment and installation experience.
72+
Chef Automate's high availability solution can run on cloud providers and on-premises infrastructure systems. Appropriately provisioned backend, frontend, and bastion systems ensure a smooth deployment and installation experience.
7173

72-
- On-premise provisioning
73-
- Cloud provisioning
74+
- On-premises provisioning
75+
- Cloud provisioning
7476

75-
### On-premise provisioning
77+
### On-premises provisioning
7678

7779
The customer can provision virtual machines or bare metal machines on a supported operating system with the required system settings to deploy the Automate HA solution.
7880

79-
### Cloud provisioing
80-
Systems and services from the following cloud providers are supported:
81+
### Cloud provisioning
82+
83+
Systems and services from the following cloud providers are supported:
8184

82-
- [AWS](https://docs.chef.io/automate/ha_aws_deploy_steps/#steps-to-provision)
83-
- Azure
84-
- Google
85+
- [AWS](https://docs.chef.io/automate/ha_aws_deploy_steps/#steps-to-provision)
86+
- Azure
87+
- Google
8588

8689
Deploy the Automate HA on the cloud infrastructure after provisioning the cloud systems. We have a simplified provisioning utility for AWS, Azure, and Google, and we expect to provision the systems manually.
8790

8891
## Deployment Methods
8992

9093
Chef Automate High Availability (HA) supports two types of deployment:
9194

92-
- [On-premise Deployment (Existing Node) Deployment](/automate/ha_onprim_deployment_procedure/)
95+
- [on-premises Deployment (Existing Node) Deployment](/automate/ha_onprim_deployment_procedure/)
9396
- [Amazon Web Services (AWS) Deployment](/automate/ha_aws_deploy_steps/)
9497

95-
### On-premise Deployment (Existing Node/Bare Infrastructure)
98+
### On-premises Deployment (Existing Node/Bare Infrastructure)
9699

97100
In this, we expect VM (Virtual machine) or Bare Metal machines (Physical machine) that are already created and have initial Operating System (OS) setup done. Including Ports and Security policies changed according to requirements.
98101

99102
After this, installation steps will Deploy Chef Automate, Chef Infra Server, PostgreSQL DB, and OpenSearch DB to the relevant VMs or Physical Machines as provided in Config.
100103

101-
Please refer [Performance Bench marking](https://docs.chef.io/automate/ha_performance_benchmarks/#performance-benchmarks) for more info.
104+
See the [performance benchmarking documentation](https://docs.chef.io/automate/ha_performance_benchmarks/#performance-benchmarks) for more information.
102105

103106
### Cloud Deployment using Amazon Web Services (AWS)
104107

@@ -113,7 +116,7 @@ The two-step deployment process is as shown below:
113116
The two-step deployment process is as shown below:
114117

115118
- Provisioning Infrastructure: Manually provision the infrastructure
116-
- Deployment of services on the provisioned infrastructure (follow the [On-premise Deployment steps](/automate/ha_onprim_deployment_procedure/)).
119+
- Deployment of services on the provisioned infrastructure (follow the [on-premises deployment procedure](/automate/ha_onprim_deployment_procedure/)).
117120
- Installation of *PostgreSQL*, *OpenSearch*, *Chef Automate*, and *Chef Infra Server* will be done in this step.
118121
- Only File System Backup and Restore are supported.
119122

@@ -122,7 +125,7 @@ The two-step deployment process is as shown below:
122125
The two-step deployment process is as shown below:
123126

124127
- Provisioning Infrastructure: Manually provision the infrastructure
125-
- Deployment of services on the provisioned infrastructure (follow the [On-premise Deployment steps](/automate/ha_onprim_deployment_procedure/)).
128+
- Deployment of services on the provisioned infrastructure (follow the [on-premises deployment procedure](/automate/ha_onprim_deployment_procedure/)).
126129
- Installation of *PostgreSQL*, *OpenSearch*, *Chef Automate*, and *Chef Infra Server* will be done in this step.
127130

128131
## Performance (Benchmarking)

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

+5-7
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ Current Automate HA integrates with the following non-Chef tools:
9292

9393
### Minimum Hardware Requirement
9494

95+
An eleven-node Automate HA cluster has the following minimum hardware requirements.
96+
9597
| Instance | Count | vCPU | RAM | Storage Size(/hab) | AWS Machine Type | AZURE Machine Type | GCP Machine Type | Additional Space |
9698
| ----------------- | ----- | ---- | --- | ------------------ | ---------------- | ------------------ | ---------------- | ----------------- |
9799
| Chef Automate | 2 | 2 | 8 | 200 GB | m5.large | Standard_D2as_v4 | n2-standard-2 | /var/tmp=5% /root=20% |
@@ -100,9 +102,7 @@ Current Automate HA integrates with the following non-Chef tools:
100102
| OpenSearch DB | 3 | 2 | 8 | 200 GB | m5.large | Standard_D2as_v4 | n2-standard-2 | /var/tmp=5% /root=20% |
101103
| Bastion Machine | 1 | 2 | 8 | 200 GB | m5.large | Standard_D2as_v4 | n2-standard-2 | /var/tmp=5% /root=20% |
102104

103-
{{< note >}}
104-
For production, OpenSearch volume size also depends on the number of nodes and frequency of Chef Infra Client runs and compliance scans.
105-
{{< /note >}}
105+
{{< note >}} For production, OpenSearch volume size also depends on the number of nodes and frequency of Chef Infra Client runs and compliance scans. {{< /note >}}
106106

107107
### Load Balancer
108108

@@ -155,17 +155,15 @@ Generate the certificates using recommended tools and supported algorithms and v
155155
- OpenSSL Algorithms: PBE-SHA1-3DES, RSA (2048), SHA-256
156156
- Certificate Format: X509 V3(PEM format) ,Private key is in PKCS8 format
157157

158-
159158
To understand how to generate certificates, refer to the [Certificate Generation](/automate/ha_cert_selfsign/#creating-a-certificate) documentation.
160159

161-
162160
## Deployment Specific Pre-requisites
163161

164162
The on-premises deployment specific pre-requisites are as follows:
165163

166164
### Infra Server
167165

168-
- Chef Automate HA comes with a bundled Infra Server, and it is recommended not to use any external server in Automate HA. Using an external server will lose the Automate HA functionalities, and things may not work as expected.
166+
- Chef Automate HA comes with a bundled Infra Server.
169167

170168
### Access
171169

@@ -259,7 +257,7 @@ To know more about the on-premises deployment disaster recovery, visit our [Disa
259257
| Existing System | Supported Setup Type | Minimum Eligible System Version | Maximum Eligible System Version | Pre-requisite Before Migration |
260258
|-----------------|----------------------|---------------------------------|-----------|------------------------------|
261259
| Chef Automate | [Standalone](/automate/install/) | Automate 2020XXXXXX | | To migrate to the Managed OpenSearch Automate HA cluster, the current standalone Chef Automate version should be at most 4.3.0. |
262-
| Chef Backend | [Chef Backend Cluster](/server/install_server_ha/) | Backend 2.X and Infra Server 14.X | Chef Infra Server 15.4.0 | Chef Backend using PostgreSQL storage for Cookbooks should only migrate to Automate HA. |
260+
| Chef Backend | [Chef Backend Cluster](/server/install_server_ha/) | Backend 2.X and Infra Server 14.X | Chef Infra Server 15.4.0 | Chef Backend using PostgreSQL storage for Cookbooks should only migrate to Automate HA. |
263261
| Chef Infra Server | [Standalone](/server/install_server/#standalone)<br />[Tiered](/server/install_server_tiered/) | Infra server 14.XXX | Chef Infra Server 15.4.0 | Chef Infra Server using PostgreSQL storage for Cookbooks should only migrate to Automate HA. |
264262
| A2HA | PS Lead A2HA On-Premises Deployment |Chef Automate version 20201230192246 | Chef Automate Version 20220223121207 | The A2HA cluster-mounted backup file system should also be attached to Automate HA cluster.<br />In case of In-Place migration, the volume having `/hab` should have more than 60% free space on each node. |
265263

‎ha_upgrade.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This page lists the commands that aid in upgrading the Chef Automate High Availa
1919
- The upgrade of the backend nodes restarts ElasticSearch and PostgreSQL services.
2020
- You cannot downgrade the Automate version. If you intend to install the lower version of the Chef Automate High Availability (HA) system, uninstall the existing version of the same, and destroy the terraform.
2121

22-
{{< note/ >}}
22+
{{< /note >}}
2323

2424
## Command List
2525

0 commit comments

Comments
 (0)
Please sign in to comment.