From 57100d68d3b0b9f24c3e71b32c0c28438a5d8c05 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Mon, 17 Mar 2025 08:57:06 -0400 Subject: [PATCH] Update Automate docs Signed-off-by: Ian Maddaus --- .../docs-chef-io/content/automate/ha.md | 35 ++++++++++--------- ...ha_on_premises_deployment_prerequisites.md | 12 +++---- _vendor/modules.txt | 2 +- go.mod | 2 +- go.sum | 4 +-- 5 files changed, 28 insertions(+), 27 deletions(-) diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha.md index 90e084a25f..3b1ccb5b6a 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha.md @@ -28,7 +28,7 @@ The Chef Automate HA equates to reliability, efficiency, and productivity, built HA architecture includes the cluster of the *Chef Automate*, *Chef Server*, *PostgreSQL*, and *OpenSearch*. -### Chef Automate HA Architecture for OnPremise / Cloud Non-Managed +### Chef Automate HA Architecture for On Premises / Cloud Non-Managed ![High Availability Architecture](/images/automate/ha_arch_onprem.png) @@ -40,7 +40,9 @@ HA architecture includes the cluster of the *Chef Automate*, *Chef Server*, *Pos 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. {{< /note >}} -### Chef Automate HA Architecture for OnPremise Non-Managed Minimum Node Cluster +### Chef Automate HA Architecture for On-Premises Non-Managed Minimum Node Cluster + +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. ![High Availability Architecture](/images/automate/ha_arch_minnode_cluster.png) @@ -67,21 +69,22 @@ The Chef Automate HA Architecture involves the following clusters as part of the ## Provisioning -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. +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. - - On-premise provisioning - - Cloud provisioning +- On-premises provisioning +- Cloud provisioning -### On-premise provisioning +### On-premises provisioning 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. -### Cloud provisioing - Systems and services from the following cloud providers are supported: +### Cloud provisioning + +Systems and services from the following cloud providers are supported: - - [AWS](https://docs.chef.io/automate/ha_aws_deploy_steps/#steps-to-provision) - - Azure - - Google +- [AWS](https://docs.chef.io/automate/ha_aws_deploy_steps/#steps-to-provision) +- Azure +- Google 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. @@ -89,16 +92,16 @@ Deploy the Automate HA on the cloud infrastructure after provisioning the cloud Chef Automate High Availability (HA) supports two types of deployment: -- [On-premise Deployment (Existing Node) Deployment](/automate/ha_onprim_deployment_procedure/) +- [on-premises Deployment (Existing Node) Deployment](/automate/ha_onprim_deployment_procedure/) - [Amazon Web Services (AWS) Deployment](/automate/ha_aws_deploy_steps/) -### On-premise Deployment (Existing Node/Bare Infrastructure) +### On-premises Deployment (Existing Node/Bare Infrastructure) 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. 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. -Please refer [Performance Bench marking](https://docs.chef.io/automate/ha_performance_benchmarks/#performance-benchmarks) for more info. +See the [performance benchmarking documentation](https://docs.chef.io/automate/ha_performance_benchmarks/#performance-benchmarks) for more information. ### Cloud Deployment using Amazon Web Services (AWS) @@ -113,7 +116,7 @@ The two-step deployment process is as shown below: The two-step deployment process is as shown below: - Provisioning Infrastructure: Manually provision the infrastructure -- Deployment of services on the provisioned infrastructure (follow the [On-premise Deployment steps](/automate/ha_onprim_deployment_procedure/)). +- Deployment of services on the provisioned infrastructure (follow the [on-premises deployment procedure](/automate/ha_onprim_deployment_procedure/)). - Installation of *PostgreSQL*, *OpenSearch*, *Chef Automate*, and *Chef Infra Server* will be done in this step. - Only File System Backup and Restore are supported. @@ -122,7 +125,7 @@ The two-step deployment process is as shown below: The two-step deployment process is as shown below: - Provisioning Infrastructure: Manually provision the infrastructure -- Deployment of services on the provisioned infrastructure (follow the [On-premise Deployment steps](/automate/ha_onprim_deployment_procedure/)). +- Deployment of services on the provisioned infrastructure (follow the [on-premises deployment procedure](/automate/ha_onprim_deployment_procedure/)). - Installation of *PostgreSQL*, *OpenSearch*, *Chef Automate*, and *Chef Infra Server* will be done in this step. ## Performance (Benchmarking) diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_on_premises_deployment_prerequisites.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_on_premises_deployment_prerequisites.md index 0e96ffedc0..b3de7542e9 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_on_premises_deployment_prerequisites.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_on_premises_deployment_prerequisites.md @@ -92,6 +92,8 @@ Current Automate HA integrates with the following non-Chef tools: ### Minimum Hardware Requirement +An eleven-node Automate HA cluster has the following minimum hardware requirements. + | Instance | Count | vCPU | RAM | Storage Size(/hab) | AWS Machine Type | AZURE Machine Type | GCP Machine Type | Additional Space | | ----------------- | ----- | ---- | --- | ------------------ | ---------------- | ------------------ | ---------------- | ----------------- | | 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: | OpenSearch DB | 3 | 2 | 8 | 200 GB | m5.large | Standard_D2as_v4 | n2-standard-2 | /var/tmp=5% /root=20% | | Bastion Machine | 1 | 2 | 8 | 200 GB | m5.large | Standard_D2as_v4 | n2-standard-2 | /var/tmp=5% /root=20% | -{{< note >}} -For production, OpenSearch volume size also depends on the number of nodes and frequency of Chef Infra Client runs and compliance scans. -{{< /note >}} +{{< note >}} For production, OpenSearch volume size also depends on the number of nodes and frequency of Chef Infra Client runs and compliance scans. {{< /note >}} ### Load Balancer @@ -155,17 +155,15 @@ Generate the certificates using recommended tools and supported algorithms and v - OpenSSL Algorithms: PBE-SHA1-3DES, RSA (2048), SHA-256 - Certificate Format: X509 V3(PEM format) ,Private key is in PKCS8 format - To understand how to generate certificates, refer to the [Certificate Generation](/automate/ha_cert_selfsign/#creating-a-certificate) documentation. - ## Deployment Specific Pre-requisites The on-premises deployment specific pre-requisites are as follows: ### Infra Server -- 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. +- Chef Automate HA comes with a bundled Infra Server. ### Access @@ -259,7 +257,7 @@ To know more about the on-premises deployment disaster recovery, visit our [Disa | Existing System | Supported Setup Type | Minimum Eligible System Version | Maximum Eligible System Version | Pre-requisite Before Migration | |-----------------|----------------------|---------------------------------|-----------|------------------------------| | 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. | -| 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. | +| 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. | | Chef Infra Server | [Standalone](/server/install_server/#standalone)
[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. | | 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.
In case of In-Place migration, the volume having `/hab` should have more than 60% free space on each node. | diff --git a/_vendor/modules.txt b/_vendor/modules.txt index b91974a145..5be441102f 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1,4 +1,4 @@ -# github.com/chef/automate/components/docs-chef-io v0.0.0-20250303080254-4089d7bebf25 +# github.com/chef/automate/components/docs-chef-io v0.0.0-20250317095354-4cf10eec01e7 # github.com/chef/desktop-config/docs-chef-io v0.0.0-20240814044820-5af667d41a43 # github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20241227173243-de19b906a228 # github.com/chef/chef-server/docs-chef-io v0.0.0-20250303143005-18808e167759 diff --git a/go.mod b/go.mod index 766235df9c..b9facf5712 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/chef/chef-web-docs go 1.22 require ( - github.com/chef/automate/components/docs-chef-io v0.0.0-20250303080254-4089d7bebf25 // indirect + github.com/chef/automate/components/docs-chef-io v0.0.0-20250317095354-4cf10eec01e7 // indirect github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258 // indirect github.com/chef/chef-server/docs-chef-io v0.0.0-20250303143005-18808e167759 // indirect github.com/chef/chef-workstation/docs-chef-io v0.0.0-20250205062508-ee50345a4044 // indirect diff --git a/go.sum b/go.sum index 9a7af7272e..79b7d2db34 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,5 @@ -github.com/chef/automate/components/docs-chef-io v0.0.0-20250303080254-4089d7bebf25 h1:iz1ALPfNghlhlsJbnBsx6uN0qx0y9o2q9d9KSvxqMzE= -github.com/chef/automate/components/docs-chef-io v0.0.0-20250303080254-4089d7bebf25/go.mod h1:juvLC7Rt33YOCgJ5nnfl4rWZRAbSwqjTbWmcAoA0LtU= +github.com/chef/automate/components/docs-chef-io v0.0.0-20250317095354-4cf10eec01e7 h1:aBSPBATSbiVOgqNwR0fZaiQplrqc1DLEG9IAL7y97pE= +github.com/chef/automate/components/docs-chef-io v0.0.0-20250317095354-4cf10eec01e7/go.mod h1:juvLC7Rt33YOCgJ5nnfl4rWZRAbSwqjTbWmcAoA0LtU= github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258 h1:wpWL3E4Kb6ynNEwilZiKk/clD0g9AjinDB/D+OKeKHU= github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258/go.mod h1:+Jpnv+LXE6dXu2xDcMzMc0RxRGuCPAoFxq5tJ/X6QpQ= github.com/chef/chef-server/docs-chef-io v0.0.0-20250303143005-18808e167759 h1:vv1u9/sudmHQz20oyPzXHouPE57ZVPofKWkBVvg7GMA=