Terraform Codename provider

The Codename provider is used to generate random pronounceable, sometimes even memorable, "superhero like" codenames - just like Docker does with container names.

The "codename" provider allows the generation of default random names within Terraform configurations. This is a logical provider, which means that it works entirely within Terraform's logic, and doesn't interact with any other services.

⚠️ this provider has been developed for educational purpose

Installation

Clone this repository:

$ git clone https://github.com/lucasepe/terraform-provider-codename

Enter the provider directory:

$ cd terraform-provider-codename

Build it:

$ make build

To install the plugin locally, type:

$ make install

Usage

Define a provider requirement:

terraform {
  required_providers {
    codename = {
      version = ">= 0.1.0"
      source  = "github.com/lucasepe/codename"
    }
  }
}

Declare the provider:

provider "codename" {}

Use the codename resource defined in this provider:

resource "codename" "example1" {
  snakefy      = true
  token_length = 4
}

resource "codename" "example2" {
  prefix = "it->"
}

output "codename1" {
  value = codename.example1.id
}

output "codename2" {
  value = codename.example2.id
}

Initialize a working directory:

$ terraform init
Initializing the backend...

Initializing provider plugins...
- Finding github.com/lucasepe/codename versions matching ">= 0.1.0"...
- Installing github.com/lucasepe/codename v0.1.0...
- Installed github.com/lucasepe/codename v0.1.0 (unauthenticated)

...

Execute the terraform script:

$ terraform apply -auto-approve
...
Apply complete! Resources: 2 added, 0 changed, 0 destroyed.

Outputs:

codename1 = "adequate_retro_girl_8157"
codename2 = "it->still-karate"