Overview

Note

Chef Automate 4.10.1 released on 6th September 2023 includes improvements to the deployment and installation experience of Automate HA. Please read the blog to learn more about key improvements. Refer to the pre-requisites page (On-Premises, AWS) and plan your usage with your customer success manager or account manager.

Note

All the nodes will apply the Frontend patch/set wherever the PostgreSQL and OpenSearch changes will be used to only one cluster node.
After patching/setting any configuration, certain services will restart. The time required for your services to regain stability may vary depending on the amount of data stored in your system.

Warning

For certificate rotation, use the cert-rotate command instead of config patch. For more information, see certificate rotation.
While patching the same from the provision host, structures such as TLS from the OpenSearch configuration .toml file and SSL from the PostgreSQL configuration toml file will be ignored.

Show Configuration

Showing configuration in all nodes can be done from the bastion server using the below commands.

Show Configuration for Automate cluster

To show the configuration for Automate cluster, run the following command:

chef-automate config show --automate

chef-automate config show -a

chef-automate config show --a2

Show Configuration for Chef Server cluster

To show the configuration for the Chef Server cluster, run the following command:

chef-automate config show --chef_server

chef-automate config show -c

chef-automate config show --cs

Show Configuration for PostgreSQL cluster

To show the configuration for the PostgreSQL cluster, run the following command:

chef-automate config show --postgresql

chef-automate config show -p

chef-automate config show --pg

Show Configuration for OpenSearch cluster

To show the configuration for the OpenSearch cluster, run the following command:

chef-automate config show --opensearch

chef-automate config show -o

chef-automate config show --os

Patch Configuration

The bastion server can patch new configurations in all nodes using the commands below.

Patch Configuration for Frontend cluster

To patch configuration for the Frontend cluster (includes Automate and Chef Server), run the following command:

chef-automate config patch path/to/automate-config.toml --frontend

chef-automate config patch path/to/automate-config.toml -f

chef-automate config patch path/to/automate-config.toml --fe

Patch Configuration for Automate cluster

To patch the configuration for Automate cluster, run the following command:

chef-automate config patch path/to/automate-config.toml --automate

chef-automate config patch path/to/automate-config.toml -a

chef-automate config patch path/to/automate-config.toml --a2

Patch Configuration for Chef Server cluster

To patch the configuration for the Chef Server cluster, run the following command:

chef-automate config patch path/to/chef_server-config.toml --chef_server

chef-automate config patch path/to/chef_server-config.toml -c

chef-automate config patch path/to/chef_server-config.toml --cs

Patch Configuration for PostgreSQL cluster

For Information on PostgreSQL node configs visit links below:

To know more about PostgreSQL node configs, see HA PostgreSQL Node Config page.

To patch the configuration for the PostgreSQL cluster, run the following command:

chef-automate config patch path/to/postgresql-config.toml --postgresql

chef-automate config patch path/to/postgresql-config.toml -p

chef-automate config patch path/to/postgresql-config.toml --pg

Patch Configuration for OpenSearch cluster

For Information on OpenSearch node configs visit links below:

To know more about OpenSearch node configs, see HA OpenSearch Node Config page.

To patch the configuration for the OpenSearch cluster, run the following command:

chef-automate config patch path/to/opensearch-config.toml --opensearch

chef-automate config patch path/to/opensearch-config.toml -o

chef-automate config patch path/to/opensearch-config.toml --os

Set Configuration

Setting new configurations in all nodes can be done from the bastion server using the below commands.

Set Configuration for Automate cluster

To set the configuration for Automate cluster, run the following command:

chef-automate config set path/to/automate-config.toml --automate

chef-automate config set path/to/automate-config.toml -a

chef-automate config set path/to/automate-config.toml --a2

Set Configuration for Chef Server cluster

To set the configuration for the Chef Server cluster, run the following command:

chef-automate config set path/to/chef_server-config.toml --chef_server

chef-automate config set path/to/chef_server-config.toml -c

chef-automate config set path/to/chef_server-config.toml --cs

Set Configuration for PostgreSQL cluster

For Information on PostgreSQL node configs visit links below:

To know more about PostgreSQL node configs, see HA PostgreSQL Node Config page.

To set the configuration for the PostgreSQL cluster, run the following command:

chef-automate config set path/to/postgresql-config.toml --postgresql

chef-automate config set path/to/postgresql-config.toml -p

chef-automate config set path/to/postgresql-config.toml --pg

Set Configuration for OpenSearch cluster

For Information on OpenSearch node configs visit links below:

To know more about OpenSearch node configs, see HA OpenSearch Node Config page.

To set the configuration for the OpenSearch cluster, run the following command:

chef-automate config set path/to/opensearch-config.toml --opensearch

chef-automate config set path/to/opensearch-config.toml -o

chef-automate config set path/to/opensearch-config.toml --os

How to patch max shards per node for opensearch

To configure OpenSearch max shard per node, create a TOML file that contains the partial configuration below. Change max_shards_per_node as needed, and then run command to apply change.

[cluster]
  max_shards_per_node = "2000"