From 4ba1f8e93b6378e657ecb226071c2949af55be65 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Wed, 6 Mar 2024 11:43:06 -0500 Subject: [PATCH] Update Automate docs Signed-off-by: Ian Maddaus --- .../docs-chef-io/content/automate/ha.md | 4 +- .../automate/ha_backup_restore_file_system.md | 4 +- .../content/automate/ha_healthcheck.md | 14 +++++ ...lerting-centralized-logging-integration.md | 54 +++++++++++++++++++ _vendor/modules.txt | 2 +- go.mod | 2 +- go.sum | 4 +- 7 files changed, 76 insertions(+), 8 deletions(-) create mode 100644 _vendor/github.com/chef/automate/components/docs-chef-io/content/automate/monitoring-alerting-centralized-logging-integration.md 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 602e7f1035..bb58ceeb95 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 @@ -47,8 +47,8 @@ Chef Automate HA for Managed Services has default port 5432 for Managed PostgreS {{< warning >}} - Choose Minimum node deployment type when you have VM constraints. -- Minimun node deployment is only for Onprem deployment. -- Minimun node deployment is not supported for AWS deployment. +- Minimum node deployment is only for on-premises deployments +- Minimum node deployment is not supported for AWS deployments {{< /warning >}} diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_file_system.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_file_system.md index 9b7efe7750..b6f12658eb 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_file_system.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_file_system.md @@ -69,10 +69,10 @@ Configure the OpenSearch `path.repo` setting by following the steps given below: ##### Healthcheck commands -- Following command can be run in the OpenSearch node +- Following command can be run at the bastion node ```sh - chef-automate status + chef-automate status --opensearch ``` - Following command can be run in the OpenSearch node diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_healthcheck.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_healthcheck.md index 2671288999..6f708e68f1 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_healthcheck.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_healthcheck.md @@ -152,3 +152,17 @@ sorthands for --postgresql is --pg and -p source /hab/sup/default/SystemdEnvironmentFile.sh automate-backend-ctl show --svc=automate-ha-postgresql ``` + +- To Rotate the password for Postgres cluster, run the command from the bastion node + +```sh + cd /hab/a2_deploy_workspace/ + ./scripts/credentials set postgresql --no-auto +``` + +- To Rotate the password for Opensearch cluster, run the command from the bastion node + +```sh + cd /hab/a2_deploy_workspace/ + ./scripts/credentials set opensearch --no-auto +``` diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/monitoring-alerting-centralized-logging-integration.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/monitoring-alerting-centralized-logging-integration.md new file mode 100644 index 0000000000..6fc92641b4 --- /dev/null +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/monitoring-alerting-centralized-logging-integration.md @@ -0,0 +1,54 @@ ++++ +title = "Chef Automate HA integrations" + +draft = false + +gh_repo = "automate" +[menu] + [menu.automate] + title = "Integrations" + parent = "automate/deploy_high_availability" + identifier = "automate/deploy_high_availability/monitoring-alerting-centralized-logging-integration.md Chef Automate HA integrations" + weight = 75 ++++ + +You can integrate third-party platforms with [Chef Automate HA](/automate/ha) to monitor Automate's health, infrastructure, components, and services. + +Chef Automate HA integrates with the following platforms: + +- AWS CloudWatch +- Datadog +- Elastic Stack (ELK) +- Prometheus + +## Prerequisites + +These integrations are supported on Chef Automate HA 4.12.66 and above. + +## AWS CloudWatch + +Chef Automate HA with AWS CloudWatch gives automate and compliance teams the necessary redundancy and visibility to successfully operate the solution. Refer to the following links for the detailed whitepapers and blog documents. + +- [Automate HA and CloudWatch Integration](https://github.com/chef/monitoring-integration-automate/blob/main/Whitepaper_AutomateHA_Monitoring_and_Alerting.md#cloudwatch-integration-with-automate-ha---monitoring) +- [Technical Blog reference of Automate HA and CloudWatch](https://www.chef.io/blog/monitoring-chef-automate-ha-with-cloudwatch) + +## Datadog + +Datadog is a monitoring and analytics platform that delivers real-time insights into application, infrastructure, and cloud service performance. Refer to the following links for the detailed whitepapers and blog documents. + +- [Automate HA and DataDog Integration](https://github.com/chef/monitoring-integration-automate/blob/main/Whitepaper_AutomateHA_Monitoring_and_Alerting.md#datadog-integration-with-automate-ha---monitoring) +- [Technical Blog reference of Automate HA and DataDog](https://www.chef.io/blog/monitoring-chef-automate-ha-with-datadog) + +## Elastic Stack + +The ELK stack is a trio of open-source tools that have revolutionized how businesses harness their data. Refer to the following links for the detailed whitepapers and blog documents. + +- [Automate HA and ELK Integration](https://github.com/chef/monitoring-integration-automate/blob/main/Whitepaper_AutomateHA_Monitoring_and_Alerting.md#elk-integration-with-automate-ha---centralised-logging) +- [Technical Blog reference of Automate HA and ELK](https://www.chef.io/blog/monitoring-chef-automate-ha-with-elk) + +## Prometheus + +Prometheus, an open-source tool excels at scraping metrics from HTTP endpoints, making it a go-to for harvesting data from various targets. Refer to the following links for the detailed whitepapers and blog documents. + +- [Automate HA and Prometheus Integration](https://github.com/chef/monitoring-integration-automate/blob/main/Whitepaper_AutomateHA_Monitoring_and_Alerting.md#prometheus-integration-with-automate-ha---monitoring) +- [Technical Blog reference of Automate HA and Prometheus](https://www.chef.io/blog/monitoring-chef-automate-ha-with-prometheus) diff --git a/_vendor/modules.txt b/_vendor/modules.txt index f2ecbfc19c..250923bbd1 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1,4 +1,4 @@ -# github.com/chef/automate/components/docs-chef-io v0.0.0-20240305054817-05b6e6188cc6 +# github.com/chef/automate/components/docs-chef-io v0.0.0-20240306133449-4e982f867599 # github.com/chef/desktop-config/docs-chef-io v0.0.0-20230711052355-bad26ce3ac0b # github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20230808222519-d0c20bbe8c45 # github.com/chef/chef-server/docs-chef-io v0.0.0-20240110155437-6cd481103560 diff --git a/go.mod b/go.mod index 367c2861f1..1f42af6eed 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/chef/chef-web-docs go 1.18 require ( - github.com/chef/automate/components/docs-chef-io v0.0.0-20240305054817-05b6e6188cc6 // indirect + github.com/chef/automate/components/docs-chef-io v0.0.0-20240306133449-4e982f867599 // indirect github.com/chef/chef-server/docs-chef-io v0.0.0-20240110155437-6cd481103560 // indirect github.com/chef/chef-workstation/docs-chef-io v0.0.0-20240220152040-faf51299a28a // indirect github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20231031143423-5ffd549d4a19 // indirect diff --git a/go.sum b/go.sum index e15922403f..eac15b8f7f 100644 --- a/go.sum +++ b/go.sum @@ -1,8 +1,8 @@ cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= -github.com/chef/automate/components/docs-chef-io v0.0.0-20240305054817-05b6e6188cc6 h1:tXOFa+/Cjp57WO1JPanjGrJdEIV9Z4Z6T7N9+lT8O00= -github.com/chef/automate/components/docs-chef-io v0.0.0-20240305054817-05b6e6188cc6/go.mod h1:juvLC7Rt33YOCgJ5nnfl4rWZRAbSwqjTbWmcAoA0LtU= +github.com/chef/automate/components/docs-chef-io v0.0.0-20240306133449-4e982f867599 h1:vya+2EqafWQi5osINw4CRrmoDNfZ3LJjrAplqpMc7eA= +github.com/chef/automate/components/docs-chef-io v0.0.0-20240306133449-4e982f867599/go.mod h1:juvLC7Rt33YOCgJ5nnfl4rWZRAbSwqjTbWmcAoA0LtU= github.com/chef/chef-server/docs-chef-io v0.0.0-20240110155437-6cd481103560 h1:1fbTdNlat08FZ9xTSEnyBmTFrVj1O75bwo3x6Iaab40= github.com/chef/chef-server/docs-chef-io v0.0.0-20240110155437-6cd481103560/go.mod h1:gMSa25GUHmLimA0gjvRd3hs1buOBqkKPrdHzHvaJauY= github.com/chef/chef-workstation/docs-chef-io v0.0.0-20240220152040-faf51299a28a h1:76ZYfDXaaPCMi4YQ4uuhKSUALF488ZNfAcJx9/p+7/I=