diff options
| author | Patrick Steinhardt <ps@pks.im> | 2020-08-10 12:07:27 +0300 |
|---|---|---|
| committer | Patrick Steinhardt <psteinhardt@gitlab.com> | 2020-09-14 10:52:13 +0300 |
| commit | 93cc67a7095a73b6e15132c55bb44c5c2b793c17 (patch) | |
| tree | 2fab2b4909a1a2e9d8c2a59478a6950c2d0fc74d /_support | |
| parent | 32b978e3dad2daf71e3cd26595c7b84a9104727e (diff) | |
terraform: Adjust README file to match latest changes
With cluster deployment now being done via Ansible, let's change the
README to reflect this change.
Diffstat (limited to '_support')
| -rw-r--r-- | _support/terraform/README.md | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/_support/terraform/README.md b/_support/terraform/README.md index b6cdb2efd..d52905424 100644 --- a/_support/terraform/README.md +++ b/_support/terraform/README.md @@ -1,21 +1,29 @@ -# terraform for gitaly ha demo +# Terraform for Gitaly HA demo -## Creating a demo cluster +## Prerequisites -### 1. Install Google Cloud SDK +### Google Cloud SDK - For most platforms, including macOS, use the [official guide](https://cloud.google.com/sdk/docs/quickstarts) - For Arch Linux, go to [this AUR](https://aur.archlinux.org/packages/google-cloud-sdk) -### 2. Install Terraform +### Install Terraform On macOS with homebrew, use `brew install terraform`. For other platforms see [the Terraform download page](https://www.terraform.io/downloads.html). -### 3. Run the script +### Install Ansible + +Please refer to [Ansible's +documentation](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) +to install it on your system. + +## Provision your cluster + +### 1. Create cluster ``` ./create-demo-cluster @@ -30,7 +38,7 @@ running in the background on your new VM's. One of the provisioned resources is the database, which can take up to 10 minutes to be created. -### 4. Configure demo cluster +### 2. Configure cluster ``` ./configure-demo-cluster @@ -40,10 +48,6 @@ Configuration of the cluster has been automated via Ansible. The cluster creation script has automatically created a `hosts.ini` file for use by Ansible containing all necessary information to configure the cluster. -If you do not have Ansible installed, please refer to [Ansible's -documentation](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) -to install it on your system. - If you wish to manually configure the cluster, please consult https://docs.gitlab.com/ee/administration/gitaly/praefect.html. @@ -53,7 +57,7 @@ To see the list of IP's for your machines, run: ./print-info ``` -## Destroying a demo cluster +### 3. Destroy cluster When you run the command below Terraform will print a plan of things to destroy, that you then have to confirm (or abort with Ctrl-C). |