From 69b8e661c2abe99bcfb955720c07e53798fdc031 Mon Sep 17 00:00:00 2001 From: Amy Brown Date: Wed, 4 Sep 2019 09:55:17 -0500 Subject: [PATCH] Readme update Updated outputs to have descriptions --- README.md | 22 +++++++++++----------- examples/root-example/README.md | 2 +- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7fbf6725..150c0f96 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## Description -This module installs Terraform Enterprise HA BETA onto 1 or more aws instances in DEMO mode. All data is stored on the instance(s) and is not preserved. +This module installs Terraform Enterprise HA BETA onto 1 or more aws instances in DEMO mode. All data is stored on the instance(s) and is not preserved. ## Architecture @@ -60,14 +60,14 @@ Please contact your Technical Account Manager for more information, and support | Name | Description | |------|-------------| -| iam\_role | | -| install\_id | | -| lb\_endpoint | | -| primary\_public\_ip | | -| ptfe\_endpoint | | -| ptfe\_health\_check | | -| replicated\_console\_password | | -| replicated\_console\_url | | -| ssh\_config\_file | | -| ssh\_private\_key | | +| iam\_role | The name of the IAM role being used | +| install\_id | The installation ID for TFE | +| lb\_endpoint | The load-balancer endpoint URI | +| primary\_public\_ip | The public IP address of the primary VMs | +| ptfe\_endpoint | The accessible PTFE URI | +| ptfe\_health\_check | The PTFE URI used for the health check | +| replicated\_console\_password | The Replicated console password | +| replicated\_console\_url | The Replicated Console URL | +| ssh\_config\_file | The path to the SSH configuration file | +| ssh\_private\_key | The SSH private key | diff --git a/examples/root-example/README.md b/examples/root-example/README.md index 3cdcb3eb..ca59045c 100644 --- a/examples/root-example/README.md +++ b/examples/root-example/README.md @@ -1,6 +1,6 @@ # Terraform Enterprise HA (Beta) Example -This example assumes you have already set up your gcp project with the required prereqs: +This example assumes you have already set up your aws project with the required prereqs: * VPC * Subnets (both public and private) spread across multiple AZs