Skip to content
8 changes: 5 additions & 3 deletions content/automate/airgapped_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<LICENSE_ID>" -o chef-automate && chmod +x chef-automate
```

Replace `<LICENSE_ID>` 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 </path/to/airgap-install-bundle>
curl "https://packages.chef.io/airgap_bundle/current/automate/latest.aib" -o </path/to/airgap-install-bundle>
```

Download the bundle of a specific version using:

```shell
curl https://packages.chef.io/airgap_bundle/current/automate/<version>.aib -o </path/to/airgap-install-bundle>
curl "https://packages.chef.io/airgap_bundle/current/automate/<version>.aib" -o </path/to/airgap-install-bundle>
```

{{< 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 >}}
Expand Down
2 changes: 2 additions & 0 deletions content/automate/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ Then run `chef-automate config patch </path/to/your-file.toml>` to deploy your c

Chef Automate must be able to access the following:

* `chefdownload-commercial.chef.io`
Comment thread
IanMadd marked this conversation as resolved.
* `chefdownload-community.chef.io`
* `packages.chef.io`
* `licensing.chef.io`
* `raw.githubusercontent.com`
Expand Down
207 changes: 102 additions & 105 deletions content/automate/get_started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
title = "Get Started with Chef Automate"
title = "Get started with Chef Automate"
weight = 10
draft = false

Expand All @@ -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 <<TERMS
To continue, you'll need to accept our terms of service:
Terms of Service
https://www.chef.io/terms-of-service

Master License and Services Agreement
https://www.chef.io/online-master-agreement

I agree to the Terms of Service and the Master License and Services Agreement (y/n)
TERMS
if STDIN.gets.chomp == 'y'
'true'
else
puts 'Chef Software Terms of Service and Master License and Services Agreement were not accepted'
exit 1
- 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
- 8 GB RAM, or more, available for the VM

## Quickstart

Use the command-line script below to create a demonstration instance of Chef Automate.
The script is mostly automated, but it requires a few manual steps.
Installing Chef Automate with the Vagrantfile below means you're 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).

1. Create a `Vagrantfile` by pasting this script into your command line:

```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://chefdownload-commercial.chef.io/stable/automate/download?p=linux&m=x86_64&license_id=<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 <<TERMS
To continue, you'll need to accept our terms of service:
Terms of Service
https://www.chef.io/terms-of-service

Master License and Services Agreement
https://www.chef.io/online-master-agreement

I agree to the Terms of Service and the Master License and Services Agreement (y/n)
TERMS
if STDIN.gets.chomp == 'y'
'true'
else
puts 'Chef Software Terms of Service and Master License and Services Agreement were not accepted'
exit 1
end
end
end
config.vm.box = CFG_BOX
config.vm.hostname = CFG_HOSTNAME

config.vm.provider "virtualbox" do |v|
v.name = 'chef-automate'
v.memory = 8192
v.cpus = 4
v.customize ['modifyvm', :id, '--audio', 'none']
end
end
end
config.vm.box = CFG_BOX
config.vm.hostname = CFG_HOSTNAME

config.vm.provider "virtualbox" do |v|
v.name = 'chef-automate'
v.memory = 8192
v.cpus = 4
v.customize ['modifyvm', :id, '--audio', 'none']
end

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
```
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 `<LICENSE_ID>` 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.
7 changes: 3 additions & 4 deletions content/automate/ha_aws_deploy_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<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
"
```

Expand Down
49 changes: 27 additions & 22 deletions content/automate/ha_aws_managed_deploy_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 >}}

Expand All @@ -22,38 +22,43 @@ 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:
<!-- markdownlint-disable MD009 -->

```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=<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/<VERSION>.aib\" -o automate.aib
"
```

Replace the following values:

- `<LICENSE_ID>` with your commercial license ID.
- `<VERSION>` 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:

```bash
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 >}}

Expand All @@ -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:

Expand All @@ -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

Expand Down
Loading
Loading