Skip to content

Commit

Permalink
Rebrand Terraform Cloud to HCP Terraform (#1328)
Browse files Browse the repository at this point in the history
  • Loading branch information
sebasslash authored Apr 23, 2024
1 parent d703ba4 commit fc605eb
Show file tree
Hide file tree
Showing 190 changed files with 426 additions and 424 deletions.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
[email protected]. For general usage questions, please post to our community forum:
https://discuss.hashicorp.com.
-->

#### Terraform Cloud/Enterprise version
#### Terraform Enterprise version

<!---
Are you using Terraform Cloud or Terraform Enterprise? If Terraform Enterprise, please include the version
If you are using Terraform Enterprise, please include the version
Example: Terraform Enterprise v202104-1
-->

Expand All @@ -27,8 +27,8 @@ Example: Terraform Enterprise v202104-1
<!---
If you are using Terraform CLI, run `terraform version` to show the version.
If you are using Terraform Cloud or Terraform Enterprise, see the Terraform version being used by a
workspace in the workspace's Overview tab.
If you are using a remote workspace in HCP Terraform or Terraform Enterprise, see the Terraform version
being used by the workspace in the workspace's Overview tab.
Paste the result between the ``` marks below.
-->
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]
about: For issues and feature requests concerning the HCP Terraform and Terraform Enterprise platform itself, please submit a HashiCorp support request or email [email protected]
- 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
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
[email protected]. For general usage questions, please post to our community forum:
https://discuss.hashicorp.com.
-->
Expand Down
18 changes: 9 additions & 9 deletions .github/actions/test-provider-tfe/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/create-release-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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)

Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<img alt="Terraform" src="https://www.datocms-assets.com/2885/1629941242-logo-terraform-main.svg" width="600px">

# 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
Expand Down Expand Up @@ -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" {
Expand Down
6 changes: 3 additions & 3 deletions docs/backwards-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.
```


Expand All @@ -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`.
```
2 changes: 1 addition & 1 deletion docs/beta.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/test-infrastructure.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
12 changes: 6 additions & 6 deletions docs/testing.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -31,25 +31,25 @@ 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.
5. `GITHUB_POLICY_SET_PATH`: A GitHub subdirectory for the repository specified by `GITHUB_POLICY_SET_IDENTIFIER`. Required for running policy set tests.
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).
Expand Down
Loading

0 comments on commit fc605eb

Please sign in to comment.