» rancher_environment

Provides a Rancher Environment resource. This can be used to create and manage environments on rancher.

» Example Usage

# Create a new Rancher environment
resource "rancher_environment" "default" {
  name = "staging"
  description = "The staging environment"
  orchestration = "cattle"

  member {
    external_id = "650430"
    external_id_type = "github_user"
    role = "owner"
  }

  member {
    external_id = "1234"
    external_id_type = "github_team"
    role = "member"
  }
}

» Argument Reference

The following arguments are supported:

  • name - (Required) The name of the environment.
  • description - (Optional) An environment description.
  • orchestration - (Optional) Must be one of cattle, swarm, mesos, windows or kubernetes. This is a helper for setting the project_template_ids for the included Rancher templates. This will conflict with project_template_id setting. Changing this forces a new resource to be created.
  • project_template_id - (Optional) This can be any valid project template ID. If this is set, then orchestration can not be. Changing this forces a new resource to be created.
  • member - (Optional) Members to add to the environment.

» Member Parameters Reference

A member takes three parameters:

  • external_id - (Required) The external ID of the member.
  • external_id_type - (Required) The external ID type of the member.
  • role - (Required) The role of the member in the environment.

» Attributes Reference

  • id - The ID of the environment (ie 1a11) that can be used in other Terraform resources such as Rancher Stack definitions.

» Import

Environments can be imported using their Rancher API ID, e.g.

$ terraform import rancher_environment.dev 1a15