terraform-provider-mgtt-squashed

Table of Contents

• Description
• Sqash commits with orphan branches
• References
• How to use

Description

Sample repository implementing a terraform provider designed for managing resources in Azure and AWS. Moreover, this should illustrate the process of consolidating multiple less descriptive commits into a single commit to maintain a cleaner Git history.

Sqash commits with orphan branches

Read trough How to move a full Git repository. We need to only checkout the master branch.

Create an orphan branch from the master (refer to user456814 answer solution #1):

git checkout --orphan orphan-branch master
git add .
git commit -m "Initial setup"
git push --set-upstream origin orphan-branch

Derive from orphan-branch -> develop -> release/0.1.0. Select release/0.1.0 as temporary default branch in Github repository settings. Delete the old master branch via git push origin --delete master. Additionally remove the local master branch via git branch -D master and create a new local one via git checkout -b "master". Derive from release/0.1.0 -> master and git push --set-upstream origin master.

Merge release/0.1.0 -> master and release/0.1.0 -> develop via pull request in the Github repository UI if any changes have been implemented on the release/0.1.0. Finally select master as default branch in Github repository settings.

References

• Writing Custom Terraform Providers. This link is deprecated but helpful to understand the basic concepts from the hashicorp founder.
• How to develop/ test existing provider locally?
• terraform-provider-klayer Github repository. 13-01-2023 - Latest practical example
• https://developer.hashicorp.com/terraform/plugin/sdkv2?collectionSlug=providers&productSlug=terraform. Latest hashicorp documentation on Terraform Plugin SDKv2 for writing custom providers.
• Schema Attributes and Types. Check section on TypeSet.

How to use

Exporting environment variables

Create from the secrets.template.cfg a secrets.cfg file in the project root directory and replace the PLACEHOLDER_* values. Some tests export the environment variables trough the secrets.cfg file.

source secrets.cfg

In order to run tests

source secrets.cfg
# go test ./...
cd mgtt/test
go test

NOTE: For tests managing Azure objects refer to following README.md. Topics on how to retrieve a fresh AZURE_ACCESS_TOKEN should be covered.

Compile custom provider

On modern Windows OS (version 10 or 11) run:

go build -o terraform-provider-mgtt.exe

On Windows Unix systems run:

go build -o terraform-provider-mgtt

Copy provider executable to plugins directory

Refer to How to develop/ test existing provider locally?.

Navigate to and remove :

cd terraform

# Remove previous build artifacts
rm .terraform # Powershell
rm -rf .terraform # Unix terminals
rm  terraform.tfstate terraform.tfstate.backup

On modern Windows OS with amd64 CPU architecture run:

mkdir -p .terraform\plugins\terraform-mgtt.com\mgttprovider\mgtt\1.0.0\windows_amd64
cp ..\terraform-provider-mgtt.exe .terraform\plugins\terraform-mgtt.com\mgttprovider\mgtt\1.0.0\windows_amd64

On Unix systems run:

# Linux Ubuntu >=18.04 or debian >=11 with amd64 CPU architecture
mkdir -p .terraform/plugins/terraform-mgtt.com/mgttprovider/mgtt/1.0.0/linux_amd64
cp ../terraform-provider-mgtt .terraform/plugins/terraform-mgtt.com/mgttprovider/mgtt/1.0.0/linux_amd64

# MacOS with amd64 CPU architecture 
mkdir -p .terraform/plugins/terraform-mgtt.com/mgttprovider/mgtt/1.0.0/darwin_amd64
cp ../terraform-provider-mgtt .terraform/plugins/terraform-mgtt.com/mgttprovider/mgtt/1.0.0/darwin_amd64

Test provider executable with hcl files and terraform commands

source secrets.cfg
cd terraform
terraform init -plugin-dir="./.terraform/plugins/"
terraform plan
# It is important to set the the log level before applying `teraform apply` or `teraform destroy` 
export TF_LOG=DEBUG
terraform apply --auto-approve # initial create requests
# Update input variables in tf files, e.g. 
# ```hcl
# resource "mgtt_azurerm_rg" "this" {
#     name = "rg-test-9000"
#     location = "West Europe"
# }
# ```
terraform apply --auto-approve # update requests 
terraform destroy --auto-approve # delete requests