CircleCI Terraform Provider

Setup

provider "circleci" {
  token = "<CircleCI Token>" // Will fallback to CIRCLECI_TOKEN environment variable if not explicitly specified
}

Resources

circleci_environment_variable

For reference, see CircleCI's documentation on Using Environment Variables.

Example Usage:

resource "circleci_environment_variable" "example_environment_variable" {
  project_id  = "${circleci_project.example.id}"
  name        = "MyVariable"
  value       = "${var.environment_variable_value}"
}

Argument Reference:

The following arguments are supported:

• project_id (Required) - The ID of the project (in <vcs_type>/<username>/<name> format).
• name (Required) - The name of the environment variable.
• value (Required) - The value of the environment variable.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id - A string with the format <vcs_type>/<username>/<project_name>/<environment_variable_name>.
• value_masked - A string with four x characters plus the last four ASCII characters of the environment variable's value, consistent with the display of environment variable values in the CircleCI website.

Import

The circleci_environment_variable resource does not support importing.

circleci_project

For reference, see CircleCI's Projects and Builds Documentation.

Example Usage:

resource "circleci_project" "example" {
  vcs_type = "github"
  username = "me"
  name     = "example"
}

Argument Reference:

The following arguments are supported:

• vcs_type (Required) - The version control system type that the project users. Can be either github or bitbucket.
• username (Required) - The username that owns the project in the version control system.
• name (Required) - The name of the project.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id - A string with the format <vcs_type>/<username>/<name>.

Import

Instances can be imported using the id, e.g.

terraform import circleci_project.example github/me/example

circleci_ssh_key

For reference, see CircleCI's documentation on Adding an SSH Key.

Example Usage:

resource "tls_private_key" "example_key" {
  algorithm = "RSA"
  rsa_bits  = "4096"
}

resource "circleci_ssh_key" "example_ssh_key" {
  project_id      = "${circleci_project.example.id}"
  hostname        = "example.com"
  private_key     = "${tls.private_key.example_key.private_key_pem}"
  fingerprint_md5 = "${tls.private_key.example_key.public_key_fingerprint_md5}"
}

Argument Reference:

The following arguments are supported:

• project_id (Required) - The ID of the project (in <vcs_type>/<username>/<name> format).
• hostname (Required) - The hostname for the key.
• private_key (Required) - The private key to use for the given hostname.
• fingerprint_md5 (Required) - The MD5 fingerprint of the given private_key.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id - A string with the format <vcs_type>/<username>/<name>/<hostname>/<fingerprint_md5>.

Import

The circleci_ssh_key resource does not support importing.

Building The Provider

make build