From fc605eb1d203c9f2d7e88c073d8a02b1cc853c3a Mon Sep 17 00:00:00 2001 From: Sebastian Rivera Date: Tue, 23 Apr 2024 15:17:27 -0400 Subject: [PATCH] Rebrand Terraform Cloud to HCP Terraform (#1328) --- .github/ISSUE_TEMPLATE/bug_report.md | 12 +++++----- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- .github/actions/test-provider-tfe/action.yml | 18 +++++++-------- .github/workflows/create-release-pr.yml | 2 +- CHANGELOG.md | 6 ++--- README.md | 9 ++++---- docs/backwards-compatibility.md | 6 ++--- docs/beta.md | 2 +- docs/development-environment.md | 2 +- docs/index.md | 2 +- docs/test-infrastructure.md | 4 ++-- docs/testing.md | 12 +++++----- examples/workspaces_variables/README.md | 18 +++++++-------- examples/workspaces_variables/manager/main.tf | 4 ++-- .../workspaces_variables/manager/providers.tf | 2 +- ...ata_source_organization_membership_test.go | 2 +- internal/provider/data_source_policy_set.go | 2 +- internal/provider/helper_test.go | 4 ++-- internal/provider/id_helpers.go | 2 +- internal/provider/provider.go | 2 +- internal/provider/provider_next.go | 4 ++-- .../provider/resource_tfe_opa_version_test.go | 4 ++-- internal/provider/resource_tfe_policy_set.go | 2 +- .../resource_tfe_sentinel_version_test.go | 4 ++-- .../resource_tfe_team_project_access.go | 2 +- .../resource_tfe_terraform_version_test.go | 4 ++-- .../provider/resource_tfe_workspace_test.go | 2 +- .../cdktf/csharp/d/ip_ranges.html.markdown | 6 ++--- .../cdktf/csharp/d/organization.html.markdown | 4 ++-- .../d/organization_membership.html.markdown | 2 +- .../d/organization_run_task.html.markdown | 2 +- .../docs/cdktf/csharp/d/slug.html.markdown | 2 +- .../cdktf/csharp/d/workspace.html.markdown | 10 ++++----- .../csharp/d/workspace_run_task.html.markdown | 2 +- website/docs/cdktf/csharp/index.html.markdown | 22 +++++++++---------- ...gent_pool_allowed_workspaces.html.markdown | 4 ++-- .../cdktf/csharp/r/agent_token.html.markdown | 2 +- .../notification_configuration.html.markdown | 6 ++--- .../cdktf/csharp/r/oauth_client.html.markdown | 4 ++-- .../cdktf/csharp/r/opa_version.html.markdown | 2 +- .../cdktf/csharp/r/organization.html.markdown | 4 ++-- .../r/organization_membership.html.markdown | 2 +- .../r/organization_run_task.html.markdown | 2 +- .../csharp/r/registry_module.html.markdown | 2 +- .../cdktf/csharp/r/run_trigger.html.markdown | 2 +- .../csharp/r/sentinel_version.html.markdown | 6 ++--- .../r/team_organization_member.html.markdown | 2 +- .../r/team_organization_members.html.markdown | 2 +- .../csharp/r/terraform_version.html.markdown | 6 ++--- .../cdktf/csharp/r/variable.html.markdown | 2 +- .../cdktf/csharp/r/workspace.html.markdown | 9 ++++---- .../csharp/r/workspace_run.html.markdown | 6 ++--- .../csharp/r/workspace_run_task.html.markdown | 2 +- .../csharp/r/workspace_settings.markdown | 2 +- .../docs/cdktf/go/d/ip_ranges.html.markdown | 6 ++--- .../cdktf/go/d/organization.html.markdown | 4 ++-- .../d/organization_membership.html.markdown | 2 +- .../go/d/organization_run_task.html.markdown | 2 +- website/docs/cdktf/go/d/slug.html.markdown | 2 +- .../docs/cdktf/go/d/workspace.html.markdown | 10 ++++----- .../go/d/workspace_run_task.html.markdown | 2 +- website/docs/cdktf/go/index.html.markdown | 22 +++++++++---------- ...gent_pool_allowed_workspaces.html.markdown | 4 ++-- .../docs/cdktf/go/r/agent_token.html.markdown | 2 +- .../notification_configuration.html.markdown | 6 ++--- .../cdktf/go/r/oauth_client.html.markdown | 4 ++-- .../docs/cdktf/go/r/opa_version.html.markdown | 4 ++-- .../cdktf/go/r/organization.html.markdown | 4 ++-- .../r/organization_membership.html.markdown | 2 +- .../go/r/organization_run_task.html.markdown | 2 +- .../cdktf/go/r/registry_module.html.markdown | 2 +- .../docs/cdktf/go/r/run_trigger.html.markdown | 2 +- .../cdktf/go/r/sentinel_version.html.markdown | 6 ++--- .../r/team_organization_member.html.markdown | 2 +- .../r/team_organization_members.html.markdown | 2 +- .../go/r/terraform_version.html.markdown | 6 ++--- .../docs/cdktf/go/r/variable.html.markdown | 2 +- .../docs/cdktf/go/r/workspace.html.markdown | 9 ++++---- .../cdktf/go/r/workspace_run.html.markdown | 6 ++--- .../go/r/workspace_run_task.html.markdown | 2 +- .../cdktf/go/r/workspace_settings.markdown | 2 +- .../docs/cdktf/java/d/ip_ranges.html.markdown | 6 ++--- .../cdktf/java/d/organization.html.markdown | 4 ++-- .../d/organization_membership.html.markdown | 2 +- .../d/organization_run_task.html.markdown | 2 +- website/docs/cdktf/java/d/slug.html.markdown | 2 +- .../docs/cdktf/java/d/workspace.html.markdown | 10 ++++----- .../java/d/workspace_run_task.html.markdown | 2 +- website/docs/cdktf/java/index.html.markdown | 22 +++++++++---------- ...gent_pool_allowed_workspaces.html.markdown | 4 ++-- .../cdktf/java/r/agent_token.html.markdown | 2 +- .../notification_configuration.html.markdown | 6 ++--- .../cdktf/java/r/oauth_client.html.markdown | 4 ++-- .../cdktf/java/r/opa_version.html.markdown | 4 ++-- .../cdktf/java/r/organization.html.markdown | 4 ++-- .../r/organization_membership.html.markdown | 2 +- .../r/organization_run_task.html.markdown | 2 +- .../java/r/registry_module.html.markdown | 2 +- .../cdktf/java/r/run_trigger.html.markdown | 2 +- .../java/r/sentinel_version.html.markdown | 6 ++--- .../r/team_organization_member.html.markdown | 2 +- .../r/team_organization_members.html.markdown | 2 +- .../java/r/terraform_version.html.markdown | 6 ++--- .../docs/cdktf/java/r/variable.html.markdown | 2 +- .../docs/cdktf/java/r/workspace.html.markdown | 9 ++++---- .../cdktf/java/r/workspace_run.html.markdown | 6 ++--- .../java/r/workspace_run_task.html.markdown | 2 +- .../cdktf/java/r/workspace_settings.markdown | 2 +- .../cdktf/python/d/ip_ranges.html.markdown | 6 ++--- .../cdktf/python/d/organization.html.markdown | 4 ++-- .../d/organization_membership.html.markdown | 2 +- .../d/organization_run_task.html.markdown | 2 +- .../docs/cdktf/python/d/slug.html.markdown | 2 +- .../cdktf/python/d/workspace.html.markdown | 10 ++++----- .../python/d/workspace_run_task.html.markdown | 2 +- website/docs/cdktf/python/index.html.markdown | 20 ++++++++--------- ...gent_pool_allowed_workspaces.html.markdown | 4 ++-- .../cdktf/python/r/agent_token.html.markdown | 2 +- .../notification_configuration.html.markdown | 6 ++--- .../cdktf/python/r/oauth_client.html.markdown | 4 ++-- .../cdktf/python/r/opa_version.html.markdown | 4 ++-- .../cdktf/python/r/organization.html.markdown | 4 ++-- .../r/organization_membership.html.markdown | 2 +- .../r/organization_run_task.html.markdown | 2 +- .../python/r/registry_module.html.markdown | 2 +- .../cdktf/python/r/run_trigger.html.markdown | 2 +- .../python/r/sentinel_version.html.markdown | 6 ++--- .../r/team_organization_member.html.markdown | 2 +- .../r/team_organization_members.html.markdown | 2 +- .../python/r/terraform_version.html.markdown | 6 ++--- .../cdktf/python/r/variable.html.markdown | 2 +- .../cdktf/python/r/workspace.html.markdown | 8 +++---- .../python/r/workspace_run.html.markdown | 6 ++--- .../python/r/workspace_run_task.html.markdown | 2 +- .../python/r/workspace_settings.markdown | 2 +- .../typescript/d/ip_ranges.html.markdown | 6 ++--- .../typescript/d/organization.html.markdown | 4 ++-- .../d/organization_membership.html.markdown | 2 +- .../d/organization_run_task.html.markdown | 2 +- .../cdktf/typescript/d/slug.html.markdown | 2 +- .../typescript/d/workspace.html.markdown | 10 ++++----- .../d/workspace_run_task.html.markdown | 2 +- .../docs/cdktf/typescript/index.html.markdown | 20 ++++++++--------- ...gent_pool_allowed_workspaces.html.markdown | 4 ++-- .../typescript/r/agent_token.html.markdown | 2 +- .../notification_configuration.html.markdown | 6 ++--- .../typescript/r/oauth_client.html.markdown | 4 ++-- .../typescript/r/opa_version.html.markdown | 4 ++-- .../typescript/r/organization.html.markdown | 8 +++++-- .../r/organization_membership.html.markdown | 2 +- .../r/organization_run_task.html.markdown | 2 +- .../r/registry_module.html.markdown | 2 +- .../typescript/r/run_trigger.html.markdown | 2 +- .../r/sentinel_version.html.markdown | 6 ++--- .../r/team_organization_member.html.markdown | 2 +- .../r/team_organization_members.html.markdown | 2 +- .../r/terraform_version.html.markdown | 6 ++--- .../cdktf/typescript/r/variable.html.markdown | 2 +- .../typescript/r/workspace.html.markdown | 8 +++---- .../typescript/r/workspace_run.html.markdown | 6 ++--- .../r/workspace_run_task.html.markdown | 2 +- .../typescript/r/workspace_settings.markdown | 2 +- website/docs/d/ip_ranges.html.markdown | 6 ++--- website/docs/d/organization.html.markdown | 4 ++-- .../d/organization_membership.html.markdown | 2 +- .../d/organization_run_task.html.markdown | 2 +- website/docs/d/slug.html.markdown | 2 +- website/docs/d/workspace.html.markdown | 10 ++++----- .../docs/d/workspace_run_task.html.markdown | 2 +- website/docs/index.html.markdown | 22 +++++++++---------- ...gent_pool_allowed_workspaces.html.markdown | 4 ++-- website/docs/r/agent_token.html.markdown | 2 +- .../notification_configuration.html.markdown | 6 ++--- website/docs/r/oauth_client.html.markdown | 4 ++-- website/docs/r/opa_version.html.markdown | 4 ++-- website/docs/r/organization.html.markdown | 4 ++-- .../r/organization_membership.html.markdown | 2 +- .../r/organization_run_task.html.markdown | 2 +- website/docs/r/registry_module.html.markdown | 2 +- website/docs/r/run_trigger.html.markdown | 2 +- website/docs/r/sentinel_version.html.markdown | 6 ++--- .../r/team_organization_member.html.markdown | 2 +- .../r/team_organization_members.html.markdown | 2 +- .../docs/r/terraform_version.html.markdown | 6 ++--- website/docs/r/variable.html.markdown | 2 +- website/docs/r/workspace.html.markdown | 8 +++---- website/docs/r/workspace_run.html.markdown | 6 ++--- .../docs/r/workspace_run_task.html.markdown | 2 +- website/docs/r/workspace_settings.markdown | 2 +- 190 files changed, 426 insertions(+), 424 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 59621c190..2ea5f5cfd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,16 +9,16 @@ labels: bug Hi there, Thank you for opening an issue! Please note that we try to keep the this issue tracker reserved for -bug reports and feature requests related to the Terraform Cloud/Enterprise provider. If you know -your issue relates to the Terraform Cloud/Enterprise platform itself, please contact +bug reports and feature requests related to the HCP Terraform and Terraform Enterprise provider. If you know +your issue relates to the HCP Terraform or Terraform Enterprise platform itself, please contact tf-cloud@hashicorp.support. For general usage questions, please post to our community forum: https://discuss.hashicorp.com. --> -#### Terraform Cloud/Enterprise version +#### Terraform Enterprise version @@ -27,8 +27,8 @@ Example: Terraform Enterprise v202104-1 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a5d2f0a85..670214e59 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,9 +3,9 @@ blank_issues_enabled: false contact_links: - - name: Terraform Cloud/Enterprise Troubleshooting and Feature Requests + - name: HCP Terraform or Terraform Enterprise Troubleshooting and Feature Requests url: https://support.hashicorp.com/hc/en-us/requests/new - about: For issues and feature requests concerning the Terraform Cloud/Enterprise platform itself, please submit a HashiCorp support request or email tf-cloud@hashicorp.support + about: For issues and feature requests concerning the HCP Terraform and Terraform Enterprise platform itself, please submit a HashiCorp support request or email tf-cloud@hashicorp.support - name: Terraform Language or Workflow Questions url: https://discuss.hashicorp.com about: Please ask Terraform language or workflow related questions through the HashiCorp Discuss forum diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 40b1fd653..b77cb636f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -9,8 +9,8 @@ labels: feature-request Hi there, Thank you for opening a request! Please note that we try to keep the this issue tracker reserved for -bug reports and feature requests related to the Terraform Cloud/Enterprise provider. If you know -your request relates to the Terraform Cloud/Enterprise platform itself, please contact +bug reports and feature requests related to the HCP Terraform and Terraform Enterprise provider. If you know +your request relates to the HCP Terraform and Terraform Enterprise platform itself, please contact tf-cloud@hashicorp.support. For general usage questions, please post to our community forum: https://discuss.hashicorp.com. --> diff --git a/.github/actions/test-provider-tfe/action.yml b/.github/actions/test-provider-tfe/action.yml index b6b48a3c4..70ccd2bae 100644 --- a/.github/actions/test-provider-tfe/action.yml +++ b/.github/actions/test-provider-tfe/action.yml @@ -5,25 +5,25 @@ name: Test description: Tests terraform-provider-tfe within a matrix inputs: admin_configuration_token: - description: TFC Admin API Configuration role token + description: HCP Terraform Admin API Configuration role token required: true admin_provision_licenses_token: - description: TFC Admin API Provision Licenses role token + description: HCP Terraform Admin API Provision Licenses role token required: true admin_security_maintenance_token: - description: TFC Admin API Security Maintenance role token + description: HCP Terraform Admin API Security Maintenance role token required: true admin_site_admin_token: - description: TFC Admin API Site Admin role token + description: HCP Terraform Admin API Site Admin role token required: true admin_subscription_token: - description: TFC Admin API Subscription role token + description: HCP Terraform Admin API Subscription role token required: true admin_support_token: - description: TFC Admin API Support role token + description: HCP Terraform Admin API Support role token required: true admin_version_maintenance_token: - description: TFC Admin API Version Maintenance role token + description: HCP Terraform Admin API Version Maintenance role token required: true matrix_index: description: Index of the matrix strategy runner @@ -32,10 +32,10 @@ inputs: description: Total number of matrix strategy runners required: true hostname: - description: Hostname of the Terraform Cloud instance to test against + description: Hostname of the HCP Terraform or Terraform Enterprise instance to test against required: true token: - description: Terraform Cloud token + description: HCP Terraform or Terraform Enterprise token required: true testing-github-token: description: The GitHub token used for testing scenarios diff --git a/.github/workflows/create-release-pr.yml b/.github/workflows/create-release-pr.yml index b9c4d15e5..6d1e8102c 100644 --- a/.github/workflows/create-release-pr.yml +++ b/.github/workflows/create-release-pr.yml @@ -111,7 +111,7 @@ jobs: This PR is meant to automate certain preparations for release and instruct maintainers on the manual release tasks. Push any changes you make to this branch and merge it just before creating a release. - 1. Ensure both main and nightly CI actions passed. These test the release version against TFC and TFE, respectively. + 1. Ensure both main and nightly CI actions passed. These test the release version against HCP Terraform and Terraform Enterprise, respectively. 2. Review the CHANGELOG and ensure and ensure [everything that's changed since the last release](https://github.com/hashicorp/terraform-provider-tfe/compare/v${{ needs.releasedVersion.outputs.version }}...main) is described. If anything is missing, inaccurate, or unclear, now is the time to fix it! Check the CHANGELOG organization: pull breaking changes to the top and make sure the most important features are at the top of the FEATURES list. Check the version header in the changelog. It must be: `## v${{ github.event.inputs.version }}` 3. Bump the static versions given as an example in the `website/docs/index.html.markdown` docs 4. Bump the static versions given in the README installation section. diff --git a/CHANGELOG.md b/CHANGELOG.md index bbd82b07d..8c387afd3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -352,7 +352,7 @@ BREAKING CHANGES: * **Removed Authentication Method**: Host-specific TF_TOKEN_... environment variable (added in 0.31.0) can no longer be used for token authentication. This method of authentication is incompatible with the Terraform Cloud remote execution model. Please use the TFE_TOKEN environment variable. * r/tfe_workspace: Default value of the `file_triggers_enabled` field is changed to `false`. This will align the `file_triggers_enabled` field default value with the default value for the same field in the - [TFC API](https://www.terraform.io/cloud-docs/api-docs/workspaces). + [Terraform Cloud API](https://www.terraform.io/cloud-docs/api-docs/workspaces). If the value of the `file_triggers_enabled` field was not explicitly set and either of the fields `working_directory` (not an empty string) or `trigger_prefixes` was used - to keep the behavior unchanged, the `file_trigger_enabled` field should now explicitly be set to `true`. ([#510](https://github.com/hashicorp/terraform-provider-tfe/pull/510/files)) @@ -451,7 +451,7 @@ ENHANCEMENTS: * r/oauth_client: Added `key`, `secret`, and `rsa_public_key` arguments, used for configuring BitBucket Server and Azure DevOps Server. ([#395](https://github.com/hashicorp/terraform-provider-tfe/pull/395)) * Improved discovery and loading of credentials from Terraform configuration files; the provider - will attempt to use Terraform CLI's authentication with Terraform Cloud/Enterprise for its own + will attempt to use Terraform CLI's authentication with Terraform Cloud or Terraform Enterprise for its own authentication, when present. ([#360](https://github.com/hashicorp/terraform-provider-tfe/pull/360)) BUG FIXES: @@ -665,7 +665,7 @@ If you have already changed all references to this data source's `ids` attribute ## 0.17.1 (May 27, 2020) BUG FIXES: -* r/tfe_team: Fixed a panic occurring with importing Owners teams on Free TFC organizations which do not include visible organization access. ([#181](https://github.com/hashicorp/terraform-provider-tfe/pull/181)) +* r/tfe_team: Fixed a panic occurring with importing Owners teams on Free Terraform Cloud organizations which do not include visible organization access. ([#181](https://github.com/hashicorp/terraform-provider-tfe/pull/181)) ## 0.17.0 (May 21, 2020) diff --git a/README.md b/README.md index 46be170f6..7c69a386c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ Terraform -# Terraform Cloud/Enterprise Provider -The official Terraform provider for [Terraform Cloud/Enterprise](https://www.hashicorp.com/products/terraform). +# HCP Terraform and Terraform Enterprise Provider -As Terraform Enterprise is a self-hosted distribution of Terraform Cloud, this +The official Terraform provider for [HCP Terraform and Terraform Enterprise](https://www.hashicorp.com/products/terraform). + +As Terraform Enterprise is a self-hosted distribution of HCP Terraform, this provider supports both Cloud and Enterprise use cases. In all/most documentation, the platform will always be stated as 'Terraform Enterprise' - but a feature will be explicitly noted as only supported in one or the other, if @@ -55,7 +56,7 @@ For more information on provider installation and constraining provider versions ## Usage -[Create a user or team API token in Terraform Cloud/Enterprise](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/api-tokens), and use the token in the provider configuration block: +[Create a user or team API token in HCP Terraform or Terraform Enterprise](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/api-tokens), and use the token in the provider configuration block: ```hcl provider "tfe" { diff --git a/docs/backwards-compatibility.md b/docs/backwards-compatibility.md index 6d37af5c9..c7369ea03 100644 --- a/docs/backwards-compatibility.md +++ b/docs/backwards-compatibility.md @@ -28,7 +28,7 @@ if tmAccess.ProjectAccess != nil { ### Explicit Enterprise Checks -If a resource or attribute is **only** available in Terraform Enterprise, use the go-tfe helper [IsEnterprise()](https://pkg.go.dev/github.com/hashicorp/go-tfe#Client.IsEnterprise) to ensure the client is configured against a TFE instance. This check is derived from the `TFP-AppName` header that Terraform Cloud emits, of which if not present, indicates a Terraform Enterprise installation. +If a resource or attribute is **only** available in Terraform Enterprise, use the go-tfe helper [IsEnterprise()](https://pkg.go.dev/github.com/hashicorp/go-tfe#Client.IsEnterprise) to ensure the client is configured against a Terraform Enterprise instance. This check is derived from the `TFP-AppName` header that HCP Terraform or Terraform Enterprise emits. ```go config := meta.(ConfiguredClient) @@ -51,7 +51,7 @@ For a new resource, add the minimum release required to the top level documentat Provides a my new resource. -~> **NOTE:** Using this resource requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202302-1. +~> **NOTE:** Using this resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202302-1. ``` @@ -64,5 +64,5 @@ The following arguments are supported: * `foo` - (Required) Foo is bar. * `bar` - (Optional) Bar is foo. -* `foobar` - (Optional) Foobar is barfoo. This attribute requires Terraform Cloud or an instance of Terraform Enterprise at least as recent as `v202302-1`. +* `foobar` - (Optional) Foobar is barfoo. This attribute requires HCP Terraform or an instance of Terraform Enterprise at least as recent as `v202302-1`. ``` diff --git a/docs/beta.md b/docs/beta.md index cd4b188a1..acfbf0850 100644 --- a/docs/beta.md +++ b/docs/beta.md @@ -1,6 +1,6 @@ # Introducing Beta Features -This guide discusses how to introduce features that are not yet generally available in Terraform Cloud. +This guide discusses how to introduce features that are not yet generally available in HCP Terraform . In general, beta features should not be merged/released until generally available (GA). However, the maintainers recognize almost any reason to release beta features on a case-by-case basis. These could include: partial customer availability, software dependency, or any reason short of feature completeness. diff --git a/docs/development-environment.md b/docs/development-environment.md index 4402abce0..26bc867ce 100644 --- a/docs/development-environment.md +++ b/docs/development-environment.md @@ -45,7 +45,7 @@ See the [Provider Requirements](https://developer.hashicorp.com/terraform/langua ## Running the Tests -The provider is mainly tested using a suite of acceptance tests that run against an internal instance of Terraform Cloud. We also test against Terraform Enterprise prior to release. +The provider is mainly tested using a suite of acceptance tests that run against an internal instance of HCP Terraform. We also test against Terraform Enterprise prior to release. To run the acceptance tests, run `make testacc` diff --git a/docs/index.md b/docs/index.md index b7fb0aabf..ddad79820 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Welcome to the Contributing Guide -Thanks for your interest in contributing to the official Terraform Cloud/Enterprise provider. We appreciate your help! If you're unsure or afraid of anything, you can submit a work in progress (WIP) pull request, or file an issue with the parts you know. We'll do our best to guide you in the right direction, and let you know if there are guidelines we will need to follow. We want people to be able to participate without fear of doing the wrong thing. +Thanks for your interest in contributing to the official HCP Terraform and Terraform Enterprise provider. We appreciate your help! If you're unsure or afraid of anything, you can submit a work in progress (WIP) pull request, or file an issue with the parts you know. We'll do our best to guide you in the right direction, and let you know if there are guidelines we will need to follow. We want people to be able to participate without fear of doing the wrong thing. This guide is broken down into sections to help you [configure your environment](development-environment.md), [creating new resources](new-resources.md), [debug](debugging.md), and [test](testing.md) code to ensure your contribution can be included in a release. diff --git a/docs/test-infrastructure.md b/docs/test-infrastructure.md index c65d3a38d..5dc5bf57f 100644 --- a/docs/test-infrastructure.md +++ b/docs/test-infrastructure.md @@ -1,8 +1,8 @@ # Test Infrastructure -We rely on acceptance tests that test the provider against infrastructure that simulates both Terraform Cloud and Terraform Enterprise. The only exception is features that depend on a feature flag evaluation: In this case, we rely on running the tests locally and reporting the results in the PR description. +We rely on acceptance tests that test the provider against infrastructure that simulates both HCP Terraform and Terraform Enterprise. The only exception is features that depend on a feature flag evaluation: In this case, we rely on running the tests locally and reporting the results in the PR description. -Within the Pull Request process, test checks are executed against infrastructure that simulates Terraform Cloud, which is rebuilt nightly and uses the latest nightly TFE build image. Changes to the underlying Terraform Cloud platform may take 24-48 hours to be reflected in this infrastructure. Tests that use the helper `skipIfCloud` are skipped during this check. +Within the Pull Request process, test checks are executed against infrastructure that simulates HCP Terraform, which is rebuilt nightly and uses the latest nightly TFE build image. Changes to the underlying HCP Terraform platform may take 24-48 hours to be reflected in this infrastructure. Tests that use the helper `skipIfCloud` are skipped during this check. In addition, we test the main branch of the provider once each night against the same image but configured to simulate Terraform Enterprise. Tests that use the helper `skipIfEnterprise` are skipped during this nightly job. diff --git a/docs/testing.md b/docs/testing.md index 3b977d5cf..6b731cdec 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -1,6 +1,6 @@ # Running tests -Running all the tests for this provider requires access to Terraform Cloud with +Running all the tests for this provider requires access to HCP Terraform with a full feature set; most tests can be run against your own installation of Terraform Enterprise. @@ -31,11 +31,11 @@ default, these are loaded from the `credentials` in the [CLI config file](https://developer.hashicorp.com/terraform/cli/config/config-file). You can override these values with the environment variables specified below: -1. `TFE_HOSTNAME` - URL of a Terraform Cloud or Terraform Enterprise instance to be used for testing, without the scheme. Example: `tfe.local` -1. `TFE_TOKEN` - A [user API token](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/users#tokens) for an administrator account on the Terraform Cloud or Terraform Enterprise instance being used for testing. +1. `TFE_HOSTNAME` - URL of a HCP Terraform or Terraform Enterprise instance to be used for testing, without the scheme. Example: `tfe.local` +1. `TFE_TOKEN` - A [user API token](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/users#tokens) for an administrator account on the HCP Terraform or Terraform Enterprise instance being used for testing. ##### Optional: -1. `TFE_USER1` and `TFE_USER2`: The usernames of two pre-existing users on the Terraform Cloud or Terraform Enterprise instance being used for testing. Required for running team membership tests. +1. `TFE_USER1` and `TFE_USER2`: The usernames of two pre-existing users on the HCP Terraform or Terraform Enterprise instance being used for testing. Required for running team membership tests. 2. `GITHUB_TOKEN` - [GitHub personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). Used to establish a VCS provider connection. 3. `GITHUB_POLICY_SET_IDENTIFIER` - GitHub policy set repository identifier in the format `username/repository`. Required for running policy set tests. 4. `GITHUB_POLICY_SET_BRANCH`: A GitHub branch for the repository specified by `GITHUB_POLICY_SET_IDENTIFIER`. Required for running policy set tests. @@ -43,13 +43,13 @@ these values with the environment variables specified below: 6. `GITHUB_REGISTRY_MODULE_IDENTIFIER` - GitHub registry module repository identifier in the format `username/repository`. Required for running registry module tests. 7. `GITHUB_WORKSPACE_IDENTIFIER` - GitHub workspace repository identifier in the format `username/repository`. Required for running workspace tests. 8. `GITHUB_WORKSPACE_BRANCH`: A GitHub branch for the repository specified by `GITHUB_WORKSPACE_IDENTIFIER`. Required for running workspace tests. -9. `ENABLE_TFE` - Some tests cover features available only in Terraform Cloud. To skip these tests when running against a Terraform Enterprise instance, set `ENABLE_TFE=1`. +9. `ENABLE_TFE` - Some tests cover features available only in HCP Terraform. To skip these tests when running against a Terraform Enterprise instance, set `ENABLE_TFE=1`. 10. `RUN_TASKS_URL` - External URL to use for testing Run Tasks operations, for example `RUN_TASKS_URL=http://somewhere.local:8080/pass`. Required for running run tasks tests. 11. `RUN_TASKS_HMAC` - The optional HMAC Key that should be used for Run Task operations. The default is no key. 12. `GITHUB_APP_INSTALLATION_ID` - GitHub App installation internal id in the format `ghain-xxxxxxx`. Required for running any tests that use GitHub App VCS (workspace, policy sets, registry module). 13. `GITHUB_APP_INSTALLATION_NAME` - GitHub App installation name. Required for running tfe_github_app_installation data source test. -**Note:** In order to run integration tests for **Paid** features you will need a token `TFE_TOKEN` with TFC/E administrator privileges, otherwise the attempt to upgrade an organization's feature set will fail. +**Note:** In order to run integration tests for **Paid** features you will need a token `TFE_TOKEN` with HCP Terraform or Terraform Enterprise administrator privileges, otherwise the attempt to upgrade an organization's feature set will fail. You can set your environment variables up however you prefer. The following are instructions for setting up environment variables using [envchain](https://github.com/sorah/envchain). 1. Make sure you have envchain installed. [Instructions for this can be found in the envchain README](https://github.com/sorah/envchain#installation). diff --git a/examples/workspaces_variables/README.md b/examples/workspaces_variables/README.md index 767ec80de..b8f8c7371 100644 --- a/examples/workspaces_variables/README.md +++ b/examples/workspaces_variables/README.md @@ -1,6 +1,6 @@ ## Managing workspaces and variables -This configuration provides an example of how to manage Terraform Cloud / Enterprise workspaces and the variables set on those workspaces using the `tfe` provider. +This configuration provides an example of how to manage HCP Terraform or Terraform Enterprise workspaces and the variables set on those workspaces using the `tfe` provider. There are two configurations supplied in this example. The `manager` configuration uses the `tfe` provider to create workspaces and variables. The `managed` configuration is the configuration that will be associated with the workspaces being created. This `managed` workspace represents what would do the actual deployment of the resources of interest, which could represent environments (dev/test/prod), customers, and so on. The use case is for any configuration that needs to be deployed where the only difference is the variables supplied. @@ -8,14 +8,14 @@ There are two configurations supplied in this example. The `manager` configurati Successful configuration of this example requires several things to be prepared in advance. -* Create or join a Terraform Cloud or Enterprise [organization](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/organizations#creating-organizations). -* Create a Terraform Cloud or Enterprise token to use with the `tfe` [provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs). While other token types can be used, a [User Token](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/users#api-tokens) is recommended in the beginning so that the provider has the same access as the user experimenting with this configuration. +* Create or join a HCP Terraform or Terraform Enterprise [organization](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/organizations#creating-organizations). +* Create a HCP Terraform or Terraform Enterprise token to use with the `tfe` [provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs). While other token types can be used, a [User Token](https://developer.hashicorp.com/terraform/cloud-docs/users-teams-organizations/users#api-tokens) is recommended in the beginning so that the provider has the same access as the user experimenting with this configuration. * Create a [Github token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) that has access to create and manage OAuth clients. A personal access token with full repo scope should be sufficient. This example uses Github, so the configuration will need to be modified to work with other VCS providers. Have the following information handy for the next steps: -* TFC or TFE organization name -* TFC or TFE token +* HCP Terraform or TFE organization name +* HCP Terraform or TFE token * Github organization name * Github repository names (`managed` and `manager`, but you could, and eventually probably will, rename them) * Github token @@ -25,7 +25,7 @@ Have the following information handy for the next steps: * Create two Github repositories named `manager` and `managed`. * Add the `manager` configuration to the `manager` repository. * Add the `managed` configuration to the `managed` repository. -* Create a TFC/TFE workspace named `manager` in the organization that was created or joined. +* Create a HCP Terraform and Terraform Enterprise workspace named `manager` in the organization that was created or joined. - If there is no existing connection for Github configured, select to [add a connection](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs). - With Github connected, choose the `manager` repository from the list. - Use the default options for the remaining settings to complete the workspace setup. @@ -34,9 +34,9 @@ Have the following information handy for the next steps: The `manager` workspace requires certain Terraform variables to be set on the [Variables page in the UI](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/variables#managing-variables-in-the-ui). All variables should be "Terraform Variables". There are no "Environment Variables" required. -* `tf_hostname` - The Terraform Cloud or Enterprise hostname. Defaults to app.terraform.io -* `tf_api_token` - The TFC/TFE user token that was generated. Mark this as sensitive. -* `tf_organization` - The TFC/TFE organization name where the managed workspaces should exist. This will most commonly be the organization that was created or joined, where the `manager` workspace also exists. The token supplied to perform the operations should have sufficient access to the organization. +* `tf_hostname` - The HCP Terraform or Enterprise hostname. Defaults to app.terraform.io +* `tf_api_token` - The HCP Terraform or Terraform Enterprise user token that was generated. Mark this as sensitive. +* `tf_organization` - The HCP Terraform or Terraform Enterprise organization name where the managed workspaces should exist. This will most commonly be the organization that was created or joined, where the `manager` workspace also exists. The token supplied to perform the operations should have sufficient access to the organization. * `vcs_repo_identifier` - A reference to the `managed` repository in the format `/`. The format of the VCS repo identifier might differ depending on the VCS provider, see [tfe_workspace](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/resources/workspace) * `vcs_token` - The Github personal access token that can create OAuth connections. Mark this as sensitive. diff --git a/examples/workspaces_variables/manager/main.tf b/examples/workspaces_variables/manager/main.tf index 3c2c86074..782c57cdf 100644 --- a/examples/workspaces_variables/manager/main.tf +++ b/examples/workspaces_variables/manager/main.tf @@ -1,14 +1,14 @@ # Copyright (c) HashiCorp, Inc. # SPDX-License-Identifier: MPL-2.0 -# This configuration creates and manages workspaces in Terraform Cloud / +# This configuration creates and manages workspaces in HCP Terraform / # Enterprise. Workspaces and the variables that should be set on them come from # two maps, and can come from additional sources as well, such as individual # variable resource blocks. The maps are merged, and then the result is # iterated over using for_each. variable "tf_organization" { - description = "The Terraform Cloud or Enterprise organization under which all operations should be performed." + description = "The HCP Terraform or Enterprise organization under which all operations should be performed." type = string } diff --git a/examples/workspaces_variables/manager/providers.tf b/examples/workspaces_variables/manager/providers.tf index b9b38b59e..e037c1fb7 100644 --- a/examples/workspaces_variables/manager/providers.tf +++ b/examples/workspaces_variables/manager/providers.tf @@ -8,7 +8,7 @@ variable "tf_api_token" { } variable "tf_hostname" { - description = "The Terraform Cloud or Enterprise hostname." + description = "The HCP Terraform or Enterprise hostname." default = "app.terraform.io" } diff --git a/internal/provider/data_source_organization_membership_test.go b/internal/provider/data_source_organization_membership_test.go index 6b31553de..646e7c7c7 100644 --- a/internal/provider/data_source_organization_membership_test.go +++ b/internal/provider/data_source_organization_membership_test.go @@ -55,7 +55,7 @@ func TestAccTFEOrganizationMembershipDataSource_findByName(t *testing.T) { t.Skip("CI Seeded users are not in the hashicorp org in CI") } - // This test requires a user that exists in a TFC organization called "hashicorp". + // This test requires a user that exists in a HCP Terraform organization called "hashicorp". // Our CI instance has a default organization "hashicorp" and prepopulates it // with users (i.e TFE_USER1, etc) since we are unable to create users via the API. // In order to run this against your own organization, simply modify the organization diff --git a/internal/provider/data_source_policy_set.go b/internal/provider/data_source_policy_set.go index 069584f9c..d17b473df 100644 --- a/internal/provider/data_source_policy_set.go +++ b/internal/provider/data_source_policy_set.go @@ -54,7 +54,7 @@ func dataSourceTFEPolicySet() *schema.Resource { }, "agent_enabled": { - Description: "Whether the policy set is executed in the TFC agent. True by default for OPA policies", + Description: "Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies", Type: schema.TypeBool, Computed: true, }, diff --git a/internal/provider/helper_test.go b/internal/provider/helper_test.go index 7d3bcc395..56a46e4f0 100644 --- a/internal/provider/helper_test.go +++ b/internal/provider/helper_test.go @@ -178,7 +178,7 @@ func createProject(t *testing.T, client *tfe.Client, orgName string, options tfe func skipIfCloud(t *testing.T) { if !enterpriseEnabled() { - t.Skip("Skipping test for a feature unavailable in Terraform Cloud. Set 'ENABLE_TFE=1' to run.") + t.Skip("Skipping test for a feature unavailable in HCP Terraform. Set 'ENABLE_TFE=1' to run.") } } @@ -196,7 +196,7 @@ func skipUnlessRunTasksDefined(t *testing.T) { func skipUnlessBeta(t *testing.T) { if !betaFeaturesEnabled() { - t.Skip("Skipping test related to a Terraform Cloud/Enterprise beta feature. Set ENABLE_BETA=1 to run.") + t.Skip("Skipping test related to a HCP Terraform and Terraform Enterprise beta feature. Set ENABLE_BETA=1 to run.") } } diff --git a/internal/provider/id_helpers.go b/internal/provider/id_helpers.go index 5547e856c..039e3d2d0 100644 --- a/internal/provider/id_helpers.go +++ b/internal/provider/id_helpers.go @@ -8,7 +8,7 @@ import ( "regexp" ) -// Checks if a given string matches the typical ID format for a TFC/E ressource +// Checks if a given string matches the typical ID format for a HCP Terraform and Terraform Enterprise ressource // -<16 base58 characters > func isResourceIDFormat(resourcePrefix string, id string) bool { base58Regex, err := regexp.Compile(fmt.Sprintf("^%s-[1-9A-HJ-NP-Za-km-z]{16}$", resourcePrefix)) diff --git a/internal/provider/provider.go b/internal/provider/provider.go index e20a3fd80..cd0e1c15c 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -50,7 +50,7 @@ var ctx = context.Background() func Provider() *schema.Provider { return &schema.Provider{ // Note that defaults and fallbacks which are usually handled by DefaultFunc here are - // instead handled when fetching a TFC/E client in getClient(). This is because the this + // instead handled when fetching a HCP Terraform and Terraform Enterprise client in getClient(). This is because the this // provider is actually two muxed providers which must respect the same logic for fetching // those values in each schema. Schema: map[string]*schema.Schema{ diff --git a/internal/provider/provider_next.go b/internal/provider/provider_next.go index 83e74b573..443e66823 100644 --- a/internal/provider/provider_next.go +++ b/internal/provider/provider_next.go @@ -28,7 +28,7 @@ var _ provider.Provider = &frameworkProvider{} // Can be used to construct ID regexp patterns var base58Alphabet = "[1-9A-HJ-NP-Za-km-z]" -// IDPattern constructs a regexp pattern for Terraform Cloud with the given prefix +// IDPattern constructs a regexp pattern for HCP Terraform with the given prefix func IDPattern(prefix string) *regexp.Regexp { return regexp.MustCompile(fmt.Sprintf("^%s-%s{16}$", prefix, base58Alphabet)) } @@ -81,7 +81,7 @@ func (p *frameworkProvider) Schema(_ context.Context, _ provider.SchemaRequest, } } -// Configure (a Provider interface function) sets up the TFC client per the +// Configure (a Provider interface function) sets up the HCP Terraform client per the // specified provider configuration block and env vars. func (p *frameworkProvider) Configure(ctx context.Context, req provider.ConfigureRequest, res *provider.ConfigureResponse) { var data FrameworkProviderConfig diff --git a/internal/provider/resource_tfe_opa_version_test.go b/internal/provider/resource_tfe_opa_version_test.go index e42bef6a6..28a638ae7 100644 --- a/internal/provider/resource_tfe_opa_version_test.go +++ b/internal/provider/resource_tfe_opa_version_test.go @@ -255,8 +255,8 @@ func genOPASha(t *testing.T, secret, data string) string { } // genSafeRandomOPAVersion returns a random version number of the form -// `0.0.`, which TFC won't ever select as the latest available -// OPA. (At the time of writing, a fresh TFC instance will include +// `0.0.`, which HCP Terraform won't ever select as the latest available +// OPA. (At the time of writing, a fresh HCP Terraform instance will include // official OPAs 0.44.0 and higher.) This is necessary because newly created // workspaces default to the latest available version, and there's nothing // preventing unrelated processes from creating workspaces during these tests. diff --git a/internal/provider/resource_tfe_policy_set.go b/internal/provider/resource_tfe_policy_set.go index ce4317fd1..802dd080a 100644 --- a/internal/provider/resource_tfe_policy_set.go +++ b/internal/provider/resource_tfe_policy_set.go @@ -76,7 +76,7 @@ func resourceTFEPolicySet() *schema.Resource { }, "agent_enabled": { - Description: "Whether the policy set is executed in the TFC agent. True by default for OPA policies", + Description: "Whether the policy set is executed in the HCP Terraform agent. True by default for OPA policies", Type: schema.TypeBool, Optional: true, Computed: true, diff --git a/internal/provider/resource_tfe_sentinel_version_test.go b/internal/provider/resource_tfe_sentinel_version_test.go index df1818f4e..54de29d5b 100644 --- a/internal/provider/resource_tfe_sentinel_version_test.go +++ b/internal/provider/resource_tfe_sentinel_version_test.go @@ -255,8 +255,8 @@ func genSentinelSha(t *testing.T, secret, data string) string { } // genSafeRandomSentinelVersion returns a random version number of the form -// `0.0.`, which TFC won't ever select as the latest available -// Sentinel. (At the time of writing, a fresh TFC instance will include +// `0.0.`, which HCP Terraform won't ever select as the latest available +// Sentinel. (At the time of writing, a fresh HCP Terraform instance will include // official Sentinels 0.22.1 and higher.) This is necessary because newly created // workspaces default to the latest available version, and there's nothing // preventing unrelated processes from creating workspaces during these tests. diff --git a/internal/provider/resource_tfe_team_project_access.go b/internal/provider/resource_tfe_team_project_access.go index 94f5b360e..ab1abe49e 100644 --- a/internal/provider/resource_tfe_team_project_access.go +++ b/internal/provider/resource_tfe_team_project_access.go @@ -315,7 +315,7 @@ func resourceTFETeamProjectAccessRead(ctx context.Context, d *schema.ResourceDat d.Set("project_id", "") } - // These two fields are only available in TFC and TFE v202308-1 and later + // These two fields are only available in HCP Terraform and TFE v202308-1 and later if tmAccess.ProjectAccess != nil { projectAccess := []map[string]interface{}{{ "settings": tmAccess.ProjectAccess.ProjectSettingsPermission, diff --git a/internal/provider/resource_tfe_terraform_version_test.go b/internal/provider/resource_tfe_terraform_version_test.go index 2a4df5bca..eb3561b61 100644 --- a/internal/provider/resource_tfe_terraform_version_test.go +++ b/internal/provider/resource_tfe_terraform_version_test.go @@ -255,8 +255,8 @@ func genSha(t *testing.T, secret, data string) string { } // genSafeRandomTerraformVersion returns a random version number of the form -// `1.0.`, which TFC won't ever select as the latest available -// Terraform. (At the time of writing, a fresh TFC instance will include +// `1.0.`, which HCP Terraform won't ever select as the latest available +// Terraform. (At the time of writing, a fresh HCP Terraform instance will include // official Terraforms 1.2 and higher.) This is necessary because newly created // workspaces default to the latest available version, and there's nothing // preventing unrelated processes from creating workspaces during these tests. diff --git a/internal/provider/resource_tfe_workspace_test.go b/internal/provider/resource_tfe_workspace_test.go index cc6f3903a..59c6afaec 100644 --- a/internal/provider/resource_tfe_workspace_test.go +++ b/internal/provider/resource_tfe_workspace_test.go @@ -2287,7 +2287,7 @@ func testAccCheckTFEWorkspacePanic(n string) resource.TestCheckFunc { return func(s *terraform.State) error { config := testAccProvider.Meta().(ConfiguredClient) - // Grab the resource out of the state and delete it from TFC/E directly. + // Grab the resource out of the state and delete it from HCP Terraform and Terraform Enterprise directly. rs, ok := s.RootModule().Resources[n] if !ok { return fmt.Errorf("Not found: %s", n) diff --git a/website/docs/cdktf/csharp/d/ip_ranges.html.markdown b/website/docs/cdktf/csharp/d/ip_ranges.html.markdown index 3a0ef1b05..88e31258f 100644 --- a/website/docs/cdktf/csharp/d/ip_ranges.html.markdown +++ b/website/docs/cdktf/csharp/d/ip_ranges.html.markdown @@ -2,12 +2,12 @@ layout: "tfe" page_title: "Terraform Enterprise: tfe_ip_ranges" description: |- - Get Terraform Cloud/Enterprise's IP ranges of its services + Get HCP Terraform and Terraform Enterprise's IP ranges of its services --- # Data Source: tfe_ip_ranges -Use this data source to retrieve a list of Terraform Cloud's IP ranges. For more information about these IP ranges, view our [documentation about Terraform Cloud IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). +Use this data source to retrieve a list of HCP Terraform's IP ranges. For more information about these IP ranges, view our [documentation about HCP Terraform IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). ## Example Usage @@ -37,7 +37,7 @@ No arguments are required for this datasource. The following attributes are exported: -* `Api` - The list of IP ranges in CIDR notation used for connections from user site to Terraform Cloud APIs. +* `Api` - The list of IP ranges in CIDR notation used for connections from user site to HCP Terraform APIs. * `Notifications` - The list of IP ranges in CIDR notation used for notifications. * `Sentinel` - The list of IP ranges in CIDR notation used for outbound requests from Sentinel policies. * `Vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers. diff --git a/website/docs/cdktf/csharp/d/organization.html.markdown b/website/docs/cdktf/csharp/d/organization.html.markdown index c4fc8f4fb..da3f0a42e 100644 --- a/website/docs/cdktf/csharp/d/organization.html.markdown +++ b/website/docs/cdktf/csharp/d/organization.html.markdown @@ -41,9 +41,9 @@ In addition to all arguments above, the following attributes are exported: * `Email` - Admin email address. * `ExternalId` - An identifier for the organization. -* `AssessmentsEnforced` - (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. +* `AssessmentsEnforced` - (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. * `CollaboratorAuthPolicy` - Authentication policy (`Password` or `TwoFactorMandatory`). Defaults to `Password`. -* `CostEstimationEnabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `CostEstimationEnabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `OwnersTeamSamlRoleId` - The name of the "owners" team. * `SendPassingStatusesForUntriggeredSpeculativePlans` - Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to true. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `AggregatedCommitStatusEnabled` - Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. diff --git a/website/docs/cdktf/csharp/d/organization_membership.html.markdown b/website/docs/cdktf/csharp/d/organization_membership.html.markdown index 6c507d22b..2ee63b153 100644 --- a/website/docs/cdktf/csharp/d/organization_membership.html.markdown +++ b/website/docs/cdktf/csharp/d/organization_membership.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about an organization membership. -~> **NOTE:** This data source requires using the provider with Terraform Cloud or +~> **NOTE:** This data source requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** If a user updates their email address, configurations using the email address should diff --git a/website/docs/cdktf/csharp/d/organization_run_task.html.markdown b/website/docs/cdktf/csharp/d/organization_run_task.html.markdown index d162d6a70..6d6651039 100644 --- a/website/docs/cdktf/csharp/d/organization_run_task.html.markdown +++ b/website/docs/cdktf/csharp/d/organization_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about an [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/csharp/d/slug.html.markdown b/website/docs/cdktf/csharp/d/slug.html.markdown index d00dccb39..97b8add0b 100644 --- a/website/docs/cdktf/csharp/d/slug.html.markdown +++ b/website/docs/cdktf/csharp/d/slug.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_slug This data source is used to represent configuration files on a local filesystem -intended to be uploaded to Terraform Cloud/Enterprise, in lieu of those files being +intended to be uploaded to HCP Terraform and Terraform Enterprise, in lieu of those files being sourced from a configured VCS provider. A unique checksum is generated for the specified local directory, which allows diff --git a/website/docs/cdktf/csharp/d/workspace.html.markdown b/website/docs/cdktf/csharp/d/workspace.html.markdown index baef07cdf..6cc97f431 100644 --- a/website/docs/cdktf/csharp/d/workspace.html.markdown +++ b/website/docs/cdktf/csharp/d/workspace.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about a workspace. -~> **NOTE:** Using `GlobalRemoteState` or `RemoteStateConsumerIds` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `GlobalRemoteState` or `RemoteStateConsumerIds` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -48,7 +48,7 @@ In addition to all arguments above, the following attributes are exported: * `AllowDestroyPlan` - Indicates whether destroy plans can be queued on the workspace. * `AutoApply` - Indicates whether to automatically apply changes when a Terraform plan is successful. * `AutoApplyRunTrigger` - Whether the workspace will automatically apply changes for runs that were created by run triggers from another workspace. -* `AssessmentsEnabled` - (Available only in Terraform Cloud) Indicates whether health assessments such as drift detection are enabled for the workspace. +* `AssessmentsEnabled` - (Available only in HCP Terraform) Indicates whether health assessments such as drift detection are enabled for the workspace. * `FileTriggersEnabled` - Indicates whether runs are triggered based on the changed files in a VCS push (if `True`) or always triggered on every push (if `False`). * `GlobalRemoteState` - (Optional) Whether the workspace should allow all workspaces in the organization to access its state data during runs. If false, then only specifically approved workspaces can access its state (determined by the `RemoteStateConsumerIds` argument). * `RemoteStateConsumerIds` - (Optional) A set of workspace IDs that will be set as the remote state consumers for the given workspace. Cannot be used if `GlobalRemoteState` is set to `True`. @@ -68,9 +68,9 @@ In addition to all arguments above, the following attributes are exported: * `StructuredRunOutputEnabled` - Indicates whether runs in this workspace use the enhanced apply UI. * `TagNames` - The names of tags added to this workspace. * `TerraformVersion` - The version (or version constraint) of Terraform used for this workspace. -* `TriggerPrefixes` - List of trigger prefixes that describe the paths Terraform Cloud monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. - Terraform Cloud or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. -* `TriggerPatterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. +* `TriggerPrefixes` - List of trigger prefixes that describe the paths HCP Terraform monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. + HCP Terraform or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. +* `TriggerPatterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. * `VcsRepo` - Settings for the workspace's VCS repository. * `WorkingDirectory` - A relative path that Terraform will execute within. * `ExecutionMode` - Indicates the [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) of the workspace. **Note:** This value might be derived from an organization-level default or set on the workspace itself; see the [`TfeWorkspaceSettings` resource](tfe_workspace_settings) for details. diff --git a/website/docs/cdktf/csharp/d/workspace_run_task.html.markdown b/website/docs/cdktf/csharp/d/workspace_run_task.html.markdown index 33ab24428..c69ab0109 100644 --- a/website/docs/cdktf/csharp/d/workspace_run_task.html.markdown +++ b/website/docs/cdktf/csharp/d/workspace_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_workspace_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about a [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/csharp/index.html.markdown b/website/docs/cdktf/csharp/index.html.markdown index c87eddf03..0bfcf9188 100644 --- a/website/docs/cdktf/csharp/index.html.markdown +++ b/website/docs/cdktf/csharp/index.html.markdown @@ -1,18 +1,18 @@ --- layout: "tfe" -page_title: "Provider: Terraform Cloud/Enterprise" +page_title: "Provider: HCP Terraform and Terraform Enterprise" description: |- - Provision Terraform Cloud or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the Terraform Cloud team at HashiCorp. + Provision HCP Terraform or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the HCP Terraform team at HashiCorp. --- -# Terraform Cloud/Enterprise Provider +# HCP Terraform and Terraform Enterprise Provider This provider is used to interact with the many resources supported by -[Terraform Cloud](/docs/cloud/index.html). As [Terraform +[HCP Terraform](/docs/cloud/index.html). As [Terraform Enterprise](/docs/enterprise/index.html) is a self-hosted distribution of -Terraform Cloud, this provider supports both Cloud and Enterprise. +HCP Terraform, this provider supports both Cloud and Enterprise. Use the navigation to the left to read about the available resources. @@ -24,7 +24,7 @@ For more information, see [Versions](#versions). ## Authentication -This provider requires a Terraform Cloud/Enterprise API token in order to manage +This provider requires a HCP Terraform and Terraform Enterprise API token in order to manage resources. To manage the full selection of resources, provide a [user @@ -48,12 +48,12 @@ the token. When configuring the input variable for either of these options, mark them as sensitive. --> **Note:** If you are using this provider in Terraform Cloud or Terraform +-> **Note:** If you are using this provider in HCP Terraform or Terraform Enterprise, you will need to use one of the two options above, even if you're using the `Remote` backend with [remote operations](https://developer.hashicorp.com/terraform/language/settings/backends/configuration) and the [CLI-driven Run workflow](/docs/cloud/run/cli.html). -If you are using this provider on your local command line without remote operations (i.e. only using Terraform Cloud as a +If you are using this provider on your local command line without remote operations (i.e. only using HCP Terraform as a [remote state backend](https://developer.hashicorp.com/terraform/language/state/remote)), there are two more options available to you: @@ -101,7 +101,7 @@ For more information on provider installation and constraining provider versions ```hcl provider "tfe" { - hostname = var.hostname # Optional, defaults to Terraform Cloud `AppTerraformIo` + hostname = var.hostname # Optional, defaults to HCP Terraform `AppTerraformIo` token = var.token version = "~> 0.53.0" } @@ -116,10 +116,10 @@ resource "tfe_organization" "org" { The following arguments are supported: -* `Hostname` - (Optional) The Terraform Cloud/Enterprise hostname to connect to. +* `Hostname` - (Optional) The HCP Terraform and Terraform Enterprise hostname to connect to. Defaults to `app.terraform.io`. Can be overridden by setting the `TfeHostname` environment variable. -* `Token` - (Optional) The token used to authenticate with Terraform Cloud/Enterprise. +* `Token` - (Optional) The token used to authenticate with HCP Terraform and Terraform Enterprise. See [Authentication](#authentication) above for more information. * `SslSkipVerify` - (Optional) Whether or not to skip certificate verifications. Defaults to `False`. Can be overridden setting the `TfeSslSkipVerify` diff --git a/website/docs/cdktf/csharp/r/agent_pool_allowed_workspaces.html.markdown b/website/docs/cdktf/csharp/r/agent_pool_allowed_workspaces.html.markdown index 87264830a..cdaa77bcc 100644 --- a/website/docs/cdktf/csharp/r/agent_pool_allowed_workspaces.html.markdown +++ b/website/docs/cdktf/csharp/r/agent_pool_allowed_workspaces.html.markdown @@ -11,9 +11,9 @@ description: |- Adds and removes allowed workspaces on an agent pool. -~> **NOTE:** This resource requires using the provider with Terraform Cloud and a Terraform Cloud +~> **NOTE:** This resource requires using the provider with HCP Terraform and a HCP Terraform for Business account. -[Learn more about Terraform Cloud pricing here](https://www.hashicorp.com/products/terraform/pricing). +[Learn more about HCP Terraform pricing here](https://www.hashicorp.com/products/terraform/pricing). ## Example Usage diff --git a/website/docs/cdktf/csharp/r/agent_token.html.markdown b/website/docs/cdktf/csharp/r/agent_token.html.markdown index e82dea728..46388e5e8 100644 --- a/website/docs/cdktf/csharp/r/agent_token.html.markdown +++ b/website/docs/cdktf/csharp/r/agent_token.html.markdown @@ -8,7 +8,7 @@ description: |- # tfe_agent_token Each agent pool has its own set of tokens which are not shared across pools. -These tokens allow agents to communicate securely with Terraform Cloud. +These tokens allow agents to communicate securely with HCP Terraform. ## Example Usage diff --git a/website/docs/cdktf/csharp/r/notification_configuration.html.markdown b/website/docs/cdktf/csharp/r/notification_configuration.html.markdown index 7ed4721e3..af6e18b37 100644 --- a/website/docs/cdktf/csharp/r/notification_configuration.html.markdown +++ b/website/docs/cdktf/csharp/r/notification_configuration.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_notification_configuration -Terraform Cloud can be configured to send notifications for run state transitions. +HCP Terraform can be configured to send notifications for run state transitions. Notification configurations allow you to specify a URL, destination type, and what events will trigger the notification. Each workspace can have up to 20 notification configurations, and they apply to all runs for that workspace. @@ -150,9 +150,9 @@ The following arguments are supported: * `DestinationType` - (Required) The type of notification configuration payload to send. Valid values are: * `Generic` - * `Email` available in Terraform Cloud or Terraform Enterprise v202005-1 or later + * `Email` available in HCP Terraform or Terraform Enterprise v202005-1 or later * `Slack` - * `MicrosoftTeams` available in Terraform Cloud or Terraform Enterprise v202206-1 or later + * `MicrosoftTeams` available in HCP Terraform or Terraform Enterprise v202206-1 or later * `EmailAddresses` - (Optional) **TFE only** A list of email addresses. This value _must not_ be provided if `DestinationType` is `Generic`, `MicrosoftTeams`, or `Slack`. * `EmailUserIds` - (Optional) A list of user IDs. This value _must not_ be provided diff --git a/website/docs/cdktf/csharp/r/oauth_client.html.markdown b/website/docs/cdktf/csharp/r/oauth_client.html.markdown index 77beca461..44a5a4074 100644 --- a/website/docs/cdktf/csharp/r/oauth_client.html.markdown +++ b/website/docs/cdktf/csharp/r/oauth_client.html.markdown @@ -40,7 +40,7 @@ class MyConvertedCode : TerraformStack #### Azure DevOps Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). **Note:** This resource requires a private key when creating Azure DevOps Server OAuth clients. @@ -72,7 +72,7 @@ class MyConvertedCode : TerraformStack #### BitBucket Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). When using BitBucket Server, you must use three required fields: `Key`, `Secret`, `RsaPublicKey`. diff --git a/website/docs/cdktf/csharp/r/opa_version.html.markdown b/website/docs/cdktf/csharp/r/opa_version.html.markdown index 3445e35ce..73ffd4d52 100644 --- a/website/docs/cdktf/csharp/r/opa_version.html.markdown +++ b/website/docs/cdktf/csharp/r/opa_version.html.markdown @@ -42,7 +42,7 @@ The following arguments are supported: * `Url` - (Required) The URL where a 64-bit Linux binary of this version can be downloaded. * `Sha` - (Required) The SHA-256 checksum of the compressed OPA binary. * `Official` - (Optional) Whether or not this is an official release of OPA. Defaults to "false". -* `Enabled` - (Optional) Whether or not this version of OPA is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `Enabled` - (Optional) Whether or not this version of OPA is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `Beta` - (Optional) Whether or not this version of OPA is beta pre-release. Defaults to "false". * `Deprecated` - (Optional) Whether or not this version of OPA is deprecated. Defaults to "false". * `DeprecatedReason` - (Optional) Additional context about why a version of OPA is deprecated. Defaults to "null" unless `Deprecated` is true. diff --git a/website/docs/cdktf/csharp/r/organization.html.markdown b/website/docs/cdktf/csharp/r/organization.html.markdown index 9731348cc..761199855 100644 --- a/website/docs/cdktf/csharp/r/organization.html.markdown +++ b/website/docs/cdktf/csharp/r/organization.html.markdown @@ -46,10 +46,10 @@ The following arguments are supported: * `CollaboratorAuthPolicy` - (Optional) Authentication policy (`Password` or `TwoFactorMandatory`). Defaults to `Password`. * `OwnersTeamSamlRoleId` - (Optional) The name of the "owners" team. -* `CostEstimationEnabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `CostEstimationEnabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `SendPassingStatusesForUntriggeredSpeculativePlans` - (Optional) Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to false. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `AggregatedCommitStatusEnabled` - (Optional) Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. If enabled, `SendPassingStatusesForUntriggeredSpeculativePlans` needs to be false. -* `AssessmentsEnforced` - (Optional) (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. +* `AssessmentsEnforced` - (Optional) (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. * `AllowForceDeleteWorkspaces` - (Optional) Whether workspace administrators are permitted to delete workspaces with resources under management. If false, only organization owners may delete these workspaces. Defaults to false. ## Attributes Reference diff --git a/website/docs/cdktf/csharp/r/organization_membership.html.markdown b/website/docs/cdktf/csharp/r/organization_membership.html.markdown index fa4bc7a4e..77ac662b7 100644 --- a/website/docs/cdktf/csharp/r/organization_membership.html.markdown +++ b/website/docs/cdktf/csharp/r/organization_membership.html.markdown @@ -9,7 +9,7 @@ description: |- Add or remove a user from an organization. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** This resource cannot be used to update an existing user's email address diff --git a/website/docs/cdktf/csharp/r/organization_run_task.html.markdown b/website/docs/cdktf/csharp/r/organization_run_task.html.markdown index 767fab5fd..c8cdf6f7b 100644 --- a/website/docs/cdktf/csharp/r/organization_run_task.html.markdown +++ b/website/docs/cdktf/csharp/r/organization_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_organization_run_task resource creates, updates and destroys [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/csharp/r/registry_module.html.markdown b/website/docs/cdktf/csharp/r/registry_module.html.markdown index d79ea5c63..478fe17fe 100644 --- a/website/docs/cdktf/csharp/r/registry_module.html.markdown +++ b/website/docs/cdktf/csharp/r/registry_module.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_registry_module -Terraform Cloud's private module registry helps you share Terraform modules across your organization. +HCP Terraform's private module registry helps you share Terraform modules across your organization. ## Example Usage diff --git a/website/docs/cdktf/csharp/r/run_trigger.html.markdown b/website/docs/cdktf/csharp/r/run_trigger.html.markdown index 6d7e3e3f6..10be6cd02 100644 --- a/website/docs/cdktf/csharp/r/run_trigger.html.markdown +++ b/website/docs/cdktf/csharp/r/run_trigger.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_run_trigger -Terraform Cloud provides a way to connect your workspace to one or more workspaces within your organization, +HCP Terraform provides a way to connect your workspace to one or more workspaces within your organization, known as "source workspaces". These connections, called run triggers, allow runs to queue automatically in your workspace on successful apply of runs in any of the source workspaces. You can connect your workspace to up to 20 source workspaces. diff --git a/website/docs/cdktf/csharp/r/sentinel_version.html.markdown b/website/docs/cdktf/csharp/r/sentinel_version.html.markdown index b1c40adaf..11d841fd2 100644 --- a/website/docs/cdktf/csharp/r/sentinel_version.html.markdown +++ b/website/docs/cdktf/csharp/r/sentinel_version.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_sentinel_version -Manage Sentinel versions available on Terraform Cloud/Enterprise. +Manage Sentinel versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -42,7 +42,7 @@ The following arguments are supported: * `Url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `Sha` - (Required) The SHA-256 checksum of the compressed Sentinel binary. * `Official` - (Optional) Whether or not this is an official release of Sentinel. Defaults to "false". -* `Enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `Enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `Beta` - (Optional) Whether or not this version of Sentinel is beta pre-release. Defaults to "false". * `Deprecated` - (Optional) Whether or not this version of Sentinel is deprecated. Defaults to "false". * `DeprecatedReason` - (Optional) Additional context about why a version of Sentinel is deprecated. Defaults to "null" unless `Deprecated` is true. @@ -63,6 +63,6 @@ terraform import tfe_sentinel_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_sentinel_version.test 0.24.0 ``` --> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/csharp/r/team_organization_member.html.markdown b/website/docs/cdktf/csharp/r/team_organization_member.html.markdown index 43bf4a9a5..990182cae 100644 --- a/website/docs/cdktf/csharp/r/team_organization_member.html.markdown +++ b/website/docs/cdktf/csharp/r/team_organization_member.html.markdown @@ -14,7 +14,7 @@ Add or remove a team member using a resources for managing team memberships. This - along with [tfe_organization_membership](organization_membership.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/csharp/r/team_organization_members.html.markdown b/website/docs/cdktf/csharp/r/team_organization_members.html.markdown index 0e580d489..248c30f82 100644 --- a/website/docs/cdktf/csharp/r/team_organization_members.html.markdown +++ b/website/docs/cdktf/csharp/r/team_organization_members.html.markdown @@ -14,7 +14,7 @@ Add or remove one or more team members using a resources for managing team memberships. This - along with [tfe_team_organization_member](team_organization_member.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/csharp/r/terraform_version.html.markdown b/website/docs/cdktf/csharp/r/terraform_version.html.markdown index ca77c024d..171d72745 100644 --- a/website/docs/cdktf/csharp/r/terraform_version.html.markdown +++ b/website/docs/cdktf/csharp/r/terraform_version.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_terraform_version -Manage Terraform versions available on Terraform Cloud/Enterprise. +Manage Terraform versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -40,7 +40,7 @@ The following arguments are supported: * `Url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `Sha` - (Required) The SHA-256 checksum of the compressed Terraform binary. * `Official` - (Optional) Whether or not this is an official release of Terraform. Defaults to "false". -* `Enabled` - (Optional) Whether or not this version of Terraform is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `Enabled` - (Optional) Whether or not this version of Terraform is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `Beta` - (Optional) Whether or not this version of Terraform is beta pre-release. Defaults to "false". * `Deprecated` - (Optional) Whether or not this version of Terraform is deprecated. Defaults to "false". * `DeprecatedReason` - (Optional) Additional context about why a version of Terraform is deprecated. Defaults to "null" unless `Deprecated` is true. @@ -61,6 +61,6 @@ terraform import tfe_terraform_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_terraform_version.test 1.1.2 ``` --> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/csharp/r/variable.html.markdown b/website/docs/cdktf/csharp/r/variable.html.markdown index 72f148929..736515ccc 100644 --- a/website/docs/cdktf/csharp/r/variable.html.markdown +++ b/website/docs/cdktf/csharp/r/variable.html.markdown @@ -106,7 +106,7 @@ variable is written once and not visible thereafter. Defaults to `False`. * `VariableSetId` - ID of the variable set that owns the variable. ~> **NOTE:** When `Sensitive` is set to true, Terraform cannot detect and repair -drift if `Value` is later changed out-of-band via the Terraform Cloud UI. +drift if `Value` is later changed out-of-band via the HCP Terraform UI. Terraform will only change the value for a sensitive variable if you change `Value` in the configuration, so that it no longer matches the last known value in the state. diff --git a/website/docs/cdktf/csharp/r/workspace.html.markdown b/website/docs/cdktf/csharp/r/workspace.html.markdown index e7cf18ea1..0ab6aab2f 100644 --- a/website/docs/cdktf/csharp/r/workspace.html.markdown +++ b/website/docs/cdktf/csharp/r/workspace.html.markdown @@ -12,8 +12,7 @@ description: |- Provides a workspace resource. ~> **NOTE:** Setting the execution mode and agent pool affinity directly on the workspace is deprecated in favor of using both [tfe_workspace_settings](workspace_settings) and [tfe_organization_default_settings](organization_default_settings), since they allow more precise control and fully support [agent_pool_allowed_workspaces](agent_pool_allowed_workspaces). Use caution when unsetting `ExecutionMode`, as it now leaves any prior value unmanaged instead of reverting to the old default value of `"remote"`. - -~> **NOTE:** Using `GlobalRemoteState` or `RemoteStateConsumerIds` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `GlobalRemoteState` or `RemoteStateConsumerIds` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -107,7 +106,7 @@ The following arguments are supported: automatically performing runs immediately after its creation. Defaults to `True`. When set to `False`, runs triggered by a webhook (such as a commit in VCS) will not be queued until at least one run has been manually queued. - **Note:** This default differs from the Terraform Cloud API default, which + **Note:** This default differs from the HCP Terraform API default, which is `False`. The provider uses `True` as any workspace provisioned with `False` would need to then have a run manually queued out-of-band before accepting webhooks. @@ -124,7 +123,7 @@ The following arguments are supported: workspace has been created, so modifying this value will result in the workspace being replaced. To disable this, use an [ignore changes](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) lifecycle meta-argument * `SpeculativeEnabled` - (Optional) Whether this workspace allows speculative - plans. Defaults to `True`. Setting this to `False` prevents Terraform Cloud + plans. Defaults to `True`. Setting this to `False` prevents HCP Terraform or the Terraform Enterprise instance from running plans on pull requests, which can improve security if the VCS repository is public or includes untrusted contributors. @@ -145,7 +144,7 @@ will be used. (like `~> 1.0.0`); if you specify a constraint, the workspace will always use the newest release that meets that constraint. Defaults to the latest available version. -* `TriggerPatterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with `TriggerPrefixes`. +* `TriggerPatterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with `TriggerPrefixes`. * `TriggerPrefixes` - (Optional) List of repository-root-relative paths which describe all locations to be tracked for changes. * `VcsRepo` - (Optional) Settings for the workspace's VCS repository, enabling the [UI/VCS-driven run workflow](https://developer.hashicorp.com/terraform/cloud-docs/run/ui). diff --git a/website/docs/cdktf/csharp/r/workspace_run.html.markdown b/website/docs/cdktf/csharp/r/workspace_run.html.markdown index 3d2bd4be3..ee1a71395 100644 --- a/website/docs/cdktf/csharp/r/workspace_run.html.markdown +++ b/website/docs/cdktf/csharp/r/workspace_run.html.markdown @@ -204,8 +204,8 @@ The following arguments are supported: Both `Apply` and `Destroy` block supports: -* `ManualConfirm` - (Required) If set to true a human will have to manually confirm a plan in Terraform Cloud's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `False`. - * If `WaitForRun` is set to `False`, this auto-apply will be done by Terraform Cloud. +* `ManualConfirm` - (Required) If set to true a human will have to manually confirm a plan in HCP Terraform's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `False`. + * If `WaitForRun` is set to `False`, this auto-apply will be done by HCP Terraform. * If `WaitForRun` is set to `True`, the apply will be confirmed by the provider. The exception is the case of policy check soft-failed where a human has to perform an override by manually confirming the plan even though `ManualConfirm` is set to false. * Note that this setting will override the workspace's default apply mode. To use the workspace default apply mode, look up the setting for `AutoApply` with the `TfeWorkspace` data source. * `Retry` - (Optional) Whether or not to retry on plan or apply errors. When set to true, `RetryAttempts` must also be greater than zero inorder for retries to happen. Defaults to `True`. @@ -218,5 +218,5 @@ Both `Apply` and `Destroy` block supports: In addition to all arguments above, the following attributes are exported: -* `Id` - The ID of the run created by this resource. Note, if the resource was created without an `Apply{}` configuration block, then this ID will not refer to a real run in Terraform Cloud. +* `Id` - The ID of the run created by this resource. Note, if the resource was created without an `Apply{}` configuration block, then this ID will not refer to a real run in HCP Terraform. \ No newline at end of file diff --git a/website/docs/cdktf/csharp/r/workspace_run_task.html.markdown b/website/docs/cdktf/csharp/r/workspace_run_task.html.markdown index 9120d9a02..af04183ce 100644 --- a/website/docs/cdktf/csharp/r/workspace_run_task.html.markdown +++ b/website/docs/cdktf/csharp/r/workspace_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_workspace_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_workspace_run_task resource associates, updates and removes [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/csharp/r/workspace_settings.markdown b/website/docs/cdktf/csharp/r/workspace_settings.markdown index 3199f9e63..d4dbc523c 100644 --- a/website/docs/cdktf/csharp/r/workspace_settings.markdown +++ b/website/docs/cdktf/csharp/r/workspace_settings.markdown @@ -118,7 +118,7 @@ The following arguments are supported: * `AgentPoolId` - (Optional) The ID of an agent pool to assign to the workspace. Requires `ExecutionMode` to be set to `Agent`. This value _must not_ be provided if `ExecutionMode` is set to any other value. * `ExecutionMode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) - to use. Using Terraform Cloud, valid values are `Remote`, `Local` or `Agent`. Using Terraform Enterprise, only `Remote` and `Local` execution modes are valid. When set to `Local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `Remote`), removing any explicit value that might have previously been set for the workspace. + to use. Using HCP Terraform, valid values are `Remote`, `Local` or `Agent`. Using Terraform Enterprise, only `Remote` and `Local` execution modes are valid. When set to `Local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `Remote`), removing any explicit value that might have previously been set for the workspace. ## Attributes Reference diff --git a/website/docs/cdktf/go/d/ip_ranges.html.markdown b/website/docs/cdktf/go/d/ip_ranges.html.markdown index 8a1607b08..6b0294d06 100644 --- a/website/docs/cdktf/go/d/ip_ranges.html.markdown +++ b/website/docs/cdktf/go/d/ip_ranges.html.markdown @@ -2,12 +2,12 @@ layout: "tfe" page_title: "Terraform Enterprise: tfe_ip_ranges" description: |- - Get Terraform Cloud/Enterprise's IP ranges of its services + Get HCP Terraform and Terraform Enterprise's IP ranges of its services --- # Data Source: tfe_ip_ranges -Use this data source to retrieve a list of Terraform Cloud's IP ranges. For more information about these IP ranges, view our [documentation about Terraform Cloud IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). +Use this data source to retrieve a list of HCP Terraform's IP ranges. For more information about these IP ranges, view our [documentation about HCP Terraform IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). ## Example Usage @@ -41,7 +41,7 @@ No arguments are required for this datasource. The following attributes are exported: -* `Api` - The list of IP ranges in CIDR notation used for connections from user site to Terraform Cloud APIs. +* `Api` - The list of IP ranges in CIDR notation used for connections from user site to HCP Terraform APIs. * `Notifications` - The list of IP ranges in CIDR notation used for notifications. * `Sentinel` - The list of IP ranges in CIDR notation used for outbound requests from Sentinel policies. * `Vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers. diff --git a/website/docs/cdktf/go/d/organization.html.markdown b/website/docs/cdktf/go/d/organization.html.markdown index dba59c1a3..9c3136c58 100644 --- a/website/docs/cdktf/go/d/organization.html.markdown +++ b/website/docs/cdktf/go/d/organization.html.markdown @@ -44,9 +44,9 @@ In addition to all arguments above, the following attributes are exported: * `Email` - Admin email address. * `ExternalId` - An identifier for the organization. -* `AssessmentsEnforced` - (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. +* `AssessmentsEnforced` - (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. * `CollaboratorAuthPolicy` - Authentication policy (`Password` or `TwoFactorMandatory`). Defaults to `Password`. -* `CostEstimationEnabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `CostEstimationEnabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `OwnersTeamSamlRoleId` - The name of the "owners" team. * `SendPassingStatusesForUntriggeredSpeculativePlans` - Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to true. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `AggregatedCommitStatusEnabled` - Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. diff --git a/website/docs/cdktf/go/d/organization_membership.html.markdown b/website/docs/cdktf/go/d/organization_membership.html.markdown index 921208eab..66d8edf1a 100644 --- a/website/docs/cdktf/go/d/organization_membership.html.markdown +++ b/website/docs/cdktf/go/d/organization_membership.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about an organization membership. -~> **NOTE:** This data source requires using the provider with Terraform Cloud or +~> **NOTE:** This data source requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** If a user updates their email address, configurations using the email address should diff --git a/website/docs/cdktf/go/d/organization_run_task.html.markdown b/website/docs/cdktf/go/d/organization_run_task.html.markdown index f3dedceaa..7828a5c2d 100644 --- a/website/docs/cdktf/go/d/organization_run_task.html.markdown +++ b/website/docs/cdktf/go/d/organization_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about an [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/go/d/slug.html.markdown b/website/docs/cdktf/go/d/slug.html.markdown index e87154825..92813d2bd 100644 --- a/website/docs/cdktf/go/d/slug.html.markdown +++ b/website/docs/cdktf/go/d/slug.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_slug This data source is used to represent configuration files on a local filesystem -intended to be uploaded to Terraform Cloud/Enterprise, in lieu of those files being +intended to be uploaded to HCP Terraform and Terraform Enterprise, in lieu of those files being sourced from a configured VCS provider. A unique checksum is generated for the specified local directory, which allows diff --git a/website/docs/cdktf/go/d/workspace.html.markdown b/website/docs/cdktf/go/d/workspace.html.markdown index 81084b9c6..0468d5103 100644 --- a/website/docs/cdktf/go/d/workspace.html.markdown +++ b/website/docs/cdktf/go/d/workspace.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about a workspace. -~> **NOTE:** Using `GlobalRemoteState` or `RemoteStateConsumerIds` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `GlobalRemoteState` or `RemoteStateConsumerIds` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -51,7 +51,7 @@ In addition to all arguments above, the following attributes are exported: * `AllowDestroyPlan` - Indicates whether destroy plans can be queued on the workspace. * `AutoApply` - Indicates whether to automatically apply changes when a Terraform plan is successful. * `AutoApplyRunTrigger` - Whether the workspace will automatically apply changes for runs that were created by run triggers from another workspace. -* `AssessmentsEnabled` - (Available only in Terraform Cloud) Indicates whether health assessments such as drift detection are enabled for the workspace. +* `AssessmentsEnabled` - (Available only in HCP Terraform) Indicates whether health assessments such as drift detection are enabled for the workspace. * `FileTriggersEnabled` - Indicates whether runs are triggered based on the changed files in a VCS push (if `True`) or always triggered on every push (if `False`). * `GlobalRemoteState` - (Optional) Whether the workspace should allow all workspaces in the organization to access its state data during runs. If false, then only specifically approved workspaces can access its state (determined by the `RemoteStateConsumerIds` argument). * `RemoteStateConsumerIds` - (Optional) A set of workspace IDs that will be set as the remote state consumers for the given workspace. Cannot be used if `GlobalRemoteState` is set to `True`. @@ -71,9 +71,9 @@ In addition to all arguments above, the following attributes are exported: * `StructuredRunOutputEnabled` - Indicates whether runs in this workspace use the enhanced apply UI. * `TagNames` - The names of tags added to this workspace. * `TerraformVersion` - The version (or version constraint) of Terraform used for this workspace. -* `TriggerPrefixes` - List of trigger prefixes that describe the paths Terraform Cloud monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. - Terraform Cloud or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. -* `TriggerPatterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. +* `TriggerPrefixes` - List of trigger prefixes that describe the paths HCP Terraform monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. + HCP Terraform or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. +* `TriggerPatterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. * `VcsRepo` - Settings for the workspace's VCS repository. * `WorkingDirectory` - A relative path that Terraform will execute within. * `ExecutionMode` - Indicates the [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) of the workspace. **Note:** This value might be derived from an organization-level default or set on the workspace itself; see the [`TfeWorkspaceSettings` resource](tfe_workspace_settings) for details. diff --git a/website/docs/cdktf/go/d/workspace_run_task.html.markdown b/website/docs/cdktf/go/d/workspace_run_task.html.markdown index 22d0cdda5..36c184ffc 100644 --- a/website/docs/cdktf/go/d/workspace_run_task.html.markdown +++ b/website/docs/cdktf/go/d/workspace_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_workspace_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about a [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/go/index.html.markdown b/website/docs/cdktf/go/index.html.markdown index c87eddf03..0bfcf9188 100644 --- a/website/docs/cdktf/go/index.html.markdown +++ b/website/docs/cdktf/go/index.html.markdown @@ -1,18 +1,18 @@ --- layout: "tfe" -page_title: "Provider: Terraform Cloud/Enterprise" +page_title: "Provider: HCP Terraform and Terraform Enterprise" description: |- - Provision Terraform Cloud or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the Terraform Cloud team at HashiCorp. + Provision HCP Terraform or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the HCP Terraform team at HashiCorp. --- -# Terraform Cloud/Enterprise Provider +# HCP Terraform and Terraform Enterprise Provider This provider is used to interact with the many resources supported by -[Terraform Cloud](/docs/cloud/index.html). As [Terraform +[HCP Terraform](/docs/cloud/index.html). As [Terraform Enterprise](/docs/enterprise/index.html) is a self-hosted distribution of -Terraform Cloud, this provider supports both Cloud and Enterprise. +HCP Terraform, this provider supports both Cloud and Enterprise. Use the navigation to the left to read about the available resources. @@ -24,7 +24,7 @@ For more information, see [Versions](#versions). ## Authentication -This provider requires a Terraform Cloud/Enterprise API token in order to manage +This provider requires a HCP Terraform and Terraform Enterprise API token in order to manage resources. To manage the full selection of resources, provide a [user @@ -48,12 +48,12 @@ the token. When configuring the input variable for either of these options, mark them as sensitive. --> **Note:** If you are using this provider in Terraform Cloud or Terraform +-> **Note:** If you are using this provider in HCP Terraform or Terraform Enterprise, you will need to use one of the two options above, even if you're using the `Remote` backend with [remote operations](https://developer.hashicorp.com/terraform/language/settings/backends/configuration) and the [CLI-driven Run workflow](/docs/cloud/run/cli.html). -If you are using this provider on your local command line without remote operations (i.e. only using Terraform Cloud as a +If you are using this provider on your local command line without remote operations (i.e. only using HCP Terraform as a [remote state backend](https://developer.hashicorp.com/terraform/language/state/remote)), there are two more options available to you: @@ -101,7 +101,7 @@ For more information on provider installation and constraining provider versions ```hcl provider "tfe" { - hostname = var.hostname # Optional, defaults to Terraform Cloud `AppTerraformIo` + hostname = var.hostname # Optional, defaults to HCP Terraform `AppTerraformIo` token = var.token version = "~> 0.53.0" } @@ -116,10 +116,10 @@ resource "tfe_organization" "org" { The following arguments are supported: -* `Hostname` - (Optional) The Terraform Cloud/Enterprise hostname to connect to. +* `Hostname` - (Optional) The HCP Terraform and Terraform Enterprise hostname to connect to. Defaults to `app.terraform.io`. Can be overridden by setting the `TfeHostname` environment variable. -* `Token` - (Optional) The token used to authenticate with Terraform Cloud/Enterprise. +* `Token` - (Optional) The token used to authenticate with HCP Terraform and Terraform Enterprise. See [Authentication](#authentication) above for more information. * `SslSkipVerify` - (Optional) Whether or not to skip certificate verifications. Defaults to `False`. Can be overridden setting the `TfeSslSkipVerify` diff --git a/website/docs/cdktf/go/r/agent_pool_allowed_workspaces.html.markdown b/website/docs/cdktf/go/r/agent_pool_allowed_workspaces.html.markdown index 87264830a..cdaa77bcc 100644 --- a/website/docs/cdktf/go/r/agent_pool_allowed_workspaces.html.markdown +++ b/website/docs/cdktf/go/r/agent_pool_allowed_workspaces.html.markdown @@ -11,9 +11,9 @@ description: |- Adds and removes allowed workspaces on an agent pool. -~> **NOTE:** This resource requires using the provider with Terraform Cloud and a Terraform Cloud +~> **NOTE:** This resource requires using the provider with HCP Terraform and a HCP Terraform for Business account. -[Learn more about Terraform Cloud pricing here](https://www.hashicorp.com/products/terraform/pricing). +[Learn more about HCP Terraform pricing here](https://www.hashicorp.com/products/terraform/pricing). ## Example Usage diff --git a/website/docs/cdktf/go/r/agent_token.html.markdown b/website/docs/cdktf/go/r/agent_token.html.markdown index 4e569863e..c4f5ddc9a 100644 --- a/website/docs/cdktf/go/r/agent_token.html.markdown +++ b/website/docs/cdktf/go/r/agent_token.html.markdown @@ -8,7 +8,7 @@ description: |- # tfe_agent_token Each agent pool has its own set of tokens which are not shared across pools. -These tokens allow agents to communicate securely with Terraform Cloud. +These tokens allow agents to communicate securely with HCP Terraform. ## Example Usage diff --git a/website/docs/cdktf/go/r/notification_configuration.html.markdown b/website/docs/cdktf/go/r/notification_configuration.html.markdown index 4318042fa..da58281f4 100644 --- a/website/docs/cdktf/go/r/notification_configuration.html.markdown +++ b/website/docs/cdktf/go/r/notification_configuration.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_notification_configuration -Terraform Cloud can be configured to send notifications for run state transitions. +HCP Terraform can be configured to send notifications for run state transitions. Notification configurations allow you to specify a URL, destination type, and what events will trigger the notification. Each workspace can have up to 20 notification configurations, and they apply to all runs for that workspace. @@ -187,9 +187,9 @@ The following arguments are supported: * `DestinationType` - (Required) The type of notification configuration payload to send. Valid values are: * `Generic` - * `Email` available in Terraform Cloud or Terraform Enterprise v202005-1 or later + * `Email` available in HCP Terraform or Terraform Enterprise v202005-1 or later * `Slack` - * `MicrosoftTeams` available in Terraform Cloud or Terraform Enterprise v202206-1 or later + * `MicrosoftTeams` available in HCP Terraform or Terraform Enterprise v202206-1 or later * `EmailAddresses` - (Optional) **TFE only** A list of email addresses. This value _must not_ be provided if `DestinationType` is `Generic`, `MicrosoftTeams`, or `Slack`. * `EmailUserIds` - (Optional) A list of user IDs. This value _must not_ be provided diff --git a/website/docs/cdktf/go/r/oauth_client.html.markdown b/website/docs/cdktf/go/r/oauth_client.html.markdown index 52a8a520d..55ebb3aa2 100644 --- a/website/docs/cdktf/go/r/oauth_client.html.markdown +++ b/website/docs/cdktf/go/r/oauth_client.html.markdown @@ -43,7 +43,7 @@ func newMyConvertedCode(scope construct, name *string) *myConvertedCode { #### Azure DevOps Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). **Note:** This resource requires a private key when creating Azure DevOps Server OAuth clients. @@ -75,7 +75,7 @@ func newMyConvertedCode(scope construct, name *string) *myConvertedCode { #### BitBucket Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). When using BitBucket Server, you must use three required fields: `Key`, `Secret`, `RsaPublicKey`. diff --git a/website/docs/cdktf/go/r/opa_version.html.markdown b/website/docs/cdktf/go/r/opa_version.html.markdown index 3404fc6b2..787153ae7 100644 --- a/website/docs/cdktf/go/r/opa_version.html.markdown +++ b/website/docs/cdktf/go/r/opa_version.html.markdown @@ -45,7 +45,7 @@ The following arguments are supported: * `Url` - (Required) The URL where a 64-bit Linux binary of this version can be downloaded. * `Sha` - (Required) The SHA-256 checksum of the compressed OPA binary. * `Official` - (Optional) Whether or not this is an official release of OPA. Defaults to "false". -* `Enabled` - (Optional) Whether or not this version of OPA is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `Enabled` - (Optional) Whether or not this version of OPA is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `Beta` - (Optional) Whether or not this version of OPA is beta pre-release. Defaults to "false". * `Deprecated` - (Optional) Whether or not this version of OPA is deprecated. Defaults to "false". * `DeprecatedReason` - (Optional) Additional context about why a version of OPA is deprecated. Defaults to "null" unless `Deprecated` is true. @@ -66,6 +66,6 @@ terraform import tfe_opa_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_opa_version.test 0.58.0 ``` --> **Note:** You can fetch a OPA version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a OPA version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/go/r/organization.html.markdown b/website/docs/cdktf/go/r/organization.html.markdown index 18aa8b09a..104e0968f 100644 --- a/website/docs/cdktf/go/r/organization.html.markdown +++ b/website/docs/cdktf/go/r/organization.html.markdown @@ -49,10 +49,10 @@ The following arguments are supported: * `CollaboratorAuthPolicy` - (Optional) Authentication policy (`Password` or `TwoFactorMandatory`). Defaults to `Password`. * `OwnersTeamSamlRoleId` - (Optional) The name of the "owners" team. -* `CostEstimationEnabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `CostEstimationEnabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `SendPassingStatusesForUntriggeredSpeculativePlans` - (Optional) Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to false. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `AggregatedCommitStatusEnabled` - (Optional) Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. If enabled, `SendPassingStatusesForUntriggeredSpeculativePlans` needs to be false. -* `AssessmentsEnforced` - (Optional) (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. +* `AssessmentsEnforced` - (Optional) (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. * `AllowForceDeleteWorkspaces` - (Optional) Whether workspace administrators are permitted to delete workspaces with resources under management. If false, only organization owners may delete these workspaces. Defaults to false. ## Attributes Reference diff --git a/website/docs/cdktf/go/r/organization_membership.html.markdown b/website/docs/cdktf/go/r/organization_membership.html.markdown index e2178d921..eb82ce5f7 100644 --- a/website/docs/cdktf/go/r/organization_membership.html.markdown +++ b/website/docs/cdktf/go/r/organization_membership.html.markdown @@ -9,7 +9,7 @@ description: |- Add or remove a user from an organization. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** This resource cannot be used to update an existing user's email address diff --git a/website/docs/cdktf/go/r/organization_run_task.html.markdown b/website/docs/cdktf/go/r/organization_run_task.html.markdown index 3f61e4f7a..0f1853c50 100644 --- a/website/docs/cdktf/go/r/organization_run_task.html.markdown +++ b/website/docs/cdktf/go/r/organization_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_organization_run_task resource creates, updates and destroys [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/go/r/registry_module.html.markdown b/website/docs/cdktf/go/r/registry_module.html.markdown index 5ea05e661..e1dfc5499 100644 --- a/website/docs/cdktf/go/r/registry_module.html.markdown +++ b/website/docs/cdktf/go/r/registry_module.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_registry_module -Terraform Cloud's private module registry helps you share Terraform modules across your organization. +HCP Terraform's private module registry helps you share Terraform modules across your organization. ## Example Usage diff --git a/website/docs/cdktf/go/r/run_trigger.html.markdown b/website/docs/cdktf/go/r/run_trigger.html.markdown index 1415e02c4..2e3f1f1b9 100644 --- a/website/docs/cdktf/go/r/run_trigger.html.markdown +++ b/website/docs/cdktf/go/r/run_trigger.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_run_trigger -Terraform Cloud provides a way to connect your workspace to one or more workspaces within your organization, +HCP Terraform provides a way to connect your workspace to one or more workspaces within your organization, known as "source workspaces". These connections, called run triggers, allow runs to queue automatically in your workspace on successful apply of runs in any of the source workspaces. You can connect your workspace to up to 20 source workspaces. diff --git a/website/docs/cdktf/go/r/sentinel_version.html.markdown b/website/docs/cdktf/go/r/sentinel_version.html.markdown index d3e4dc21f..f8604a4be 100644 --- a/website/docs/cdktf/go/r/sentinel_version.html.markdown +++ b/website/docs/cdktf/go/r/sentinel_version.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_sentinel_version -Manage Sentinel versions available on Terraform Cloud/Enterprise. +Manage Sentinel versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -45,7 +45,7 @@ The following arguments are supported: * `Url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `Sha` - (Required) The SHA-256 checksum of the compressed Sentinel binary. * `Official` - (Optional) Whether or not this is an official release of Sentinel. Defaults to "false". -* `Enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `Enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `Beta` - (Optional) Whether or not this version of Sentinel is beta pre-release. Defaults to "false". * `Deprecated` - (Optional) Whether or not this version of Sentinel is deprecated. Defaults to "false". * `DeprecatedReason` - (Optional) Additional context about why a version of Sentinel is deprecated. Defaults to "null" unless `Deprecated` is true. @@ -66,6 +66,6 @@ terraform import tfe_sentinel_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_sentinel_version.test 0.24.0 ``` --> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/go/r/team_organization_member.html.markdown b/website/docs/cdktf/go/r/team_organization_member.html.markdown index 68050926d..3bca2cdf7 100644 --- a/website/docs/cdktf/go/r/team_organization_member.html.markdown +++ b/website/docs/cdktf/go/r/team_organization_member.html.markdown @@ -14,7 +14,7 @@ Add or remove a team member using a resources for managing team memberships. This - along with [tfe_organization_membership](organization_membership.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/go/r/team_organization_members.html.markdown b/website/docs/cdktf/go/r/team_organization_members.html.markdown index 30e3aa131..1ea1c7c40 100644 --- a/website/docs/cdktf/go/r/team_organization_members.html.markdown +++ b/website/docs/cdktf/go/r/team_organization_members.html.markdown @@ -14,7 +14,7 @@ Add or remove one or more team members using a resources for managing team memberships. This - along with [tfe_team_organization_member](team_organization_member.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/go/r/terraform_version.html.markdown b/website/docs/cdktf/go/r/terraform_version.html.markdown index 8babb3618..acdb57ea4 100644 --- a/website/docs/cdktf/go/r/terraform_version.html.markdown +++ b/website/docs/cdktf/go/r/terraform_version.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_terraform_version -Manage Terraform versions available on Terraform Cloud/Enterprise. +Manage Terraform versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -43,7 +43,7 @@ The following arguments are supported: * `Url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `Sha` - (Required) The SHA-256 checksum of the compressed Terraform binary. * `Official` - (Optional) Whether or not this is an official release of Terraform. Defaults to "false". -* `Enabled` - (Optional) Whether or not this version of Terraform is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `Enabled` - (Optional) Whether or not this version of Terraform is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `Beta` - (Optional) Whether or not this version of Terraform is beta pre-release. Defaults to "false". * `Deprecated` - (Optional) Whether or not this version of Terraform is deprecated. Defaults to "false". * `DeprecatedReason` - (Optional) Additional context about why a version of Terraform is deprecated. Defaults to "null" unless `Deprecated` is true. @@ -64,6 +64,6 @@ terraform import tfe_terraform_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_terraform_version.test 1.1.2 ``` --> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/go/r/variable.html.markdown b/website/docs/cdktf/go/r/variable.html.markdown index 89e3df028..24801da02 100644 --- a/website/docs/cdktf/go/r/variable.html.markdown +++ b/website/docs/cdktf/go/r/variable.html.markdown @@ -116,7 +116,7 @@ variable is written once and not visible thereafter. Defaults to `False`. * `VariableSetId` - ID of the variable set that owns the variable. ~> **NOTE:** When `Sensitive` is set to true, Terraform cannot detect and repair -drift if `Value` is later changed out-of-band via the Terraform Cloud UI. +drift if `Value` is later changed out-of-band via the HCP Terraform UI. Terraform will only change the value for a sensitive variable if you change `Value` in the configuration, so that it no longer matches the last known value in the state. diff --git a/website/docs/cdktf/go/r/workspace.html.markdown b/website/docs/cdktf/go/r/workspace.html.markdown index ec6f8d392..764ac546b 100644 --- a/website/docs/cdktf/go/r/workspace.html.markdown +++ b/website/docs/cdktf/go/r/workspace.html.markdown @@ -12,8 +12,7 @@ description: |- Provides a workspace resource. ~> **NOTE:** Setting the execution mode and agent pool affinity directly on the workspace is deprecated in favor of using both [tfe_workspace_settings](workspace_settings) and [tfe_organization_default_settings](organization_default_settings), since they allow more precise control and fully support [agent_pool_allowed_workspaces](agent_pool_allowed_workspaces). Use caution when unsetting `ExecutionMode`, as it now leaves any prior value unmanaged instead of reverting to the old default value of `"remote"`. - -~> **NOTE:** Using `GlobalRemoteState` or `RemoteStateConsumerIds` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `GlobalRemoteState` or `RemoteStateConsumerIds` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -119,7 +118,7 @@ The following arguments are supported: automatically performing runs immediately after its creation. Defaults to `True`. When set to `False`, runs triggered by a webhook (such as a commit in VCS) will not be queued until at least one run has been manually queued. - **Note:** This default differs from the Terraform Cloud API default, which + **Note:** This default differs from the HCP Terraform API default, which is `False`. The provider uses `True` as any workspace provisioned with `False` would need to then have a run manually queued out-of-band before accepting webhooks. @@ -136,7 +135,7 @@ The following arguments are supported: workspace has been created, so modifying this value will result in the workspace being replaced. To disable this, use an [ignore changes](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) lifecycle meta-argument * `SpeculativeEnabled` - (Optional) Whether this workspace allows speculative - plans. Defaults to `True`. Setting this to `False` prevents Terraform Cloud + plans. Defaults to `True`. Setting this to `False` prevents HCP Terraform or the Terraform Enterprise instance from running plans on pull requests, which can improve security if the VCS repository is public or includes untrusted contributors. @@ -157,7 +156,7 @@ will be used. (like `~> 1.0.0`); if you specify a constraint, the workspace will always use the newest release that meets that constraint. Defaults to the latest available version. -* `TriggerPatterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with `TriggerPrefixes`. +* `TriggerPatterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with `TriggerPrefixes`. * `TriggerPrefixes` - (Optional) List of repository-root-relative paths which describe all locations to be tracked for changes. * `VcsRepo` - (Optional) Settings for the workspace's VCS repository, enabling the [UI/VCS-driven run workflow](https://developer.hashicorp.com/terraform/cloud-docs/run/ui). diff --git a/website/docs/cdktf/go/r/workspace_run.html.markdown b/website/docs/cdktf/go/r/workspace_run.html.markdown index 86eba172a..17d31514f 100644 --- a/website/docs/cdktf/go/r/workspace_run.html.markdown +++ b/website/docs/cdktf/go/r/workspace_run.html.markdown @@ -224,8 +224,8 @@ The following arguments are supported: Both `Apply` and `Destroy` block supports: -* `ManualConfirm` - (Required) If set to true a human will have to manually confirm a plan in Terraform Cloud's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `False`. - * If `WaitForRun` is set to `False`, this auto-apply will be done by Terraform Cloud. +* `ManualConfirm` - (Required) If set to true a human will have to manually confirm a plan in HCP Terraform's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `False`. + * If `WaitForRun` is set to `False`, this auto-apply will be done by HCP Terraform. * If `WaitForRun` is set to `True`, the apply will be confirmed by the provider. The exception is the case of policy check soft-failed where a human has to perform an override by manually confirming the plan even though `ManualConfirm` is set to false. * Note that this setting will override the workspace's default apply mode. To use the workspace default apply mode, look up the setting for `AutoApply` with the `TfeWorkspace` data source. * `Retry` - (Optional) Whether or not to retry on plan or apply errors. When set to true, `RetryAttempts` must also be greater than zero inorder for retries to happen. Defaults to `True`. @@ -238,5 +238,5 @@ Both `Apply` and `Destroy` block supports: In addition to all arguments above, the following attributes are exported: -* `Id` - The ID of the run created by this resource. Note, if the resource was created without an `Apply{}` configuration block, then this ID will not refer to a real run in Terraform Cloud. +* `Id` - The ID of the run created by this resource. Note, if the resource was created without an `Apply{}` configuration block, then this ID will not refer to a real run in HCP Terraform. \ No newline at end of file diff --git a/website/docs/cdktf/go/r/workspace_run_task.html.markdown b/website/docs/cdktf/go/r/workspace_run_task.html.markdown index 9120d9a02..af04183ce 100644 --- a/website/docs/cdktf/go/r/workspace_run_task.html.markdown +++ b/website/docs/cdktf/go/r/workspace_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_workspace_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_workspace_run_task resource associates, updates and removes [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/go/r/workspace_settings.markdown b/website/docs/cdktf/go/r/workspace_settings.markdown index 3b5cd4d88..2ae60b1cf 100644 --- a/website/docs/cdktf/go/r/workspace_settings.markdown +++ b/website/docs/cdktf/go/r/workspace_settings.markdown @@ -142,7 +142,7 @@ The following arguments are supported: * `AgentPoolId` - (Optional) The ID of an agent pool to assign to the workspace. Requires `ExecutionMode` to be set to `Agent`. This value _must not_ be provided if `ExecutionMode` is set to any other value. * `ExecutionMode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) - to use. Using Terraform Cloud, valid values are `Remote`, `Local` or `Agent`. Using Terraform Enterprise, only `Remote` and `Local` execution modes are valid. When set to `Local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `Remote`), removing any explicit value that might have previously been set for the workspace. + to use. Using HCP Terraform, valid values are `Remote`, `Local` or `Agent`. Using Terraform Enterprise, only `Remote` and `Local` execution modes are valid. When set to `Local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `Remote`), removing any explicit value that might have previously been set for the workspace. ## Attributes Reference diff --git a/website/docs/cdktf/java/d/ip_ranges.html.markdown b/website/docs/cdktf/java/d/ip_ranges.html.markdown index 263877c09..26c254cb9 100644 --- a/website/docs/cdktf/java/d/ip_ranges.html.markdown +++ b/website/docs/cdktf/java/d/ip_ranges.html.markdown @@ -2,12 +2,12 @@ layout: "tfe" page_title: "Terraform Enterprise: tfe_ip_ranges" description: |- - Get Terraform Cloud/Enterprise's IP ranges of its services + Get HCP Terraform and Terraform Enterprise's IP ranges of its services --- # Data Source: tfe_ip_ranges -Use this data source to retrieve a list of Terraform Cloud's IP ranges. For more information about these IP ranges, view our [documentation about Terraform Cloud IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). +Use this data source to retrieve a list of HCP Terraform's IP ranges. For more information about these IP ranges, view our [documentation about HCP Terraform IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). ## Example Usage @@ -36,7 +36,7 @@ No arguments are required for this datasource. The following attributes are exported: -* `api` - The list of IP ranges in CIDR notation used for connections from user site to Terraform Cloud APIs. +* `api` - The list of IP ranges in CIDR notation used for connections from user site to HCP Terraform APIs. * `notifications` - The list of IP ranges in CIDR notation used for notifications. * `sentinel` - The list of IP ranges in CIDR notation used for outbound requests from Sentinel policies. * `vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers. diff --git a/website/docs/cdktf/java/d/organization.html.markdown b/website/docs/cdktf/java/d/organization.html.markdown index c91e00ea9..c0a56628d 100644 --- a/website/docs/cdktf/java/d/organization.html.markdown +++ b/website/docs/cdktf/java/d/organization.html.markdown @@ -40,9 +40,9 @@ In addition to all arguments above, the following attributes are exported: * `email` - Admin email address. * `externalId` - An identifier for the organization. -* `assessmentsEnforced` - (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. +* `assessmentsEnforced` - (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. * `collaboratorAuthPolicy` - Authentication policy (`password` or `twoFactorMandatory`). Defaults to `password`. -* `costEstimationEnabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `costEstimationEnabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `ownersTeamSamlRoleId` - The name of the "owners" team. * `sendPassingStatusesForUntriggeredSpeculativePlans` - Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to true. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `aggregatedCommitStatusEnabled` - Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. diff --git a/website/docs/cdktf/java/d/organization_membership.html.markdown b/website/docs/cdktf/java/d/organization_membership.html.markdown index f7dc4b44f..95270a8e3 100644 --- a/website/docs/cdktf/java/d/organization_membership.html.markdown +++ b/website/docs/cdktf/java/d/organization_membership.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about an organization membership. -~> **NOTE:** This data source requires using the provider with Terraform Cloud or +~> **NOTE:** This data source requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** If a user updates their email address, configurations using the email address should diff --git a/website/docs/cdktf/java/d/organization_run_task.html.markdown b/website/docs/cdktf/java/d/organization_run_task.html.markdown index f9cf694c6..54f03175b 100644 --- a/website/docs/cdktf/java/d/organization_run_task.html.markdown +++ b/website/docs/cdktf/java/d/organization_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about an [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/java/d/slug.html.markdown b/website/docs/cdktf/java/d/slug.html.markdown index e21a72d67..04646bb98 100644 --- a/website/docs/cdktf/java/d/slug.html.markdown +++ b/website/docs/cdktf/java/d/slug.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_slug This data source is used to represent configuration files on a local filesystem -intended to be uploaded to Terraform Cloud/Enterprise, in lieu of those files being +intended to be uploaded to HCP Terraform and Terraform Enterprise, in lieu of those files being sourced from a configured VCS provider. A unique checksum is generated for the specified local directory, which allows diff --git a/website/docs/cdktf/java/d/workspace.html.markdown b/website/docs/cdktf/java/d/workspace.html.markdown index c2757acbe..6c35a05c2 100644 --- a/website/docs/cdktf/java/d/workspace.html.markdown +++ b/website/docs/cdktf/java/d/workspace.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about a workspace. -~> **NOTE:** Using `globalRemoteState` or `remoteStateConsumerIds` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `globalRemoteState` or `remoteStateConsumerIds` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -47,7 +47,7 @@ In addition to all arguments above, the following attributes are exported: * `allowDestroyPlan` - Indicates whether destroy plans can be queued on the workspace. * `autoApply` - Indicates whether to automatically apply changes when a Terraform plan is successful. * `autoApplyRunTrigger` - Whether the workspace will automatically apply changes for runs that were created by run triggers from another workspace. -* `assessmentsEnabled` - (Available only in Terraform Cloud) Indicates whether health assessments such as drift detection are enabled for the workspace. +* `assessmentsEnabled` - (Available only in HCP Terraform) Indicates whether health assessments such as drift detection are enabled for the workspace. * `fileTriggersEnabled` - Indicates whether runs are triggered based on the changed files in a VCS push (if `true`) or always triggered on every push (if `false`). * `globalRemoteState` - (Optional) Whether the workspace should allow all workspaces in the organization to access its state data during runs. If false, then only specifically approved workspaces can access its state (determined by the `remoteStateConsumerIds` argument). * `remoteStateConsumerIds` - (Optional) A set of workspace IDs that will be set as the remote state consumers for the given workspace. Cannot be used if `globalRemoteState` is set to `true`. @@ -67,9 +67,9 @@ In addition to all arguments above, the following attributes are exported: * `structuredRunOutputEnabled` - Indicates whether runs in this workspace use the enhanced apply UI. * `tagNames` - The names of tags added to this workspace. * `terraformVersion` - The version (or version constraint) of Terraform used for this workspace. -* `triggerPrefixes` - List of trigger prefixes that describe the paths Terraform Cloud monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. - Terraform Cloud or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. -* `triggerPatterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. +* `triggerPrefixes` - List of trigger prefixes that describe the paths HCP Terraform monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. + HCP Terraform or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. +* `triggerPatterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. * `vcsRepo` - Settings for the workspace's VCS repository. * `workingDirectory` - A relative path that Terraform will execute within. * `executionMode` - Indicates the [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) of the workspace. **Note:** This value might be derived from an organization-level default or set on the workspace itself; see the [`tfeWorkspaceSettings` resource](tfe_workspace_settings) for details. diff --git a/website/docs/cdktf/java/d/workspace_run_task.html.markdown b/website/docs/cdktf/java/d/workspace_run_task.html.markdown index 743a50ecb..648f04556 100644 --- a/website/docs/cdktf/java/d/workspace_run_task.html.markdown +++ b/website/docs/cdktf/java/d/workspace_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_workspace_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about a [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/java/index.html.markdown b/website/docs/cdktf/java/index.html.markdown index f5fc97051..bfcf361ab 100644 --- a/website/docs/cdktf/java/index.html.markdown +++ b/website/docs/cdktf/java/index.html.markdown @@ -1,18 +1,18 @@ --- layout: "tfe" -page_title: "Provider: Terraform Cloud/Enterprise" +page_title: "Provider: HCP Terraform and Terraform Enterprise" description: |- - Provision Terraform Cloud or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the Terraform Cloud team at HashiCorp. + Provision HCP Terraform or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the HCP Terraform team at HashiCorp. --- -# Terraform Cloud/Enterprise Provider +# HCP Terraform and Terraform Enterprise Provider This provider is used to interact with the many resources supported by -[Terraform Cloud](/docs/cloud/index.html). As [Terraform +[HCP Terraform](/docs/cloud/index.html). As [Terraform Enterprise](/docs/enterprise/index.html) is a self-hosted distribution of -Terraform Cloud, this provider supports both Cloud and Enterprise. +HCP Terraform, this provider supports both Cloud and Enterprise. Use the navigation to the left to read about the available resources. @@ -24,7 +24,7 @@ For more information, see [Versions](#versions). ## Authentication -This provider requires a Terraform Cloud/Enterprise API token in order to manage +This provider requires a HCP Terraform and Terraform Enterprise API token in order to manage resources. To manage the full selection of resources, provide a [user @@ -48,12 +48,12 @@ the token. When configuring the input variable for either of these options, mark them as sensitive. --> **Note:** If you are using this provider in Terraform Cloud or Terraform +-> **Note:** If you are using this provider in HCP Terraform or Terraform Enterprise, you will need to use one of the two options above, even if you're using the `remote` backend with [remote operations](https://developer.hashicorp.com/terraform/language/settings/backends/configuration) and the [CLI-driven Run workflow](/docs/cloud/run/cli.html). -If you are using this provider on your local command line without remote operations (i.e. only using Terraform Cloud as a +If you are using this provider on your local command line without remote operations (i.e. only using HCP Terraform as a [remote state backend](https://developer.hashicorp.com/terraform/language/state/remote)), there are two more options available to you: @@ -101,7 +101,7 @@ For more information on provider installation and constraining provider versions ```hcl provider "tfe" { - hostname = var.hostname # Optional, defaults to Terraform Cloud `appTerraformIo` + hostname = var.hostname # Optional, defaults to HCP Terraform `appTerraformIo` token = var.token version = "~> 0.53.0" } @@ -116,10 +116,10 @@ resource "tfe_organization" "org" { The following arguments are supported: -* `hostname` - (Optional) The Terraform Cloud/Enterprise hostname to connect to. +* `hostname` - (Optional) The HCP Terraform and Terraform Enterprise hostname to connect to. Defaults to `app.terraform.io`. Can be overridden by setting the `tfeHostname` environment variable. -* `token` - (Optional) The token used to authenticate with Terraform Cloud/Enterprise. +* `token` - (Optional) The token used to authenticate with HCP Terraform and Terraform Enterprise. See [Authentication](#authentication) above for more information. * `sslSkipVerify` - (Optional) Whether or not to skip certificate verifications. Defaults to `false`. Can be overridden setting the `tfeSslSkipVerify` diff --git a/website/docs/cdktf/java/r/agent_pool_allowed_workspaces.html.markdown b/website/docs/cdktf/java/r/agent_pool_allowed_workspaces.html.markdown index 78e686b1f..622ca4ab5 100644 --- a/website/docs/cdktf/java/r/agent_pool_allowed_workspaces.html.markdown +++ b/website/docs/cdktf/java/r/agent_pool_allowed_workspaces.html.markdown @@ -11,9 +11,9 @@ description: |- Adds and removes allowed workspaces on an agent pool. -~> **NOTE:** This resource requires using the provider with Terraform Cloud and a Terraform Cloud +~> **NOTE:** This resource requires using the provider with HCP Terraform and a HCP Terraform for Business account. -[Learn more about Terraform Cloud pricing here](https://www.hashicorp.com/products/terraform/pricing). +[Learn more about HCP Terraform pricing here](https://www.hashicorp.com/products/terraform/pricing). ## Example Usage diff --git a/website/docs/cdktf/java/r/agent_token.html.markdown b/website/docs/cdktf/java/r/agent_token.html.markdown index 7c7950c62..ee927bb0d 100644 --- a/website/docs/cdktf/java/r/agent_token.html.markdown +++ b/website/docs/cdktf/java/r/agent_token.html.markdown @@ -8,7 +8,7 @@ description: |- # tfe_agent_token Each agent pool has its own set of tokens which are not shared across pools. -These tokens allow agents to communicate securely with Terraform Cloud. +These tokens allow agents to communicate securely with HCP Terraform. ## Example Usage diff --git a/website/docs/cdktf/java/r/notification_configuration.html.markdown b/website/docs/cdktf/java/r/notification_configuration.html.markdown index b5dfcaaa5..1d8226dbf 100644 --- a/website/docs/cdktf/java/r/notification_configuration.html.markdown +++ b/website/docs/cdktf/java/r/notification_configuration.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_notification_configuration -Terraform Cloud can be configured to send notifications for run state transitions. +HCP Terraform can be configured to send notifications for run state transitions. Notification configurations allow you to specify a URL, destination type, and what events will trigger the notification. Each workspace can have up to 20 notification configurations, and they apply to all runs for that workspace. @@ -155,9 +155,9 @@ The following arguments are supported: * `destinationType` - (Required) The type of notification configuration payload to send. Valid values are: * `generic` - * `email` available in Terraform Cloud or Terraform Enterprise v202005-1 or later + * `email` available in HCP Terraform or Terraform Enterprise v202005-1 or later * `slack` - * `microsoftTeams` available in Terraform Cloud or Terraform Enterprise v202206-1 or later + * `microsoftTeams` available in HCP Terraform or Terraform Enterprise v202206-1 or later * `emailAddresses` - (Optional) **TFE only** A list of email addresses. This value _must not_ be provided if `destinationType` is `generic`, `microsoftTeams`, or `slack`. * `emailUserIds` - (Optional) A list of user IDs. This value _must not_ be provided diff --git a/website/docs/cdktf/java/r/oauth_client.html.markdown b/website/docs/cdktf/java/r/oauth_client.html.markdown index 10ffa2236..b9971f0e2 100644 --- a/website/docs/cdktf/java/r/oauth_client.html.markdown +++ b/website/docs/cdktf/java/r/oauth_client.html.markdown @@ -39,7 +39,7 @@ public class MyConvertedCode extends TerraformStack { #### Azure DevOps Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). **Note:** This resource requires a private key when creating Azure DevOps Server OAuth clients. @@ -67,7 +67,7 @@ public class MyConvertedCode extends TerraformStack { #### BitBucket Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). When using BitBucket Server, you must use three required fields: `key`, `secret`, `rsaPublicKey`. diff --git a/website/docs/cdktf/java/r/opa_version.html.markdown b/website/docs/cdktf/java/r/opa_version.html.markdown index 73ad963fc..ec06ecbe8 100644 --- a/website/docs/cdktf/java/r/opa_version.html.markdown +++ b/website/docs/cdktf/java/r/opa_version.html.markdown @@ -41,7 +41,7 @@ The following arguments are supported: * `url` - (Required) The URL where a 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed OPA binary. * `official` - (Optional) Whether or not this is an official release of OPA. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of OPA is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of OPA is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of OPA is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of OPA is deprecated. Defaults to "false". * `deprecatedReason` - (Optional) Additional context about why a version of OPA is deprecated. Defaults to "null" unless `deprecated` is true. @@ -62,6 +62,6 @@ terraform import tfe_opa_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_opa_version.test 0.58.0 ``` --> **Note:** You can fetch a OPA version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a OPA version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/java/r/organization.html.markdown b/website/docs/cdktf/java/r/organization.html.markdown index 28d572537..31a21048f 100644 --- a/website/docs/cdktf/java/r/organization.html.markdown +++ b/website/docs/cdktf/java/r/organization.html.markdown @@ -45,10 +45,10 @@ The following arguments are supported: * `collaboratorAuthPolicy` - (Optional) Authentication policy (`password` or `twoFactorMandatory`). Defaults to `password`. * `ownersTeamSamlRoleId` - (Optional) The name of the "owners" team. -* `costEstimationEnabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `costEstimationEnabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `sendPassingStatusesForUntriggeredSpeculativePlans` - (Optional) Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to false. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `aggregatedCommitStatusEnabled` - (Optional) Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. If enabled, `sendPassingStatusesForUntriggeredSpeculativePlans` needs to be false. -* `assessmentsEnforced` - (Optional) (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. +* `assessmentsEnforced` - (Optional) (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. * `allowForceDeleteWorkspaces` - (Optional) Whether workspace administrators are permitted to delete workspaces with resources under management. If false, only organization owners may delete these workspaces. Defaults to false. ## Attributes Reference diff --git a/website/docs/cdktf/java/r/organization_membership.html.markdown b/website/docs/cdktf/java/r/organization_membership.html.markdown index beb0aa529..d79169891 100644 --- a/website/docs/cdktf/java/r/organization_membership.html.markdown +++ b/website/docs/cdktf/java/r/organization_membership.html.markdown @@ -9,7 +9,7 @@ description: |- Add or remove a user from an organization. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** This resource cannot be used to update an existing user's email address diff --git a/website/docs/cdktf/java/r/organization_run_task.html.markdown b/website/docs/cdktf/java/r/organization_run_task.html.markdown index b5526b76d..06e680375 100644 --- a/website/docs/cdktf/java/r/organization_run_task.html.markdown +++ b/website/docs/cdktf/java/r/organization_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_organization_run_task resource creates, updates and destroys [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/java/r/registry_module.html.markdown b/website/docs/cdktf/java/r/registry_module.html.markdown index 7b4570b1a..b3f6bbbd6 100644 --- a/website/docs/cdktf/java/r/registry_module.html.markdown +++ b/website/docs/cdktf/java/r/registry_module.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_registry_module -Terraform Cloud's private module registry helps you share Terraform modules across your organization. +HCP Terraform's private module registry helps you share Terraform modules across your organization. ## Example Usage diff --git a/website/docs/cdktf/java/r/run_trigger.html.markdown b/website/docs/cdktf/java/r/run_trigger.html.markdown index ab39f922e..aa1f0d6f3 100644 --- a/website/docs/cdktf/java/r/run_trigger.html.markdown +++ b/website/docs/cdktf/java/r/run_trigger.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_run_trigger -Terraform Cloud provides a way to connect your workspace to one or more workspaces within your organization, +HCP Terraform provides a way to connect your workspace to one or more workspaces within your organization, known as "source workspaces". These connections, called run triggers, allow runs to queue automatically in your workspace on successful apply of runs in any of the source workspaces. You can connect your workspace to up to 20 source workspaces. diff --git a/website/docs/cdktf/java/r/sentinel_version.html.markdown b/website/docs/cdktf/java/r/sentinel_version.html.markdown index 4dfbecd80..a3b78d9b4 100644 --- a/website/docs/cdktf/java/r/sentinel_version.html.markdown +++ b/website/docs/cdktf/java/r/sentinel_version.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_sentinel_version -Manage Sentinel versions available on Terraform Cloud/Enterprise. +Manage Sentinel versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -41,7 +41,7 @@ The following arguments are supported: * `url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed Sentinel binary. * `official` - (Optional) Whether or not this is an official release of Sentinel. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of Sentinel is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of Sentinel is deprecated. Defaults to "false". * `deprecatedReason` - (Optional) Additional context about why a version of Sentinel is deprecated. Defaults to "null" unless `deprecated` is true. @@ -62,6 +62,6 @@ terraform import tfe_sentinel_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_sentinel_version.test 0.24.0 ``` --> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/java/r/team_organization_member.html.markdown b/website/docs/cdktf/java/r/team_organization_member.html.markdown index 47ee810c7..5eaa5550e 100644 --- a/website/docs/cdktf/java/r/team_organization_member.html.markdown +++ b/website/docs/cdktf/java/r/team_organization_member.html.markdown @@ -14,7 +14,7 @@ Add or remove a team member using a resources for managing team memberships. This - along with [tfe_organization_membership](organization_membership.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/java/r/team_organization_members.html.markdown b/website/docs/cdktf/java/r/team_organization_members.html.markdown index 5164b24cb..bb5fd68a2 100644 --- a/website/docs/cdktf/java/r/team_organization_members.html.markdown +++ b/website/docs/cdktf/java/r/team_organization_members.html.markdown @@ -14,7 +14,7 @@ Add or remove one or more team members using a resources for managing team memberships. This - along with [tfe_team_organization_member](team_organization_member.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/java/r/terraform_version.html.markdown b/website/docs/cdktf/java/r/terraform_version.html.markdown index 7e7d59769..e35695f98 100644 --- a/website/docs/cdktf/java/r/terraform_version.html.markdown +++ b/website/docs/cdktf/java/r/terraform_version.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_terraform_version -Manage Terraform versions available on Terraform Cloud/Enterprise. +Manage Terraform versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -39,7 +39,7 @@ The following arguments are supported: * `url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed Terraform binary. * `official` - (Optional) Whether or not this is an official release of Terraform. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of Terraform is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of Terraform is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of Terraform is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of Terraform is deprecated. Defaults to "false". * `deprecatedReason` - (Optional) Additional context about why a version of Terraform is deprecated. Defaults to "null" unless `deprecated` is true. @@ -60,6 +60,6 @@ terraform import tfe_terraform_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_terraform_version.test 1.1.2 ``` --> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/java/r/variable.html.markdown b/website/docs/cdktf/java/r/variable.html.markdown index 779e4a090..477cd345c 100644 --- a/website/docs/cdktf/java/r/variable.html.markdown +++ b/website/docs/cdktf/java/r/variable.html.markdown @@ -108,7 +108,7 @@ variable is written once and not visible thereafter. Defaults to `false`. * `variableSetId` - ID of the variable set that owns the variable. ~> **NOTE:** When `sensitive` is set to true, Terraform cannot detect and repair -drift if `value` is later changed out-of-band via the Terraform Cloud UI. +drift if `value` is later changed out-of-band via the HCP Terraform UI. Terraform will only change the value for a sensitive variable if you change `value` in the configuration, so that it no longer matches the last known value in the state. diff --git a/website/docs/cdktf/java/r/workspace.html.markdown b/website/docs/cdktf/java/r/workspace.html.markdown index dbc42ef46..731b3184f 100644 --- a/website/docs/cdktf/java/r/workspace.html.markdown +++ b/website/docs/cdktf/java/r/workspace.html.markdown @@ -12,8 +12,7 @@ description: |- Provides a workspace resource. ~> **NOTE:** Setting the execution mode and agent pool affinity directly on the workspace is deprecated in favor of using both [tfe_workspace_settings](workspace_settings) and [tfe_organization_default_settings](organization_default_settings), since they allow more precise control and fully support [agent_pool_allowed_workspaces](agent_pool_allowed_workspaces). Use caution when unsetting `executionMode`, as it now leaves any prior value unmanaged instead of reverting to the old default value of `"remote"`. - -~> **NOTE:** Using `globalRemoteState` or `remoteStateConsumerIds` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `globalRemoteState` or `remoteStateConsumerIds` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -108,7 +107,7 @@ The following arguments are supported: automatically performing runs immediately after its creation. Defaults to `true`. When set to `false`, runs triggered by a webhook (such as a commit in VCS) will not be queued until at least one run has been manually queued. - **Note:** This default differs from the Terraform Cloud API default, which + **Note:** This default differs from the HCP Terraform API default, which is `false`. The provider uses `true` as any workspace provisioned with `false` would need to then have a run manually queued out-of-band before accepting webhooks. @@ -125,7 +124,7 @@ The following arguments are supported: workspace has been created, so modifying this value will result in the workspace being replaced. To disable this, use an [ignore changes](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) lifecycle meta-argument * `speculativeEnabled` - (Optional) Whether this workspace allows speculative - plans. Defaults to `true`. Setting this to `false` prevents Terraform Cloud + plans. Defaults to `true`. Setting this to `false` prevents HCP Terraform or the Terraform Enterprise instance from running plans on pull requests, which can improve security if the VCS repository is public or includes untrusted contributors. @@ -146,7 +145,7 @@ will be used. (like `~> 1.0.0`); if you specify a constraint, the workspace will always use the newest release that meets that constraint. Defaults to the latest available version. -* `triggerPatterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with `triggerPrefixes`. +* `triggerPatterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with `triggerPrefixes`. * `triggerPrefixes` - (Optional) List of repository-root-relative paths which describe all locations to be tracked for changes. * `vcsRepo` - (Optional) Settings for the workspace's VCS repository, enabling the [UI/VCS-driven run workflow](https://developer.hashicorp.com/terraform/cloud-docs/run/ui). diff --git a/website/docs/cdktf/java/r/workspace_run.html.markdown b/website/docs/cdktf/java/r/workspace_run.html.markdown index e384d6dc2..cef85d937 100644 --- a/website/docs/cdktf/java/r/workspace_run.html.markdown +++ b/website/docs/cdktf/java/r/workspace_run.html.markdown @@ -210,8 +210,8 @@ The following arguments are supported: Both `apply` and `destroy` block supports: -* `manualConfirm` - (Required) If set to true a human will have to manually confirm a plan in Terraform Cloud's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `false`. - * If `waitForRun` is set to `false`, this auto-apply will be done by Terraform Cloud. +* `manualConfirm` - (Required) If set to true a human will have to manually confirm a plan in HCP Terraform's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `false`. + * If `waitForRun` is set to `false`, this auto-apply will be done by HCP Terraform. * If `waitForRun` is set to `true`, the apply will be confirmed by the provider. The exception is the case of policy check soft-failed where a human has to perform an override by manually confirming the plan even though `manualConfirm` is set to false. * Note that this setting will override the workspace's default apply mode. To use the workspace default apply mode, look up the setting for `autoApply` with the `tfeWorkspace` data source. * `retry` - (Optional) Whether or not to retry on plan or apply errors. When set to true, `retryAttempts` must also be greater than zero inorder for retries to happen. Defaults to `true`. @@ -224,5 +224,5 @@ Both `apply` and `destroy` block supports: In addition to all arguments above, the following attributes are exported: -* `id` - The ID of the run created by this resource. Note, if the resource was created without an `apply{}` configuration block, then this ID will not refer to a real run in Terraform Cloud. +* `id` - The ID of the run created by this resource. Note, if the resource was created without an `apply{}` configuration block, then this ID will not refer to a real run in HCP Terraform. \ No newline at end of file diff --git a/website/docs/cdktf/java/r/workspace_run_task.html.markdown b/website/docs/cdktf/java/r/workspace_run_task.html.markdown index 384eaef1d..0947c38b7 100644 --- a/website/docs/cdktf/java/r/workspace_run_task.html.markdown +++ b/website/docs/cdktf/java/r/workspace_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_workspace_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_workspace_run_task resource associates, updates and removes [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/java/r/workspace_settings.markdown b/website/docs/cdktf/java/r/workspace_settings.markdown index f1b7262d3..b26d65803 100644 --- a/website/docs/cdktf/java/r/workspace_settings.markdown +++ b/website/docs/cdktf/java/r/workspace_settings.markdown @@ -122,7 +122,7 @@ The following arguments are supported: * `agentPoolId` - (Optional) The ID of an agent pool to assign to the workspace. Requires `executionMode` to be set to `agent`. This value _must not_ be provided if `executionMode` is set to any other value. * `executionMode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) - to use. Using Terraform Cloud, valid values are `remote`, `local` or `agent`. Using Terraform Enterprise, only `remote` and `local` execution modes are valid. When set to `local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `remote`), removing any explicit value that might have previously been set for the workspace. + to use. Using HCP Terraform, valid values are `remote`, `local` or `agent`. Using Terraform Enterprise, only `remote` and `local` execution modes are valid. When set to `local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `remote`), removing any explicit value that might have previously been set for the workspace. ## Attributes Reference diff --git a/website/docs/cdktf/python/d/ip_ranges.html.markdown b/website/docs/cdktf/python/d/ip_ranges.html.markdown index 545b0540a..8815924b6 100644 --- a/website/docs/cdktf/python/d/ip_ranges.html.markdown +++ b/website/docs/cdktf/python/d/ip_ranges.html.markdown @@ -2,14 +2,14 @@ layout: "tfe" page_title: "Terraform Enterprise: tfe_ip_ranges" description: |- - Get Terraform Cloud/Enterprise's IP ranges of its services + Get HCP Terraform and Terraform Enterprise's IP ranges of its services --- # Data Source: tfe_ip_ranges -Use this data source to retrieve a list of Terraform Cloud's IP ranges. For more information about these IP ranges, view our [documentation about Terraform Cloud IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). +Use this data source to retrieve a list of HCP Terraform's IP ranges. For more information about these IP ranges, view our [documentation about HCP Terraform IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). ## Example Usage @@ -39,7 +39,7 @@ No arguments are required for this datasource. The following attributes are exported: -* `api` - The list of IP ranges in CIDR notation used for connections from user site to Terraform Cloud APIs. +* `api` - The list of IP ranges in CIDR notation used for connections from user site to HCP Terraform APIs. * `notifications` - The list of IP ranges in CIDR notation used for notifications. * `sentinel` - The list of IP ranges in CIDR notation used for outbound requests from Sentinel policies. * `vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers. diff --git a/website/docs/cdktf/python/d/organization.html.markdown b/website/docs/cdktf/python/d/organization.html.markdown index e28ac7661..07b6e2775 100644 --- a/website/docs/cdktf/python/d/organization.html.markdown +++ b/website/docs/cdktf/python/d/organization.html.markdown @@ -41,9 +41,9 @@ In addition to all arguments above, the following attributes are exported: * `email` - Admin email address. * `external_id` - An identifier for the organization. -* `assessments_enforced` - (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. +* `assessments_enforced` - (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. * `collaborator_auth_policy` - Authentication policy (`password` or `two_factor_mandatory`). Defaults to `password`. -* `cost_estimation_enabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `cost_estimation_enabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `owners_team_saml_role_id` - The name of the "owners" team. * `send_passing_statuses_for_untriggered_speculative_plans` - Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to true. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `aggregated_commit_status_enabled` - Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. diff --git a/website/docs/cdktf/python/d/organization_membership.html.markdown b/website/docs/cdktf/python/d/organization_membership.html.markdown index 5d34fc000..7e5cfd59f 100644 --- a/website/docs/cdktf/python/d/organization_membership.html.markdown +++ b/website/docs/cdktf/python/d/organization_membership.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about an organization membership. -~> **NOTE:** This data source requires using the provider with Terraform Cloud or +~> **NOTE:** This data source requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** If a user updates their email address, configurations using the email address should diff --git a/website/docs/cdktf/python/d/organization_run_task.html.markdown b/website/docs/cdktf/python/d/organization_run_task.html.markdown index f4057ee90..fe30dd820 100644 --- a/website/docs/cdktf/python/d/organization_run_task.html.markdown +++ b/website/docs/cdktf/python/d/organization_run_task.html.markdown @@ -9,7 +9,7 @@ description: |- # Data Source: tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about an [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/python/d/slug.html.markdown b/website/docs/cdktf/python/d/slug.html.markdown index c4f0c8a54..3cde8b5ec 100644 --- a/website/docs/cdktf/python/d/slug.html.markdown +++ b/website/docs/cdktf/python/d/slug.html.markdown @@ -9,7 +9,7 @@ description: |- # Data Source: tfe_slug This data source is used to represent configuration files on a local filesystem -intended to be uploaded to Terraform Cloud/Enterprise, in lieu of those files being +intended to be uploaded to HCP Terraform and Terraform Enterprise, in lieu of those files being sourced from a configured VCS provider. A unique checksum is generated for the specified local directory, which allows diff --git a/website/docs/cdktf/python/d/workspace.html.markdown b/website/docs/cdktf/python/d/workspace.html.markdown index a60c39267..3286a7bed 100644 --- a/website/docs/cdktf/python/d/workspace.html.markdown +++ b/website/docs/cdktf/python/d/workspace.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about a workspace. -~> **NOTE:** Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -48,7 +48,7 @@ In addition to all arguments above, the following attributes are exported: * `allow_destroy_plan` - Indicates whether destroy plans can be queued on the workspace. * `auto_apply` - Indicates whether to automatically apply changes when a Terraform plan is successful. * `auto_apply_run_trigger` - Whether the workspace will automatically apply changes for runs that were created by run triggers from another workspace. -* `assessments_enabled` - (Available only in Terraform Cloud) Indicates whether health assessments such as drift detection are enabled for the workspace. +* `assessments_enabled` - (Available only in HCP Terraform) Indicates whether health assessments such as drift detection are enabled for the workspace. * `file_triggers_enabled` - Indicates whether runs are triggered based on the changed files in a VCS push (if `true`) or always triggered on every push (if `false`). * `global_remote_state` - (Optional) Whether the workspace should allow all workspaces in the organization to access its state data during runs. If false, then only specifically approved workspaces can access its state (determined by the `remote_state_consumer_ids` argument). * `remote_state_consumer_ids` - (Optional) A set of workspace IDs that will be set as the remote state consumers for the given workspace. Cannot be used if `global_remote_state` is set to `true`. @@ -68,9 +68,9 @@ In addition to all arguments above, the following attributes are exported: * `structured_run_output_enabled` - Indicates whether runs in this workspace use the enhanced apply UI. * `tag_names` - The names of tags added to this workspace. * `terraform_version` - The version (or version constraint) of Terraform used for this workspace. -* `trigger_prefixes` - List of trigger prefixes that describe the paths Terraform Cloud monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. - Terraform Cloud or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. -* `trigger_patterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. +* `trigger_prefixes` - List of trigger prefixes that describe the paths HCP Terraform monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. + HCP Terraform or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. +* `trigger_patterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. * `vcs_repo` - Settings for the workspace's VCS repository. * `working_directory` - A relative path that Terraform will execute within. * `execution_mode` - Indicates the [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) of the workspace. **Note:** This value might be derived from an organization-level default or set on the workspace itself; see the [`tfe_workspace_settings` resource](tfe_workspace_settings) for details. diff --git a/website/docs/cdktf/python/d/workspace_run_task.html.markdown b/website/docs/cdktf/python/d/workspace_run_task.html.markdown index 84261df7d..8a0452d2a 100644 --- a/website/docs/cdktf/python/d/workspace_run_task.html.markdown +++ b/website/docs/cdktf/python/d/workspace_run_task.html.markdown @@ -9,7 +9,7 @@ description: |- # Data Source: tfe_workspace_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about a [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/python/index.html.markdown b/website/docs/cdktf/python/index.html.markdown index ade17ce04..88f5382fa 100644 --- a/website/docs/cdktf/python/index.html.markdown +++ b/website/docs/cdktf/python/index.html.markdown @@ -1,18 +1,18 @@ --- layout: "tfe" -page_title: "Provider: Terraform Cloud/Enterprise" +page_title: "Provider: HCP Terraform and Terraform Enterprise" description: |- - Provision Terraform Cloud or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the Terraform Cloud team at HashiCorp. + Provision HCP Terraform or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the HCP Terraform team at HashiCorp. --- -# Terraform Cloud/Enterprise Provider +# HCP Terraform and Terraform Enterprise Provider This provider is used to interact with the many resources supported by -[Terraform Cloud](/docs/cloud/index.html). As [Terraform +[HCP Terraform](/docs/cloud/index.html). As [Terraform Enterprise](/docs/enterprise/index.html) is a self-hosted distribution of -Terraform Cloud, this provider supports both Cloud and Enterprise. +HCP Terraform, this provider supports both Cloud and Enterprise. Use the navigation to the left to read about the available resources. @@ -24,7 +24,7 @@ For more information, see [Versions](#versions). ## Authentication -This provider requires a Terraform Cloud/Enterprise API token in order to manage +This provider requires a HCP Terraform and Terraform Enterprise API token in order to manage resources. To manage the full selection of resources, provide a [user @@ -48,12 +48,12 @@ the token. When configuring the input variable for either of these options, mark them as sensitive. --> **Note:** If you are using this provider in Terraform Cloud or Terraform +-> **Note:** If you are using this provider in HCP Terraform or Terraform Enterprise, you will need to use one of the two options above, even if you're using the `remote` backend with [remote operations](https://developer.hashicorp.com/terraform/language/settings/backends/configuration) and the [CLI-driven Run workflow](/docs/cloud/run/cli.html). -If you are using this provider on your local command line without remote operations (i.e. only using Terraform Cloud as a +If you are using this provider on your local command line without remote operations (i.e. only using HCP Terraform as a [remote state backend](https://developer.hashicorp.com/terraform/language/state/remote)), there are two more options available to you: @@ -125,10 +125,10 @@ class MyConvertedCode(TerraformStack): The following arguments are supported: -* `hostname` - (Optional) The Terraform Cloud/Enterprise hostname to connect to. +* `hostname` - (Optional) The HCP Terraform and Terraform Enterprise hostname to connect to. Defaults to `app.terraform.io`. Can be overridden by setting the `TFE_HOSTNAME` environment variable. -* `token` - (Optional) The token used to authenticate with Terraform Cloud/Enterprise. +* `token` - (Optional) The token used to authenticate with HCP Terraform and Terraform Enterprise. See [Authentication](#authentication) above for more information. * `ssl_skip_verify` - (Optional) Whether or not to skip certificate verifications. Defaults to `false`. Can be overridden setting the `TFE_SSL_SKIP_VERIFY` diff --git a/website/docs/cdktf/python/r/agent_pool_allowed_workspaces.html.markdown b/website/docs/cdktf/python/r/agent_pool_allowed_workspaces.html.markdown index b3908db0f..eb8ae5940 100644 --- a/website/docs/cdktf/python/r/agent_pool_allowed_workspaces.html.markdown +++ b/website/docs/cdktf/python/r/agent_pool_allowed_workspaces.html.markdown @@ -11,9 +11,9 @@ description: |- Adds and removes allowed workspaces on an agent pool. -~> **NOTE:** This resource requires using the provider with Terraform Cloud and a Terraform Cloud +~> **NOTE:** This resource requires using the provider with HCP Terraform and a HCP Terraform for Business account. -[Learn more about Terraform Cloud pricing here](https://www.hashicorp.com/products/terraform/pricing). +[Learn more about HCP Terraform pricing here](https://www.hashicorp.com/products/terraform/pricing). ## Example Usage diff --git a/website/docs/cdktf/python/r/agent_token.html.markdown b/website/docs/cdktf/python/r/agent_token.html.markdown index 0a6b17a56..d2176cbb4 100644 --- a/website/docs/cdktf/python/r/agent_token.html.markdown +++ b/website/docs/cdktf/python/r/agent_token.html.markdown @@ -10,7 +10,7 @@ description: |- # tfe_agent_token Each agent pool has its own set of tokens which are not shared across pools. -These tokens allow agents to communicate securely with Terraform Cloud. +These tokens allow agents to communicate securely with HCP Terraform. ## Example Usage diff --git a/website/docs/cdktf/python/r/notification_configuration.html.markdown b/website/docs/cdktf/python/r/notification_configuration.html.markdown index d6e1694af..dbd5276f3 100644 --- a/website/docs/cdktf/python/r/notification_configuration.html.markdown +++ b/website/docs/cdktf/python/r/notification_configuration.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_notification_configuration -Terraform Cloud can be configured to send notifications for run state transitions. +HCP Terraform can be configured to send notifications for run state transitions. Notification configurations allow you to specify a URL, destination type, and what events will trigger the notification. Each workspace can have up to 20 notification configurations, and they apply to all runs for that workspace. @@ -154,9 +154,9 @@ The following arguments are supported: * `destination_type` - (Required) The type of notification configuration payload to send. Valid values are: * `generic` - * `email` available in Terraform Cloud or Terraform Enterprise v202005-1 or later + * `email` available in HCP Terraform or Terraform Enterprise v202005-1 or later * `slack` - * `microsoft-teams` available in Terraform Cloud or Terraform Enterprise v202206-1 or later + * `microsoft-teams` available in HCP Terraform or Terraform Enterprise v202206-1 or later * `email_addresses` - (Optional) **TFE only** A list of email addresses. This value _must not_ be provided if `destination_type` is `generic`, `microsoft-teams`, or `slack`. * `email_user_ids` - (Optional) A list of user IDs. This value _must not_ be provided diff --git a/website/docs/cdktf/python/r/oauth_client.html.markdown b/website/docs/cdktf/python/r/oauth_client.html.markdown index a0d2139ef..f856bc68c 100644 --- a/website/docs/cdktf/python/r/oauth_client.html.markdown +++ b/website/docs/cdktf/python/r/oauth_client.html.markdown @@ -42,7 +42,7 @@ class MyConvertedCode(TerraformStack): #### Azure DevOps Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). **Note:** This resource requires a private key when creating Azure DevOps Server OAuth clients. @@ -71,7 +71,7 @@ class MyConvertedCode(TerraformStack): #### BitBucket Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). When using BitBucket Server, you must use three required fields: `key`, `secret`, `rsa_public_key`. diff --git a/website/docs/cdktf/python/r/opa_version.html.markdown b/website/docs/cdktf/python/r/opa_version.html.markdown index a6beba2e4..243e8df08 100644 --- a/website/docs/cdktf/python/r/opa_version.html.markdown +++ b/website/docs/cdktf/python/r/opa_version.html.markdown @@ -42,7 +42,7 @@ The following arguments are supported: * `url` - (Required) The URL where a 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed OPA binary. * `official` - (Optional) Whether or not this is an official release of OPA. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of OPA is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of OPA is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of OPA is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of OPA is deprecated. Defaults to "false". * `deprecated_reason` - (Optional) Additional context about why a version of OPA is deprecated. Defaults to "null" unless `deprecated` is true. @@ -63,6 +63,6 @@ terraform import tfe_opa_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_opa_version.test 0.58.0 ``` --> **Note:** You can fetch a OPA version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a OPA version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/python/r/organization.html.markdown b/website/docs/cdktf/python/r/organization.html.markdown index babd13d88..4b6dee594 100644 --- a/website/docs/cdktf/python/r/organization.html.markdown +++ b/website/docs/cdktf/python/r/organization.html.markdown @@ -46,10 +46,10 @@ The following arguments are supported: * `collaborator_auth_policy` - (Optional) Authentication policy (`password` or `two_factor_mandatory`). Defaults to `password`. * `owners_team_saml_role_id` - (Optional) The name of the "owners" team. -* `cost_estimation_enabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `cost_estimation_enabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `send_passing_statuses_for_untriggered_speculative_plans` - (Optional) Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to false. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `aggregated_commit_status_enabled` - (Optional) Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. If enabled, `send_passing_statuses_for_untriggered_speculative_plans` needs to be false. -* `assessments_enforced` - (Optional) (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. +* `assessments_enforced` - (Optional) (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. * `allow_force_delete_workspaces` - (Optional) Whether workspace administrators are permitted to delete workspaces with resources under management. If false, only organization owners may delete these workspaces. Defaults to false. ## Attributes Reference diff --git a/website/docs/cdktf/python/r/organization_membership.html.markdown b/website/docs/cdktf/python/r/organization_membership.html.markdown index 93f7c20b1..9170eb8d7 100644 --- a/website/docs/cdktf/python/r/organization_membership.html.markdown +++ b/website/docs/cdktf/python/r/organization_membership.html.markdown @@ -11,7 +11,7 @@ description: |- Add or remove a user from an organization. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** This resource cannot be used to update an existing user's email address diff --git a/website/docs/cdktf/python/r/organization_run_task.html.markdown b/website/docs/cdktf/python/r/organization_run_task.html.markdown index 0f562bca2..343f6b044 100644 --- a/website/docs/cdktf/python/r/organization_run_task.html.markdown +++ b/website/docs/cdktf/python/r/organization_run_task.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_organization_run_task resource creates, updates and destroys [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/python/r/registry_module.html.markdown b/website/docs/cdktf/python/r/registry_module.html.markdown index 9aadf00f2..709544552 100644 --- a/website/docs/cdktf/python/r/registry_module.html.markdown +++ b/website/docs/cdktf/python/r/registry_module.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_registry_module -Terraform Cloud's private module registry helps you share Terraform modules across your organization. +HCP Terraform's private module registry helps you share Terraform modules across your organization. ## Example Usage diff --git a/website/docs/cdktf/python/r/run_trigger.html.markdown b/website/docs/cdktf/python/r/run_trigger.html.markdown index 1ef9fc6f8..df20da152 100644 --- a/website/docs/cdktf/python/r/run_trigger.html.markdown +++ b/website/docs/cdktf/python/r/run_trigger.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_run_trigger -Terraform Cloud provides a way to connect your workspace to one or more workspaces within your organization, +HCP Terraform provides a way to connect your workspace to one or more workspaces within your organization, known as "source workspaces". These connections, called run triggers, allow runs to queue automatically in your workspace on successful apply of runs in any of the source workspaces. You can connect your workspace to up to 20 source workspaces. diff --git a/website/docs/cdktf/python/r/sentinel_version.html.markdown b/website/docs/cdktf/python/r/sentinel_version.html.markdown index f1cf14543..9cdc86f21 100644 --- a/website/docs/cdktf/python/r/sentinel_version.html.markdown +++ b/website/docs/cdktf/python/r/sentinel_version.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_sentinel_version -Manage Sentinel versions available on Terraform Cloud/Enterprise. +Manage Sentinel versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -42,7 +42,7 @@ The following arguments are supported: * `url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed Sentinel binary. * `official` - (Optional) Whether or not this is an official release of Sentinel. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of Sentinel is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of Sentinel is deprecated. Defaults to "false". * `deprecated_reason` - (Optional) Additional context about why a version of Sentinel is deprecated. Defaults to "null" unless `deprecated` is true. @@ -63,6 +63,6 @@ terraform import tfe_sentinel_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_sentinel_version.test 0.24.0 ``` --> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/python/r/team_organization_member.html.markdown b/website/docs/cdktf/python/r/team_organization_member.html.markdown index 048cfa5d9..30df802ba 100644 --- a/website/docs/cdktf/python/r/team_organization_member.html.markdown +++ b/website/docs/cdktf/python/r/team_organization_member.html.markdown @@ -16,7 +16,7 @@ Add or remove a team member using a resources for managing team memberships. This - along with [tfe_organization_membership](organization_membership.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/python/r/team_organization_members.html.markdown b/website/docs/cdktf/python/r/team_organization_members.html.markdown index 7895bcf61..e24bd8262 100644 --- a/website/docs/cdktf/python/r/team_organization_members.html.markdown +++ b/website/docs/cdktf/python/r/team_organization_members.html.markdown @@ -16,7 +16,7 @@ Add or remove one or more team members using a resources for managing team memberships. This - along with [tfe_team_organization_member](team_organization_member.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/python/r/terraform_version.html.markdown b/website/docs/cdktf/python/r/terraform_version.html.markdown index 010e15457..741305dbf 100644 --- a/website/docs/cdktf/python/r/terraform_version.html.markdown +++ b/website/docs/cdktf/python/r/terraform_version.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_terraform_version -Manage Terraform versions available on Terraform Cloud/Enterprise. +Manage Terraform versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -42,7 +42,7 @@ The following arguments are supported: * `url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed Terraform binary. * `official` - (Optional) Whether or not this is an official release of Terraform. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of Terraform is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of Terraform is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of Terraform is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of Terraform is deprecated. Defaults to "false". * `deprecated_reason` - (Optional) Additional context about why a version of Terraform is deprecated. Defaults to "null" unless `deprecated` is true. @@ -63,6 +63,6 @@ terraform import tfe_terraform_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_terraform_version.test 1.1.2 ``` --> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/python/r/variable.html.markdown b/website/docs/cdktf/python/r/variable.html.markdown index a606daed4..bacb23e52 100644 --- a/website/docs/cdktf/python/r/variable.html.markdown +++ b/website/docs/cdktf/python/r/variable.html.markdown @@ -112,7 +112,7 @@ variable is written once and not visible thereafter. Defaults to `false`. * `variable_set_id` - ID of the variable set that owns the variable. ~> **NOTE:** When `sensitive` is set to true, Terraform cannot detect and repair -drift if `value` is later changed out-of-band via the Terraform Cloud UI. +drift if `value` is later changed out-of-band via the HCP Terraform UI. Terraform will only change the value for a sensitive variable if you change `value` in the configuration, so that it no longer matches the last known value in the state. diff --git a/website/docs/cdktf/python/r/workspace.html.markdown b/website/docs/cdktf/python/r/workspace.html.markdown index 99f3ba59a..7eff9ff55 100644 --- a/website/docs/cdktf/python/r/workspace.html.markdown +++ b/website/docs/cdktf/python/r/workspace.html.markdown @@ -13,7 +13,7 @@ Provides a workspace resource. ~> **NOTE:** Setting the execution mode and agent pool affinity directly on the workspace is deprecated in favor of using both [tfe_workspace_settings](workspace_settings) and [tfe_organization_default_settings](organization_default_settings), since they allow more precise control and fully support [agent_pool_allowed_workspaces](agent_pool_allowed_workspaces). Use caution when unsetting `execution_mode`, as it now leaves any prior value unmanaged instead of reverting to the old default value of `"remote"`. -~> **NOTE:** Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -110,7 +110,7 @@ The following arguments are supported: automatically performing runs immediately after its creation. Defaults to `true`. When set to `false`, runs triggered by a webhook (such as a commit in VCS) will not be queued until at least one run has been manually queued. - **Note:** This default differs from the Terraform Cloud API default, which + **Note:** This default differs from the HCP Terraform API default, which is `false`. The provider uses `true` as any workspace provisioned with `false` would need to then have a run manually queued out-of-band before accepting webhooks. @@ -127,7 +127,7 @@ The following arguments are supported: workspace has been created, so modifying this value will result in the workspace being replaced. To disable this, use an [ignore changes](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) lifecycle meta-argument * `speculative_enabled` - (Optional) Whether this workspace allows speculative - plans. Defaults to `true`. Setting this to `false` prevents Terraform Cloud + plans. Defaults to `true`. Setting this to `false` prevents HCP Terraform or the Terraform Enterprise instance from running plans on pull requests, which can improve security if the VCS repository is public or includes untrusted contributors. @@ -148,7 +148,7 @@ will be used. (like `~> 1.0.0`); if you specify a constraint, the workspace will always use the newest release that meets that constraint. Defaults to the latest available version. -* `trigger_patterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) 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`. +* `trigger_patterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with `trigger-prefixes`. * `trigger_prefixes` - (Optional) List of repository-root-relative paths which describe all locations to be tracked for changes. * `vcs_repo` - (Optional) Settings for the workspace's VCS repository, enabling the [UI/VCS-driven run workflow](https://developer.hashicorp.com/terraform/cloud-docs/run/ui). diff --git a/website/docs/cdktf/python/r/workspace_run.html.markdown b/website/docs/cdktf/python/r/workspace_run.html.markdown index 200047332..84e2790a6 100644 --- a/website/docs/cdktf/python/r/workspace_run.html.markdown +++ b/website/docs/cdktf/python/r/workspace_run.html.markdown @@ -213,8 +213,8 @@ The following arguments are supported: Both `apply` and `destroy` block supports: -* `manual_confirm` - (Required) If set to true a human will have to manually confirm a plan in Terraform Cloud's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `false`. - * If `wait_for_run` is set to `false`, this auto-apply will be done by Terraform Cloud. +* `manual_confirm` - (Required) If set to true a human will have to manually confirm a plan in HCP Terraform's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `false`. + * If `wait_for_run` is set to `false`, this auto-apply will be done by HCP Terraform. * If `wait_for_run` is set to `true`, the apply will be confirmed by the provider. The exception is the case of policy check soft-failed where a human has to perform an override by manually confirming the plan even though `manual_confirm` is set to false. * Note that this setting will override the workspace's default apply mode. To use the workspace default apply mode, look up the setting for `auto_apply` with the `tfe_workspace` data source. * `retry` - (Optional) Whether or not to retry on plan or apply errors. When set to true, `retry_attempts` must also be greater than zero inorder for retries to happen. Defaults to `true`. @@ -227,5 +227,5 @@ Both `apply` and `destroy` block supports: In addition to all arguments above, the following attributes are exported: -* `id` - The ID of the run created by this resource. Note, if the resource was created without an `apply{}` configuration block, then this ID will not refer to a real run in Terraform Cloud. +* `id` - The ID of the run created by this resource. Note, if the resource was created without an `apply{}` configuration block, then this ID will not refer to a real run in HCP Terraform. \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspace_run_task.html.markdown b/website/docs/cdktf/python/r/workspace_run_task.html.markdown index b27948513..9a8c536d6 100644 --- a/website/docs/cdktf/python/r/workspace_run_task.html.markdown +++ b/website/docs/cdktf/python/r/workspace_run_task.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_workspace_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_workspace_run_task resource associates, updates and removes [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/python/r/workspace_settings.markdown b/website/docs/cdktf/python/r/workspace_settings.markdown index 3825237d4..5bed20c55 100644 --- a/website/docs/cdktf/python/r/workspace_settings.markdown +++ b/website/docs/cdktf/python/r/workspace_settings.markdown @@ -128,7 +128,7 @@ The following arguments are supported: * `agent_pool_id` - (Optional) The ID of an agent pool to assign to the workspace. Requires `execution_mode` to be set to `agent`. This value _must not_ be provided if `execution_mode` is set to any other value. * `execution_mode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) - to use. Using Terraform Cloud, valid values are `remote`, `local` or `agent`. Using Terraform Enterprise, only `remote` and `local` execution modes are valid. When set to `local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `remote`), removing any explicit value that might have previously been set for the workspace. + to use. Using HCP Terraform, valid values are `remote`, `local` or `agent`. Using Terraform Enterprise, only `remote` and `local` execution modes are valid. When set to `local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `remote`), removing any explicit value that might have previously been set for the workspace. ## Attributes Reference diff --git a/website/docs/cdktf/typescript/d/ip_ranges.html.markdown b/website/docs/cdktf/typescript/d/ip_ranges.html.markdown index 93428bb23..619c8b782 100644 --- a/website/docs/cdktf/typescript/d/ip_ranges.html.markdown +++ b/website/docs/cdktf/typescript/d/ip_ranges.html.markdown @@ -2,14 +2,14 @@ layout: "tfe" page_title: "Terraform Enterprise: tfe_ip_ranges" description: |- - Get Terraform Cloud/Enterprise's IP ranges of its services + Get HCP Terraform and Terraform Enterprise's IP ranges of its services --- # Data Source: tfe_ip_ranges -Use this data source to retrieve a list of Terraform Cloud's IP ranges. For more information about these IP ranges, view our [documentation about Terraform Cloud IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). +Use this data source to retrieve a list of HCP Terraform's IP ranges. For more information about these IP ranges, view our [documentation about HCP Terraform IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). ## Example Usage @@ -42,7 +42,7 @@ No arguments are required for this datasource. The following attributes are exported: -* `api` - The list of IP ranges in CIDR notation used for connections from user site to Terraform Cloud APIs. +* `api` - The list of IP ranges in CIDR notation used for connections from user site to HCP Terraform APIs. * `notifications` - The list of IP ranges in CIDR notation used for notifications. * `sentinel` - The list of IP ranges in CIDR notation used for outbound requests from Sentinel policies. * `vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers. diff --git a/website/docs/cdktf/typescript/d/organization.html.markdown b/website/docs/cdktf/typescript/d/organization.html.markdown index 7f2b0b3fc..c8c2e5f36 100644 --- a/website/docs/cdktf/typescript/d/organization.html.markdown +++ b/website/docs/cdktf/typescript/d/organization.html.markdown @@ -44,9 +44,9 @@ In addition to all arguments above, the following attributes are exported: * `email` - Admin email address. * `externalId` - An identifier for the organization. -* `assessmentsEnforced` - (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. +* `assessmentsEnforced` - (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. * `collaboratorAuthPolicy` - Authentication policy (`password` or `two_factor_mandatory`). Defaults to `password`. -* `costEstimationEnabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `costEstimationEnabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `ownersTeamSamlRoleId` - The name of the "owners" team. * `sendPassingStatusesForUntriggeredSpeculativePlans` - Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to true. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `aggregatedCommitStatusEnabled` - Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. diff --git a/website/docs/cdktf/typescript/d/organization_membership.html.markdown b/website/docs/cdktf/typescript/d/organization_membership.html.markdown index 1f6b95439..17657f337 100644 --- a/website/docs/cdktf/typescript/d/organization_membership.html.markdown +++ b/website/docs/cdktf/typescript/d/organization_membership.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about an organization membership. -~> **NOTE:** This data source requires using the provider with Terraform Cloud or +~> **NOTE:** This data source requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** If a user updates their email address, configurations using the email address should diff --git a/website/docs/cdktf/typescript/d/organization_run_task.html.markdown b/website/docs/cdktf/typescript/d/organization_run_task.html.markdown index eb3ef17ab..ced7a4194 100644 --- a/website/docs/cdktf/typescript/d/organization_run_task.html.markdown +++ b/website/docs/cdktf/typescript/d/organization_run_task.html.markdown @@ -9,7 +9,7 @@ description: |- # Data Source: tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about an [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/typescript/d/slug.html.markdown b/website/docs/cdktf/typescript/d/slug.html.markdown index 84a8bf12d..3e121741d 100644 --- a/website/docs/cdktf/typescript/d/slug.html.markdown +++ b/website/docs/cdktf/typescript/d/slug.html.markdown @@ -9,7 +9,7 @@ description: |- # Data Source: tfe_slug This data source is used to represent configuration files on a local filesystem -intended to be uploaded to Terraform Cloud/Enterprise, in lieu of those files being +intended to be uploaded to HCP Terraform and Terraform Enterprise, in lieu of those files being sourced from a configured VCS provider. A unique checksum is generated for the specified local directory, which allows diff --git a/website/docs/cdktf/typescript/d/workspace.html.markdown b/website/docs/cdktf/typescript/d/workspace.html.markdown index 5a491e8d7..d78b4727a 100644 --- a/website/docs/cdktf/typescript/d/workspace.html.markdown +++ b/website/docs/cdktf/typescript/d/workspace.html.markdown @@ -11,7 +11,7 @@ description: |- Use this data source to get information about a workspace. -~> **NOTE:** Using `globalRemoteState` or `remoteStateConsumerIds` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `globalRemoteState` or `remoteStateConsumerIds` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -51,7 +51,7 @@ In addition to all arguments above, the following attributes are exported: * `allowDestroyPlan` - Indicates whether destroy plans can be queued on the workspace. * `autoApply` - Indicates whether to automatically apply changes when a Terraform plan is successful. * `autoApplyRunTrigger` - Whether the workspace will automatically apply changes for runs that were created by run triggers from another workspace. -* `assessmentsEnabled` - (Available only in Terraform Cloud) Indicates whether health assessments such as drift detection are enabled for the workspace. +* `assessmentsEnabled` - (Available only in HCP Terraform) Indicates whether health assessments such as drift detection are enabled for the workspace. * `fileTriggersEnabled` - Indicates whether runs are triggered based on the changed files in a VCS push (if `true`) or always triggered on every push (if `false`). * `globalRemoteState` - (Optional) Whether the workspace should allow all workspaces in the organization to access its state data during runs. If false, then only specifically approved workspaces can access its state (determined by the `remoteStateConsumerIds` argument). * `remoteStateConsumerIds` - (Optional) A set of workspace IDs that will be set as the remote state consumers for the given workspace. Cannot be used if `globalRemoteState` is set to `true`. @@ -71,9 +71,9 @@ In addition to all arguments above, the following attributes are exported: * `structuredRunOutputEnabled` - Indicates whether runs in this workspace use the enhanced apply UI. * `tagNames` - The names of tags added to this workspace. * `terraformVersion` - The version (or version constraint) of Terraform used for this workspace. -* `triggerPrefixes` - List of trigger prefixes that describe the paths Terraform Cloud monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. - Terraform Cloud or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. -* `triggerPatterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. +* `triggerPrefixes` - List of trigger prefixes that describe the paths HCP Terraform monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. + HCP Terraform or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. +* `triggerPatterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. * `vcsRepo` - Settings for the workspace's VCS repository. * `workingDirectory` - A relative path that Terraform will execute within. * `executionMode` - Indicates the [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) of the workspace. **Note:** This value might be derived from an organization-level default or set on the workspace itself; see the [`tfe_workspace_settings` resource](tfe_workspace_settings) for details. diff --git a/website/docs/cdktf/typescript/d/workspace_run_task.html.markdown b/website/docs/cdktf/typescript/d/workspace_run_task.html.markdown index 5d1a71a5b..5ccb6689f 100644 --- a/website/docs/cdktf/typescript/d/workspace_run_task.html.markdown +++ b/website/docs/cdktf/typescript/d/workspace_run_task.html.markdown @@ -9,7 +9,7 @@ description: |- # Data Source: tfe_workspace_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about a [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/typescript/index.html.markdown b/website/docs/cdktf/typescript/index.html.markdown index dae0514b7..e1c75f06d 100644 --- a/website/docs/cdktf/typescript/index.html.markdown +++ b/website/docs/cdktf/typescript/index.html.markdown @@ -1,18 +1,18 @@ --- layout: "tfe" -page_title: "Provider: Terraform Cloud/Enterprise" +page_title: "Provider: HCP Terraform and Terraform Enterprise" description: |- - Provision Terraform Cloud or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the Terraform Cloud team at HashiCorp. + Provision HCP Terraform or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the HCP Terraform team at HashiCorp. --- -# Terraform Cloud/Enterprise Provider +# HCP Terraform and Terraform Enterprise Provider This provider is used to interact with the many resources supported by -[Terraform Cloud](/docs/cloud/index.html). As [Terraform +[HCP Terraform](/docs/cloud/index.html). As [Terraform Enterprise](/docs/enterprise/index.html) is a self-hosted distribution of -Terraform Cloud, this provider supports both Cloud and Enterprise. +HCP Terraform, this provider supports both Cloud and Enterprise. Use the navigation to the left to read about the available resources. @@ -24,7 +24,7 @@ For more information, see [Versions](#versions). ## Authentication -This provider requires a Terraform Cloud/Enterprise API token in order to manage +This provider requires a HCP Terraform and Terraform Enterprise API token in order to manage resources. To manage the full selection of resources, provide a [user @@ -48,12 +48,12 @@ the token. When configuring the input variable for either of these options, mark them as sensitive. --> **Note:** If you are using this provider in Terraform Cloud or Terraform +-> **Note:** If you are using this provider in HCP Terraform or Terraform Enterprise, you will need to use one of the two options above, even if you're using the `remote` backend with [remote operations](https://developer.hashicorp.com/terraform/language/settings/backends/configuration) and the [CLI-driven Run workflow](/docs/cloud/run/cli.html). -If you are using this provider on your local command line without remote operations (i.e. only using Terraform Cloud as a +If you are using this provider on your local command line without remote operations (i.e. only using HCP Terraform as a [remote state backend](https://developer.hashicorp.com/terraform/language/state/remote)), there are two more options available to you: @@ -135,10 +135,10 @@ class MyConvertedCode extends TerraformStack { The following arguments are supported: -* `hostname` - (Optional) The Terraform Cloud/Enterprise hostname to connect to. +* `hostname` - (Optional) The HCP Terraform and Terraform Enterprise hostname to connect to. Defaults to `app.terraform.io`. Can be overridden by setting the `TFE_HOSTNAME` environment variable. -* `token` - (Optional) The token used to authenticate with Terraform Cloud/Enterprise. +* `token` - (Optional) The token used to authenticate with HCP Terraform and Terraform Enterprise. See [Authentication](#authentication) above for more information. * `sslSkipVerify` - (Optional) Whether or not to skip certificate verifications. Defaults to `false`. Can be overridden setting the `TFE_SSL_SKIP_VERIFY` diff --git a/website/docs/cdktf/typescript/r/agent_pool_allowed_workspaces.html.markdown b/website/docs/cdktf/typescript/r/agent_pool_allowed_workspaces.html.markdown index f532fa426..76bb59161 100644 --- a/website/docs/cdktf/typescript/r/agent_pool_allowed_workspaces.html.markdown +++ b/website/docs/cdktf/typescript/r/agent_pool_allowed_workspaces.html.markdown @@ -11,9 +11,9 @@ description: |- Adds and removes allowed workspaces on an agent pool. -~> **NOTE:** This resource requires using the provider with Terraform Cloud and a Terraform Cloud +~> **NOTE:** This resource requires using the provider with HCP Terraform and a HCP Terraform for Business account. -[Learn more about Terraform Cloud pricing here](https://www.hashicorp.com/products/terraform/pricing). +[Learn more about HCP Terraform pricing here](https://www.hashicorp.com/products/terraform/pricing). ## Example Usage diff --git a/website/docs/cdktf/typescript/r/agent_token.html.markdown b/website/docs/cdktf/typescript/r/agent_token.html.markdown index a9b84db50..f36186414 100644 --- a/website/docs/cdktf/typescript/r/agent_token.html.markdown +++ b/website/docs/cdktf/typescript/r/agent_token.html.markdown @@ -10,7 +10,7 @@ description: |- # tfe_agent_token Each agent pool has its own set of tokens which are not shared across pools. -These tokens allow agents to communicate securely with Terraform Cloud. +These tokens allow agents to communicate securely with HCP Terraform. ## Example Usage diff --git a/website/docs/cdktf/typescript/r/notification_configuration.html.markdown b/website/docs/cdktf/typescript/r/notification_configuration.html.markdown index a4d382fde..8b8518e06 100644 --- a/website/docs/cdktf/typescript/r/notification_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/notification_configuration.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_notification_configuration -Terraform Cloud can be configured to send notifications for run state transitions. +HCP Terraform can be configured to send notifications for run state transitions. Notification configurations allow you to specify a URL, destination type, and what events will trigger the notification. Each workspace can have up to 20 notification configurations, and they apply to all runs for that workspace. @@ -186,9 +186,9 @@ The following arguments are supported: * `destinationType` - (Required) The type of notification configuration payload to send. Valid values are: * `generic` - * `email` available in Terraform Cloud or Terraform Enterprise v202005-1 or later + * `email` available in HCP Terraform or Terraform Enterprise v202005-1 or later * `slack` - * `microsoft-teams` available in Terraform Cloud or Terraform Enterprise v202206-1 or later + * `microsoft-teams` available in HCP Terraform or Terraform Enterprise v202206-1 or later * `emailAddresses` - (Optional) **TFE only** A list of email addresses. This value _must not_ be provided if `destinationType` is `generic`, `microsoft-teams`, or `slack`. * `emailUserIds` - (Optional) A list of user IDs. This value _must not_ be provided diff --git a/website/docs/cdktf/typescript/r/oauth_client.html.markdown b/website/docs/cdktf/typescript/r/oauth_client.html.markdown index 1a3b53615..d02868f1f 100644 --- a/website/docs/cdktf/typescript/r/oauth_client.html.markdown +++ b/website/docs/cdktf/typescript/r/oauth_client.html.markdown @@ -45,7 +45,7 @@ class MyConvertedCode extends TerraformStack { #### Azure DevOps Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). **Note:** This resource requires a private key when creating Azure DevOps Server OAuth clients. @@ -78,7 +78,7 @@ class MyConvertedCode extends TerraformStack { #### BitBucket Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). When using BitBucket Server, you must use three required fields: `key`, `secret`, `rsaPublicKey`. diff --git a/website/docs/cdktf/typescript/r/opa_version.html.markdown b/website/docs/cdktf/typescript/r/opa_version.html.markdown index e1d634b0d..616a73c82 100644 --- a/website/docs/cdktf/typescript/r/opa_version.html.markdown +++ b/website/docs/cdktf/typescript/r/opa_version.html.markdown @@ -45,7 +45,7 @@ The following arguments are supported: * `url` - (Required) The URL where a 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed OPA binary. * `official` - (Optional) Whether or not this is an official release of OPA. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of OPA is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of OPA is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of OPA is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of OPA is deprecated. Defaults to "false". * `deprecatedReason` - (Optional) Additional context about why a version of OPA is deprecated. Defaults to "null" unless `deprecated` is true. @@ -66,6 +66,6 @@ terraform import tfe_opa_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_opa_version.test 0.58.0 ``` --> **Note:** You can fetch a OPA version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a OPA version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/organization.html.markdown b/website/docs/cdktf/typescript/r/organization.html.markdown index 3ba278ef1..05b4e55e4 100644 --- a/website/docs/cdktf/typescript/r/organization.html.markdown +++ b/website/docs/cdktf/typescript/r/organization.html.markdown @@ -49,10 +49,14 @@ The following arguments are supported: * `collaboratorAuthPolicy` - (Optional) Authentication policy (`password` or `two_factor_mandatory`). Defaults to `password`. * `ownersTeamSamlRoleId` - (Optional) The name of the "owners" team. -* `costEstimationEnabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `costEstimationEnabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `sendPassingStatusesForUntriggeredSpeculativePlans` - (Optional) Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to false. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. +<<<<<<< HEAD * `aggregatedCommitStatusEnabled` - (Optional) Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. If enabled, `sendPassingStatusesForUntriggeredSpeculativePlans` needs to be false. -* `assessmentsEnforced` - (Optional) (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. +* `assessmentsEnforced` - (Optional) (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. +======= +* `assessmentsEnforced` - (Optional) (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. +>>>>>>> 79010b4f (Removed all references to HCP Terraform) * `allowForceDeleteWorkspaces` - (Optional) Whether workspace administrators are permitted to delete workspaces with resources under management. If false, only organization owners may delete these workspaces. Defaults to false. ## Attributes Reference diff --git a/website/docs/cdktf/typescript/r/organization_membership.html.markdown b/website/docs/cdktf/typescript/r/organization_membership.html.markdown index 094241ddd..7874e4048 100644 --- a/website/docs/cdktf/typescript/r/organization_membership.html.markdown +++ b/website/docs/cdktf/typescript/r/organization_membership.html.markdown @@ -11,7 +11,7 @@ description: |- Add or remove a user from an organization. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** This resource cannot be used to update an existing user's email address diff --git a/website/docs/cdktf/typescript/r/organization_run_task.html.markdown b/website/docs/cdktf/typescript/r/organization_run_task.html.markdown index a52e2e0b8..462ace970 100644 --- a/website/docs/cdktf/typescript/r/organization_run_task.html.markdown +++ b/website/docs/cdktf/typescript/r/organization_run_task.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_organization_run_task resource creates, updates and destroys [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/cdktf/typescript/r/registry_module.html.markdown b/website/docs/cdktf/typescript/r/registry_module.html.markdown index 1404322a4..b29f30999 100644 --- a/website/docs/cdktf/typescript/r/registry_module.html.markdown +++ b/website/docs/cdktf/typescript/r/registry_module.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_registry_module -Terraform Cloud's private module registry helps you share Terraform modules across your organization. +HCP Terraform's private module registry helps you share Terraform modules across your organization. ## Example Usage diff --git a/website/docs/cdktf/typescript/r/run_trigger.html.markdown b/website/docs/cdktf/typescript/r/run_trigger.html.markdown index 24f65857b..e8bc59ed1 100644 --- a/website/docs/cdktf/typescript/r/run_trigger.html.markdown +++ b/website/docs/cdktf/typescript/r/run_trigger.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_run_trigger -Terraform Cloud provides a way to connect your workspace to one or more workspaces within your organization, +HCP Terraform provides a way to connect your workspace to one or more workspaces within your organization, known as "source workspaces". These connections, called run triggers, allow runs to queue automatically in your workspace on successful apply of runs in any of the source workspaces. You can connect your workspace to up to 20 source workspaces. diff --git a/website/docs/cdktf/typescript/r/sentinel_version.html.markdown b/website/docs/cdktf/typescript/r/sentinel_version.html.markdown index c11688de7..f439c7125 100644 --- a/website/docs/cdktf/typescript/r/sentinel_version.html.markdown +++ b/website/docs/cdktf/typescript/r/sentinel_version.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_sentinel_version -Manage Sentinel versions available on Terraform Cloud/Enterprise. +Manage Sentinel versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -45,7 +45,7 @@ The following arguments are supported: * `url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed Sentinel binary. * `official` - (Optional) Whether or not this is an official release of Sentinel. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of Sentinel is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of Sentinel is deprecated. Defaults to "false". * `deprecatedReason` - (Optional) Additional context about why a version of Sentinel is deprecated. Defaults to "null" unless `deprecated` is true. @@ -66,6 +66,6 @@ terraform import tfe_sentinel_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_sentinel_version.test 0.24.0 ``` --> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/team_organization_member.html.markdown b/website/docs/cdktf/typescript/r/team_organization_member.html.markdown index 9c60fbb77..f264c9f96 100644 --- a/website/docs/cdktf/typescript/r/team_organization_member.html.markdown +++ b/website/docs/cdktf/typescript/r/team_organization_member.html.markdown @@ -16,7 +16,7 @@ Add or remove a team member using a resources for managing team memberships. This - along with [tfe_organization_membership](organization_membership.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/typescript/r/team_organization_members.html.markdown b/website/docs/cdktf/typescript/r/team_organization_members.html.markdown index 7dda75e25..425e367ba 100644 --- a/website/docs/cdktf/typescript/r/team_organization_members.html.markdown +++ b/website/docs/cdktf/typescript/r/team_organization_members.html.markdown @@ -16,7 +16,7 @@ Add or remove one or more team members using a resources for managing team memberships. This - along with [tfe_team_organization_member](team_organization_member.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/cdktf/typescript/r/terraform_version.html.markdown b/website/docs/cdktf/typescript/r/terraform_version.html.markdown index 498537295..7dfc5508d 100644 --- a/website/docs/cdktf/typescript/r/terraform_version.html.markdown +++ b/website/docs/cdktf/typescript/r/terraform_version.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_terraform_version -Manage Terraform versions available on Terraform Cloud/Enterprise. +Manage Terraform versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -45,7 +45,7 @@ The following arguments are supported: * `url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed Terraform binary. * `official` - (Optional) Whether or not this is an official release of Terraform. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of Terraform is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of Terraform is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of Terraform is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of Terraform is deprecated. Defaults to "false". * `deprecatedReason` - (Optional) Additional context about why a version of Terraform is deprecated. Defaults to "null" unless `deprecated` is true. @@ -66,6 +66,6 @@ terraform import tfe_terraform_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_terraform_version.test 1.1.2 ``` --> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/variable.html.markdown b/website/docs/cdktf/typescript/r/variable.html.markdown index 329aa0a2d..46e787a4f 100644 --- a/website/docs/cdktf/typescript/r/variable.html.markdown +++ b/website/docs/cdktf/typescript/r/variable.html.markdown @@ -118,7 +118,7 @@ variable is written once and not visible thereafter. Defaults to `false`. * `variableSetId` - ID of the variable set that owns the variable. ~> **NOTE:** When `sensitive` is set to true, Terraform cannot detect and repair -drift if `value` is later changed out-of-band via the Terraform Cloud UI. +drift if `value` is later changed out-of-band via the HCP Terraform UI. Terraform will only change the value for a sensitive variable if you change `value` in the configuration, so that it no longer matches the last known value in the state. diff --git a/website/docs/cdktf/typescript/r/workspace.html.markdown b/website/docs/cdktf/typescript/r/workspace.html.markdown index e260749b3..4630dc0ce 100644 --- a/website/docs/cdktf/typescript/r/workspace.html.markdown +++ b/website/docs/cdktf/typescript/r/workspace.html.markdown @@ -13,7 +13,7 @@ Provides a workspace resource. ~> **NOTE:** Setting the execution mode and agent pool affinity directly on the workspace is deprecated in favor of using both [tfe_workspace_settings](workspace_settings) and [tfe_organization_default_settings](organization_default_settings), since they allow more precise control and fully support [agent_pool_allowed_workspaces](agent_pool_allowed_workspaces). Use caution when unsetting `executionMode`, as it now leaves any prior value unmanaged instead of reverting to the old default value of `"remote"`. -~> **NOTE:** Using `globalRemoteState` or `remoteStateConsumerIds` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `globalRemoteState` or `remoteStateConsumerIds` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -116,7 +116,7 @@ The following arguments are supported: automatically performing runs immediately after its creation. Defaults to `true`. When set to `false`, runs triggered by a webhook (such as a commit in VCS) will not be queued until at least one run has been manually queued. - **Note:** This default differs from the Terraform Cloud API default, which + **Note:** This default differs from the HCP Terraform API default, which is `false`. The provider uses `true` as any workspace provisioned with `false` would need to then have a run manually queued out-of-band before accepting webhooks. @@ -133,7 +133,7 @@ The following arguments are supported: workspace has been created, so modifying this value will result in the workspace being replaced. To disable this, use an [ignore changes](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) lifecycle meta-argument * `speculativeEnabled` - (Optional) Whether this workspace allows speculative - plans. Defaults to `true`. Setting this to `false` prevents Terraform Cloud + plans. Defaults to `true`. Setting this to `false` prevents HCP Terraform or the Terraform Enterprise instance from running plans on pull requests, which can improve security if the VCS repository is public or includes untrusted contributors. @@ -154,7 +154,7 @@ will be used. (like `~> 1.0.0`); if you specify a constraint, the workspace will always use the newest release that meets that constraint. Defaults to the latest available version. -* `triggerPatterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) 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`. +* `triggerPatterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with `trigger-prefixes`. * `triggerPrefixes` - (Optional) List of repository-root-relative paths which describe all locations to be tracked for changes. * `vcsRepo` - (Optional) Settings for the workspace's VCS repository, enabling the [UI/VCS-driven run workflow](https://developer.hashicorp.com/terraform/cloud-docs/run/ui). diff --git a/website/docs/cdktf/typescript/r/workspace_run.html.markdown b/website/docs/cdktf/typescript/r/workspace_run.html.markdown index 388a6fded..fabcce29e 100644 --- a/website/docs/cdktf/typescript/r/workspace_run.html.markdown +++ b/website/docs/cdktf/typescript/r/workspace_run.html.markdown @@ -222,8 +222,8 @@ The following arguments are supported: Both `apply` and `destroy` block supports: -* `manualConfirm` - (Required) If set to true a human will have to manually confirm a plan in Terraform Cloud's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `false`. - * If `waitForRun` is set to `false`, this auto-apply will be done by Terraform Cloud. +* `manualConfirm` - (Required) If set to true a human will have to manually confirm a plan in HCP Terraform's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `false`. + * If `waitForRun` is set to `false`, this auto-apply will be done by HCP Terraform. * If `waitForRun` is set to `true`, the apply will be confirmed by the provider. The exception is the case of policy check soft-failed where a human has to perform an override by manually confirming the plan even though `manualConfirm` is set to false. * Note that this setting will override the workspace's default apply mode. To use the workspace default apply mode, look up the setting for `autoApply` with the `tfe_workspace` data source. * `retry` - (Optional) Whether or not to retry on plan or apply errors. When set to true, `retryAttempts` must also be greater than zero inorder for retries to happen. Defaults to `true`. @@ -236,5 +236,5 @@ Both `apply` and `destroy` block supports: In addition to all arguments above, the following attributes are exported: -* `id` - The ID of the run created by this resource. Note, if the resource was created without an `apply{}` configuration block, then this ID will not refer to a real run in Terraform Cloud. +* `id` - The ID of the run created by this resource. Note, if the resource was created without an `apply{}` configuration block, then this ID will not refer to a real run in HCP Terraform. \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspace_run_task.html.markdown b/website/docs/cdktf/typescript/r/workspace_run_task.html.markdown index b45d66f2a..f4c7001e4 100644 --- a/website/docs/cdktf/typescript/r/workspace_run_task.html.markdown +++ b/website/docs/cdktf/typescript/r/workspace_run_task.html.markdown @@ -9,7 +9,7 @@ description: |- # tfe_workspace_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_workspace_run_task resource associates, updates and removes [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/cdktf/typescript/r/workspace_settings.markdown b/website/docs/cdktf/typescript/r/workspace_settings.markdown index 26cba38c8..5ce4c9141 100644 --- a/website/docs/cdktf/typescript/r/workspace_settings.markdown +++ b/website/docs/cdktf/typescript/r/workspace_settings.markdown @@ -146,7 +146,7 @@ The following arguments are supported: * `agentPoolId` - (Optional) The ID of an agent pool to assign to the workspace. Requires `executionMode` to be set to `agent`. This value _must not_ be provided if `executionMode` is set to any other value. * `executionMode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) - to use. Using Terraform Cloud, valid values are `remote`, `local` or `agent`. Using Terraform Enterprise, only `remote` and `local` execution modes are valid. When set to `local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `remote`), removing any explicit value that might have previously been set for the workspace. + to use. Using HCP Terraform, valid values are `remote`, `local` or `agent`. Using Terraform Enterprise, only `remote` and `local` execution modes are valid. When set to `local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `remote`), removing any explicit value that might have previously been set for the workspace. ## Attributes Reference diff --git a/website/docs/d/ip_ranges.html.markdown b/website/docs/d/ip_ranges.html.markdown index 0a2559354..9fcec42c5 100644 --- a/website/docs/d/ip_ranges.html.markdown +++ b/website/docs/d/ip_ranges.html.markdown @@ -2,12 +2,12 @@ layout: "tfe" page_title: "Terraform Enterprise: tfe_ip_ranges" description: |- - Get Terraform Cloud/Enterprise's IP ranges of its services + Get HCP Terraform and Terraform Enterprise's IP ranges of its services --- # Data Source: tfe_ip_ranges -Use this data source to retrieve a list of Terraform Cloud's IP ranges. For more information about these IP ranges, view our [documentation about Terraform Cloud IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). +Use this data source to retrieve a list of HCP Terraform's IP ranges. For more information about these IP ranges, view our [documentation about HCP Terraform IP Ranges](https://developer.hashicorp.com/terraform/cloud-docs/architectural-details/ip-ranges). ## Example Usage @@ -27,7 +27,7 @@ No arguments are required for this datasource. The following attributes are exported: -* `api` - The list of IP ranges in CIDR notation used for connections from user site to Terraform Cloud APIs. +* `api` - The list of IP ranges in CIDR notation used for connections from user site to HCP Terraform APIs. * `notifications` - The list of IP ranges in CIDR notation used for notifications. * `sentinel` - The list of IP ranges in CIDR notation used for outbound requests from Sentinel policies. * `vcs` - The list of IP ranges in CIDR notation used for connecting to VCS providers. diff --git a/website/docs/d/organization.html.markdown b/website/docs/d/organization.html.markdown index 95fb50f3b..062b406c3 100644 --- a/website/docs/d/organization.html.markdown +++ b/website/docs/d/organization.html.markdown @@ -28,9 +28,9 @@ In addition to all arguments above, the following attributes are exported: * `email` - Admin email address. * `external_id` - An identifier for the organization. -* `assessments_enforced` - (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. +* `assessments_enforced` - (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set thier own preferences. * `collaborator_auth_policy` - Authentication policy (`password` or `two_factor_mandatory`). Defaults to `password`. -* `cost_estimation_enabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `cost_estimation_enabled` - Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `owners_team_saml_role_id` - The name of the "owners" team. * `send_passing_statuses_for_untriggered_speculative_plans` - Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to true. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `aggregated_commit_status_enabled` - Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. diff --git a/website/docs/d/organization_membership.html.markdown b/website/docs/d/organization_membership.html.markdown index 14ec12230..b8b2a6662 100644 --- a/website/docs/d/organization_membership.html.markdown +++ b/website/docs/d/organization_membership.html.markdown @@ -9,7 +9,7 @@ description: |- Use this data source to get information about an organization membership. -~> **NOTE:** This data source requires using the provider with Terraform Cloud or +~> **NOTE:** This data source requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** If a user updates their email address, configurations using the email address should diff --git a/website/docs/d/organization_run_task.html.markdown b/website/docs/d/organization_run_task.html.markdown index a92c820ca..0efd1dd8b 100644 --- a/website/docs/d/organization_run_task.html.markdown +++ b/website/docs/d/organization_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about an [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/d/slug.html.markdown b/website/docs/d/slug.html.markdown index e6756d755..2b70a13ee 100644 --- a/website/docs/d/slug.html.markdown +++ b/website/docs/d/slug.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_slug This data source is used to represent configuration files on a local filesystem -intended to be uploaded to Terraform Cloud/Enterprise, in lieu of those files being +intended to be uploaded to HCP Terraform and Terraform Enterprise, in lieu of those files being sourced from a configured VCS provider. A unique checksum is generated for the specified local directory, which allows diff --git a/website/docs/d/workspace.html.markdown b/website/docs/d/workspace.html.markdown index c05287009..da6018846 100644 --- a/website/docs/d/workspace.html.markdown +++ b/website/docs/d/workspace.html.markdown @@ -9,7 +9,7 @@ description: |- Use this data source to get information about a workspace. -~> **NOTE:** Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -35,7 +35,7 @@ In addition to all arguments above, the following attributes are exported: * `allow_destroy_plan` - Indicates whether destroy plans can be queued on the workspace. * `auto_apply` - Indicates whether to automatically apply changes when a Terraform plan is successful. * `auto_apply_run_trigger` - Whether the workspace will automatically apply changes for runs that were created by run triggers from another workspace. -* `assessments_enabled` - (Available only in Terraform Cloud) Indicates whether health assessments such as drift detection are enabled for the workspace. +* `assessments_enabled` - (Available only in HCP Terraform) Indicates whether health assessments such as drift detection are enabled for the workspace. * `file_triggers_enabled` - Indicates whether runs are triggered based on the changed files in a VCS push (if `true`) or always triggered on every push (if `false`). * `global_remote_state` - (Optional) Whether the workspace should allow all workspaces in the organization to access its state data during runs. If false, then only specifically approved workspaces can access its state (determined by the `remote_state_consumer_ids` argument). * `remote_state_consumer_ids` - (Optional) A set of workspace IDs that will be set as the remote state consumers for the given workspace. Cannot be used if `global_remote_state` is set to `true`. @@ -55,9 +55,9 @@ In addition to all arguments above, the following attributes are exported: * `structured_run_output_enabled` - Indicates whether runs in this workspace use the enhanced apply UI. * `tag_names` - The names of tags added to this workspace. * `terraform_version` - The version (or version constraint) of Terraform used for this workspace. -* `trigger_prefixes` - List of trigger prefixes that describe the paths Terraform Cloud monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. - Terraform Cloud or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. -* `trigger_patterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository. +* `trigger_prefixes` - List of trigger prefixes that describe the paths HCP Terraform monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. + HCP Terraform or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. +* `trigger_patterns` - List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. * `vcs_repo` - Settings for the workspace's VCS repository. * `working_directory` - A relative path that Terraform will execute within. * `execution_mode` - Indicates the [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) of the workspace. **Note:** This value might be derived from an organization-level default or set on the workspace itself; see the [`tfe_workspace_settings` resource](tfe_workspace_settings) for details. diff --git a/website/docs/d/workspace_run_task.html.markdown b/website/docs/d/workspace_run_task.html.markdown index bff6bf459..05d0131ad 100644 --- a/website/docs/d/workspace_run_task.html.markdown +++ b/website/docs/d/workspace_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # Data Source: tfe_workspace_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. Use this data source to get information about a [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown index 51add7bd3..90fc05815 100644 --- a/website/docs/index.html.markdown +++ b/website/docs/index.html.markdown @@ -1,16 +1,16 @@ --- layout: "tfe" -page_title: "Provider: Terraform Cloud/Enterprise" +page_title: "Provider: HCP Terraform and Terraform Enterprise" description: |- - Provision Terraform Cloud or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the Terraform Cloud team at HashiCorp. + Provision HCP Terraform or Terraform Enterprise - with Terraform! Management of organizations, workspaces, teams, variables, run triggers, policy sets, and more. Maintained by the HCP Terraform team at HashiCorp. --- -# Terraform Cloud/Enterprise Provider +# HCP Terraform and Terraform Enterprise Provider This provider is used to interact with the many resources supported by -[Terraform Cloud](/docs/cloud/index.html). As [Terraform +[HCP Terraform](/docs/cloud/index.html). As [Terraform Enterprise](/docs/enterprise/index.html) is a self-hosted distribution of -Terraform Cloud, this provider supports both Cloud and Enterprise. +HCP Terraform, this provider supports both Cloud and Enterprise. Use the navigation to the left to read about the available resources. @@ -22,7 +22,7 @@ For more information, see [Versions](#versions). ## Authentication -This provider requires a Terraform Cloud/Enterprise API token in order to manage +This provider requires a HCP Terraform and Terraform Enterprise API token in order to manage resources. To manage the full selection of resources, provide a [user @@ -46,12 +46,12 @@ the token. When configuring the input variable for either of these options, mark them as sensitive. --> **Note:** If you are using this provider in Terraform Cloud or Terraform +-> **Note:** If you are using this provider in HCP Terraform or Terraform Enterprise, you will need to use one of the two options above, even if you're using the `remote` backend with [remote operations](https://developer.hashicorp.com/terraform/language/settings/backends/configuration) and the [CLI-driven Run workflow](/docs/cloud/run/cli.html). -If you are using this provider on your local command line without remote operations (i.e. only using Terraform Cloud as a +If you are using this provider on your local command line without remote operations (i.e. only using HCP Terraform as a [remote state backend](https://developer.hashicorp.com/terraform/language/state/remote)), there are two more options available to you: @@ -99,7 +99,7 @@ For more information on provider installation and constraining provider versions ```hcl provider "tfe" { - hostname = var.hostname # Optional, defaults to Terraform Cloud `app.terraform.io` + hostname = var.hostname # Optional, defaults to HCP Terraform `app.terraform.io` token = var.token version = "~> 0.53.0" } @@ -114,10 +114,10 @@ resource "tfe_organization" "org" { The following arguments are supported: -* `hostname` - (Optional) The Terraform Cloud/Enterprise hostname to connect to. +* `hostname` - (Optional) The HCP Terraform or Terraform Enterprise hostname to connect to. Defaults to `app.terraform.io`. Can be overridden by setting the `TFE_HOSTNAME` environment variable. -* `token` - (Optional) The token used to authenticate with Terraform Cloud/Enterprise. +* `token` - (Optional) The token used to authenticate with HCP Terraform or Terraform Enterprise. See [Authentication](#authentication) above for more information. * `ssl_skip_verify` - (Optional) Whether or not to skip certificate verifications. Defaults to `false`. Can be overridden setting the `TFE_SSL_SKIP_VERIFY` diff --git a/website/docs/r/agent_pool_allowed_workspaces.html.markdown b/website/docs/r/agent_pool_allowed_workspaces.html.markdown index 6f533db42..b753d64dd 100644 --- a/website/docs/r/agent_pool_allowed_workspaces.html.markdown +++ b/website/docs/r/agent_pool_allowed_workspaces.html.markdown @@ -9,9 +9,9 @@ description: |- Adds and removes allowed workspaces on an agent pool. -~> **NOTE:** This resource requires using the provider with Terraform Cloud and a Terraform Cloud +~> **NOTE:** This resource requires using the provider with HCP Terraform and a HCP Terraform for Business account. -[Learn more about Terraform Cloud pricing here](https://www.hashicorp.com/products/terraform/pricing). +[Learn more about HCP Terraform pricing here](https://www.hashicorp.com/products/terraform/pricing). ## Example Usage diff --git a/website/docs/r/agent_token.html.markdown b/website/docs/r/agent_token.html.markdown index d6b15696d..0a8111a7f 100644 --- a/website/docs/r/agent_token.html.markdown +++ b/website/docs/r/agent_token.html.markdown @@ -8,7 +8,7 @@ description: |- # tfe_agent_token Each agent pool has its own set of tokens which are not shared across pools. -These tokens allow agents to communicate securely with Terraform Cloud. +These tokens allow agents to communicate securely with HCP Terraform. ## Example Usage diff --git a/website/docs/r/notification_configuration.html.markdown b/website/docs/r/notification_configuration.html.markdown index 10b6c2c0e..2abe6d4d1 100644 --- a/website/docs/r/notification_configuration.html.markdown +++ b/website/docs/r/notification_configuration.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_notification_configuration -Terraform Cloud can be configured to send notifications for run state transitions. +HCP Terraform can be configured to send notifications for run state transitions. Notification configurations allow you to specify a URL, destination type, and what events will trigger the notification. Each workspace can have up to 20 notification configurations, and they apply to all runs for that workspace. @@ -102,9 +102,9 @@ The following arguments are supported: * `destination_type` - (Required) The type of notification configuration payload to send. Valid values are: * `generic` - * `email` available in Terraform Cloud or Terraform Enterprise v202005-1 or later + * `email` available in HCP Terraform or Terraform Enterprise v202005-1 or later * `slack` - * `microsoft-teams` available in Terraform Cloud or Terraform Enterprise v202206-1 or later + * `microsoft-teams` available in HCP Terraform or Terraform Enterprise v202206-1 or later * `email_addresses` - (Optional) **TFE only** A list of email addresses. This value _must not_ be provided if `destination_type` is `generic`, `microsoft-teams`, or `slack`. * `email_user_ids` - (Optional) A list of user IDs. This value _must not_ be provided diff --git a/website/docs/r/oauth_client.html.markdown b/website/docs/r/oauth_client.html.markdown index 00aec36b0..60155e2bd 100644 --- a/website/docs/r/oauth_client.html.markdown +++ b/website/docs/r/oauth_client.html.markdown @@ -30,7 +30,7 @@ resource "tfe_oauth_client" "test" { #### Azure DevOps Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/azure-devops-server). **Note:** This resource requires a private key when creating Azure DevOps Server OAuth clients. @@ -48,7 +48,7 @@ resource "tfe_oauth_client" "test" { #### BitBucket Server Usage -See [documentation for TFC/E setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). +See [documentation for HCP Terraform and Terraform Enterprise setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs/bitbucket-server). When using BitBucket Server, you must use three required fields: `key`, `secret`, `rsa_public_key`. diff --git a/website/docs/r/opa_version.html.markdown b/website/docs/r/opa_version.html.markdown index 8c8503021..a87ff5fe3 100644 --- a/website/docs/r/opa_version.html.markdown +++ b/website/docs/r/opa_version.html.markdown @@ -29,7 +29,7 @@ The following arguments are supported: * `url` - (Required) The URL where a 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed OPA binary. * `official` - (Optional) Whether or not this is an official release of OPA. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of OPA is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of OPA is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of OPA is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of OPA is deprecated. Defaults to "false". * `deprecated_reason` - (Optional) Additional context about why a version of OPA is deprecated. Defaults to "null" unless `deprecated` is true. @@ -50,4 +50,4 @@ terraform import tfe_opa_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_opa_version.test 0.58.0 ``` --> **Note:** You can fetch a OPA version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a OPA version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` diff --git a/website/docs/r/organization.html.markdown b/website/docs/r/organization.html.markdown index c72a0ff49..c2c24451e 100644 --- a/website/docs/r/organization.html.markdown +++ b/website/docs/r/organization.html.markdown @@ -33,10 +33,10 @@ The following arguments are supported: * `collaborator_auth_policy` - (Optional) Authentication policy (`password` or `two_factor_mandatory`). Defaults to `password`. * `owners_team_saml_role_id` - (Optional) The name of the "owners" team. -* `cost_estimation_enabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a Terraform Cloud organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. +* `cost_estimation_enabled` - (Optional) Whether or not the cost estimation feature is enabled for all workspaces in the organization. Defaults to true. In a HCP Terraform organization which does not have Teams & Governance features, this value is always false and cannot be changed. In Terraform Enterprise, Cost Estimation must also be enabled in Site Administration. * `send_passing_statuses_for_untriggered_speculative_plans` - (Optional) Whether or not to send VCS status updates for untriggered speculative plans. This can be useful if large numbers of untriggered workspaces are exhausting request limits for connected version control service providers like GitHub. Defaults to false. In Terraform Enterprise, this setting has no effect and cannot be changed but is also available in Site Administration. * `aggregated_commit_status_enabled` - (Optional) Whether or not to enable Aggregated Status Checks. This can be useful for monorepo repositories with multiple workspaces receiving status checks for events such as a pull request. If enabled, `send_passing_statuses_for_untriggered_speculative_plans` needs to be false. -* `assessments_enforced` - (Optional) (Available only in Terraform Cloud) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. +* `assessments_enforced` - (Optional) (Available only in HCP Terraform) Whether to force health assessments (drift detection) on all eligible workspaces or allow workspaces to set their own preferences. * `allow_force_delete_workspaces` - (Optional) Whether workspace administrators are permitted to delete workspaces with resources under management. If false, only organization owners may delete these workspaces. Defaults to false. ## Attributes Reference diff --git a/website/docs/r/organization_membership.html.markdown b/website/docs/r/organization_membership.html.markdown index ba03cd04d..b2feec05a 100644 --- a/website/docs/r/organization_membership.html.markdown +++ b/website/docs/r/organization_membership.html.markdown @@ -9,7 +9,7 @@ description: |- Add or remove a user from an organization. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ~> **NOTE:** This resource cannot be used to update an existing user's email address diff --git a/website/docs/r/organization_run_task.html.markdown b/website/docs/r/organization_run_task.html.markdown index 5676125ef..4e019f4a4 100644 --- a/website/docs/r/organization_run_task.html.markdown +++ b/website/docs/r/organization_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_organization_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_organization_run_task resource creates, updates and destroys [Organization Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#creating-a-run-task). diff --git a/website/docs/r/registry_module.html.markdown b/website/docs/r/registry_module.html.markdown index 548dcbed9..495700a2f 100644 --- a/website/docs/r/registry_module.html.markdown +++ b/website/docs/r/registry_module.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_registry_module -Terraform Cloud's private module registry helps you share Terraform modules across your organization. +HCP Terraform's private module registry helps you share Terraform modules across your organization. ## Example Usage diff --git a/website/docs/r/run_trigger.html.markdown b/website/docs/r/run_trigger.html.markdown index 973e0a458..930389e92 100644 --- a/website/docs/r/run_trigger.html.markdown +++ b/website/docs/r/run_trigger.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_run_trigger -Terraform Cloud provides a way to connect your workspace to one or more workspaces within your organization, +HCP Terraform provides a way to connect your workspace to one or more workspaces within your organization, known as "source workspaces". These connections, called run triggers, allow runs to queue automatically in your workspace on successful apply of runs in any of the source workspaces. You can connect your workspace to up to 20 source workspaces. diff --git a/website/docs/r/sentinel_version.html.markdown b/website/docs/r/sentinel_version.html.markdown index d1b669953..91ac02b60 100644 --- a/website/docs/r/sentinel_version.html.markdown +++ b/website/docs/r/sentinel_version.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_sentinel_version -Manage Sentinel versions available on Terraform Cloud/Enterprise. +Manage Sentinel versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -29,7 +29,7 @@ The following arguments are supported: * `url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed Sentinel binary. * `official` - (Optional) Whether or not this is an official release of Sentinel. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of Sentinel is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of Sentinel is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of Sentinel is deprecated. Defaults to "false". * `deprecated_reason` - (Optional) Additional context about why a version of Sentinel is deprecated. Defaults to "null" unless `deprecated` is true. @@ -50,4 +50,4 @@ terraform import tfe_sentinel_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_sentinel_version.test 0.24.0 ``` --> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Sentinel version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` diff --git a/website/docs/r/team_organization_member.html.markdown b/website/docs/r/team_organization_member.html.markdown index 4966bbc06..84eb67747 100644 --- a/website/docs/r/team_organization_member.html.markdown +++ b/website/docs/r/team_organization_member.html.markdown @@ -14,7 +14,7 @@ Add or remove a team member using a resources for managing team memberships. This - along with [tfe_organization_membership](organization_membership.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/r/team_organization_members.html.markdown b/website/docs/r/team_organization_members.html.markdown index e021768d4..ed21af645 100644 --- a/website/docs/r/team_organization_members.html.markdown +++ b/website/docs/r/team_organization_members.html.markdown @@ -14,7 +14,7 @@ Add or remove one or more team members using a resources for managing team memberships. This - along with [tfe_team_organization_member](team_organization_member.html) - is the preferred method as it allows you to add members to a team by email addresses. The [tfe_team_organization_member](team_organization_member.html) is used to manage a single team membership whereas [tfe_team_organization_members](team_organization_members.html) is used to manage all team memberships at once. All four resources cannot be used for the same team simultaneously. -~> **NOTE:** This resource requires using the provider with Terraform Cloud or +~> **NOTE:** This resource requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202004-1. ## Example Usage diff --git a/website/docs/r/terraform_version.html.markdown b/website/docs/r/terraform_version.html.markdown index bd321176d..3f1a4288d 100644 --- a/website/docs/r/terraform_version.html.markdown +++ b/website/docs/r/terraform_version.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_terraform_version -Manage Terraform versions available on Terraform Cloud/Enterprise. +Manage Terraform versions available on HCP Terraform and Terraform Enterprise. ## Example Usage @@ -29,7 +29,7 @@ The following arguments are supported: * `url` - (Required) The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded. * `sha` - (Required) The SHA-256 checksum of the compressed Terraform binary. * `official` - (Optional) Whether or not this is an official release of Terraform. Defaults to "false". -* `enabled` - (Optional) Whether or not this version of Terraform is enabled for use in Terraform Cloud/Enterprise. Defaults to "true". +* `enabled` - (Optional) Whether or not this version of Terraform is enabled for use in HCP Terraform and Terraform Enterprise. Defaults to "true". * `beta` - (Optional) Whether or not this version of Terraform is beta pre-release. Defaults to "false". * `deprecated` - (Optional) Whether or not this version of Terraform is deprecated. Defaults to "false". * `deprecated_reason` - (Optional) Additional context about why a version of Terraform is deprecated. Defaults to "null" unless `deprecated` is true. @@ -50,4 +50,4 @@ terraform import tfe_terraform_version.test tool-L4oe7rNwn7J4E5Yr terraform import tfe_terraform_version.test 1.1.2 ``` --> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the Terraform Cloud UI. The ID is in the format `tool-` +-> **Note:** You can fetch a Terraform version ID from the URL of an existing version in the HCP Terraform UI. The ID is in the format `tool-` diff --git a/website/docs/r/variable.html.markdown b/website/docs/r/variable.html.markdown index 30a431098..92b57b1c6 100644 --- a/website/docs/r/variable.html.markdown +++ b/website/docs/r/variable.html.markdown @@ -83,7 +83,7 @@ variable is written once and not visible thereafter. Defaults to `false`. * `variable_set_id` - ID of the variable set that owns the variable. ~> **NOTE:** When `sensitive` is set to true, Terraform cannot detect and repair -drift if `value` is later changed out-of-band via the Terraform Cloud UI. +drift if `value` is later changed out-of-band via the HCP Terraform UI. Terraform will only change the value for a sensitive variable if you change `value` in the configuration, so that it no longer matches the last known value in the state. diff --git a/website/docs/r/workspace.html.markdown b/website/docs/r/workspace.html.markdown index 378aac39a..879e9f43a 100644 --- a/website/docs/r/workspace.html.markdown +++ b/website/docs/r/workspace.html.markdown @@ -11,7 +11,7 @@ Provides a workspace resource. ~> **NOTE:** Setting the execution mode and agent pool affinity directly on the workspace is deprecated in favor of using both [tfe_workspace_settings](workspace_settings) and [tfe_organization_default_settings](organization_default_settings), since they allow more precise control and fully support [agent_pool_allowed_workspaces](agent_pool_allowed_workspaces). Use caution when unsetting `execution_mode`, as it now leaves any prior value unmanaged instead of reverting to the old default value of `"remote"`. -~> **NOTE:** Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1. +~> **NOTE:** Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with HCP Terraform or an instance of Terraform Enterprise at least as recent as v202104-1. ## Example Usage @@ -86,7 +86,7 @@ The following arguments are supported: automatically performing runs immediately after its creation. Defaults to `true`. When set to `false`, runs triggered by a webhook (such as a commit in VCS) will not be queued until at least one run has been manually queued. - **Note:** This default differs from the Terraform Cloud API default, which + **Note:** This default differs from the HCP Terraform API default, which is `false`. The provider uses `true` as any workspace provisioned with `false` would need to then have a run manually queued out-of-band before accepting webhooks. @@ -103,7 +103,7 @@ The following arguments are supported: workspace has been created, so modifying this value will result in the workspace being replaced. To disable this, use an [ignore changes](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) lifecycle meta-argument * `speculative_enabled` - (Optional) Whether this workspace allows speculative - plans. Defaults to `true`. Setting this to `false` prevents Terraform Cloud + plans. Defaults to `true`. Setting this to `false` prevents HCP Terraform or the Terraform Enterprise instance from running plans on pull requests, which can improve security if the VCS repository is public or includes untrusted contributors. @@ -124,7 +124,7 @@ will be used. (like `~> 1.0.0`); if you specify a constraint, the workspace will always use the newest release that meets that constraint. Defaults to the latest available version. -* `trigger_patterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) 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`. +* `trigger_patterns` - (Optional) List of [glob patterns](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/vcs#glob-patterns-for-automatic-run-triggering) that describe the files HCP Terraform monitors for changes. Trigger patterns are always appended to the root directory of the repository. Mutually exclusive with `trigger-prefixes`. * `trigger_prefixes` - (Optional) List of repository-root-relative paths which describe all locations to be tracked for changes. * `vcs_repo` - (Optional) Settings for the workspace's VCS repository, enabling the [UI/VCS-driven run workflow](https://developer.hashicorp.com/terraform/cloud-docs/run/ui). diff --git a/website/docs/r/workspace_run.html.markdown b/website/docs/r/workspace_run.html.markdown index 9bc7e76b2..602ca6c9a 100644 --- a/website/docs/r/workspace_run.html.markdown +++ b/website/docs/r/workspace_run.html.markdown @@ -190,8 +190,8 @@ The following arguments are supported: Both `apply` and `destroy` block supports: -* `manual_confirm` - (Required) If set to true a human will have to manually confirm a plan in Terraform Cloud's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `false`. - * If `wait_for_run` is set to `false`, this auto-apply will be done by Terraform Cloud. +* `manual_confirm` - (Required) If set to true a human will have to manually confirm a plan in HCP Terraform's UI to start an apply. If set to false, this resource will be automatically applied. Defaults to `false`. + * If `wait_for_run` is set to `false`, this auto-apply will be done by HCP Terraform. * If `wait_for_run` is set to `true`, the apply will be confirmed by the provider. The exception is the case of policy check soft-failed where a human has to perform an override by manually confirming the plan even though `manual_confirm` is set to false. * Note that this setting will override the workspace's default apply mode. To use the workspace default apply mode, look up the setting for `auto_apply` with the `tfe_workspace` data source. * `retry` - (Optional) Whether or not to retry on plan or apply errors. When set to true, `retry_attempts` must also be greater than zero inorder for retries to happen. Defaults to `true`. @@ -204,4 +204,4 @@ Both `apply` and `destroy` block supports: In addition to all arguments above, the following attributes are exported: -* `id` - The ID of the run created by this resource. Note, if the resource was created without an `apply{}` configuration block, then this ID will not refer to a real run in Terraform Cloud. \ No newline at end of file +* `id` - The ID of the run created by this resource. Note, if the resource was created without an `apply{}` configuration block, then this ID will not refer to a real run in HCP Terraform. \ No newline at end of file diff --git a/website/docs/r/workspace_run_task.html.markdown b/website/docs/r/workspace_run_task.html.markdown index ae7fb562d..de0b3a012 100644 --- a/website/docs/r/workspace_run_task.html.markdown +++ b/website/docs/r/workspace_run_task.html.markdown @@ -7,7 +7,7 @@ description: |- # tfe_workspace_run_task -[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow Terraform Cloud to interact with external systems at specific points in the Terraform Cloud run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. +[Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks) allow HCP Terraform to interact with external systems at specific points in the HCP Terraform run lifecycle. Run tasks are reusable configurations that you can attach to any workspace in an organization. The tfe_workspace_run_task resource associates, updates and removes [Workspace Run tasks](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings/run-tasks#associating-run-tasks-with-a-workspace). diff --git a/website/docs/r/workspace_settings.markdown b/website/docs/r/workspace_settings.markdown index e47b78f9a..8caeea24a 100644 --- a/website/docs/r/workspace_settings.markdown +++ b/website/docs/r/workspace_settings.markdown @@ -88,7 +88,7 @@ The following arguments are supported: * `agent_pool_id` - (Optional) The ID of an agent pool to assign to the workspace. Requires `execution_mode` to be set to `agent`. This value _must not_ be provided if `execution_mode` is set to any other value. * `execution_mode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode) - to use. Using Terraform Cloud, valid values are `remote`, `local` or `agent`. Using Terraform Enterprise, only `remote` and `local` execution modes are valid. When set to `local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `remote`), removing any explicit value that might have previously been set for the workspace. + to use. Using HCP Terraform, valid values are `remote`, `local` or `agent`. Using Terraform Enterprise, only `remote` and `local` execution modes are valid. When set to `local`, the workspace will be used for state storage only. **Important:** If you omit this attribute, the resource configures the workspace to use your organization's default execution mode (which in turn defaults to `remote`), removing any explicit value that might have previously been set for the workspace. ## Attributes Reference