Skip to content

Commit fffdda4

Browse files
committed
improve messaging
1 parent 7e7329e commit fffdda4

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Terraform Automation Demo using AWS Cloud Provider
22

3+
The purpose of this repository is to show case terraform automation for AWS
4+
Cloud. This demo will provision the following cloud resources associated to
5+
corresponding terraform configurations:
6+
7+
| AWS Resource | Terraform Resource | Link to TerraHub Config |
8+
|-----------------------|--------------------|-------------------------|
9+
| API Gateway Deployment | aws_api_gateway_deployment | https://github.com/TerraHubCorp/demo-terraform-automation-aws/blob/master/api_gateway_deployment/.terrahub.yml#L9 |
10+
| API Gateway REST API | aws_api_gateway_rest_api | https://github.com/TerraHubCorp/demo-terraform-automation-aws/blob/master/api_gateway_rest_api/.terrahub.yml#L9 |
11+
| IAM Role | aws_iam_role | https://github.com/TerraHubCorp/demo-terraform-automation-aws/blob/master/iam_role/.terrahub.yml#L8 |
12+
| Lambda Function | aws_lambda_function | https://github.com/TerraHubCorp/demo-terraform-automation-aws/blob/master/lambda/.terrahub.yml#L11 |
13+
| Security Group | aws_security_group | https://github.com/TerraHubCorp/demo-terraform-automation-aws/blob/master/security_group/.terrahub.yml#L9 |
14+
| Subnet | aws_subnet | https://github.com/TerraHubCorp/demo-terraform-automation-aws/blob/master/subnet_private/.terrahub.yml#L9 |
15+
| VPC | aws_vpc | https://github.com/TerraHubCorp/demo-terraform-automation-aws/blob/master/vpc/.terrahub.yml#L7 |
16+
17+
Follow below instructions to try this out in your own AWS Cloud account.
18+
319
## Create IAM User
420
1. Sign in to the AWS Management Console and open the IAM console at https://console.aws.amazon.com/iam/
521
2. In the navigation pane, choose Users and then choose Add user
@@ -59,7 +75,12 @@ Automated Setup (run the following command in terminal):
5975
export AWS_DEFAULT_REGION="$(aws configure get region --output=text)"
6076
```
6177

62-
## Create Terraform Configurations Using TerraHub
78+
## Terraform Automation and Orchestration Tool
79+
80+
The next couple of paragraphs are show casing the process of creating terraform
81+
configurations using [TerraHub CLI](https://github.com/TerraHubCorp/terrahub).
82+
We have opted to use YML format instead of HCL because it's easier and faster
83+
to customize and automate terraform runs (see `terrahub component` command).
6384

6485
Run the following commands in terminal:
6586
```shell
@@ -76,6 +97,8 @@ [email protected] (built: 2018-04-07T19:15:39.787Z)
7697
> NOTE: If you don't have TerraHub CLI, check out
7798
[installation guide](https://www.npmjs.com/package/terrahub)
7899

100+
## Build Terraform Configurations
101+
79102
Run the following commands in terminal:
80103
```shell
81104
mkdir demo-terraform-automation-aws
@@ -88,6 +111,12 @@ Your output should be similar to the one below:
88111
✅ Project successfully initialized
89112
```
90113

114+
> NOTE: If you want to jump directly to terraform automation part of the demo,
115+
instead of creating `demo-terraform-automation-aws` from scratch, clone current
116+
repository, follow the instructions for `Update Project Config` and skip down to
117+
`Visualize TerraHub Components`. This way you will fast forward through terrahub
118+
components creation and customization, and switch directly to the automation part.
119+
91120
## Create TerraHub Components from Templates
92121

93122
Run the following command in terminal:
@@ -329,7 +358,7 @@ Your output should be similar to the one below:
329358
Run the following command in terminal:
330359

331360
```shell
332-
terrahub run -a -y
361+
terrahub run -y -a
333362
```
334363

335364
Your output should be similar to the one below:

0 commit comments

Comments
 (0)