feat: add support for terraform cloud "projects" feature #9 (#10)

Author: davcen

README.md

@@ -11,21 +11,23 @@ Terraform module to provision and manage Terraform Cloud workspaces
 - Variables
 - Variable Set assignments
 
-:warning: For Notifications configuration, only "webhook", "slack" and "microsoft-teams" types are supported at the moment
+> **Warning**
+> 
+> For Notifications configuration, only "webhook", "slack" and "microsoft-teams" types are supported at the moment
 
 ## Usage
 
 ### Simple workspace with local run mode
 ```
 module "workspace_only_for_remote_state" {
   source  = "flowingis/workspace/tfe"
-  version = "0.3.0"
+  version = "0.5.0"
 
   name         = "my-workspace-name"
   organization = "my-organization"
   description  = "Simple workspace that only manages the remote state for some resource on AWS"
 
-  terraform_version = "1.1.9"
+  terraform_version = "1.3.7"
   execution_mode    = "local"
 
   terraform_variables = {
@@ -52,13 +54,13 @@ module "workspace_only_for_remote_state" {
 ```
 module "my_workspace" {
   source  = "flowingis/workspace/tfe"
-  version = "0.3.0"
+  version = "0.5.0"
 
   name         = "my-workspace-name"
   organization = "my-organization"
   description  = "Advanced workspace with remote run mode"
 
-  terraform_version = "1.1.9"
+  terraform_version = "1.3.7"
 
   queue_all_runs            = false
   working_directory         = "/my/sub/path"
@@ -106,13 +108,13 @@ It is possible to integrate this module with [tfe-variable-set module](https://r
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
-| <a name="requirement_tfe"></a> [tfe](#requirement\_tfe) | >= 0.39.0 |
+| <a name="requirement_tfe"></a> [tfe](#requirement\_tfe) | >= 0.40.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_tfe"></a> [tfe](#provider\_tfe) | >= 0.39.0 |
+| <a name="provider_tfe"></a> [tfe](#provider\_tfe) | >= 0.40.0 |
 
 ## Modules
 
@@ -150,6 +152,7 @@ No modules.
 | <a name="input_notification_webhook_configuration"></a> [notification\_webhook\_configuration](#input\_notification\_webhook\_configuration) | (Optional) List of notification configuration of 'Webhook' type<br><br>  Item syntax:<br>  [<br>    {<br>      name = "webhook\_1"<br>      enabled = true<br>      token = "mysupersecrettoken1"<br>      url = "https://myendpoint1.domain.ext"<br>      triggers = [<br>        "created",<br>        "planning",<br>        "needs\_attention",<br>        "applying",<br>        "completed",<br>        "errored"<br>      ]<br>    },<br>    {<br>      name = "webhook\_2"<br>      enabled = false<br>      token = "mysupersecrettoken2"<br>      url = "https://myendpoint2.domain.ext"<br>    },<br>    {<br>      ...<br>    }<br>  ] | <pre>list(object({<br>    name     = string,<br>    enabled  = bool,<br>    token    = string,<br>    url      = string,<br>    triggers = list(string) #Optional<br>  }))</pre> | `[]` | no |
 | <a name="input_oauth_token_id"></a> [oauth\_token\_id](#input\_oauth\_token\_id) | (Optional) The token ID of the VCS connection to use | `string` | `""` | no |
 | <a name="input_organization"></a> [organization](#input\_organization) | (Required) Name of the organization | `string` | n/a | yes |
+| <a name="input_project_id"></a> [project\_id](#input\_project\_id) | (Optional) ID of the project where the workspace should be created | `string` | `""` | no |
 | <a name="input_queue_all_runs"></a> [queue\_all\_runs](#input\_queue\_all\_runs) | (Optional) Whether the workspace should start automatically performing runs immediately after its creation | `bool` | `true` | no |
 | <a name="input_remote_state_consumer_ids"></a> [remote\_state\_consumer\_ids](#input\_remote\_state\_consumer\_ids) | (Optional) The set of workspace IDs set as explicit remote state consumers for the given workspace | `list(string)` | `[]` | no |
 | <a name="input_run_triggers"></a> [run\_triggers](#input\_run\_triggers) | List of source workspaces IDs that trigger runs in this workspace | `list(string)` | `[]` | no |
@@ -164,7 +167,7 @@ No modules.
 | <a name="input_terraform_version"></a> [terraform\_version](#input\_terraform\_version) | (Required) The version of Terraform to use for this workspace | `string` | n/a | yes |
 | <a name="input_trigger_patterns"></a> [trigger\_patterns](#input\_trigger\_patterns) | (Optional) List of glob patterns that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with trigger-prefixes. Only available for Terraform Cloud | `list(string)` | `null` | no |
 | <a name="input_trigger_prefixes"></a> [trigger\_prefixes](#input\_trigger\_prefixes) | (Optional) List of repository-root-relative paths which describe all locations to be tracked for changes | `list(string)` | `null` | no |
-| <a name="input_variable_set_ids"></a> [variable\_set\_ids](#input\_variable\_set\_ids) | List of variable set ids applied to this workspace | `list(string)` | `[]` | no |
+| <a name="input_variable_set_ids"></a> [variable\_set\_ids](#input\_variable\_set\_ids) | (Optional) List of variable set ids applied to this workspace | `list(string)` | `[]` | no |
 | <a name="input_variables_descriptions"></a> [variables\_descriptions](#input\_variables\_descriptions) | (Optional) Map of descriptions applied to workspace variables<br><br>  Item syntax:<br>  {<br>    variable1\_name = "description"<br>    variable2\_name = "description"<br>    ...<br>  } | `map(string)` | `{}` | no |
 | <a name="input_vcs_repository_branch"></a> [vcs\_repository\_branch](#input\_vcs\_repository\_branch) | (Optional) The repository branch that Terraform will execute from | `string` | `""` | no |
 | <a name="input_vcs_repository_identifier"></a> [vcs\_repository\_identifier](#input\_vcs\_repository\_identifier) | (Optional) A reference to your VCS repository in the format <organization>/<repository> where <organization> and <repository> refer to the organization and repository in your VCS provider. The format for Azure DevOps is //\_git/ | `string` | `""` | no |

examples/advanced-workspace/README.md

@@ -31,12 +31,14 @@ Choose the appropriate method to automatically specify these values, like descri
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.1.0 |
-| <a name="requirement_tfe"></a> [tfe](#requirement\_tfe) | ~> 0.39.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.3.0 |
+| <a name="requirement_tfe"></a> [tfe](#requirement\_tfe) | ~> 0.40.0 |
 
 ## Providers
 
-No providers.
+| Name | Version |
+|------|---------|
+| <a name="provider_tfe"></a> [tfe](#provider\_tfe) | ~> 0.40.0 |
 
 ## Modules
 
@@ -46,7 +48,10 @@ No providers.
 
 ## Resources
 
-No resources.
+| Name | Type |
+|------|------|
+| [tfe_project.myproject](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/resources/project) | resource |
+| [tfe_organization.myorg](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/organization) | data source |
 
 ## Inputs
 

examples/advanced-workspace/main.tf

@@ -1,10 +1,10 @@
 terraform {
-  required_version = "~> 1.1.0"
+  required_version = "~> 1.3.0"
 
   required_providers {
     tfe = {
       source  = "hashicorp/tfe"
-      version = "~> 0.39.0"
+      version = "~> 0.40.0"
     }
   }
 }
@@ -13,13 +13,26 @@ provider "tfe" {
   token = var.tfc_token
 }
 
+# Use existing organization
+data "tfe_organization" "myorg" {
+  name = "myorg"
+}
+
+# Use a dedicated project for this workspace
+resource "tfe_project" "myproject" {
+  organization = data.tfe_organization.myorg.name
+  name         = "myproject"
+}
+
 module "advanced_workspace" {
   source = "../../"
 
   name              = "advanced-workspace"
-  organization      = "myorg"
+  organization      = data.tfe_organization.myorg.name
   description       = "An advanced Terraform Cloud/Enterprise workspace"
-  terraform_version = "1.1.9"
+  terraform_version = "1.3.7"
+
+  project_id = tfe_project.myproject.id
 
   terraform_variables = {
     string_variable = "stringvalue"

examples/simple-workspace/README.md

@@ -26,8 +26,8 @@ for further information.
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.1.0 |
-| <a name="requirement_tfe"></a> [tfe](#requirement\_tfe) | ~> 0.39.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.3.0 |
+| <a name="requirement_tfe"></a> [tfe](#requirement\_tfe) | ~> 0.40.0 |
 
 ## Providers
 

examples/simple-workspace/main.tf

@@ -1,10 +1,10 @@
 terraform {
-  required_version = "~> 1.1.0"
+  required_version = "~> 1.3.0"
 
   required_providers {
     tfe = {
       source  = "hashicorp/tfe"
-      version = "~> 0.39.0"
+      version = "~> 0.40.0"
     }
   }
 }

main.tf

@@ -75,6 +75,7 @@ resource "tfe_workspace" "this" {
   file_triggers_enabled         = var.file_triggers_enabled
   global_remote_state           = var.global_remote_state
   remote_state_consumer_ids     = var.remote_state_consumer_ids
+  project_id                    = var.project_id
   queue_all_runs                = var.queue_all_runs
   speculative_enabled           = var.speculative_enabled
   structured_run_output_enabled = var.structured_run_output_enabled

variables.tf

@@ -415,7 +415,13 @@ EOT
 }
 
 variable "variable_set_ids" {
-  description = "List of variable set ids applied to this workspace"
+  description = "(Optional) List of variable set ids applied to this workspace"
   type        = list(string)
   default     = []
 }
+
+variable "project_id" {
+  description = "(Optional) ID of the project where the workspace should be created"
+  type        = string
+  default     = ""
+}

versions.tf

@@ -4,7 +4,7 @@ terraform {
   required_providers {
     tfe = {
       source  = "hashicorp/tfe"
-      version = ">= 0.39.0"
+      version = ">= 0.40.0"
     }
   }
 }