https://github.com/Azure/generator-az-terra-module
Generator for azure terraform module project.
https://github.com/Azure/generator-az-terra-module
Last synced: 5 months ago
JSON representation
Generator for azure terraform module project.
- Host: GitHub
- URL: https://github.com/Azure/generator-az-terra-module
- Owner: Azure
- License: mit
- Archived: true
- Created: 2017-12-08T06:25:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T16:46:02.000Z (about 2 years ago)
- Last Synced: 2024-11-03T05:24:03.029Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.33 MB
- Stars: 31
- Watchers: 14
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- jimsghstars - Azure/generator-az-terra-module - Generator for azure terraform module project. (JavaScript)
README
# Contributing
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
# Azure Terraform Module Generator
`generator-az-terra-module` creates base template to start a new terraform module along with terratest for automatically testing the module.
## Prerequisites
1. Install latest [Node LTS](https://nodejs.org).
2. `npm install -g yo`
3. `npm install -g generator-az-terra-module`
## Usage
```
$ yo az-terra-module
```
***NOTE:** This template will generate files in the **current directory**, so be sure to always run it against a new directory.*
## Set Service Principal of Azure for Terraform
- [Configure Azure Service Principal](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/terraform-install-configure)
## Prepare for Native Run
If you're a big fan of everything in native, please run the below script to set up the environment:
```bash
$ sudo ./env_setup.sh
```
## Prepare for Docker Run
If you're a big fan of using Docker containers, please follow the instructions below to quickly set up a Docker container. Not a big fan of Docker containers, that's OK too, you can choose to exclude the Dockerfile from your project template.
```bash
$ docker build --build-arg BUILD_ARM_SUBSCRIPTION_ID=$ARM_SUBSCRIPTION_ID --build-arg BUILD_ARM_CLIENT_ID=$ARM_CLIENT_ID --build-arg BUILD_ARM_CLIENT_SECRET=$ARM_CLIENT_SECRET --build-arg BUILD_ARM_TENANT_ID=$ARM_TENANT_ID -t terra-mod-example .
$ docker run -it terra-mod-example /bin/sh
```
## Build module
```
$ bundle install
$ rake build
```
## Run module
```
$ terraform init
$ terraform plan
$ terraform apply
```
## Test module
```
$ rake e2e
```