Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 3.42 KB

README.md

File metadata and controls

52 lines (39 loc) · 3.42 KB

Terraform Code Repo for Major Cloud Providers and Custom Provider Guide

  • AWS Workflow
  • Kubernetes Workflow
  • Azure Workflow - ToDo
  • GCP Workflow - ToDo
  • DigitalOcean Workflow - ToDo

Information about this project

  • Idea for this open source repository is to collate the Terraform Resource Creation code for Major Cloud Providers
  • Also it has sample code for How to develop Terraform Custom Provider
  • Feel free to explore the repo content, and add ⭐ or fork if you like the content
  • Repo is open for contributions and if you want to contribute please read the important notice for contribution guidelines

Read before you start contributing to this repo

  • Read Contribution Guidelines before contributing to this repository!

  • Read GitHub Code Of Conduct guidelinesbefore contributing to this repository!

  • Feel free to pick up any of the open Issues or create new issue using the template!

  • This repo also has GitHub action Terraform AWS workflow to check the Terraform AWS resource code is valid and works fine. Please utilize it for checking the terraform code you're creating. All you've to do is,

    • Open Workflow in "Actions" Tab
    • Click on Run Workflow
    • Choose you branch_name and Enter your tf file path on which you want to run the workflow
    • Check if the workflow is passing or not. Fix the issue in case of failure.

Good to Have: Create documentation to list down resources/modules/providers/output

  • Please install terraform-docs CLI utility to generate documentation for Terraform Code.
  • After installing the utility, please run the below command to create markdown document
terraform-docs markdown table --output-file TF_README.md --output-mode inject <your-terraform-code-directory>
  • Please use below command for generating docs recursively for all the Terraform code modules
~/go/bin/terraform-docs markdown table --output-file TF_README.md --recursive --recursive-path "<terraform-code-module-path>" --output-mode inject .

Note:

I've renamed the default branch from master to main. So If you've cloned my repo locally, then please follow the steps mentioned in this document to rename your local repo from master to main

  • Feel free to browse through the branch and post any questions to me.
  • LinkedIn - Saravanan Gnanaguru

💻 Happy contributing to the Community!!

Repo contributors profile link