Skip to main content

On-Prem Deployment with Customer Managed Database


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.

This section will discuss deploying Chef Automate HA on-premise machines with a customer-managed database. Please see the On-Premises Prerequisites page and move ahead with the following sections of this page.


If SELinux is enabled, deployment with configure it to permissive (Usually in case of RHEL SELinux is enabled)
  • Before proceeding with deployment steps make sure to provision ,Click here to know more details.

  • See the steps here to run on bastion host to download the latest Automate CLI and Airgapped Bundle.

Generate Chef Automate config

  1. Generate the configuration file.

    sudo chef-automate config gen config.toml

    Click here to know more about generating config.

    You can also view the Sample Config.


    You can also generate config using the init-config-ha subcommand and to generate init config for existing infrastructure.

    chef-automate init-config-ha existing_infra


  1. Verify the configuration file.

    sudo chef-automate verify -c config.toml

    To know more about config verify, you can check Config Verify Doc page.

    Once the verification is successfully completed, then proceed with deployment, In case of failure, please fix the issue and re-run the verify command.

Steps to Deploy

The following command will run the deployment.

chef-automate deploy config.toml --airgap-bundle automate.aib

To skip verification in the deploy command, use --skip-verify flag

chef-automate deploy config.toml --airgap-bundle automate.aib --skip-verify

Verify Deployment

  1. Once the deployment is successful, get the consolidate status of the cluster.

     chef-automate status summary
  2. Get the service status from each node.

     chef-automate status
  3. Run the verification command.

     chef-automate verify
  4. Get the cluster information.

     chef-automate info

Check if Chef Automate UI is accessible by going to (Domain used for Chef Automate)

After successful deployment, proceed with the following:

  1. Create user and orgs, Click here to learn more about user and org creation
  2. Workstation setup, Click here to learn more about workstation setup
  3. Node bootstrapping, Click here to learn more about node bootstrapping.


A shared file system is always required to create OpenSearch snapshots. To register the snapshot repository using OpenSearch, it is necessary to mount the same shared filesystem to the exact location on all master and data nodes. To know more about the backup and restore configuration, see On-Premise Deployment using Filesystem or using Object Storage.

Add/Remove Nodes

The Chef Automate commands require some arguments so that it can determine which types of nodes you want to add or remove to/from your HA setup from your bastion host. To know more see Add Nodes to the Deployment to add nodes and Remove Single Node from Cluster to remove nodes.

Patch Configs

The bastion server can patch new configurations in all nodes. To know more see Patch Configuration section.

sample config to set up on-premises deployment with self managed services

    ssh_user = "ec2-user"
    ssh_group_name = "ec2-user"
    ssh_key_file = "/home/ec2-user/KEY_FILENAME.pem"
    ssh_port = "22"
    secrets_key_file = "/hab/a2_deploy_workspace/secrets.key"
    secrets_store_file = "/hab/a2_deploy_workspace/secrets.json"
    architecture = "existing_nodes"
    workspace_path = "/hab/a2_deploy_workspace"
    backup_mount = "/mnt/automate_backups"
    backup_config = "object_storage"
    bucket_name = "example-bucket"
    access_key = "JVS......."
    secret_key = "VIK........"
    endpoint = ""
    admin_password = "adminpassword"
    fqdn = ""
    config_file = "configs/automate.toml"
    root_ca = "-----BEGIN CERTIFICATE-----
    -----END CERTIFICATE-----"
    instance_count = "2"
    fqdn = ""
    lb_root_ca = "-----BEGIN CERTIFICATE-----
    -----END CERTIFICATE-----"
    instance_count = "2"
    instance_count = "0"
    instance_count = "0"
    automate_private_ips = ["", ""]
    chef_server_private_ips = ["", ""]
    type = "self-managed"
      instance_url = ""
      superuser_username = "superusername"
      superuser_password = "superuserpassowrd"
      dbuser_username = "databaseusername"
      dbuser_password = "databaseuserpassword"
      postgresql_root_cert = "-----BEGIN CERTIFICATE-----
      -----END CERTIFICATE-----"
      opensearch_domain_name = "opensearch-domain"
      opensearch_domain_url = ""
      opensearch_username = "opensearchusername"
      opensearch_user_password = "opensearchuserpassword;"
      opensearch_root_cert = "-----BEGIN CERTIFICATE-----
      -----END CERTIFICATE-----"

Uninstall Chef Automate HA

To uninstall Chef Automate HA instances after unsuccessful deployment, run the below command in your bastion host.

chef-automate cleanup --onprem-deployment
Edit this page on GitHub

Thank you for your feedback!


Search Results