diff --git a/content/automate/airgapped_installation.md b/content/automate/airgapped_installation.md index 5c950dc73..5c319736d 100644 --- a/content/automate/airgapped_installation.md +++ b/content/automate/airgapped_installation.md @@ -29,21 +29,23 @@ To get a trial license for an airgapped host [contact Chef](https://www.chef.io/ Download the Chef Automate command-line tool from the `current` [release channel]({{< relref "install.md#release-channels" >}}). ```shell -curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate +curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` +Replace `` with your Progress Chef commercial license ID. + ## Download the Airgap Installation Bundle Download the airgap installation bundles of the latest automate version to an internet-connected machine using: ```shell -curl https://packages.chef.io/airgap_bundle/current/automate/latest.aib -o +curl "https://packages.chef.io/airgap_bundle/current/automate/latest.aib" -o ``` Download the bundle of a specific version using: ```shell -curl https://packages.chef.io/airgap_bundle/current/automate/.aib -o +curl "https://packages.chef.io/airgap_bundle/current/automate/.aib" -o ``` {{< note >}} Chef Automate bundles are available for 365 days from the release of a version. However, the milestone release bundles are available for download forever.{{< /note >}} diff --git a/content/automate/configuration.md b/content/automate/configuration.md index 8aa081a54..92bc617a1 100644 --- a/content/automate/configuration.md +++ b/content/automate/configuration.md @@ -171,6 +171,8 @@ Then run `chef-automate config patch ` to deploy your c Chef Automate must be able to access the following: +* `chefdownload-commercial.chef.io` +* `chefdownload-community.chef.io` * `packages.chef.io` * `licensing.chef.io` * `raw.githubusercontent.com` diff --git a/content/automate/get_started.md b/content/automate/get_started.md index b1be99459..19b782253 100644 --- a/content/automate/get_started.md +++ b/content/automate/get_started.md @@ -1,5 +1,5 @@ +++ -title = "Get Started with Chef Automate" +title = "Get started with Chef Automate" weight = 10 draft = false @@ -8,139 +8,136 @@ draft = false [menu] [menu.automate] - title = "Get Started Tutorial" + title = "Get started tutorial" parent = "automate/getting_started" identifier = "automate/getting_started/" weight = 10 +++ -Hello and welcome to Chef Automate! This Quickstart guides you through the initial installation and trial activation. +This quickstart guides you through the initial installation and trial activation. The easiest way to start exploring Chef Automate is to install it on a local virtual machine (VM). -This [Vagrant](https://www.vagrantup.com/) file will help you create your own test environment. +Use this [Vagrant](https://www.vagrantup.com/) file to create your own test environment. ## Prerequisites For this demonstration, you need: -* Administrator (root) access to your system -* A virtualization product such as [VirtualBox](https://www.virtualbox.org/) installed on your system -* [Vagrant](https://www.vagrantup.com/intro/getting-started/) installed on your system -* 8GB RAM, or more, available for the VM - -## Quickstart Overview - -Use the command line script below to create a demonstration instance of Chef Automate. -The script is mostly automated, but it does require a few manual steps. -By installing Chef Automate with the Vagrantfile provided below you're automatically consenting to Chef Software, Inc.'s [Terms of Service](https://www.chef.io/terms-of-service) and [Master License and Services Agreement](https://www.chef.io/online-master-agreement) - -## Create a Vagrantfile - -Copy and paste this script into your command line to create the Chef Automate `Vagrantfile`: - -```ruby -cat > Vagrantfile <<'EOH' -CFG_BOX = 'bento/ubuntu-18.04' -CFG_IP = '192.168.33.199' -CFG_HOSTNAME = 'chef-automate.test' - -$deployscript = <<-SCRIPT -export DEBIAN_FRONTEND='noninteractive' -apt-get -qq update -apt-get install -y --no-install-recommends curl unzip -apt-get clean -sysctl -w vm.max_map_count=262144 -sysctl -w vm.dirty_expire_centisecs=20000 -echo "${CFG_IP} ${CFG_HOSTNAME}" | tee -a /etc/hosts -curl -fsSL https://packages.chef.io/files/current/automate/latest/chef-automate_linux_amd64.zip -o /tmp/chef-automate_linux_amd64.zip -unzip -qod /usr/local/bin /tmp/chef-automate_linux_amd64.zip -chmod +x /usr/local/bin/chef-automate -chef-automate deploy --accept-terms-and-mlsa -echo "Server is up and running. Please log in at https://${CFG_HOSTNAME}/" -echo 'You may log in using credentials provided below:' -cat /home/vagrant/automate-credentials.toml -SCRIPT - -Vagrant.configure(2) do |config| - class AcceptLicense - def to_s - return 'true' if ENV['ACCEPT_CHEF_TERMS_AND_MLSA'] == 'true' - puts < Vagrantfile <<'EOH' + CFG_BOX = 'bento/ubuntu-18.04' + CFG_IP = '192.168.33.199' + CFG_HOSTNAME = 'chef-automate.test' + + $deployscript = <<-SCRIPT + export DEBIAN_FRONTEND='noninteractive' + apt-get -qq update + apt-get install -y --no-install-recommends curl unzip + apt-get clean + sysctl -w vm.max_map_count=262144 + sysctl -w vm.dirty_expire_centisecs=20000 + echo "${CFG_IP} ${CFG_HOSTNAME}" | tee -a /etc/hosts + curl -fsSL "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o /usr/local/bin/chef-automate + chmod +x /usr/local/bin/chef-automate + chef-automate deploy --accept-terms-and-mlsa + echo "Server is up and running. Please log in at https://${CFG_HOSTNAME}/" + echo 'You may log in using credentials provided below:' + cat /home/vagrant/automate-credentials.toml + SCRIPT + + Vagrant.configure(2) do |config| + class AcceptLicense + def to_s + return 'true' if ENV['ACCEPT_CHEF_TERMS_AND_MLSA'] == 'true' + puts < CFG_IP, - 'CFG_HOSTNAME' => CFG_HOSTNAME, - 'ACCEPT_CHEF_TERMS_AND_MLSA' => AcceptLicense.new}, inline: $deployscript -end -EOH -``` + config.vm.synced_folder '.', '/opt/a2-testing', create: true + config.vm.network 'private_network', ip: CFG_IP + config.vm.provision 'shell', env: {'CFG_IP' => CFG_IP, + 'CFG_HOSTNAME' => CFG_HOSTNAME, + 'ACCEPT_CHEF_TERMS_AND_MLSA' => AcceptLicense.new}, inline: $deployscript + end + EOH + ``` -## Add an entry to /etc/hosts + Replace `` in the Vagrantfile with your commercial license ID before you run it. -The example Vagrantfile sets the VM hostname to `chef-automate.test`. The installer uses this hostname as the FQDN that Chef Automate listens on. -For security reasons, you must access Chef Automate with the configured FQDN. -To avoid configuring DNS for your test instance, add an entry to your workstation's `/etc/hosts` file. -Use the following command to append the required entry: +1. Add an entry to `/etc/hosts`. -```bash -echo 192.168.33.199 chef-automate.test | sudo tee -a /etc/hosts -``` + The example Vagrantfile sets the VM hostname to `chef-automate.test`. The installer uses this hostname as the FQDN that Chef Automate listens on. + For security reasons, you must access Chef Automate with the configured FQDN. + To avoid configuring DNS for your test instance, add an entry to your workstation's `/etc/hosts` file. + Use the following command to append the required entry: -## Start the Virtual Machine + ```bash + echo 192.168.33.199 chef-automate.test | sudo tee -a /etc/hosts + ``` -Now that you have the `Vagrantfile` in your current directory, provision a new VM by running: +1. Start the virtual machine by running: -```bash -vagrant up -``` + ```bash + vagrant up + ``` -Downloading the base OS image for the VM takes 1 to 3 minutes the first time you set up Chef Automate. + Downloading the base OS image for the VM takes 1 to 3 minutes the first time you set up Chef Automate. -When the command completes, you can access the Chef Automate by browsing to `https://chef-automate.test/`. + When the command completes, you can access Chef Automate by going to `https://chef-automate.test/`. -You can find login credentials by opening the `automate-credentials.toml`, which the installer has written in your current working directory, or in the output log. + You can find login credentials by opening `automate-credentials.toml`, which the installer writes in your current working directory, or in the output log. -## Start a free 60-day Trial +## Start a free 60-day trial -Retrieving a trial license through Chef Automate requires the Vagrant instance to have internet connectivity (at the time of trial license creation only). +Getting a trial license through Chef Automate requires the Vagrant instance to have internet connectivity when you create the trial license. -1. Sign into Chef Automate at `https://chef-automate.test/` with the credentials in the `automate-credentials.toml` file. -1. Follow the instructions in the welcome screen to get a 60-day trial license by entering your name and email address. +1. Sign in to Chef Automate at `https://chef-automate.test/` with the credentials in the `automate-credentials.toml` file. +1. Follow the instructions on the welcome screen to get a 60-day trial license by entering your name and email address. -## Installing without Vagrant +## Install without Vagrant You can install Chef Automate on any x86_64 Linux instance running CentOS 7.5, RHEL 7.5, or Ubuntu 16.04 with the following minimum system resources: -* 4 CPU -* 16 GB RAM -* 5 GB free disk space +- 4 CPU +- 16 GB RAM +- 5 GB free disk space -Follow the [Installation Guide]({{< relref "install.md" >}}) to install Chef Automate on your own resources. +Follow the [installation guide]({{< relref "install.md" >}}) to install Chef Automate on your own resources. diff --git a/content/automate/ha_aws_deploy_steps.md b/content/automate/ha_aws_deploy_steps.md index ec52761a6..eec9b1061 100644 --- a/content/automate/ha_aws_deploy_steps.md +++ b/content/automate/ha_aws_deploy_steps.md @@ -42,12 +42,11 @@ Run the following steps on Bastion Host Machine: #Run commands as sudo. sudo -- sh -c " #Download Chef Automate CLI. - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip \ - | gunzip - > chef-automate && chmod +x chef-automate \ - | cp -f chef-automate /usr/bin/chef-automate + curl \"https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=\" \ + -o /usr/bin/chef-automate && chmod +x /usr/bin/chef-automate #Download the latest Airgapped Bundle. #To download specific version bundle, example version: 4.2.59 then replace latest.aib with 4.2.59.aib - curl https://packages.chef.io/airgap_bundle/current/automate/latest.aib -o automate.aib + curl \"https://packages.chef.io/airgap_bundle/current/automate/latest.aib\" -o automate.aib " ``` diff --git a/content/automate/ha_aws_managed_deploy_steps.md b/content/automate/ha_aws_managed_deploy_steps.md index 5c559afcf..b2e7a3a73 100644 --- a/content/automate/ha_aws_managed_deploy_steps.md +++ b/content/automate/ha_aws_managed_deploy_steps.md @@ -10,7 +10,7 @@ draft = false weight = 240 +++ -Follow the steps below to deploy Chef Automate High Availability (HA) on AWS (Amazon Web Services) cloud with Managed AWS Services. Please see the [AWS Deployment Prerequisites](/automate/ha_aws_deployment_prerequisites/) page and move ahead with the following sections of this page. +Follow these steps to deploy Chef Automate High Availability (HA) on AWS (Amazon Web Services) with AWS Managed Services. See the [AWS Deployment Prerequisites](/automate/ha_aws_deployment_prerequisites/) page before you continue. {{< warning >}} @@ -22,30 +22,35 @@ Follow the steps below to deploy Chef Automate High Availability (HA) on AWS (Am {{< /warning >}} -## Run these steps on Bastion Host Machine +## Install the Chef Automate CLI and air-gapped bundle -1. Run the below commands to download the latest Automate CLI and Airgapped Bundle: + - ```bash - #Run commands as sudo. - sudo -- sh -c " - #Download Chef Automate CLI. - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip \ - | gunzip - > chef-automate && chmod +x chef-automate \ - | cp -f chef-automate /usr/bin/chef-automate - #Download the latest Airgapped Bundle. - #To download specific version bundle, example version: 4.2.59 then replace latest.aib with 4.2.59.aib - curl https://packages.chef.io/airgap_bundle/current/automate/latest.aib -o automate.aib - " - ``` +1. On the bastion host, install the Chef Automate CLI and the air-gapped bundle: - {{< note spaces=3 >}} + ```bash + sudo -- sh -c " + # Download Chef Automate CLI. + curl \"https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=\" \ + -o /usr/bin/chef-automate && chmod +x /usr/bin/chef-automate + + # Download the air-gapped bundle. + curl \"https://packages.chef.io/airgap_bundle/current/automate/.aib\" -o automate.aib + " + ``` + + Replace the following values: + + - `` with your commercial license ID. + - `` with the version of the air-gapped bundle you want to install. Use `latest` for the latest version, or specify a version number, for example, `4.2.59`. - Chef Automate bundles are available for 365 days from the release of a version. However, the milestone release bundles are available for download forever. + {{< note >}} + + Chef Automate bundles are available for 365 days after a version is released. Milestone release bundles remain available indefinitely. - {{< /note >}} + {{< /note >}} -## Steps to Generate Config +## Generate the Chef Automate config 1. Generate config with relevant data using the below command: @@ -53,7 +58,7 @@ Follow the steps below to deploy Chef Automate High Availability (HA) on AWS (Am chef-automate config gen config.toml ``` - To know more about on how to generate config, refer to the [Automate HA Config Generation](/automate/ha_config_gen) page. + For more information, see the [Chef Automate HA config generation documentation](/automate/ha_config_gen). {{< note >}} @@ -67,7 +72,7 @@ Follow the steps below to deploy Chef Automate High Availability (HA) on AWS (Am {{< readfile file="content/automate/reusable/md/password_character_warning.md" >}} -## Steps to Provision +## Provision Chef Automate 1. Continue with the deployment after generating the config: @@ -81,7 +86,7 @@ Once the provisioning is successful, **if you have added custom DNS to your conf {{< /note >}} -## Config Verify +## Verify the Chef Automate configuration ### Prerequisites diff --git a/content/automate/ha_chef_backend_to_automate_ha.md b/content/automate/ha_chef_backend_to_automate_ha.md index 9fac698ad..f23b22212 100644 --- a/content/automate/ha_chef_backend_to_automate_ha.md +++ b/content/automate/ha_chef_backend_to_automate_ha.md @@ -184,47 +184,51 @@ Where: bash infra_server_objects_count_collector.sh -S -K /path/to/key -F Filename ``` -## Steps for In-place Migration +## Migrate from Chef Backend to Chef Automate in place -1. [Backup the existing chef server data](/automate/ha_chef_backend_to_automate_ha/##backup-the-existing-chef-infra-server-or-chef-backend-data) -2. ssh to all the backend nodes of chef-backend and run +1. [Back up the existing Chef Infra Server data](/automate/ha_chef_backend_to_automate_ha/##backup-the-existing-chef-infra-server-or-chef-backend-data) +2. SSH to each Chef Backend backend node and run the following command to stop the services: - ```sh - chef-backend-ctl stop + ```bash + chef-backend-ctl stop ``` -3. ssh to all frontend nodes of chef-backend and run +3. SSH to each Chef Backend frontend node and run the following command to stop the services: - ```sh - chef-server-ctl stop + ```bash + chef-server-ctl stop ``` -4. Create one bastion machine under the same network space. -5. ssh to bastion machine and download chef-automate CLI and extract the downloaded zip file +4. Create one bastion host under the same network space. +5. SSH to the bastion host and download the Chef Automate CLI: - ```sh - https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate | cp -f chef-automate /usr/bin/chef-automate + ```bash + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o /usr/bin/chef-automate && chmod +x /usr/bin/chef-automate ``` -6. Create an airgap bundle using the command + Replace `` with your Progress Chef commercial license ID. - ```sh - ./chef-automate airgap bundle create +6. Create an air-gapped bundle on the bastion host: + + ```bash + ./chef-automate airgap bundle create ``` -7. Generate the `config.toml` file using the following command: +7. Generate the `config.toml` file: - ```sh - ./chef-automate init-config-ha existing_infra + ```bash + ./chef-automate init-config-ha existing_infra ``` -8. Edit `config.toml` and add the following: - - Update the `instance_count` - - fqdn : load balance URL, which points to the frontend node. - - keys : ssh username and private keys - - Ensure to provide Chef Backend's frontend server IPs for Automate HA Chef Automate and Chef Infra Server. - - Ensure to provide Chef Backend's backend server IPs for Automate HA PostgreSQL and OpenSearch machines. - - Sample configuration; please modify according to your needs. +8. Edit `config.toml` with the following information: + + - Update the `instance_count` for each component. + - Set `fqdn` to the load balancer URL pointing to the frontend node. + - Set `ssh_user` and `ssh_key_file` for SSH access. + - Provide Chef Backend's frontend server IPs for Automate HA Chef Automate and Chef Infra Server in `automate_private_ips` and `chef_server_private_ips`. + - Provide Chef Backend's backend server IPs for Automate HA PostgreSQL and OpenSearch in `postgresql_private_ips` and `opensearch_private_ips`. + + See the following example configuration below and modify it for your environment: ```sh [architecture.existing_infra] @@ -236,7 +240,7 @@ Where: ssh_port = "22" ssh_key_file = "~/.ssh/mykey.pem" sudo_password = "" - # DON'T MODIFY THE BELOW LINE (backup_mount) + # Don't modify backup_mount backup_mount = "/mnt/automate_backups" # Eg.: backup_config = "object_storage" or "file_system" backup_config = "file_system" @@ -273,15 +277,15 @@ Where: postgresql_private_ips = ["10.0.3.0","10.0.4.0","10.0.5.0"] ``` -9. Deploy using the following command: +9. Deploy Automate HA: - ```sh - ./chef-automate deploy config.toml --airgap-bundle + ```bash + ./chef-automate deploy config.toml --airgap-bundle ``` -10. Clean up the old packages from the chef-backend (like Elasticsearch and PostgreSQL) -11. Once done, [restore data to Chef Automate HA](/automate/ha_chef_backend_to_automate_ha/#restore-data-to-chef-automate-ha) -12. [Validate the data](/automate/ha_chef_backend_to_automate_ha/#steps-to-validate-if-migration-is-successful) +10. [Restore the backup data to Chef Automate HA](/automate/ha_chef_backend_to_automate_ha/#restore-data-to-chef-automate-ha). +11. [Validate the migration](/automate/ha_chef_backend_to_automate_ha/#steps-to-validate-if-migration-is-successful). +12. Remove the old packages from the Chef Backend nodes (Elasticsearch, PostgreSQL, and other Chef Backend components). ## Connect Workstation/Nodes to Automate HA diff --git a/content/automate/ha_common.md b/content/automate/ha_common.md index b8ea12223..d2b0f3074 100644 --- a/content/automate/ha_common.md +++ b/content/automate/ha_common.md @@ -319,12 +319,19 @@ This section elaborates the validation procedure that checks the firewall rules Follow these steps to examine the firewall rules are stateful, and ports are open before Chef Automate High Availability (HA) backend cluster deployment in air-gapped environment (means no access to the internet): -1. Download hab, _hab-x86_64-linux.tar.gz_ by executing the command, `sudo wget https://packages.chef.io/files/stable/habitat/latest/hab-x86_64-linux.tar.gz`. +1. Download the Chef Habitat CLI: + + ```bash + sudo wget \ + "https://chefdownload-commercial.chef.io/stable/habitat/download?p=linux&pv=2.6&m=x86_64&license_id=" \ + -O /tmp/hab-x86_64-linux.tar.gz + ``` + + Replace `` with your Progress Chef commercial license ID. 1. Install hab package in your internet environment by executing the following commands that generate the _netcat package_: ```bash - sudo tar -xvzf /tmp/hab-x86_64-linux.tar.gz -C /usr/local/bin --strip-components 1 export HAB_LICENSE=accept-no-persist hab pkg install core/netcat -bf diff --git a/content/automate/ha_node_bootstrapping.md b/content/automate/ha_node_bootstrapping.md index 7b5337a15..4c4c940e2 100644 --- a/content/automate/ha_node_bootstrapping.md +++ b/content/automate/ha_node_bootstrapping.md @@ -81,9 +81,11 @@ The Chef Infra Client installer puts everything into a unique directory (/opt/ch - Install the latest version of chef Workstation on the ubuntu system. - ```bash - wget https://packages.chef.io/files/stable/chef-workstation/21.7.524/ubuntu/20.04/chef-workstation_21.7.524-1_amd64.deb - ``` + ```bash + wget "https://chefdownload-commercial.chef.io/stable/chef-workstation/download?p=ubuntu&pv=20.04&m=x86_64&v=21.7.524&license_id=" -O chef-workstation_21.7.524-1_amd64.deb + ``` + + Replace `` with your Progress Chef commercial license ID. - To install the same: diff --git a/content/automate/ha_on_premises_deployment_procedure.md b/content/automate/ha_on_premises_deployment_procedure.md index 669c436c2..f5d9796ed 100644 --- a/content/automate/ha_on_premises_deployment_procedure.md +++ b/content/automate/ha_on_premises_deployment_procedure.md @@ -48,10 +48,9 @@ Ensure all resources are on existing or cloud infrastructure (`AWS`/`Azure`/`Goo ```bash sudo -- sh -c " - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip \ - | gunzip - > chef-automate && chmod +x chef-automate \ - | cp -f chef-automate /usr/bin/chef-automate - curl https://packages.chef.io/airgap_bundle/current/automate/latest.aib -o automate.aib + curl \"https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=\" \ + -o /usr/bin/chef-automate && chmod +x /usr/bin/chef-automate + curl \"https://packages.chef.io/airgap_bundle/current/automate/latest.aib\" -o automate.aib " ``` diff --git a/content/automate/ha_upgrade_introduction.md b/content/automate/ha_upgrade_introduction.md index c4f909a3a..ef6701e88 100644 --- a/content/automate/ha_upgrade_introduction.md +++ b/content/automate/ha_upgrade_introduction.md @@ -16,23 +16,27 @@ To upgrade Chef Automate HA, follow these steps: 1. Download the latest CLI: ```bash - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate | cp -f chef-automate /usr/bin/chef-automate + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate && sudo mv chef-automate /usr/bin/chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + 1. Download the airgap bundle. To download the latest bundle, run: ```bash - curl https://packages.chef.io/airgap_bundle/current/automate/latest.aib -o latest.aib + curl "https://packages.chef.io/airgap_bundle/current/automate/latest.aib" -o latest.aib ``` To download a specific version, run: ```bash - curl https://packages.chef.io/airgap_bundle/current/automate/.aib -o automate-.aib + curl "https://packages.chef.io/airgap_bundle/current/automate/.aib" -o automate-.aib ``` + Replace `` with your commercial license ID and `` with the desired version. + {{< note >}} Chef Automate bundles are available for 365 days from the release of a version. However, the milestone release bundles are available for download forever. {{< /note >}} diff --git a/content/automate/infra_server.md b/content/automate/infra_server.md index 30802695f..fe0914a1a 100644 --- a/content/automate/infra_server.md +++ b/content/automate/infra_server.md @@ -44,9 +44,11 @@ Before beginning your installation, check the [System Requirements]({{< relref " To download the `chef-automate` command line tool, run the following command in your command line interface: ```shell -curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate +curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` +Replace `` with your Progress Chef commercial license ID. + ## Install Chef Automate and Chef Infra Server on the Same Host Use either a command line interface or a configuration file to install Chef Automate and Chef Infra Server on the same host. diff --git a/content/automate/install.md b/content/automate/install.md index 216683c0b..ffd66aeb9 100644 --- a/content/automate/install.md +++ b/content/automate/install.md @@ -20,12 +20,14 @@ See [Airgapped Installation]({{< relref "airgapped_installation.md" >}}) for ins ## Download the Chef Automate Command-Line Tool -Download and unzip the Chef Automate command-line tool: +Download the Chef Automate command-line tool: ```shell -curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate +curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` +Replace `` with your Progress Chef commercial license ID. + ## Create Default Configuration Create a `config.toml` file with default values for your Chef Automate installation: diff --git a/content/automate/major_upgrade.md b/content/automate/major_upgrade.md index 7fe878362..cf6480067 100644 --- a/content/automate/major_upgrade.md +++ b/content/automate/major_upgrade.md @@ -51,9 +51,11 @@ Please upgrade to latest date pattern version number. 1. On an internet-connected machine, download the latest Chef Automate CLI. ```sh - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + 1. Create a bundle for version 20220329091442. ```sh @@ -184,9 +186,11 @@ To upgrade to 3.0.x, follow the steps below: 1. Download latest CLI of Chef Automate ```sh - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + 2. Create an Airgap Installation Bundle (AIB): ```sh @@ -196,7 +200,7 @@ To upgrade to 3.0.x, follow the steps below: Or you can download it with a curl request. ```sh - curl https://packages.chef.io/airgap_bundle/current/automate/3.0.49.aib -o automate-3.0.49.aib + curl "https://packages.chef.io/airgap_bundle/current/automate/3.0.49.aib" -o automate-3.0.49.aib ``` 3. Copy the latest Chef Automate CLI (`chef-automate`) and AIB (`automate_3.0.x.aib`) to the air-gapped machine running Chef Automate. @@ -256,9 +260,11 @@ To upgrade to 3.0.x, follow the steps below: 1. Download latest CLI of Chef Automate ```sh - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + 2. Create an Airgap Installation Bundle (AIB): ```sh @@ -268,7 +274,7 @@ To upgrade to 3.0.x, follow the steps below: Or you can download it with a curl request. ```sh - curl https://packages.chef.io/airgap_bundle/current/automate/latest.aib -o automate-3.0.49.aib + curl "https://packages.chef.io/airgap_bundle/current/automate/latest.aib" -o automate-3.0.49.aib ``` 3. Copy the latest Chef Automate CLI (`chef-automate`) and AIB (`automate_3.0.x.aib`) to the air-gapped machine running Chef Automate. diff --git a/content/automate/major_upgrade_4.x.md b/content/automate/major_upgrade_4.x.md index 32eb488b7..50bcbfffc 100644 --- a/content/automate/major_upgrade_4.x.md +++ b/content/automate/major_upgrade_4.x.md @@ -49,9 +49,11 @@ For example, if today you are on version _2021201164433_, your upgrade journey s - **Download latest chef-automate cli:** ```sh - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + ## Upgrade to Version 3.0.49 Check your current version: @@ -96,9 +98,11 @@ To upgrade Chef Automate from version 3.0.49 to 4.x with embedded Elasticsearch, 1. Download latest chef-automate cli. ```sh - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + 2. Start a major version upgrade: ```sh @@ -241,9 +245,11 @@ To upgrade Chef Automate with external Elasticsearch from version 3.0.49 to 4.x, 1. Download latest chef-automate cli. ```sh - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + 2. Start major version upgrade: ```sh @@ -343,9 +349,11 @@ To upgrade from version 3.0.49 to 4.x, follow the steps below: 1. Download latest CLI of Chef Automate. ```sh - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + 2. Create an Airgap Installation Bundle (AIB). ```sh @@ -355,7 +363,7 @@ To upgrade from version 3.0.49 to 4.x, follow the steps below: OR we can directly download via curl request ```sh - curl https://packages.chef.io/airgap_bundle/current/automate/latest.aib -o automate-4.x.y.aib + curl "https://packages.chef.io/airgap_bundle/current/automate/latest.aib" -o automate-4.x.y.aib ``` 3. Copy the latest Chef Automate CLI (`chef-automate`) and AIB (`automate-4.x.y.aib`) to the air-gapped machine running Chef Automate. @@ -516,9 +524,11 @@ To upgrade to version 3.0.49 to 4.x, follow the steps below: 1. Download latest CLI of Chef Automate ```sh - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + 2. Create an Airgap Installation Bundle (AIB): ```sh @@ -528,7 +538,7 @@ To upgrade to version 3.0.49 to 4.x, follow the steps below: OR we can directly download via curl request ```sh - curl https://packages.chef.io/airgap_bundle/current/automate/latest.aib -o automate-4.x.y.aib + curl "https://packages.chef.io/airgap_bundle/current/automate/latest.aib" -o automate-4.x.y.aib ``` 3. Copy the latest Chef Automate CLI (`chef-automate`) and AIB (`automate-4.x.y.aib`) to the air-gapped machine running Chef Automate. @@ -683,12 +693,16 @@ If you are using Proxy Settings and have upgraded to a version between 4.0.27 an DeploymentServiceCallError: A request to the deployment-service failed: Request to get upgrade status failed: rpc error: code = Unknown desc = error in getting the versions from current channel: error in invoking the endpoint https://packages.chef.io/manifests/current/automate/versions.json: Get "https://packages.chef.io/manifests/current/automate/versions.json": dial tcp: lookup packages.chef.io on 10.2.72.20:53: read udp 10.1.97.98:59620->10.2.72.20:53: i/o timeout ``` -To move ahead with the upgrade you can download the latest CLI and Airgapped bundle using the curl command with proxy settings: +To move ahead with the upgrade you can download the latest CLI and air-gapped bundle using the curl command with proxy settings: ```sh -curl -x http://proxy_server:proxy_port --proxy-user username:password -L https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate +curl -x http://proxy_server:proxy_port --proxy-user username:password -L "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate +``` -curl -x http://proxy_server:proxy_port --proxy-user username:password -L https://packages.chef.io/airgap_bundle/current/automate/latest.aib -o automate-latest.aib +Replace `` with your Progress Chef commercial license ID. + +```sh +curl -x http://proxy_server:proxy_port --proxy-user username:password -L "https://packages.chef.io/airgap_bundle/current/automate/latest.aib" -o automate-latest.aib ``` After downloading, run the upgrade command with airgapped bundle option: diff --git a/content/automate/managed_services.md b/content/automate/managed_services.md index 63c1a9e3b..22192052c 100644 --- a/content/automate/managed_services.md +++ b/content/automate/managed_services.md @@ -450,12 +450,14 @@ If you are planning to set Chef Automate with External AWS PostgreSQL/OpenSearch ### Download the Chef Automate Command-Line Tool -Download and unzip the Chef Automate command-line tool: +Download the Chef Automate command-line tool: ```shell -curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate +curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` +Replace `` with your Progress Chef commercial license ID. + ### Create Default Configuration Create a `config.toml` file with default values for your Chef Automate installation: diff --git a/content/automate/migrate.md b/content/automate/migrate.md index f7ad97e3a..4ec78ead9 100644 --- a/content/automate/migrate.md +++ b/content/automate/migrate.md @@ -50,19 +50,16 @@ You will need the `chef-automate` command line tool to initiate your upgrade. 1. Download the latest version of the Chef Automate CLI: ```shell - wget https://packages.chef.io/files/current/automate/latest/chef-automate_linux_amd64.zip + wget "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -O chef-automate + chmod +x chef-automate ``` -2. Unzip the package: + Replace `` with your Progress Chef commercial license ID. - ```shell - unzip chef-automate_linux_amd64.zip - ``` - -3. Move the unzipped `chef-automate` binary to `/usr/local/bin`: +2. Move the `chef-automate` binary to `/usr/local/bin`: ```shell - mv chef-automate /usr/local/bin + sudo mv chef-automate /usr/local/bin ``` ### Internet Access @@ -71,6 +68,8 @@ The Chef Automate upgrade process requires connectivity to the internet to insta The standard Chef Automate installation requires current versions for Chrome, Edge, or Firefox browsers. If you filter internet access via proxy or by other means, you must ensure the following domains are accessible: +* `chefdownload-commercial.chef.io` +* `chefdownload-community.chef.io` * `packages.chef.io` * `licensing.chef.io` * `raw.githubusercontent.com` diff --git a/content/automate/node_integrations.md b/content/automate/node_integrations.md index 228c48eac..8e8ac5fcf 100644 --- a/content/automate/node_integrations.md +++ b/content/automate/node_integrations.md @@ -127,7 +127,7 @@ Chef Automate doesn't run a detect job on the instances; all instances with an S The `ssm` Scan Job: -1. Installs the latest stable InSpec from `packages.chef.io` +1. Installs the latest stable InSpec 1. Executes InSpec locally, providing InSpec with the `fqdn` of Chef Automate and a data collector token, so each instance reports directly back to Chef Automate Your Automate instance must be reachable (open to incoming traffic) from the instances being scanned in order for the SSM scanning to work. You can filter the instances to be scanned by specifying tag key/value matches or regions. diff --git a/content/automate/on_prem_builder.md b/content/automate/on_prem_builder.md index cf853cb57..ad6c1d1dc 100644 --- a/content/automate/on_prem_builder.md +++ b/content/automate/on_prem_builder.md @@ -71,12 +71,14 @@ Chef Automate and Chef Habitat Builder require: ### Download the Chef Automate Installer -Download and unzip the installer: +Download the installer: ```shell -curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate +curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` +Replace `` with your Progress Chef commercial license ID. + ### Deploy Chef Automate and Chef Habitat Builder On-prem Deploying Chef Habitat Builder with Chef Automate requires a Chef Automate license. diff --git a/content/automate/restore.md b/content/automate/restore.md index 414b2f22d..deecef532 100644 --- a/content/automate/restore.md +++ b/content/automate/restore.md @@ -18,12 +18,14 @@ Before restoring a Chef Automate installation, see how to [configure your backup ## Prerequisites -1. On the restore host, download and unzip the Chef Automate command-line tool: +1. On the restore host, download the Chef Automate command-line tool: - ```shell - curl https://packages.chef.io/files/current/latest/chef-automate-cli/chef-automate_linux_amd64.zip | gunzip - > chef-automate && chmod +x chef-automate + ```shell + curl "https://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=" -o chef-automate && chmod +x chef-automate ``` + Replace `` with your Progress Chef commercial license ID. + 1. To restore from **filesystem backups**, Chef Automate requires access to a backup directory containing a timestamp-based directory and an `automate-elasticsearch-data` directory in the [configured location]({{< ref "backup.md#backup-to-a-filesystem" >}}). Ensure access for the backup type used: