Terraform Core Team Repository Creation Process

This section describes the process for AVM core team members who are responsible for creating Terraform Module repositories.

Important

This contribution flow is for AVM Core Team members only.

1. Find Issues Ready for Repository Creation

When a module owner is ready to start development, they will add the Status: Ready For Repository Creation label to the proposal issue.
To find issues that are ready for repository creation, click this link
Open one of the issues to find the details you need.
1. Module name: This will be in the format avm-<type>-<name>. e.g. avm-res-network-virtualnetwork
2. Module owner GitHub handle: This will be in the content of the issue
3. Module description: If this does not exist, then create one. The description will automtically be prefixed with Terraform Azure Verified <module-type> Module for ..., where <module-type> is either Resource, Pattern, or Utility

2. Create the repository

Open a PowerShell terminal
Clone the https://github.com/Azure/terraform-azure-modules repository and navigate to the repository_creation_helper folder
```
git clone "https://github.com/Azure/terraform-azure-modules"
cd ./terraform-azure-modules/repository_creation_helper
```
Install the GitHub CLI if you don’t already have it installed: https://cli.github.com

gh auth login -h "github.com" -w -p "https" -s "delete_repo" -s "workflow" -s "read:user" -s "user:email"

Follow the prompts to login to your GitHub account.

Run the following command, replacing the values with the details you collected in step 1

$moduleProvider = "azurerm" # Only change this if you know why you need to change it :)
$moduleName = "<module name>" # Replace with the module name (do not include the "terraform-azurerm" prefix)
$moduleDescription = "<module description>" # Replace with a short description of the module
$moduleOwner = "<github user handle>" # Replace with the GitHub handle of the module owner

./New-Repository.ps1 `
    -moduleProvider $moduleProvider `
    -moduleName $moduleName `
    -moduleDescription $moduleDescription `
    -moduleOwner $moduleOwner

For example:

$moduleProvider = "azurerm" # Only change this if you know why you need to change it :)
$moduleName = "avm-res-network-virtualnetwork" # Replace with the module name (do not include the "terraform-azurerm" prefix)
$moduleDescription = "Virtual Networks" # Replace with a short description of the module
$moduleOwner = "jaredfholgate" # Replace with the GitHub handle of the module owner

./New-Repository.ps1 `
    -moduleProvider $moduleProvider `
    -moduleName $moduleName `
    -moduleDescription $moduleDescription `
    -moduleOwner $moduleOwner

The script will stop and prompt you to fill out the Microsoft Open Source details,
Open the Open Source Portal using the link in the script output.

Click Complete Setup, then use the following table to provide the settings:

Question	Answer
Classify the repository	Production
Assign a Service tree or Opt-out	Azure Verified Modules / AVM
Direct owners	Add the module owner and yourself as direct owners. Add the avm-team-module-owners as security group.
Is this going to ship as a public open source licensed project	Yes, creating an open source licensed project
What type of open source will this be	Sample code
What license will you be releasing with	MIT
Did your team write all the code and create all of the assets you are releasing?	Yes, all created by my team
Does this project send any data or telemetry back to Microsoft?	Yes, telemetry
Does this project implement cryptography	No
Project name	Azure Verified Module (Terraform) for ‘module name’
Project version	1
Project description	Azure Verified Module (Terraform) for ‘module name’. Part of AVM project - https://aka.ms/avm
Business goals	Create IaC module that will accelerate deployment on Azure using Microsoft best practice.
Will this be used in a Microsoft product or service?	This is open source project and can be leveraged in Microsoft service and product.
Adopt security best practice?	Yes, use just-in-time elevation
Maintainer permissions	Leave empty
Write permissions	Leave empty
Repository template	Uncheck
Add .gitignore	Uncheck

Click Finish setup + start business review to complete the setup
Wait for it to process and then click View repository
If you don’t see the Elevate your access button, then refresh the browser window
Click Elevate your access and follow the prompts to elevate your access
Now head back over to the terminal and type yes and hit enter to complete the repository configuration
Open the new repository in GitHub.com and verify it all looks good.
1. On the home page
  1. The name is correct
  2. The description is correct
  3. The Terraform registry url looks good
  4. The repository has the template files in it
2. In Setting
  1. The repository is public
  2. The Collaborators and teams are correct

3. Request the GitHub App Install

Create a new issue at https://github.com/microsoft/github-operations/issues/new?template=GitHub-App-Installation-Request.md

Update the issue with the following details:

Title: [GitHub App] Installation Request - Azure Verified Modules

Body - replace <repository url> with the URL of the repository you created in step 2:

> __Note:__ If the app is listed on the [Auto-Approved list](https://docs.opensource.microsoft.com/github/apps/approvals/), you do not need to complete this form.

You complete these steps:

- [x] Confirm the app is not in the [Auto-Approved list](https://docs.opensource.microsoft.com/github/apps/approvals/)
- [x] Fill out and verify the information in this form
- [x] Update the title to reflect the org/repo and/or app name
- [x] Submit the native request within the GitHub user interface

Operations will help complete these steps:

- [ ] Approve the app if already requested on GitHub natively
- [ ] Close this issue

Finally, you'll complete any configuration with the app or your repo that is required once approved.

# My request

- GitHub App name: Azure Verified Modules

- GitHub organization in which the app would be installed: Azure

- Is this an app created by you and/or your team?

  - [x] Yes, this is an app created by me and/or my team
  - [ ] No, this is a Microsoft 1st-party app created by another team
  - [ ] No, this is a 3rd-party marketplace app

- If this __is an app created by you and/or your team__, please provide some ownership information in case future questions come up:

  - Service Tree ID: our service tree ID is: Unchanged
  - A few specific individuals at Microsoft if we have questions (corporate email list):Unchanged
  - An optional team discussion list: Unchanged

- Is this an app you/your team created to address [reduced PAT lifetimes](https://aka.ms/opensource/tsg/pat)?
  - [x] Yes
  - [ ] No

- Are you looking for this app to be installed on individual repos or all repos in an organization?

  - [x] Individual repos: <repository url>
  - [ ] All repos in an organization

- Does this app have any side-effects if it is installed into all repos in an organization? Side effects can include creating labels, issues, pull requests, automatic checks on PRs, etc.

  - [ ] Yes, it has side effects and you should be careful if installing to all repos in an org
  - [x] No side effects

- Please provide a description of the app's functionality and what are you trying to accomplish by utilizing this app:

  Unchanged

- For any major permissions (org admin, repo admin, etc.), can you explain what they are and why they are needed?

  Unchanged

- Any other notes or information can you provide about the app?

Submit the issue

4. Notify the Module Owner and Update the Issue Status

Add a comment to the issue you found in step 1 to let the module owner know that the repository has been created and is be ready for them to start development.

@<module owner> The module repository has now been created. You can find it at <repository url>.

The final step of repository configuration is still in progress, but you will be able to start developing your code immediately.

The final step is to create the environment and credentials require to run the end to end tests. If the environment called `test` is not available in 48 hours, please let me know.

Thanks

Add the Status: Repository Created label to the issue
Remove the Status: Ready For Repository Creation label from the issue