Skip to content

Latest commit

 

History

History
102 lines (56 loc) · 1.91 KB

README.md

File metadata and controls

102 lines (56 loc) · 1.91 KB

Terraform state management (for Azure)

Introduction

This module manages storage for Terraform states and is usually used in the Terraform "state" module as a base for other modules' backend configuration.

Usage

Instantiate the module by calling it from Terraform like this:

module "state" {
  source = "dodevops/state/azure"
  version = "<version>"
}

Requirements

The following requirements are needed by this module:

  • terraform (>=1.9.0)

  • azurerm (>=4.0.0)

Providers

The following providers are used by this module:

  • azurerm (>=4.0.0)

Modules

No modules.

Resources

The following resources are used by this module:

Required Inputs

The following input variables are required:

location

Description: The azure location used for azure

Type: string

project

Description: Three letter project key

Type: string

resource_group

Description: Name of the resource group to use

Type: string

stage

Description: Name of the stage for this state

Type: string

Optional Inputs

The following input variables are optional (have default values):

delete_retention_policy

Description: Days until soft deleted resources are hard deleted

Type: number

Default: 7

tags

Description: Map of tags for the resources

Type: map(any)

Default: {}

Outputs

No outputs.

Development

Use the terraform module tools to check and generate the documentation by running

docker run -v "$PWD":/terraform ghcr.io/dodevops/terraform-module-tools:latest