Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 6.17 KB

Contribute.md

File metadata and controls

85 lines (52 loc) · 6.17 KB
Raw

Contributing to Terraform Verified Modules

We accept modules created by not only Microsoft employees but the wider developer community. The following instructions will help you with the development of Azure Terraform verified modules. Please follow it step by step.

Creating a New Verified Module

Before Getting Started

Before designing the first version of your module, please keep in mind the following guidances:

  • Always deliver a module that works for at least 80% of user cases.
  • Never include corner cases in your module. A module should be a reusable block of code.
  • Your module should only expose the most commonly modified arguments as variables. That is to say, your module should only support variables that you are most likely to need.

Label your Module with Our Naming Convention

Please follow our naming convention to make your module easy to understand and work with. The order should be: terraform-azurerm-{module function}, like terraform-azurerm-subnet

Create Your own GitHub Repository of Your Module

Please guarantee that your repository looks exactly the same as this template created by Zijie. The repo shall normally contain the following items:

LICENSE will contain the license under which your module will be distributed. When you share your module, the LICENSE file will let people using it know the terms under which it has been made available.

README.md will contain documentation describing what your module contains and how to use your module, in markdown format. Nornally, they shall contain the following components in order:

  • A clear and concise description.
  • A Resource types section with a table that outlines all resources that can be deployed as part of your module.
  • A Parameters section with a table containing all parameters, their types, default and allowed values, and their brief description.
  • An Output section with a table describing all outputs the module template returns.
  • A Template references section listing relevant resources.

main.tf will contain the main set of configuration for your module. You can also create other configuration files and organize them however makes sense for your project.

variables.tf will contain the variable definitions for your module. Since all Terraform values must be defined, any variables that are not given a default value will become required arguments. Variables with default values can also be provided as module arguments, overriding the default value.

outputs.tf will contain the output definitions for your module.

examples will contain real-world examples of using your module. Please make sure that they are up-dated, functional, and easy to understand.

test folder will normally contain functional test files and should follow these general guidelines:

  • A module should have as many moudle test files as it needs (at least includes e2e test, unit test, and upgrade test) to evaluate all parts of the module's functionality.
  • Sensitive data should not be stored in the module test files.

.gitignore(optional) will specify intentionally untracked files that Git should ignore.

Tests before Commit

  1. First, you should set up service principal’s credentials in your environment variables like below:
export ARM_SUBSCRIPTION_ID="<azure_subscription_id>"

export ARM_TENANT_ID="<azure_subscription_tenant_id>"

export ARM_CLIENT_ID="<service_principal_appid>"

export ARM_CLIENT_SECRET="<service_principal_password>"

  1. We recommend you run the pre-commit checks and tests in our provided docker image. In order to do this, you need to download docker, then run the command via your terminal: mcr.microsoft.com/azterraform:latest.

  2. Please run make pre-commit to check the Terraform code in your local environment.

    For Mac/Linux, the whole command should be: $ docker run --rm -v $(pwd):/src -w /src mcr.microsoft.com/azterraform:latest make pre-commit

    For Windows, the whole command should be: $ docker run --rm -v ${pwd}:/src -w /src mcr.microsoft.com/azterraform:latest make pre-commit

  3. Run the pr-check task to check whether your code meets our pipeline’s requirement.

    For Mac/Linux, the whole command should be: $ docker run --rm -v $(pwd):/src -w /src mcr.microsoft.com/azterraform:latest make pr-check

    For Windows, the whole command should be: $ docker run --rm -v ${pwd}:/src -w /src mcr.microsoft.com/azterraform:latest make pr-check

  4. Please run the e2e-test with the following command.

    For Mac/Linux, the whole command should be: docker run --rm -v $(pwd):/src -w /src -e ARM_SUBSCRIPTION_ID -e ARM_TENANT_ID -e ARM_CLIENT_ID -e ARM_CLIENT_SECRET mcr.microsoft.com/azterraform:latest make e2e-test

    For Windows, the whole command should be: docker run --rm -v ${pwd}:/src -w /src -e ARM_SUBSCRIPTION_ID -e ARM_TENANT_ID -e ARM_CLIENT_ID -e ARM_CLIENT_SECRET mcr.microsoft.com/azterraform:latest make e2e-test

  5. Finally, install the 1ES (One Engineering Service) to enable the subsequent automatic tests.

Make a Pull Request

After passing all the pre-commit & pr-check & E2E test, you can make a pull request in our repo. Please note that each module needs to have its own pull request.

Subsequently, our CI pr-check will be executed automatically. Once the pr-check has passed, the e2e test and version upgrade test will be executed with manual approval. Passing all tests indicates that your modules are in alignment with our verified module pipeline. If the tests fail, please refer to the pipeline's output and make modifications. Thank you for your cooperation.

The End

When your pull request has been merged into our main branch, as the module owner, you are responsible for maintaining and updating it. In cases that you are not able to guarantee its applicability in real business scenarios, please inform the Azure Terraform team as soon as possible. We will alert users the potential risk or roll it off from our GitHub repo.

Thank you for your attention and hope you enjoy the whole process!