https://github.com/launchbynttdata/tf-azureado-module_reference-pipeline

reference-architecture terraform
Last synced: 2 months ago
JSON representation
Host: GitHub
URL: https://github.com/launchbynttdata/tf-azureado-module_reference-pipeline
Owner: launchbynttdata
License: apache-2.0
Created: 2024-03-25T15:31:00.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-12-19T01:10:15.000Z (5 months ago)
Last Synced: 2025-01-03T10:46:06.774Z (4 months ago)
Topics: reference-architecture, terraform
Language: HCL
Size: 87.9 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project

README

        # tf-azureado-module_reference-pipeline

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/)

## Overview

This repository contains a reference terraform module

## How to Use This Repo

This repo is intended to be used as a template for any new TF module. In some cases, we're able to use our VCS to template for us. In other cases, we aren't.

### Prerequisites

- [asdf](https://github.com/asdf-vm/asdf) used for tool version management

- [make](https://www.gnu.org/software/make/) used for automating various functions of the repo

- [repo](https://android.googlesource.com/tools/repo) used to pull in all components to create the full repo template

### Repo Init

Run the following commands to prep repo and enable all `Makefile` commands to run

```shell

asdf plugin add terraform

asdf plugin add tflint

asdf plugin add golang

asdf plugin add golangci-lint

asdf plugin add nodejs

asdf plugin add opa

asdf plugin add conftest

asdf plugin add pre-commit

asdf plugin add terragrunt

asdf install

```

### Templating

#### Manual Templating

This applies to systems like Azure DevOps and CodeCommit.

We need to clone the repo, rename it, and start a fresh git history to get rid of the `lcaf-skeleton-terraform` history. Below is a loose explanation of how to do this.

``` shell

git clone 

mv lcaf-skeleton-terraform tf-

cd tf-

rm -rf .git

git init

vi .git/HEAD

Change the HEAD to point to `main` instead of `master` and save the `HEAD`

```

#### Remove Educational Material

We need to clear out the example code (different from the boilerplate code). We want to save the repo structure; we don't need the contents. There are `examples`, and `tests` that apply to the boilerplate that we're not going to need as developers of new modules.

Note before you clear these things out, it's useful to actually understand what they are and why they're there. We'll be building our own as we go forward so we need to know what it is we're removing. If this isn't your first module, it's safe to fly through this. If this is your first (or your first several, even), take the time to read the code before you remove it.

```shell

cd path/to/this/repo

rm -rf examples/*

rm -rf README.md

mv TEMPLATED_README.md README.md

```

#### Version Control (VCS) Templating

This applies to systems like GitHub.

TBD

### Repo Setup

#### Overriding Make Behavior

When run, `make` will look for a file called `.lcafenv` in the repository root. This file if present will be included, and it can be used to override variables without altering the [Makefile](Makefile). A few examples of variables that can be substituted are commented out in [the file](.lcafenv).

#### Module Configuration

- You'll need to update [`versions.tf`](./versions.tf) based on your provider needs.

## Explanation of the Skeleton

### Resources and Providers

- Terraform modules define resources that can be instantiated via provider

- Possible providers include but are not limited to `aws`, `azurerm`, and `gcp`

- In this module we generate text resources with the `random` provider

### Module Guidelines

- Each repository should have a default module in its root

  - Should have default values and be instantiable with minimal to no inputs

  - We can think of these default values as the "default example"

- A `Makefile` provides tasks for terraform module development

  - It will clone and cache `caf-components-tf-module` and `caf-components-platform` git repositories when a `make configure` is ran

  - For clearing cached components, it provides a `make clean` command

  - Linter config and all other tasks are defined in `caf-components-tf-module`

- An `examples` folder contains example uses of the default and nested modules

  - There should be at least one example for each nested module

- A `tests` folder contains Go functional tests

  - Make pre-deploy tests that validate terraform plan json where applicable

  - Make post-deploy tests that validate the deployment where applicable

- Provider should be configured by the user, not the module

  - Modules only define what providers/versions are required

### Go Functional Tests

- Modules are how Go manages dependencies

- To initiate a new modules run the command: `go mod init [repo_url]`

  - It is recommended to use the absolute repository url (e.g. github.com/launchbynttdata/lcaf-skeleton-terraform)

- Relative path is highly discouraged in Go, use absolute path to import a package

  - (e.g. `github.com/launchbynttdata/lcaf-skeleton-terraform/[path_to_file]`)

- To update paths or versions run the command: `go get -t ./...`  go will update the dependencies accordingly

## Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | ~> 1.0 |

|  [azuredevops](#requirement\_azuredevops) | ~> 0.11.0 |

|  [azurerm](#requirement\_azurerm) | ~> 3.96 |

## Providers

No providers.

## Modules

| Name | Source | Version |

|------|--------|---------|

|  [resource\_names](#module\_resource\_names) | terraform.registry.launch.nttdata.com/module_library/resource_name/launch | ~> 2.0 |

|  [pipeline](#module\_pipeline) | terraform.registry.launch.nttdata.com/module_primitive/pipelines/azureado | ~> 1.0 |

## Resources

No resources.

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [product\_family](#input\_product\_family) | (Required) Name of the product family for which the resource is created.
    Example: org\_name, department\_name. | `string` | `"dso"` | no |

|  [product\_service](#input\_product\_service) | (Required) Name of the product service for which the resource is created.
    For example, backend, frontend, middleware etc. | `string` | `"azdo"` | no |

|  [environment](#input\_environment) | Environment in which the resource should be provisioned like dev, qa, prod etc. | `string` | `"dev"` | no |

|  [environment\_number](#input\_environment\_number) | The environment count for the respective environment. Defaults to 000. Increments in value of 1 | `string` | `"000"` | no |

|  [resource\_number](#input\_resource\_number) | The resource count for the respective resource. Defaults to 000. Increments in value of 1 | `string` | `"000"` | no |

|  [region](#input\_region) | Azure location of the associated resources | `string` | `"eastus"` | no |

|  [use\_azure\_region\_abbr](#input\_use\_azure\_region\_abbr) | Whether to use Azure region abbreviation for azure region | `bool` | `true` | no |

|  [resource\_names\_map](#input\_resource\_names\_map) | A map of key to resource\_name that will be used by tf-launch-module\_library-resource\_name to generate resource names | 
map(object(
    {
      name       = string
      max_length = optional(number, 60)
    }
  ))
 | {
  "pipeline": {
    "max_length": 60,
    "name": "pipeline"
  }
} | no |

|  [project\_id](#input\_project\_id) | (Required) The project ID or project name. | `string` | n/a | yes |

|  [path](#input\_path) | The folder path of the build definition. | `string` | `null` | no |

|  [agent\_pool\_name](#input\_agent\_pool\_name) | The agent pool that should execute the build. Defaults to Azure Pipelines. | `string` | `"Azure Pipelines"` | no |

|  [ci\_trigger](#input\_ci\_trigger) | The repository block as documented below. | object({
    use_yaml = optional(bool)
    override = optional(object({
      batch = optional(bool)
      branch_filter = optional(object({
        include = optional(list(string))
        exclude = optional(list(string))
      }))
      path_filter = optional(object({
        include = optional(list(string))
        exclude = optional(list(string))
      }))
      max_concurrent_builds_per_branch = number
      polling_interval                 = number
      polling_job_id                   = string
    }))
  })
 | {
  "use_yaml": false
} | no |

|  [pull\_request\_trigger](#input\_pull\_request\_trigger) | Pull Request Integration trigger. | object({
    use_yaml       = bool
    initial_branch = optional(string)
    forks = object({
      enabled       = bool
      share_secrets = bool
    })
    override = optional(object({
      auto_cancel = bool
      branch_filter = optional(object({
        include = optional(list(string))
        exclude = optional(list(string))
      }))
      path_filter = optional(object({
        include = optional(list(string))
        exclude = optional(list(string))
      }))
    }))
  })
 | {
  "forks": {
    "enabled": false,
    "share_secrets": false
  },
  "use_yaml": false
} | no |

|  [variable\_groups](#input\_variable\_groups) | A list of variable group IDs (integers) to link to the build definition. Defaults to {}. | `list(number)` | `null` | no |

|  [features](#input\_features) | A list of variable group IDs (integers) to link to the build definition. Defaults to {}. | object({
    skip_first_run = optional(bool)
  }) | `{}` | no |

|  [queue\_status](#input\_queue\_status) | The queue status of the build definition. Valid values: enabled or paused or disabled. Defaults to enabled. | `string` | `"enabled"` | no |

|  [schedules](#input\_schedules) | The repository block as documented below. | object({
    days_to_build              = list(string)
    schedule_only_with_changes = optional(bool)
    start_hours                = optional(string)
    start_minutes              = optional(string)
    time_zone                  = optional(string)
    branch_filter = optional(object({
      include = optional(list(string))
      exclude = optional(list(string))
    }))
  }) | `null` | no |

|  [repository](#input\_repository) | The repository block as documented below. | object({
    branch_name           = string
    repo_id               = string
    repo_type             = string
    service_connection_id = optional(string)
    yml_path              = optional(string)
    github_enterprise_url = optional(string)
    report_build_status   = optional(bool)
  })
 | n/a | yes |

## Outputs

| Name | Description |

|------|-------------|

|  [id](#output\_id) | n/a |

|  [revision](#output\_revision) | n/a |

|  [schedule\_id](#output\_schedule\_id) | n/a |
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/launchbynttdata/tf-azureado-module_reference-pipeline

Awesome Lists containing this project

README
