Skip to content
This repository has been archived by the owner on Jul 12, 2022. It is now read-only.

Commit

Permalink
Update RIT AWS GENERATE TERRAFORM-PROJECT readme (#286)
Browse files Browse the repository at this point in the history
* Changes in the repository URL input

Signed-off-by: eduardorcury <eduardoribeirocury@gmail.com>

* Update README.md

Signed-off-by: eduardorcury <eduardoribeirocury@gmail.com>

* Change on label for repository input

Signed-off-by: eduardorcury <eduardoribeirocury@gmail.com>

* Correcting premisses of README.md

Signed-off-by: eduardorcury <eduardoribeirocury@gmail.com>

* Creating Dockerfile

Signed-off-by: eduardorcury <eduardoribeirocury@gmail.com>

* Adding Docker implementation to Makefile/metadata.json

Signed-off-by: eduardorcury <eduardoribeirocury@gmail.com>

* Update README.md

Signed-off-by: eduardorcury <eduardoribeirocury@gmail.com>

* Update aws generate terraform project README

Signed-off-by: eduardorcury <eduardoribeirocury@gmail.com>
  • Loading branch information
eduardorcury authored Oct 21, 2020
1 parent df0ea97 commit ab9e1bc
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 5 deletions.
56 changes: 51 additions & 5 deletions aws/generate/terraform-project/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,58 @@
# Terraform aws project
# Aws generate terraform project

## command
## Premisses

- [Golang](https://golang.org/doc/install) installed

## Command

- Prompt

```bash
rit aws generate terraform-project
```

## description
- Stdin

```bash
echo '{"project_name":"my-terraform-project", "project_location":"/home/user/projects", "bucket_name":"my-aws-bucket", "bucket_region":"us-east-1"}' | rit aws generate terraform-project --stdin
```

## Description

This formula allows the user to generate a terraform based project. The user has to provide 4 different inputs:

- The project name

- The path to the directory in wich the project will be created

- The name of the bucket the will be used as backend

- The AWS region of the bucket

The folders and files generated by this commands are as follows:

- A **main.tf** file containing the provider and inicial configuration

- A **.tfbackend** file containing the backend configuration

- Folders for terraform modules, templates and different environment variables

- **README.md** and **.gitignore** files

- A **Jenkisfile**

- A **.circleci** to run tests with terraform commands

- A **Makefile** with commands to run *terraform init/plan/apply/destroy*


## Demonstration

- Command execution

<img src="demo.gif">

- Generated folder

This formula receives 2 inputs (project name, project location)
and builds a terraform project with commons folders and files.
<img src="tree-image.png">
Binary file added aws/generate/terraform-project/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added aws/generate/terraform-project/tree-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ab9e1bc

Please sign in to comment.