Blueprint

6min

The primary Terraform resource for the Terraform blueprint is the autocloud_blueprint resource. This resource combines all the configuration elements together and defines the display, contents, and (optionally) the destination pull request for the code a consumer generates when using the blueprint, and creates the blueprint in AutoCloud. The sections that follow define the arguments the resource requires.
Metadata
The Terraform blueprint requires some metadata used to define how it is displayed in the catalog to consumers. This metadata consists of five arguments:
Argument
Description
Required
name
A string with a descriptive display name for the blueprint.
Yes
author
The email address of the AutoCloud user who is responsible for maintaining the blueprint.
Yes
description
A short description of the purpose of the blueprint and the resources it will generate.
Yes
labels
An array of string labels to apply to the blueprint for searching and filtering.
Yes
instructions
A markdown string containing instructions to the consumer indicating how they should complete the blueprint.
Yes
Example:
Terraform
####
# Create Blueprint
#
resource "autocloud_blueprint" "this" {
  name = "KMS Encrypted S3 Bucket"

  ###
  # UI Configuration
  #
  author       = "john@autocloud.dev" # Must be a valid email address
  description  = "KMS Encrypted S3 Bucket"
  instructions = <<-EOT
  To deploy this generator, follow these simple steps:

    * step 1: step 1 description
    * step 2: step 2 description
    * step 3: step 3 description
  EOT

  labels = ["aws"]
}
####
# Create Blueprint
#
resource "autocloud_blueprint" "this" {
  name = "KMS Encrypted S3 Bucket"

  ###
  # UI Configuration
  #
  author       = "john@autocloud.dev" # Must be a valid email address
  description  = "KMS Encrypted S3 Bucket"
  instructions = <<-EOT
  To deploy this generator, follow these simple steps:

    * step 1: step 1 description
    * step 2: step 2 description
    * step 3: step 3 description
  EOT

  labels = ["aws"]
}
﻿
Config
The Terraform blueprint requires and accepts one config argument, which contains the final configuration of the modules as defined by the autocloud_blueprint_config data resources.
Example:
Terraform
###
# Form configuration
config = data.autocloud_blueprint_config.final.config
###
# Form configuration
config = data.autocloud_blueprint_config.final.config
﻿
Source Control Destination
A Terraform blueprint can have a set of target git repositories the consumer is allowed to submit generated code to for review and deployment. If no git_config is defined for a blueprint, the consumer will still be able to download the terraform code generated by the blueprint. The git_config argument block specifies this configuration. Only one git_config block is allowed. The block supports four arguments:
Argument
Description
Required
destination_branch
Defines the destination branch the generated pull request will target.
Yes
git_url_options
An array of of Git repository URLs the user can submit code to.
Yes
git_url_default
The default Git repository to submit to, needs to be in the git_url_options block.
Yes
pull_request
A block specifying the configuration for the generated pull request. See below.
Yes
 The pull_request block supports four arguments:
Argument
Description
Required
title
A string defining the pull request title. Interpolation supported.
Yes
commit_message_template
A string defining the commit message used to commit the generated code. Interpolation supported.
Yes
body
A markdown string defining the contents of the pull request. Interpolation supported.
Yes
variables
A dictionary of keys and values used in interpolating the other arguments.
No
Example:
Terraform
###
# Destination repository git configuraiton
#
git_config {
  destination_branch = "main"

  git_url_options = [
    "git@github.com:autoclouddev/infrastructure-live-demo.git",
    "git@github.com:autoclouddev/infrastructure-live-nonprod.git"
  ]
  git_url_default = "git@github.com:autoclouddev/infrastructure-live-demo.git"

  pull_request {
    title                   = "[AutoCloud] new KMS Encrypted S3 Bucket {{namespace}}-{{environment}}-{{name}}, created by {{authorName}}"
    commit_message_template = "[AutoCloud] new KMS Encrypted S3 Bucket {{namespace}}-{{environment}}-{{name}}, created by {{authorName}}"
    body                    = file("./files/pull_request.md.tpl")
    variables = {
      authorName = "generic.authorName"
      namespace   = "kmskey.namespace"
      environment = "kmskey.environment"
      name        = "kmskey.name"
    }
  }
}
###
# Destination repository git configuraiton
#
git_config {
  destination_branch = "main"

  git_url_options = [
    "git@github.com:autoclouddev/infrastructure-live-demo.git",
    "git@github.com:autoclouddev/infrastructure-live-nonprod.git"
  ]
  git_url_default = "git@github.com:autoclouddev/infrastructure-live-demo.git"

  pull_request {
    title                   = "[AutoCloud] new KMS Encrypted S3 Bucket {{namespace}}-{{environment}}-{{name}}, created by {{authorName}}"
    commit_message_template = "[AutoCloud] new KMS Encrypted S3 Bucket {{namespace}}-{{environment}}-{{name}}, created by {{authorName}}"
    body                    = file("./files/pull_request.md.tpl")
    variables = {
      authorName = "generic.authorName"
      namespace   = "kmskey.namespace"
      environment = "kmskey.environment"
      name        = "kmskey.name"
    }
  }
}
﻿
﻿Output File Definition﻿
﻿A Terraform blueprint can have multiple output files which contain the generated code. These files are specified using the file argument block. The block supports four arguments:﻿
Argument
Description
Required
action
Defines the action, currently must always be "CREATE".
Yes
destination
Defines the path relative to the Git repository root where the file will be created. Interpolation supported.
Yes
variables
A dictionary of keys and values used in interpolating the destination string.
No
modules
An array of modules to include in the file, referenced by their Terraform resource name.
Yes
Example:
Terraform
###
# File definitions
#
file {
  action      = "CREATE"
  destination = "aws/{{environment}}/{{namespace}}-{{environment}}-{{name}}.tf"
  variables = {
    namespace   = "kmskey.namespace"
    environment = "kmskey.environment"
    name        = "kmskey.name"
  }

  modules = [
    autocloud_module.kms_key.name,
    autocloud_module.s3_bucket.name,
  ]
}
###
# File definitions
#
file {
  action      = "CREATE"
  destination = "aws/{{environment}}/{{namespace}}-{{environment}}-{{name}}.tf"
  variables = {
    namespace   = "kmskey.namespace"
    environment = "kmskey.environment"
    name        = "kmskey.name"
  }

  modules = [
    autocloud_module.kms_key.name,
    autocloud_module.s3_bucket.name,
  ]
}
﻿
﻿

Updated 18 May 2023

Did this page help you?

Variable Definitions

Configuration Options

Docs powered by Archbee

TABLE OF CONTENTS

Metadata

Config

Source Control Destination

Output File Definition

Argument	Description	Required
name	A string with a descriptive display name for the blueprint.	Yes
author	The email address of the AutoCloud user who is responsible for maintaining the blueprint.	Yes
description	A short description of the purpose of the blueprint and the resources it will generate.	Yes
labels	An array of string labels to apply to the blueprint for searching and filtering.	Yes
instructions	A markdown string containing instructions to the consumer indicating how they should complete the blueprint.	Yes

Blueprint

Metadata

Config

Source Control Destination

﻿Output File Definition﻿

Output File Definition