hugolesta/NodeForm

NodeForm

This project was created to help everybody who want to manage terraform easy, reliable way.

This implementation will be developed using languages like Javascript and HCL. In this fist case we focus in terraform for managing infrastructure in AWS (Amazon web services) but you shouln't have issues running this solution with another cloud providers.

This project was fully tested in Linux and MacOS S.O, we don't know if it work properly in S.O like Windows.

Requirements

• Nodejs should be installed

• tfenv should be installed, we have a task called jake install-tfenv check extra information below

• Nodejs should be installed.

Usage

At the beginning of the usage, you should start running the following commands.

Install jake.js

 sudo npm install -g jake

In this project, you should run the command below for installing the proyect dependencies.

 npm install

You can list all tasks running the following command

 jake -T

The following tasks listed below you shall run in this proyect at this moment.

Name	Description
jake install-tfenv	Install tfenv in this S.O if isnt exists.
jake get	Create your environment folder and resolve terrafile.
jake init	Use init after run the get task, this task will prepare all environment.
jake plan	Only use when you need to check terraform resources status.
jake apply	Only use when you need deploy terraform resources.
jake destroy	Only use when you need destroy terraform resources.
jake add-module	Add new modules in terrafile.json, you shall use it in your projects.
jake manage-credentials	Manage your aws credentials, select some profile and use it.
jake show-selected-credentials	Check what profile you have selected at this moment.

After install node dependencies, you should select Aws profiles using Jake as your main tool.

 jake manage-credentials

Select the profile you want and press ENTER. This profile will be saves in a new file called .env, and a variable called AWS_PROFILE will be populated.

If you need to know an example of how to implement .env file you must to check .env.example.

 jake show-selected-credentials

It will show you what profile you have selected at this moment, if none of them are selected, it'll give you some advice for reaching some profile.

After select some profile you should run the following command in order to check if you have tfenv installed in your S.O.

 jake install-tfenv

This task will install tfenv in your S.O, after that, make sure to install some terraform version running the following command.

 tfenv install 0.12.18

In this case, it'll install terraform version 0.12.18

 tfenv use 0.12.18

It'll use terraform version 0.12.18 previously installed.

 jake add-module

You should add some modules for allow use it.

This option will ask you some information like the following.

• Terraform module name
• Repo url, it allow https and ssh git links.
• Release version for the module previously added.

 jake get

It'll create a new folder called dev with common files inside, it also create the terraform modules added in terrafile.json in a new folder called modules

 jake init

It'll share common terraform files between different environment folders, after that, It'll init your project downloading all the terraform providers and plugins.

 jake plan

It'll list all your terraform infrastructure changes.

 jake apply

It'll deploy all your terraform infrastructure using the previous profile setted.

 jake destroy

It'll destroy all your terraform infrastructure using the previous profile setted.

Contributors

Hugo Lesta