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 6a4ec89e6f..4543ab1c8b 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 @@ -102,6 +102,17 @@ Follow the steps below when migrating to On-Premises or AWS HA deployment **(but password = "admin" ``` + From Automate **4.x.y** version onwards, Postgresql credentials are not stored in the `config`. Add the Postgresql password to the generated config above. For example: + + ```bash + [global.v1.external.postgresql.auth.password.superuser] + username = "admin" + password = "admin" + [global.v1.external.postgresql.auth.password.dbuser] + username = "admin" + password = "admin" + ``` + {{< warning >}} {{% automate/char-warn %}} {{< /warning >}} @@ -205,6 +216,17 @@ Follow the steps below when migrating to On-Premises or Cloud HA deployment **(b password = "admin" ``` + From Automate **4.x.y** version onwards, Postgresql credentials are not stored in the `config`. Add the Postgresql password to the generated config above. For example: + + ```bash + [global.v1.external.postgresql.auth.password.superuser] + username = "admin" + password = "admin" + [global.v1.external.postgresql.auth.password.dbuser] + username = "admin" + password = "admin" + ``` + {{< warning >}} {{% automate/char-warn %}} {{< /warning >}} @@ -376,6 +398,17 @@ For AWS managed services, map the snapshot role to the OpenSearch dashboard. It password = "admin" ``` + From Automate **4.x.y** version onwards, Postgresql credentials are not stored in the `config`. Add the Postgresql password to the generated config above. For example: + + ```bash + [global.v1.external.postgresql.auth.password.superuser] + username = "admin" + password = "admin" + [global.v1.external.postgresql.auth.password.dbuser] + username = "admin" + password = "admin" + ``` + {{< warning >}} {{% automate/char-warn %}} {{< /warning >}} diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_aws_efs.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_aws_efs.md index 7c2674adfa..43609a4bc0 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_aws_efs.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_aws_efs.md @@ -121,7 +121,18 @@ Configure the OpenSearch `path.repo` attribute. chef-automate backup create ``` -### Restoring the EFS Backed-up Data +### Restore + +#### Pre-Restore Validation + +Run the restore command with the --verify-restore-config flag to validate the configuration settings before initiating the restore process. +To perform the pre-check, run the following command from the bastion host: + +`chef-automate backup restore --yes -b /mnt/automate_backups/backups --verify-restore-config` + +The verification process ensures that the backup and restore configurations are correct and identifies potential issues so they can be addressed in advance. + +#### Run Restore To restore backed-up data of the Chef Automate High Availability (HA) using External File System (EFS), follow the steps given below: diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_aws_s3.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_aws_s3.md index 94b5b8489b..3c3cdcc21c 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_aws_s3.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_aws_s3.md @@ -140,13 +140,24 @@ In case of if you are using the Managed AWS Service you need to create a [snapsh ### Restore +#### Pre-Restore Validation + +Run the restore command with the --verify-restore-config flag to validate the configuration settings before initiating the restore process. +To perform the pre-check, run the following command from the bastion host: + +`chef-automate backup restore s3://bucket_name/path_to_backups/BACKUP_ID --verify-restore-config` + +The verification process ensures that the backup and restore configurations are correct and identifies potential issues so they can be addressed in advance. + +#### Run Restore + To restore backed-up data of the Chef Automate High Availability (HA) using External AWS S3, follow the steps given below: - Check the status of all Chef Automate and Chef Infra Server front-end nodes by executing the `chef-automate status` command. - Log in to the same instance of Chef Automate front-end node from which backup is taken. -- Execute the restore command from bastion `chef-automate backup restore s3://bucket_name/path/to/backups/BACKUP_ID --skip-preflight --s3-access-key "Access_Key" --s3-secret-key "Secret_Key"`. +- Execute the restore command from bastion `chef-automate backup restore s3://bucket_name/path_to_backups/BACKUP_ID --skip-preflight --s3-access-key "Access_Key" --s3-secret-key "Secret_Key"`. - In case of Airgapped Environment, Execute this restore command from bastion `chef-automate backup restore /backups/BACKUP_ID --airgap-bundle --skip-preflight`. 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 b6f12658eb..adc489654e 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 @@ -129,6 +129,17 @@ chef-automate backup create ### Restore +#### Pre-Restore Validation + +Run the restore command with the --verify-restore-config flag to validate the configuration settings before initiating the restore process. +To perform the pre-check, run the following command from the bastion host: + +`chef-automate backup restore --yes -b /mnt/automate_backups/backups --verify-restore-config` + +The verification process ensures that the backup and restore configurations are correct and identifies potential issues so they can be addressed in advance. + +#### Run Restore + To restore backed-up data of the Chef Automate High Availability (HA) using External File System (EFS), follow the steps given below: - Check the status of Automate HA Cluster from the bastion nodes by executing the `chef-automate status` command. diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_object_storage.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_object_storage.md index 71ee213ff1..2a8a01be6b 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_object_storage.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_backup_restore_object_storage.md @@ -302,6 +302,17 @@ chef-automate backup create ### Restore +#### Pre-Restore Validation + +Run the restore command with the --verify-restore-config flag to validate the configuration settings before initiating the restore process. +To perform the pre-check, run the following command from the bastion host: + +`chef-automate backup restore s3://bucket_name/path_to_backups/BACKUP_ID --verify-restore-config` + +The verification process ensures that the backup and restore configurations are correct and identifies potential issues so they can be addressed in advance. + +#### Run Restore + Restore a backup from external object storage. 1. Check the status of the Automate HA cluster from the bastion host. @@ -315,7 +326,7 @@ Restore a backup from external object storage. For S3: ```sh - chef-automate backup restore s3://BUCKET_NAME/PATH/TO/BACKUPS/BACKUP_ID --skip-preflight --s3-access-key "ACCESS_KEY" --s3-secret-key "SECRET_KEY" + chef-automate backup restore s3://BUCKET_NAME/PATH_TO_BACKUPS/BACKUP_ID --skip-preflight --s3-access-key "ACCESS_KEY" --s3-secret-key "SECRET_KEY" ``` For GCS: diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_existing_a2ha_to_automate_ha.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_existing_a2ha_to_automate_ha.md index 72843f8377..1ec616e01a 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_existing_a2ha_to_automate_ha.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_existing_a2ha_to_automate_ha.md @@ -96,7 +96,7 @@ done sudo chef-automate stop ``` -1. Add the OpenSearch credentials to the applied config. +1. Add the OpenSearch/Postgresql credentials to the applied config. - If using Chef Managed OpenSearch, add the config below into `current_config.toml` (unless you have changed the credentials). @@ -106,6 +106,17 @@ done password = "admin" ``` + - If using Chef Managed Postgresql, add the config below into `current_config.toml` (unless you have changed the credentials). + + ```bash + [global.v1.external.postgresql.auth.password.superuser] + username = "admin" + password = "admin" + [global.v1.external.postgresql.auth.password.dbuser] + username = "admin" + password = "admin" + ``` + - In case `backup_config = "file_system"` had been provided in config.toml of Automate HA deployment, then please patch the below OpenSearch config from bastion before starting the restore. - Create a toml (say os_config.toml) file from **provision host** and copy the following template with the path to the repo. Update the repo path, what you have created at the time of deployment ``. diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_inplace_migration.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_inplace_migration.md index e2c6bf5131..b447e9752c 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_inplace_migration.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/ha_inplace_migration.md @@ -157,6 +157,12 @@ Find the following config in the **current_config.toml** file and update it to l [global.v1.external.opensearch.auth.basic_auth] username = "admin" password = "admin" +[global.v1.external.postgresql.auth.password.superuser] + username = "admin" + password = "admin" +[global.v1.external.postgresql.auth.password.dbuser] + username = "admin" + password = "admin" ``` AND diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/reusable/md/restore_troubleshooting.md b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/reusable/md/restore_troubleshooting.md index 778dcda8ee..83ad614f52 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/reusable/md/restore_troubleshooting.md +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/content/automate/reusable/md/restore_troubleshooting.md @@ -1,4 +1,4 @@ -Try these steps if Chef Automate returns an error while restoring data. +Follow the steps below if Chef Automate encounters an error during data restoration. 1. Check the Chef Automate status. @@ -6,26 +6,28 @@ Try these steps if Chef Automate returns an error while restoring data. chef-automate status ``` -1. Check the status of your Habitat service on the Automate node. +2. Check the status of your Habitat service on the Automate node. ```sh hab svc status ``` -1. If the deployment services are not healthy, reload them. +3. If the deployment services are not healthy, reload them. ```sh hab svc load chef/deployment-service ``` -Now check the status of the Automate node and then try running the restore command from the bastion host. +4. Check the status of the Automate node, and then attempt to run the restore command from the bastion host. -1. How to change the `base_path` or `path`. The steps for the File System backup are as shown below: +5. To change the `base_path` or `path`, follow the steps below for performing a backup. - - While at the time of deployment `backup_mount` default value will be `/mnt/automate_backups` - - In case, if you modify the `backup_mount` in `config.toml` before deployment, then the deployment process will do the configuration with the updated value - - In case, you changed the `backup_mount` value post-deployment, then we need to patch the configuration manually to all the frontend and backend nodes, for example, if you change the `backup_mount` to `/bkp/backps` - - Update the FE nodes with the below template, use the command `chef-automate config patch fe.toml --fe` + * File System + + * During deployment, the `backup_mount` is default set to `/mnt/automate_backups`. + * The deployment process will automatically apply the updated path if you update the `backup_mount` value in the `config.toml` file before deployment. + * If the `backup_mount` value is changed after deployment (e.g., to /bkp/backps), you must manually patch the configuration on all frontend and backend nodes. + * Update the FE nodes using the template below. To update the configuration, use the command `chef-automate config patch fe.toml --fe`. ```sh [global.v1.backups] @@ -36,22 +38,22 @@ Now check the status of the Automate node and then try running the restore comma path = "/bkp/backps" ``` - - Update the OpenSearch node with the below template, use the command `chef-automate config patch os.toml --os` + * Update the OpenSearch nodes using the template provided below. Use the `chef-automate config patch os.toml --os` command to update the Opensearch node configs. ```sh [path] repo = "/bkp/backps" ``` - - Run the curl request to one of the automate frontend node + * Run the curl request against one of the Automate frontend nodes. ```sh curl localhost:10144/_snapshot?pretty ``` - - If the response is empty `{}`, then we are good + * If the response is an empty JSON object `{}`, no changes are required to the snapshot settings in the OpenSearch cluster. - - If the response has json output, then it should have correct value for the `backup_mount`, refer the `location` value in the response. It should start with the `/bkp/backps` + * If you see a JSON response similar to the example below, check that the `backup_mount` setting is correctly configured. Use the `location` value in the response to verify. It should start with `/bkp/backps`. ```sh { @@ -82,7 +84,7 @@ Now check the status of the Automate node and then try running the restore comma } ``` - - If the pre string in the `location` is not match with `backup_mount`, then we need to to delete the existing snapshots. use below script to delete the snapshot from the one of the automate frontend node. + * If the prefix in the `location` value does not match the `backup_mount`, the existing snapshots must be deleted. Use the script below to delete the snapshots from the one of the Automate frontend nodes. ```sh snapshot=$(curl -XGET http://localhost:10144/_snapshot?pretty | jq 'keys[]') @@ -92,7 +94,7 @@ Now check the status of the Automate node and then try running the restore comma done ``` - - The above scritp requires the `jq` needs to be installed, You can install from the airgap bundle, please use command on the one of the automate frontend node to locate the `jq` package. + * The above script requires `jq` to be installed, You can install it from the airgap bundle. To locate the `jq` package, run the command below on one of the Automate frontend nodes. ```sh ls -ltrh /hab/cache/artifacts/ | grep jq @@ -101,16 +103,16 @@ Now check the status of the Automate node and then try running the restore comma -rw-r--r--. 1 ec2-user ec2-user 730K Dec 8 08:55 core-jq-static-1.6-20190703002933-x86_64-linux.hart ``` - - In case of multiple `jq` version, then install the latest one. use the below command to install the `jq` package to the automate frontend node + * If multiple versions of `jq` are available, install the latest one. Use the command below to install the `jq` package on one of the Automate frontend nodes. ```sh hab pkg install /hab/cache/artifacts/core-jq-static-1.6-20190703002933-x86_64-linux.hart -bf ``` -1. Below steps for object storage as a backup option + * Object Storage - - While at the time of deployment `backup_config` will be `object_storage` - - To use the `object_storage`, we are using below template at the time of deployment + * During deployment, the `backup_config` should be set to `object_storage`. + * To use `object_storage`, we use the following template during deployment. ```sh [object_storage.config] @@ -123,8 +125,8 @@ Now check the status of the Automate node and then try running the restore comma region = "" ``` - - If you configured pre deployment, then we are good - - If you want to change the `bucket` or `base_path`, then use the below template for Frontend nodes + * If you configured it before deployment, then you are all set. + * If you want to change the `bucket` or `base_path`, use the following template for Frontend nodes. ```sh [global.v1] @@ -136,17 +138,17 @@ Now check the status of the Automate node and then try running the restore comma base_path = "automate" ``` - - You can choose any value for the variable `base_path`. `base_path` patch is only required for the frontend node. - - Use the command to apply the above template `chef-automate config patch frontend.toml --fe` - - Post the configuration patch, and use the curl request to validate + * You can assign any value to the `base_path` variable. The `base_path` configuration is required only for the Frontend nodes. + * Use the command `chef-automate config patch frontend.toml --fe` to apply the above template and update the configuration. + * Use the following curl request to validate the configuration. ```sh curl localhost:10144/_snapshot?pretty ``` - - If the response is empty `{}`, then we are good + * If the response is an empty JSON object ({}), the configuration is valid. - - If the response has JSON output, then it should have the correct value for the `base_path` + * If the response contains a JSON output similar to the example below, it should have the correct value for the `base_path`. ```sh { @@ -189,4 +191,4 @@ Now check the status of the Automate node and then try running the restore comma } ``` - - In case of `base_path` value is not matching, then we have to delete the existing `snapshot`. please refer to the steps from the file system. + * If the `base_path` value does not match, you must delete the existing snapshots. Please take a look at the File System troubleshooting steps for guidance. diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/data/automate/cli_chef_automate/commands/chef-automate.yaml b/_vendor/github.com/chef/automate/components/docs-chef-io/data/automate/cli_chef_automate/commands/chef-automate.yaml index bd48239a6b..14affab04e 100644 --- a/_vendor/github.com/chef/automate/components/docs-chef-io/data/automate/cli_chef_automate/commands/chef-automate.yaml +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/data/automate/cli_chef_automate/commands/chef-automate.yaml @@ -41,6 +41,7 @@ see_also: - migrate-from-v1 - Migrate from Chef Automate v1 - migrate-from-v1-status - Watch the status of the migration to Chef Automate 2 - node - This command is used to add or delete HA nodes + - notice - Provides notice information - post-major-upgrade - Utilities for post-major-upgrade - preflight-check - Perform preflight check - provision-infra - Provision Automate HA infra. diff --git a/_vendor/github.com/chef/automate/components/docs-chef-io/data/automate/cli_chef_automate/commands/chef-automate_notice.yaml b/_vendor/github.com/chef/automate/components/docs-chef-io/data/automate/cli_chef_automate/commands/chef-automate_notice.yaml new file mode 100644 index 0000000000..9c1f66c537 --- /dev/null +++ b/_vendor/github.com/chef/automate/components/docs-chef-io/data/automate/cli_chef_automate/commands/chef-automate_notice.yaml @@ -0,0 +1,23 @@ +name: chef-automate notice +synopsis: Provides notice information +usage: chef-automate notice [flags] +description: | + Creates a notice.txt file with the open source notices for all dependencies. +options: + - name: help + shorthand: h + default_value: "false" + usage: help for notice +inherited_options: + - name: debug + shorthand: d + default_value: "false" + usage: Enable debug output + - name: no-check-version + default_value: "false" + usage: Disable version check + - name: result-json + usage: Write command result as JSON to PATH +see_also: + - chef-automate - Chef Automate CLI +supported_on: Bastion diff --git a/_vendor/modules.txt b/_vendor/modules.txt index 4d039af08a..d4de0701cd 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1,4 +1,4 @@ -# github.com/chef/automate/components/docs-chef-io v0.0.0-20250617123043-e9e3b2463824 +# github.com/chef/automate/components/docs-chef-io v0.0.0-20250902130712-4abbca2f9c80 # 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-20250703193412-93daafc684a8 # github.com/habitat-sh/on-prem-builder/docs-chef-io v0.0.0-20250805192817-f8b1dae05d5e diff --git a/go.mod b/go.mod index 86ed4f842c..7c2abd7056 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/chef/chef-web-docs go 1.23 require ( - github.com/chef/automate/components/docs-chef-io v0.0.0-20250617123043-e9e3b2463824 // indirect + github.com/chef/automate/components/docs-chef-io v0.0.0-20250902130712-4abbca2f9c80 // indirect github.com/chef/chef-docs-theme v0.0.0-20250808212116-563fde1a25bc // indirect github.com/chef/chef-server/docs-chef-io v0.0.0-20250829012113-e4bd9ba4c0bd // indirect github.com/chef/chef-workstation/docs-chef-io v0.0.0-20250718131033-13973a5c0863 // indirect diff --git a/go.sum b/go.sum index d20060d6b0..3ababc083b 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,7 @@ 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/automate/components/docs-chef-io v0.0.0-20250902130712-4abbca2f9c80 h1:JQEuqGaOg0DgvwbMwbMSzEiqcxPa14flEo9TKmPDSnU= +github.com/chef/automate/components/docs-chef-io v0.0.0-20250902130712-4abbca2f9c80/go.mod h1:juvLC7Rt33YOCgJ5nnfl4rWZRAbSwqjTbWmcAoA0LtU= github.com/chef/chef-docs-theme v0.0.0-20250808212116-563fde1a25bc h1:QwjE9YnoY01CkGNOjdZup9tudvM0iq19IA3VHzIGmZg= github.com/chef/chef-docs-theme v0.0.0-20250808212116-563fde1a25bc/go.mod h1:+Jpnv+LXE6dXu2xDcMzMc0RxRGuCPAoFxq5tJ/X6QpQ= github.com/chef/chef-server/docs-chef-io v0.0.0-20250829012113-e4bd9ba4c0bd h1:h4LEzg1X9xW9S/2jPgoXQhQqTTDe60yrM6HN5vDTJ6I=