Git Product home page Git Product logo

terraform-gitops-ascent's Introduction

Starter kit for a Terraform GitOps module

This is a Starter kit to help with the creation of Terraform modules. The basic structure of a Terraform module is fairly simple and consists of the following basic values:

  • README.md - provides a description of the module
  • main.tf - defines the logic for the module
  • variables.tf (optional) - defines the input variables for the module
  • outputs.tf (optional) - defines the values that are output from the module

Beyond those files, any other content can be added and organized however you see fit. For example, you can add a scripts/ directory that contains shell scripts executed by a local-exec null_resource in the terraform module. The contents will depend on what your module does and how it does it.

Instructions for creating a new module

  1. Update the title and description in the README to match the module you are creating
  2. Fill out the remaining sections in the README template as appropriate
  3. Implement your logic in the in the main.tf, variables.tf, and outputs.tf
  4. Use releases/tags to manage release versions of your module

Software dependencies

The module depends on the following software components:

Command-line tools

  • terraform - v12
  • kubectl

Terraform providers

  • IBM Cloud provider >= 1.5.3
  • Helm provider >= 1.1.1 (provided by Terraform)

Module dependencies

This module makes use of the output from other modules:

  • GitOps - github.com/cloud-native-toolkit/terraform-tools-gitops.git
  • Namespace - github.com/cloud-native-toolkit/terraform-gitops-namespace.git
  • etc

Example usage

module "dev_tools_argocd" {
  source = "github.com/cloud-native-toolkit/terraform-tools-argocd.git"

  cluster_config_file = module.dev_cluster.config_file_path
  cluster_type        = module.dev_cluster.type
  app_namespace       = module.dev_cluster_namespaces.tools_namespace_name
  ingress_subdomain   = module.dev_cluster.ingress_hostname
  olm_namespace       = module.dev_software_olm.olm_namespace
  operator_namespace  = module.dev_software_olm.target_namespace
  name                = "argocd"
}

terraform-gitops-ascent's People

Contributors

seansund avatar

Watchers

Andrew Trice avatar  avatar Kyle Bigler avatar Bobby Woolf avatar Matthew Perrins avatar Noé Samaille avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.