From 17acd2ae8bdb2eb894ab9e95feba39199e3cd94b Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Tue, 17 Jun 2025 09:41:49 -0400 Subject: [PATCH] Update Automate docs Signed-off-by: Ian Maddaus --- .../content/automate/ha_automate_to_automate_ha.md | 2 +- .../ha_on_premises_deployment_prerequisites.md | 7 ++++++- .../content/automate/ha_troubleshooting.md | 10 +++++----- .../content/automate/opensearch_external_upgrade.md | 4 ++-- .../content/automate/servicenow_incident_creation.md | 4 ++-- .../content/automate/servicenow_integration.md | 4 ++-- _vendor/modules.txt | 2 +- go.mod | 2 +- go.sum | 4 ++-- 9 files changed, 22 insertions(+), 17 deletions(-) diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_automate_to_automate_ha.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_automate_to_automate_ha.md index 1bb8bf64f4..6a4ec89e6f 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_automate_to_automate_ha.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_automate_to_automate_ha.md @@ -244,7 +244,7 @@ Follow the steps below when migrating to On-Premises or Cloud HA deployment **(b ## Migration with S3 -For AWS managed services, map the snapshot role to the OpenSearch dashboard. It is necessary to [enable backup and restore in OpenSearch](automate/managed_services/#enabling-opensearch-backup-restore). +For AWS managed services, map the snapshot role to the OpenSearch dashboard. It is necessary to [enable backup and restore in OpenSearch](/automate/managed_services/#enabling-opensearch-backup-restore). 1. If the standalone Automate is not configured with S3 backup configurations then patch the following configuration in Standalone Chef Automate for creating the backup in the S3. 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 b3de7542e9..1429d6560f 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 @@ -78,7 +78,11 @@ Current Automate HA integrates with the following non-Chef tools: - **SQL Database:** PostgreSQL: 13.18 - **NoSQL Database:** OpenSearch: 1.3.7 -- **Load Balancer:** NGINX: 1.21.3 or HA Proxy: 2.2.18 or AWS Application Load Balancer +- **Load Balancer:** + - [Kemp LoadMaster](https://kemptechnologies.com/?_gl=1*jfw3dz*_gcl_au*MTIzMDA0NzAwNC4xNzM4NjA3NTQ3*_ga*MTk4NzcyMzc0My4xNzM4NjA3NTQ3*_ga_9JSNBCSF54*MTc0NDYxNTI1MS4xNC4xLjE3NDQ2MzQ4NTcuMzUuMC4w) (Preferred) + - NGINX: 1.21.3 + - HA Proxy: 2.2.18 + - AWS Application Load Balancer ## Hardware Requirements @@ -110,6 +114,7 @@ Load Balancers in on-premises deployment need to be set up according to [Chef Au You can set up your [load balancer](/automate/loadbalancer_configuration/) using: +- [Kemp LoadMaster](https://docs.progress.com/bundle/loadmaster-deployment-guide-progress-chef-automate-and-infra-server-ga/page/Document-Purpose.html) (Preferred) - [NGINX 1.21.3](/automate/loadbalancer_configuration/#load-balancer-setup-using-nginx) - [HA Proxy 2.2.18](/automate/loadbalancer_configuration/#load-balancer-setup-using-ha-proxy) - [AWS Application Load Balancer](https://aws.amazon.com/elasticloadbalancing/application-load-balancer/) diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_troubleshooting.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_troubleshooting.md index d5aa094c03..21e67838e5 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_troubleshooting.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_troubleshooting.md @@ -39,7 +39,7 @@ To make the service healthy, ensure the chef server can curl the data collector ### Rate limiter ingestion issues on data collector endpoint ```bash -Sep 24 22:33:20 rp000134186 hab: automate-gateway.default(O): time="2024-09-24T22:33:20-05:00" level=error +Sep 24 22:33:20 hab: automate-gateway.default(O): time="2024-09-24T22:33:20-05:00" level=error msg="resource=collector-requests cur=960 max=960: Resource limit exceeded" grpc_port=2001 hostname=127.0.0.1 https_port=2000 null_backend_socket=/hab/svc/automate-gateway/var/null_backend.sock ``` @@ -72,7 +72,7 @@ Reference: [Chef Automate Configuration](https://docs.chef.io/automate/configura ### Queue is full errors on data collector endpoint ```bash -Sep 30 00:04:43 rp000134186 hab: ingest-service.default(O): time="2024-09-30T00:04:43-05:00" level=error msg="Chef run ingestion failure" +Sep 30 00:04:43 hab: ingest-service.default(O): time="2024-09-30T00:04:43-05:00" level=error msg="Chef run ingestion failure" error="Message rejected because queue is full" ``` @@ -122,7 +122,7 @@ The restore command fails when other users or services access the nodes' databas - Stop the services on all the frontend `chef-automate stop` . -Stopping the service on all frontend node will able to drop the database while running the restore command. +Stopping the service on all frontend node will able to drop the database while running the restore command. ### Issue: Cached Artifact not found in Offline Mode @@ -171,7 +171,7 @@ Ensure that the access key, secret key, and endpoints are correct. If you are us ```bash chef-automate backup restore s3://bucket_name/path/to/backups/BACKUP_ID --skip-preflight --s3-access-key "Access_Key" --s3-secret-key "Secret_Key" --s3-endpoint "https://s3.amazonaws.com" ``` -In the above command we need to update `--s3-access-key`, `--s3-secret-key` and `--s3-endpoint` +In the above command we need to update `--s3-access-key`, `--s3-secret-key` and `--s3-endpoint` ### Issue: HAB Access Error @@ -229,7 +229,7 @@ UnknownError: Unable to determine error cause: Command did not exit gracefully. ### Issue: knife-ec-restore during migration: Failed to restore synchronous operations -- While running the restore command, if you are getting this error in logs: +- While running the restore command, if you are getting this error in logs: `Failed to restore synchronous operations` follow either of the methods below. diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/opensearch_external_upgrade.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/opensearch_external_upgrade.md index 665933da66..84194c505e 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/opensearch_external_upgrade.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/opensearch_external_upgrade.md @@ -63,7 +63,7 @@ Chef Automate 4.x supports external OpenSearch. Please follow the migration sect Steps To Enable External OpenSearch -- Set the `external.opensearch` `enable` attribute to false. +- Set the `external.opensearch` `enable` attribute to `true`. - Set the `nodes` attribute to the external OpenSearch URL array. - Set the auth . - Set the `auth` attribute `scheme` to `basic_auth`. @@ -72,7 +72,7 @@ Steps To Enable External OpenSearch For example: -``` +```toml [global.v1.external.opensearch] enable = true nodes = ["http://opensearch1.example:10168", "http://opensearch2.example:10168", "..." ] diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/servicenow_incident_creation.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/servicenow_incident_creation.md index 7cc761cef7..23e496cbc8 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/servicenow_incident_creation.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/servicenow_incident_creation.md @@ -36,9 +36,9 @@ The Incident App generates a data stream of compliance events that you can lever * A running [Chef Automate](https://www.chef.io/automate/) instance. * Chef Automate has a valid SSL/TLS certificate from a trusted certificate authority (CA). -* A running [ServiceNow](https://www.servicenow.com/) instance. The supported ServiceNow versions are **Vancouver**, **Washington DC** and **Xanadu**. +* A running [ServiceNow](https://www.servicenow.com/) instance. The supported ServiceNow versions are **Xanadu** and **Yokohama**. * The ServiceNow instance is reachable on port 443. -* The ServiceNow instance should be compatible with **Vancouver**, **Washington DC** and **Xanadu** versions. +* The ServiceNow instance should be compatible with **Xanadu** and **Yokohama** versions. ## Install diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/servicenow_integration.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/servicenow_integration.md index c52633cf36..628189a2b6 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/servicenow_integration.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/servicenow_integration.md @@ -31,9 +31,9 @@ The Integration App works by exposing the REST API endpoints for communication b - A running [Chef Automate](https://www.chef.io/automate/) instance. - Chef Automate has a valid SSL/TLS certificate from a trusted certificate authority (CA). -- A running [ServiceNow](https://www.servicenow.com/) instance.* A running [ServiceNow](https://www.servicenow.com/) instance. The supported ServiceNow versions are **Vancouver**, **Washington DC** and **Xanadu**. +- A running [ServiceNow](https://www.servicenow.com/) instance.* A running [ServiceNow](https://www.servicenow.com/) instance. The supported ServiceNow versions are **Xanadu** and **Yokohama**. - The ServiceNow instance is reachable on port 443. -- The ServiceNow instance should be compatible with **Vancouver**, **Washington DC** and **Xanadu** versions. +- The ServiceNow instance should be compatible with **Xanadu** and **Yokohama** versions. ### Required ServiceNow Plugins diff --git a/_vendor/modules.txt b/_vendor/modules.txt index 6fce7128fe..c117c5edb6 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1,4 +1,4 @@ -# github.com/chef/automate/components/docs-chef-io v0.0.0-20250523162809-c04dcb15deda +# github.com/chef/automate/components/docs-chef-io v0.0.0-20250617123043-e9e3b2463824 # 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-20250523161510-a254ccc738ad # github.com/chef/chef-server/docs-chef-io v0.0.0-20250414141619-a0fb7ff68e94 diff --git a/go.mod b/go.mod index 90ca598182..58eef0a374 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-20250523162809-c04dcb15deda // indirect + github.com/chef/automate/components/docs-chef-io v0.0.0-20250617123043-e9e3b2463824 // indirect github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258 // indirect github.com/chef/chef-server/docs-chef-io v0.0.0-20250414141619-a0fb7ff68e94 // indirect github.com/chef/chef-workstation/docs-chef-io v0.0.0-20250522055454-8df8550a2503 // indirect diff --git a/go.sum b/go.sum index b2b9e41cfe..8f33733eba 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,5 @@ -github.com/chef/automate/components/docs-chef-io v0.0.0-20250523162809-c04dcb15deda h1:XooPMJHu/R5h4LjMGSWZ77xKaZHqtPPs7a/rDt8RuPc= -github.com/chef/automate/components/docs-chef-io v0.0.0-20250523162809-c04dcb15deda/go.mod h1:juvLC7Rt33YOCgJ5nnfl4rWZRAbSwqjTbWmcAoA0LtU= +github.com/chef/automate/components/docs-chef-io v0.0.0-20250617123043-e9e3b2463824 h1:K1jZj4ISjLOgvpGm42YrpdRHwbZQX5juZOXbwj5N+78= +github.com/chef/automate/components/docs-chef-io v0.0.0-20250617123043-e9e3b2463824/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-20250414141619-a0fb7ff68e94 h1:YpF+MQ2CQ0V/sOtGrTCxa+Lpd5J9iR6ADDkrdSMqtw0=