From 3fa779b32be34ad4e0d7e8160d4af1fb18ec965b Mon Sep 17 00:00:00 2001 From: Aram Karapetyan Date: Sun, 3 Sep 2023 13:42:34 +0400 Subject: [PATCH] DMVP-2598: simplify tfe use (#8) * feat!(DMVP-2598): move contents into workspace sub-module and create root module to handle main task * chore(DMVP-2598): adjusting use * chore(DMVP-2598): remove backend as it does not work with cloud * chore(DMVP-2598): simplify * chore(DMVP-2598): adjust values (WIP) * chore(DMVP-2598): fix scm name issue * chore(DMVP-2598): specify backend type as it does not work without * chore(DMVP-2598): more adjustments * chore(DMVP-2598): adjust backend * chore(DMVP-2598): revert backend back to remote * chore(DMVP-2598): bring back variables as it is hard to manage on root level * chore(DMVP-2598): set right locations for terraform files * chore(DMVP-2598): refactor the way we will generate infra resources * chore(DMVP-2598): remove module.path as it looks files in module folder * fix(DMVP-2598): handle empty yaml files * fix(DMVP-2598): exclude files coming from .terraform folder * chore(DMVP-2598): add docs * chore(DMVP-2598): fix typos and move provide into right place * chore(DMVP-2598): remove duplicate terraform definition --- .gitignore | 4 + LICENSE | 201 ++++++++++++++++++ README.md | 50 +++-- modules/workspace/README.md | 77 +++++++ locals.tf => modules/workspace/locals.tf | 0 main.tf => modules/workspace/main.tf | 0 output.tf => modules/workspace/output.tf | 0 .../workspace/templates}/README.md.tftpl | 0 .../workspace/templates}/main.tf.tftpl | 0 .../workspace/templates}/outputs.tf.tftpl | 0 .../workspace/templates}/providers.tf.tftpl | 0 .../workspace/templates}/versions.tf.tftpl | 0 .../yaml-conf-and-workspace-link/.gitignore | 0 .../yaml-conf-and-workspace-link/0-setup.tf | 0 .../yaml-conf-and-workspace-link/1-example.tf | 0 .../yaml-conf-and-workspace-link/2-assert.tf | 0 .../yaml-conf-and-workspace-link/README.md | 0 .../mocks/another-set-of-modules.yaml | 0 .../mocks/modules-state-cleanup.yaml | 0 .../mocks/modules.yaml | 0 modules/workspace/variables.tf | 106 +++++++++ versions.tf => modules/workspace/versions.tf | 0 oauth-client.tf | 9 + tests/basic/0-setup.tf | 8 + tests/basic/1-example.tf | 21 ++ tests/basic/Makefile | 7 + tests/basic/_terraform/component-1/README.md | 10 + tests/basic/_terraform/component-1/main.tf | 19 ++ tests/basic/_terraform/component-1/outputs.tf | 6 + .../basic/_terraform/component-1/providers.tf | 24 +++ .../basic/_terraform/component-1/versions.tf | 23 ++ tests/basic/example-infra/component-1.yaml | 56 +++++ tests/basic/example-infra/empty.yaml | 0 tests/basic/metacloud.yaml | 6 + variable-sets.tf | 29 +++ variables.tf | 143 ++++++------- version.tf | 9 + workspaces.tf | 44 ++++ 38 files changed, 751 insertions(+), 101 deletions(-) create mode 100644 LICENSE create mode 100644 modules/workspace/README.md rename locals.tf => modules/workspace/locals.tf (100%) rename main.tf => modules/workspace/main.tf (100%) rename output.tf => modules/workspace/output.tf (100%) rename {templates => modules/workspace/templates}/README.md.tftpl (100%) rename {templates => modules/workspace/templates}/main.tf.tftpl (100%) rename {templates => modules/workspace/templates}/outputs.tf.tftpl (100%) rename {templates => modules/workspace/templates}/providers.tf.tftpl (100%) rename {templates => modules/workspace/templates}/versions.tf.tftpl (100%) rename {tests => modules/workspace/tests}/yaml-conf-and-workspace-link/.gitignore (100%) rename {tests => modules/workspace/tests}/yaml-conf-and-workspace-link/0-setup.tf (100%) rename {tests => modules/workspace/tests}/yaml-conf-and-workspace-link/1-example.tf (100%) rename {tests => modules/workspace/tests}/yaml-conf-and-workspace-link/2-assert.tf (100%) rename {tests => modules/workspace/tests}/yaml-conf-and-workspace-link/README.md (100%) rename {tests => modules/workspace/tests}/yaml-conf-and-workspace-link/mocks/another-set-of-modules.yaml (100%) rename {tests => modules/workspace/tests}/yaml-conf-and-workspace-link/mocks/modules-state-cleanup.yaml (100%) rename {tests => modules/workspace/tests}/yaml-conf-and-workspace-link/mocks/modules.yaml (100%) create mode 100644 modules/workspace/variables.tf rename versions.tf => modules/workspace/versions.tf (100%) create mode 100644 oauth-client.tf create mode 100644 tests/basic/0-setup.tf create mode 100644 tests/basic/1-example.tf create mode 100644 tests/basic/Makefile create mode 100755 tests/basic/_terraform/component-1/README.md create mode 100755 tests/basic/_terraform/component-1/main.tf create mode 100755 tests/basic/_terraform/component-1/outputs.tf create mode 100755 tests/basic/_terraform/component-1/providers.tf create mode 100755 tests/basic/_terraform/component-1/versions.tf create mode 100644 tests/basic/example-infra/component-1.yaml create mode 100644 tests/basic/example-infra/empty.yaml create mode 100644 tests/basic/metacloud.yaml create mode 100644 variable-sets.tf create mode 100644 version.tf create mode 100644 workspaces.tf diff --git a/.gitignore b/.gitignore index 0235df0..4f6d0dd 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,7 @@ override.tf.json # example: *tfplan* .DS_Store +_tfc +.terraform +**/*.tfbackend +**/terraform.tfvars diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 0357f28..c0b150f 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,31 @@ -# terraform-tfe-cloud -The module allows to generate terraform setups in folders and push/link them with terraform cloud workspace, for examples look into "./tests" folder +# Why +We needed way to run terraform modules using yaml files as it is much simpler. -## minimal example -```hcl -module "this" { - source = "dasmeta/cloud/tfe" +## How +We have decided to use terraform cloud to execute terraform code. +We have decided that it is right to have workspace per module as we do not want giant module dependencies. +We have created terraform module that can parse yaml files, create workspaces and make TFC to execute code / modules. - name = "0-my-dns-setup" - module_source = "dasmeta/dns/aws" - module_version = "1.0.0" - module_vars = { - zone_name = dev.example.com - create_zone = true - records = [] - } -} -``` +Current implementation si very basic: +1. accepts module source/version, variables, dependencies and uses variables from other workspaces if allowed. -to enable pre commit hooks run: -```sh -git config core.hooksPath githooks -``` - -## Requirements +## Caviats +Modules does generate terraform code from yamls and sets up workspaces but since the code is not yet in git repository first run will fail. +After another apply is run from local and resulting code is comitted to git repo it will pick up code and executel. -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | ~> 1.3 | -| [tfe](#requirement\_tfe) | ~> 0.40 | +## How to use +0. Create workspace in terrqform cloud +1. Create folder and place yaml files in the folder +2. Yaml files point to modules and provide variables like done in tests/basic/example-infra folder +3. Supply variables to the module like done in basic tests +4. Terraform apply will create workspaces and code (by default in _terraform folder). +5. Commit the code and TFC will pick up and apply changes as requested. + +## ToDo +1. Modify module to not create workspace immidiately but only when code is comitted (this might create issue with race condition, workspaces can be creared but TFC mighhave had already tried to execute code). +2. There is an issue with some providers (more details in jira). +3. Currently some generated code is escaped which is wrong. +4. Get this repo be managed by terraform module manager terraform repo. ## Providers diff --git a/modules/workspace/README.md b/modules/workspace/README.md new file mode 100644 index 0000000..873c7c2 --- /dev/null +++ b/modules/workspace/README.md @@ -0,0 +1,77 @@ +# terraform-tfe-cloud +The module allows to generate terraform setups in folders and push/link them with terraform cloud workspace, for examples look into "./tests" folder + +## minimal example +```hcl +module "this" { + source = "dasmeta/cloud/tfe" + + name = "0-my-dns-setup" + module_source = "dasmeta/dns/aws" + module_version = "1.0.0" + module_vars = { + zone_name = dev.example.com + create_zone = true + records = [] + } +} +``` + +to enable pre commit hooks run: +```sh +git config core.hooksPath githooks +``` + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | ~> 1.3 | +| [tfe](#requirement\_tfe) | ~> 0.40 | + +## Providers + +| Name | Version | +|------|---------| +| [local](#provider\_local) | 2.4.0 | +| [tfe](#provider\_tfe) | 0.47.0 | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [provider\_custom\_vars\_default\_merged](#module\_provider\_custom\_vars\_default\_merged) | cloudposse/config/yaml//modules/deepmerge | 1.0.2 | + +## Resources + +| Name | Type | +|------|------| +| [local_file.this](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource | +| [tfe_project.project](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/resources/project) | resource | +| [tfe_workspace.this](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/resources/workspace) | resource | +| [tfe_workspace_variable_set.this](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/resources/workspace_variable_set) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [linked\_workspaces](#input\_linked\_workspaces) | The list of workspaces from where we can pull outputs and use in our module variables | `list(string)` | `null` | no | +| [module\_providers](#input\_module\_providers) | The list of providers to add in providers.tf | `any` | `[]` | no | +| [module\_source](#input\_module\_source) | The module source | `string` | n/a | yes | +| [module\_vars](#input\_module\_vars) | The module variables | `any` | `{}` | no | +| [module\_version](#input\_module\_version) | The module version | `string` | n/a | yes | +| [name](#input\_name) | module/repo-folder/workspace name and uniq identifier | `string` | n/a | yes | +| [repo](#input\_repo) | git/vcs repository configurations | 
object({
    identifier         = string                  # / format repo identifier
    branch             = optional(string, null)  # will default to repo default branch if not set
    ingress_submodules = optional(string, false) # whether to fetch submodules a]when cloning vcs
    oauth_token_id     = optional(string, null)  # the auth token generated by resource tfe_oauth_client
    tags_regex         = optional(string, null)  # regular expression used to trigger Workspace run for matching Git tags
  })
| `null` | no | +| [target\_dir](#input\_target\_dir) | The directory where new module folder will be created, this will be terraform project repository root url | `string` | `"./"` | no | +| [terraform\_backend](#input\_terraform\_backend) | Allows to set terraform backend configurations | 
object({
    name    = string
    configs = optional(any, {})
  })
| 
{
  "configs": null,
  "name": null
}
| no | +| [terraform\_version](#input\_terraform\_version) | The required\_version variable value for terraform{} block in versions.tf | `string` | `">= 1.3.0"` | no | +| [variable\_set\_ids](#input\_variable\_set\_ids) | The list of variable set ids to attach to workspace | `list(string)` | `null` | no | +| [workspace](#input\_workspace) | Terraform cloud workspace configurations | 
object({
    org                 = string
    tags                = optional(list(string), null)
    description         = optional(string, null)
    directory           = optional(string, "./") # this seems supposed to be the root directory of git repo
    global_remote_state = optional(bool, true)   # allow org workspaces access to this workspace state, TODO: there is a way to implement specific workspaces whitelisting using remote_state_consumer_ids, needs apply and testing
    project             = optional(string, null) # name of the project to be created and where the workspace should be created
    project_id          = optional(string, null) # ID of the project which already exists, if none of project and project_id is provided Default Project is used for storing workspaces
  })
| n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| [project\_id](#output\_project\_id) | The ID of terraform cloud project | +| [workspace\_id](#output\_workspace\_id) | The ID of created terraform cloud workspace | + diff --git a/locals.tf b/modules/workspace/locals.tf similarity index 100% rename from locals.tf rename to modules/workspace/locals.tf diff --git a/main.tf b/modules/workspace/main.tf similarity index 100% rename from main.tf rename to modules/workspace/main.tf diff --git a/output.tf b/modules/workspace/output.tf similarity index 100% rename from output.tf rename to modules/workspace/output.tf diff --git a/templates/README.md.tftpl b/modules/workspace/templates/README.md.tftpl similarity index 100% rename from templates/README.md.tftpl rename to modules/workspace/templates/README.md.tftpl diff --git a/templates/main.tf.tftpl b/modules/workspace/templates/main.tf.tftpl similarity index 100% rename from templates/main.tf.tftpl rename to modules/workspace/templates/main.tf.tftpl diff --git a/templates/outputs.tf.tftpl b/modules/workspace/templates/outputs.tf.tftpl similarity index 100% rename from templates/outputs.tf.tftpl rename to modules/workspace/templates/outputs.tf.tftpl diff --git a/templates/providers.tf.tftpl b/modules/workspace/templates/providers.tf.tftpl similarity index 100% rename from templates/providers.tf.tftpl rename to modules/workspace/templates/providers.tf.tftpl diff --git a/templates/versions.tf.tftpl b/modules/workspace/templates/versions.tf.tftpl similarity index 100% rename from templates/versions.tf.tftpl rename to modules/workspace/templates/versions.tf.tftpl diff --git a/tests/yaml-conf-and-workspace-link/.gitignore b/modules/workspace/tests/yaml-conf-and-workspace-link/.gitignore similarity index 100% rename from tests/yaml-conf-and-workspace-link/.gitignore rename to modules/workspace/tests/yaml-conf-and-workspace-link/.gitignore diff --git a/tests/yaml-conf-and-workspace-link/0-setup.tf b/modules/workspace/tests/yaml-conf-and-workspace-link/0-setup.tf similarity index 100% rename from tests/yaml-conf-and-workspace-link/0-setup.tf rename to modules/workspace/tests/yaml-conf-and-workspace-link/0-setup.tf diff --git a/tests/yaml-conf-and-workspace-link/1-example.tf b/modules/workspace/tests/yaml-conf-and-workspace-link/1-example.tf similarity index 100% rename from tests/yaml-conf-and-workspace-link/1-example.tf rename to modules/workspace/tests/yaml-conf-and-workspace-link/1-example.tf diff --git a/tests/yaml-conf-and-workspace-link/2-assert.tf b/modules/workspace/tests/yaml-conf-and-workspace-link/2-assert.tf similarity index 100% rename from tests/yaml-conf-and-workspace-link/2-assert.tf rename to modules/workspace/tests/yaml-conf-and-workspace-link/2-assert.tf diff --git a/tests/yaml-conf-and-workspace-link/README.md b/modules/workspace/tests/yaml-conf-and-workspace-link/README.md similarity index 100% rename from tests/yaml-conf-and-workspace-link/README.md rename to modules/workspace/tests/yaml-conf-and-workspace-link/README.md diff --git a/tests/yaml-conf-and-workspace-link/mocks/another-set-of-modules.yaml b/modules/workspace/tests/yaml-conf-and-workspace-link/mocks/another-set-of-modules.yaml similarity index 100% rename from tests/yaml-conf-and-workspace-link/mocks/another-set-of-modules.yaml rename to modules/workspace/tests/yaml-conf-and-workspace-link/mocks/another-set-of-modules.yaml diff --git a/tests/yaml-conf-and-workspace-link/mocks/modules-state-cleanup.yaml b/modules/workspace/tests/yaml-conf-and-workspace-link/mocks/modules-state-cleanup.yaml similarity index 100% rename from tests/yaml-conf-and-workspace-link/mocks/modules-state-cleanup.yaml rename to modules/workspace/tests/yaml-conf-and-workspace-link/mocks/modules-state-cleanup.yaml diff --git a/tests/yaml-conf-and-workspace-link/mocks/modules.yaml b/modules/workspace/tests/yaml-conf-and-workspace-link/mocks/modules.yaml similarity index 100% rename from tests/yaml-conf-and-workspace-link/mocks/modules.yaml rename to modules/workspace/tests/yaml-conf-and-workspace-link/mocks/modules.yaml diff --git a/modules/workspace/variables.tf b/modules/workspace/variables.tf new file mode 100644 index 0000000..1105cc2 --- /dev/null +++ b/modules/workspace/variables.tf @@ -0,0 +1,106 @@ +variable "name" { + type = string + description = "module/repo-folder/workspace name and unique identifier" +} + +variable "module_source" { + type = string + description = "The module source" +} + +variable "module_version" { + type = string + description = "The module version" +} + +variable "workspace" { + type = object({ + org = string + tags = optional(list(string), null) + description = optional(string, null) + directory = optional(string, "./") # this seems supposed to be the root directory of git repo + global_remote_state = optional(bool, true) # allow org workspaces access to this workspace state, TODO: there is a way to implement specific workspaces whitelisting using remote_state_consumer_ids, needs apply and testing + project = optional(string, null) # name of the project to be created and where the workspace should be created + project_id = optional(string, null) # ID of the project which already exists, if none of project and project_id is provided Default Project is used for storing workspaces + }) + description = "Terraform cloud workspace configurations" +} + +variable "module_vars" { + type = any + default = {} + description = "The module variables" +} + +variable "target_dir" { + type = string + default = "./" + description = "The directory where new module folder will be created, this will be terraform project repository root url" +} + +variable "terraform_version" { + type = string + default = ">= 1.3.0" + description = "The required_version variable value for terraform{} block in versions.tf" +} + +variable "module_providers" { + type = any + # object({ + # name = string + # version = string + # source = optional(string) + # alias = optional(string) + # custom_vars = optional(any, {}) + # })) + default = [] + description = "The list of providers to add in providers.tf" +} + +variable "terraform_backend" { + type = object({ + name = string + configs = optional(any, {}) + }) + default = { name = null, configs = null } + description = "Allows to set terraform backend configurations" +} + +variable "repo" { + type = object({ + identifier = string # / format repo identifier + branch = optional(string, null) # will default to repo default branch if not set + ingress_submodules = optional(string, false) # whether to fetch submodules a]when cloning vcs + oauth_token_id = optional(string, null) # the auth token generated by resource tfe_oauth_client + tags_regex = optional(string, null) # regular expression used to trigger Workspace run for matching Git tags + }) + default = null + description = "git/vcs repository configurations" +} + +variable "variable_set_ids" { + type = list(string) + default = null + description = "The list of variable set ids to attach to workspace" +} + +variable "linked_workspaces" { + type = list(string) + default = null + description = "The list of workspaces from where we can pull outputs and use in our module variables" +} + +variable "output" { + type = any + default = [] + description = "The module output" +} + +variable "terraform_backend" { + type = object({ + name = string + configs = optional(any, {}) + }) + default = { name = null, configs = null } + description = "Allows to set terraform backend configurations" +} diff --git a/versions.tf b/modules/workspace/versions.tf similarity index 100% rename from versions.tf rename to modules/workspace/versions.tf diff --git a/oauth-client.tf b/oauth-client.tf new file mode 100644 index 0000000..32999a6 --- /dev/null +++ b/oauth-client.tf @@ -0,0 +1,9 @@ +# for oauth_token_id generation +resource "tfe_oauth_client" "this" { + name = "git-oauth-client" + organization = var.org # this one is terraform cloud organisation + service_provider = local.scm_providers[var.git_provider].provider + http_url = local.scm_providers[var.git_provider].http_url + api_url = local.scm_providers[var.git_provider].api_url + oauth_token = var.git_token +} diff --git a/tests/basic/0-setup.tf b/tests/basic/0-setup.tf new file mode 100644 index 0000000..49f74c6 --- /dev/null +++ b/tests/basic/0-setup.tf @@ -0,0 +1,8 @@ +terraform { + cloud { + organization = "dasmeta-testing" + workspaces { + name = "terraform-tfe-cloud-test" + } + } +} diff --git a/tests/basic/1-example.tf b/tests/basic/1-example.tf new file mode 100644 index 0000000..2ab9f59 --- /dev/null +++ b/tests/basic/1-example.tf @@ -0,0 +1,21 @@ +module "basic" { + source = "../.." + + org = "dasmeta-testing" + token = "< TFC token >" + + rootdir = "_terraform" + targetdir = "_terraform" + yamldir = "example-infra" + + git_provider = "github" + git_org = "dasmeta-testing" + git_repo = "test-infrastructure" + git_token = "< github oauth token >" + + aws = { + access_key_id = "" + secret_access_key = "" + default_region = "" + } +} diff --git a/tests/basic/Makefile b/tests/basic/Makefile new file mode 100644 index 0000000..de8c1ad --- /dev/null +++ b/tests/basic/Makefile @@ -0,0 +1,7 @@ +run: + mkdir _tfc + cd _tfc && \ + terraform init \ + -backend-config="organization=dasmeta-testing" \ + -backend-config="workspaces.name=testing-infrastructure" \ + -from-module="github.com/dasmeta/terraform-tfe-cloud.git?ref=DMVP-2598-simplify-tfe-use" diff --git a/tests/basic/_terraform/component-1/README.md b/tests/basic/_terraform/component-1/README.md new file mode 100755 index 0000000..0b5c768 --- /dev/null +++ b/tests/basic/_terraform/component-1/README.md @@ -0,0 +1,10 @@ +#### This folder content has been generated from by using special terraform code generator module. It is supposed not direct/manual change should be go into files in this folder if there is no special need(like when one debugging) or making hotfix. Please follow the flow/format and instruction on how to manage this content using configuration files (most possible it is .yaml file in root of repo) and corresponding CI/CD action(or terraform generator code next to .yaml file) + +#### the module can be found here https://github.com/dasmeta/terraform-tfe-cloud + + +```txt +tf cloud workspace name: component-1 +tf module source: dasmeta/account/aws +tf_module version: 1.2.2 +``` diff --git a/tests/basic/_terraform/component-1/main.tf b/tests/basic/_terraform/component-1/main.tf new file mode 100755 index 0000000..427f7d9 --- /dev/null +++ b/tests/basic/_terraform/component-1/main.tf @@ -0,0 +1,19 @@ +## This file and its content are generated based on config, pleas check README.md for more details + +module "this" { + source = "dasmeta/account/aws" + version = "1.2.2" + + alarm_actions = {"enabled":true,"slack_webhooks":[{"channel":"test-monitoring","hook_url":"${0-account/secret-reader.secrets.MONITORING_SLACK_HOOK_URL}","username":"reporter"}],"web_endpoints":["${0-account/secret-reader.secrets.MONITORING_OPSGENIE_HOOK_URL_HIGH}"]} + alarm_actions_virginia = {"enabled":true,"slack_webhooks":[{"channel":"test-monitoring","hook_url":"${0-account/secret-reader.secrets.MONITORING_SLACK_HOOK_URL}","username":"reporter2"}],"web_endpoints":["${0-account/secret-reader.secrets.MONITORING_OPSGENIE_HOOK_URL_HIGH}"]} + secrets = {"enabled":true,"values":{}} + providers = {"aws":"aws","aws.virginia":"aws.virginia"} +} + + +data "tfe_outputs" "this" { + for_each = { for workspace in ["0-account/root/secret-reader"] : workspace => workspace } + + organization = "dasmeta-testing" + workspace = replace(each.value, "/[^a-zA-Z0-9_-]+/", "_") +} diff --git a/tests/basic/_terraform/component-1/outputs.tf b/tests/basic/_terraform/component-1/outputs.tf new file mode 100755 index 0000000..beeab86 --- /dev/null +++ b/tests/basic/_terraform/component-1/outputs.tf @@ -0,0 +1,6 @@ +## This file and its content are generated based on config, pleas check README.md for more details + +output "results" { + value = module.this + +} diff --git a/tests/basic/_terraform/component-1/providers.tf b/tests/basic/_terraform/component-1/providers.tf new file mode 100755 index 0000000..fe3cf1b --- /dev/null +++ b/tests/basic/_terraform/component-1/providers.tf @@ -0,0 +1,24 @@ +## This file and its content are generated based on config, pleas check README.md for more details + +provider "aws" { + + + region = "eu-central-1" + + + default_tags { + + tags = {"Account":"test","AppliedFrom":"terraform-cloud","ManageLevel":"account","ManagedBy":"terraform","TerraformCloudWorkspace":"component-1","TerraformModuleSource":"dasmeta/account/aws","TerraformModuleVersion":"1.2.2"} + } +} +provider "aws" { + alias = "virginia" + + region = "us-east-1" + + + default_tags { + + tags = {"Account":"test","AppliedFrom":"terraform-cloud","Environment":"stage","ManageLevel":"product","ManagedBy":"terraform","Product":"test","TerraformCloudWorkspace":"component-1","TerraformModuleSource":"dasmeta/account/aws","TerraformModuleVersion":"1.2.2"} + } +} diff --git a/tests/basic/_terraform/component-1/versions.tf b/tests/basic/_terraform/component-1/versions.tf new file mode 100755 index 0000000..e48e012 --- /dev/null +++ b/tests/basic/_terraform/component-1/versions.tf @@ -0,0 +1,23 @@ +## This file and its content are generated based on config, pleas check README.md for more details + +terraform { + cloud { + organization = "dasmeta-testing" + + workspaces { + name = "component-1" + } + } + + required_providers { + + aws = { + source = "hashicorp/aws" + version = "~> 4.0" + configuration_aliases = [aws.virginia] + } + + } + + required_version = ">= 1.3.0" +} diff --git a/tests/basic/example-infra/component-1.yaml b/tests/basic/example-infra/component-1.yaml new file mode 100644 index 0000000..8e13e9e --- /dev/null +++ b/tests/basic/example-infra/component-1.yaml @@ -0,0 +1,56 @@ +source: dasmeta/account/aws +version: 1.2.2 +variables: + alarm_actions: + enabled: true + slack_webhooks: + - hook_url: ${0-account/secret-reader.secrets.MONITORING_SLACK_HOOK_URL} + channel: test-monitoring + username: reporter + web_endpoints: + - ${0-account/secret-reader.secrets.MONITORING_OPSGENIE_HOOK_URL_HIGH} + alarm_actions_virginia: + enabled: true + slack_webhooks: + - hook_url: ${0-account/secret-reader.secrets.MONITORING_SLACK_HOOK_URL} + channel: test-monitoring + username: reporter2 + web_endpoints: + - ${0-account/secret-reader.secrets.MONITORING_OPSGENIE_HOOK_URL_HIGH} + # cloudtrail: + # enabled: true + # is_organization_trail: false + # enable_cloudwatch_logs: false # TODO: check why we need this and if there is need enable it + # name: "cloud-audit-logs" + # event_selector: [] # TODO: check what about this config and enable/configure if needed + # insight_selector: [] # TODO: check what about this config and enable/configure if needed + # alerts_events: [] # TODO: check what about this config and enable/configure if needed + # enforce_mfa: + # enabled: true + secrets: + enabled: true + values: {} # values will be filled from SM ui in aws web console +providers: + - name: aws + version: ~> 4.0 + module_nested_provider: true + variables: + region: eu-central-1 + default_tags: + tags: + Account: test + ManageLevel: account + - name: aws + alias: virginia + version: ">= 4.0" + module_nested_provider: true + variables: + region: us-east-1 + default_tags: + tags: + Account: test + Environment: stage + Product: test + ManageLevel: product +linked_workspaces: + - 0-account/root/secret-reader diff --git a/tests/basic/example-infra/empty.yaml b/tests/basic/example-infra/empty.yaml new file mode 100644 index 0000000..e69de29 diff --git a/tests/basic/metacloud.yaml b/tests/basic/metacloud.yaml new file mode 100644 index 0000000..d77819a --- /dev/null +++ b/tests/basic/metacloud.yaml @@ -0,0 +1,6 @@ +terraform_cloud_org: dasmeta-testing +terraform_cloud_workspace: terraform-tfe-cloud-test + +git_provider: github +git_org: dasmeta-testing +git_repo: test-infrastructure diff --git a/variable-sets.tf b/variable-sets.tf new file mode 100644 index 0000000..6206ced --- /dev/null +++ b/variable-sets.tf @@ -0,0 +1,29 @@ +# create variable set +module "aws_credentials_variable_set" { + source = "dasmeta/cloud/tfe//modules/variable-set" + version = "1.0.2" + + name = "aws_credentials" + org = var.org + + variables = [ + { + key = "AWS_ACCESS_KEY_ID" + value = var.aws.access_key_id + category = "env" + sensitive = true + }, + { + key = "AWS_SECRET_ACCESS_KEY" + value = var.aws.secret_access_key + category = "env" + sensitive = true + }, + { + key = "AWS_DEFAULT_REGION" + value = var.aws.default_region + category = "env" + sensitive = false + } + ] +} diff --git a/variables.tf b/variables.tf index 93aa804..13776d1 100644 --- a/variables.tf +++ b/variables.tf @@ -1,98 +1,91 @@ -variable "name" { - type = string - description = "module/repo-folder/workspace name and uniq identifier" -} +/** + * The variables can be set in ./terraform.tfvars file or by env variables: -variable "module_source" { + export TF_VAR_{variable-name}=xxxxxxxxxxxxxxx +**/ +# for TFE setup +variable "org" { type = string - description = "The module source" + description = "The terraform cloud org name" } - -variable "module_version" { +variable "token" { type = string - description = "The module version" + description = "The terraform cloud token" } -variable "workspace" { - type = object({ - org = string - tags = optional(list(string), null) - description = optional(string, null) - directory = optional(string, "./") # this seems supposed to be the root directory of git repo - global_remote_state = optional(bool, true) # allow org workspaces access to this workspace state, TODO: there is a way to implement specific workspaces whitelisting using remote_state_consumer_ids, needs apply and testing - project = optional(string, null) # name of the project to be created and where the workspace should be created - project_id = optional(string, null) # ID of the project which already exists, if none of project and project_id is provided Default Project is used for storing workspaces - }) - - description = "Terraform cloud workspace configurations" -} - -variable "module_vars" { - type = any - default = {} - description = "The module variables" +# For code generation +variable "yamldir" { + type = string + default = "." + description = "The directory where yamls located" } -variable "target_dir" { +variable "targetdir" { type = string - default = "./" - description = "The directory where new module folder will be created, this will be terraform project repository root url" + default = "./../_terraform/" + description = "The directory where tf cloud workspace corresponding workspaces will be created" } -variable "terraform_version" { +variable "rootdir" { type = string - default = ">= 1.3.0" - description = "The required_version variable value for terraform{} block in versions.tf" + default = "./_terraform/" + description = "The directory on git repo where the workspaces creator main.tf file located " } -variable "module_providers" { - type = any - # object({ - # name = string - # version = string - # source = optional(string) - # alias = optional(string) - # custom_vars = optional(any, {}) - # })) - default = [] - description = "The list of providers to add in providers.tf" +# SCM +locals { + scm_providers = { + github = { + http_url = "https://github.com" + api_url = "https://api.github.com" + provider = "github" + } + gitlab = { + http_url = "https://gitlab.com" + api_url = "https://gitlab.com/api/v4" + provider = "gitlab_hosted" + } + } } -variable "output" { - type = any - default = [] - description = "The module output" +variable "git_provider" { + type = string + default = "gitlab" + description = "The vsc(github, gitlab, ...) provider id" } -variable "terraform_backend" { - type = object({ - name = string - configs = optional(any, {}) - }) - default = { name = null, configs = null } - description = "Allows to set terraform backend configurations" +variable "git_org" { + type = string + description = "The github org/owner name" } - -variable "repo" { - type = object({ - identifier = string # / format repo identifier - branch = optional(string, null) # will default to repo default branch if not set - ingress_submodules = optional(string, false) # whether to fetch submodules a]when cloning vcs - oauth_token_id = optional(string, null) # the auth token generated by resource tfe_oauth_client - tags_regex = optional(string, null) # regular expression used to trigger Workspace run for matching Git tags - }) - default = null - description = "git/vcs repository configurations" +variable "git_repo" { + type = string + description = "The github repo name without org prefix" } - -variable "variable_set_ids" { - type = list(string) - default = null - description = "The list of variable set ids to attach to workspace" +variable "git_token" { + type = string + description = "The vsc(github, gitlab, ...) personal access token" } -variable "linked_workspaces" { - type = list(string) - default = null - description = "The list of workspaces from where we can pull outputs and use in our module variables" +# Cloud Access (goes to shared variable set, should be adjusted) +variable "aws" { + type = map(any) + default = { + access_key_id = "" + secret_access_key = "" + default_region = "" + } + # variable "aws_access_key_id" { + # type = string + # description = "The aws user access key" + # } + # variable "aws_secret_access_key" { + # type = string + # description = "The aws user secret access key" + # } + # variable "aws_default_region" { + # type = string + # default = "eu-central-1" + # description = "The aws default region" + # } } diff --git a/version.tf b/version.tf new file mode 100644 index 0000000..f1e6ec6 --- /dev/null +++ b/version.tf @@ -0,0 +1,9 @@ +terraform { + required_providers { + tfe = { + version = "~> 0.40" + } + } + + required_version = ">= 1.3.0" +} diff --git a/workspaces.tf b/workspaces.tf new file mode 100644 index 0000000..e6bf63a --- /dev/null +++ b/workspaces.tf @@ -0,0 +1,44 @@ +locals { + yaml_files_raw = { + for file in fileset( + var.yamldir, + "**/*.yaml" + ) : replace(file, "/.yaml$/", "") => try(yamldecode(file("${var.yamldir}/${file}")), {}) + if length(regexall("\\.terraform", file)) <= 0 # exclude files coming from .terraform folder + } + + yaml_files = { for key, item in local.yaml_files_raw : key => item + if try(item.source, null) != null && try(item.version, null) != null } +} + +module "workspaces" { + # source = "dasmeta/cloud/tfe" + # version = "1.0.4" + # source = "/Users/juliaaghamyan/Desktop/dasmeta/terraform-tfe-cloud/" + source = "git::https://github.com/dasmeta/terraform-tfe-cloud.git?ref=DMVP-fix-var" + + # for_each = { for key, item in yamldecode(file("./infra.yaml")) : key => item } # single file mode + for_each = local.yaml_files # folder with files mode + + name = each.key + module_source = each.value.source + module_version = each.value.version + module_vars = each.value.variables + output = try(each.value.output, null) + target_dir = var.targetdir + + module_providers = try(each.value.providers, []) + linked_workspaces = try(each.value.linked_workspaces, null) + + workspace = { + org = var.org + directory = var.rootdir + } + + repo = { + identifier = "${var.git_org}/${var.git_repo}" + oauth_token_id = tfe_oauth_client.this.oauth_token_id + } + + variable_set_ids = concat([module.aws_credentials_variable_set.id], try(each.value.variable_set_ids, [])) +}