Skip to content

Commit

Permalink
Merge pull request #35033 from hashicorp/RK/fix-links
Browse files Browse the repository at this point in the history
docs: Fix links and headers
  • Loading branch information
ritsok authored Apr 22, 2024
2 parents 5868f99 + a344e83 commit d1f9d3b
Show file tree
Hide file tree
Showing 62 changed files with 264 additions and 265 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Terraform providers are not maintained in this repository; you can find relevant
repository and relevant issue tracker for each provider within the
[Terraform Registry index](https://registry.terraform.io/browse/providers).

This repository also does not include the source code for some other parts of the Terraform product including Terraform Cloud, Terraform Enterprise, and the Terraform Registry. The source for those components is not publicly available. If you have feedback about these products, including bug reports, please email [[email protected]](mailto:[email protected]) or [open a support request](https://support.hashicorp.com/hc/en-us/requests/new).
This repository also does not include the source code for some other parts of the Terraform product including HCP Terraform, Terraform Enterprise, and the Terraform Registry. The source for those components is not publicly available. If you have feedback about these products, including bug reports, please email [[email protected]](mailto:[email protected]) or [open a support request](https://support.hashicorp.com/hc/en-us/requests/new).

---

Expand Down Expand Up @@ -200,7 +200,7 @@ go test ./internal/addrs

Terraform's unit test suite is self-contained, using mocks and local files to help ensure that it can run offline and is unlikely to be broken by changes to outside systems.

However, several Terraform components interact with external services, such as the automatic provider installation mechanism, the Terraform Registry, Terraform Cloud, etc.
However, several Terraform components interact with external services, such as the automatic provider installation mechanism, the Terraform Registry, HCP Terraform, etc.

There are some optional tests in the Terraform CLI codebase that *do* interact with external services, which we collectively refer to as "acceptance tests". You can enable these by setting the environment variable `TF_ACC=1` when running the tests. We recommend focusing only on the specific package you are working on when enabling acceptance tests, both because it can help the test run to complete faster and because you are less likely to encounter failures due to drift in systems unrelated to your current goal:

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ body:
For general usage questions, please see: https://www.terraform.io/community.html.
## If your issue relates to:
* **Terraform Cloud/Enterprise**: please email [email protected] or [open a new request](https://support.hashicorp.com/hc/en-us/requests/new).
* **HCP Terraform or Terraform Enterprise**: please email [email protected] or [open a new request](https://support.hashicorp.com/hc/en-us/requests/new).
* **AWS Terraform Provider**: Open an issue at [hashicorp/terraform-provider-aws](https://github.com/hashicorp/terraform-provider-aws/issues/new/choose).
* **Azure Terraform Provider**: Open an issue at [hashicorp/terraform-provider-azurerm](https://github.com/hashicorp/terraform-provider-azurerm/issues/new/choose).
* **Other Terraform Providers**: Please open an issue in the provider's own repository, which can be found by searching the [Terraform Registry](https://registry.terraform.io/browse/providers).
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 and Terraform Enterprise Troubleshooting and Feature Requests
url: https://support.hashicorp.com/hc/en-us/requests/new
about: For issues and feature requests related to the Terraform Cloud/Enterprise platform, please submit a HashiCorp support request or email [email protected]
about: For issues and feature requests related to HCP Terraform and Terraform Enterprise, please submit a HashiCorp support request or email [email protected]
- name: AWS Terraform Provider Feedback and Questions
url: https://github.com/hashicorp/terraform-provider-aws
about: The AWS Terraform Provider has its own repository, any provider related issues or questions should be directed there.
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ body:
For general usage questions, please see: https://www.terraform.io/community.html.
## If your feature request relates to:
* **Terraform Cloud/Enterprise**: please email [email protected] or [open a new request](https://support.hashicorp.com/hc/en-us/requests/new).
* **HCP Terraform or Terraform Enterprise**: please email [email protected] or [open a new request](https://support.hashicorp.com/hc/en-us/requests/new).
* **AWS Terraform Provider**: Open an issue at [hashicorp/terraform-provider-aws](https://github.com/hashicorp/terraform-provider-aws/issues/new/choose).
* **Azure Terraform Provider**: Open an issue at [hashicorp/terraform-provider-azurerm](https://github.com/hashicorp/terraform-provider-azurerm/issues/new/choose).
* **Other Terraform Providers**: Please open an issue in the provider's own repository, which can be found by searching the [Terraform Registry](https://registry.terraform.io/browse/providers).
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ constructed, and then the backend is responsible for executing that action.
Backends that execute operations, however, do so as an architectural implementation detail and not a
general feature of backends. That is, the term 'backend' as a Terraform feature is used to refer to
a plugin that determines where Terraform stores its state snapshots - only the default `local`
backend and Terraform Cloud's backends (`remote`, `cloud`) perform operations.
backend and HCP Terraform's backends (`remote`, `cloud`) perform operations.

Thus, most backends do _not_ implement this interface, and so the `command` package wraps these
backends in an instance of
Expand Down
4 changes: 2 additions & 2 deletions docs/dependency-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,8 @@ special constraints due to how Terraform uses them:
prevent adoption of changes made to pre-existing functionality that
Terraform already exposes.

* `github.com/hashicorp/go-tfe` -- the client library for the Terraform Cloud
API -- includes various types corresponding to Terraform Cloud API
* `github.com/hashicorp/go-tfe` -- the client library for the HCP Terraform
API -- includes various types corresponding to HCP Terraform API
requests and responses. The internal package `internal/cloud` contains mock
implementations of some of those types, which may need to be updated when
the client library is upgraded.
Expand Down
4 changes: 2 additions & 2 deletions internal/cloud/e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Required flags
external network calls. This is needed to run these tests. Without it, the
tests do not run.
* `TFE_TOKEN=<admin token>` and `TFE_HOSTNAME=<hostname>`. The helpers
for these tests require admin access to a TFC/TFE instance.
for these tests require admin access to an HCP Terraform or Terraform Enterprise instance.
* `-timeout=30m`. Some of these tests take longer than the default 10m timeout for `go test`.

### Flags
Expand All @@ -19,6 +19,6 @@ for these tests require admin access to a TFC/TFE instance.
* Use the `-tfoutput` flag to print the terraform output to standard out.
* Use `-ldflags` to change the version Prerelease to match a version
available remotely. Some behaviors rely on the exact local version Terraform
being available in TFC/TFE, and manipulating the Prerelease during build is
being available in HCP Terraform or Terraform Enterprise, and manipulating the Prerelease during build is
often the only way to ensure this.
[(More on `-ldflags`.)](https://www.digitalocean.com/community/tutorials/using-ldflags-to-set-version-information-for-go-applications)
4 changes: 2 additions & 2 deletions tools/terraform-bundle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ to this need:
current Terraform configuration, serving a similar (though not identical)
purpose than `terraform-bundle` had served.

For those using Terraform CLI alone, without Terraform Cloud, we recommend
For those using Terraform CLI alone, without HCP Terraform, we recommend
planning to transition to the above features instead of using
`terraform-bundle`.

Expand Down Expand Up @@ -53,7 +53,7 @@ Terraform v0.13's introduction of automatic third-party provider installation.
## Terraform Enterprise Users

If you use Terraform Enterprise, the self-hosted distribution of
Terraform Cloud, you can use `terraform-bundle` as described above to build
HCP Terraform, you can use `terraform-bundle` as described above to build
custom Terraform packages with bundled provider plugins.

For more information, see
Expand Down
4 changes: 2 additions & 2 deletions website/data/cli-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,10 @@
]
},
{
"title": "Using Terraform Cloud",
"title": "Using HCP Terraform",
"routes": [
{ "title": "Overview", "path": "cloud" },
{ "title": "Terraform Cloud Settings", "path": "cloud/settings" },
{ "title": "HCP Terraform Settings", "path": "cloud/settings" },
{
"title": "Initializing and Migrating",
"path": "cloud/migrating"
Expand Down
2 changes: 1 addition & 1 deletion website/data/language-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -933,7 +933,7 @@
"title": "Terraform Settings",
"routes": [
{ "title": "Overview", "path": "settings" },
{ "title": "Terraform Cloud", "path": "settings/terraform-cloud" },
{ "title": "HCP Terraform", "path": "settings/cloud" },
{
"title": "Backends",
"routes": [
Expand Down
18 changes: 9 additions & 9 deletions website/docs/cli/auth/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,28 @@
page_title: Authentication - Terraform CLI
description: >-
Documentation about the login and logout commands that help automate getting
an API token for your Terraform Cloud account.
an API token for your HCP Terraform account.
---

# CLI Authentication

> **Hands-on:** Try the [Authenticate the CLI with Terraform Cloud](/terraform/tutorials/cloud/cloud-login?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial.
> **Hands-on:** Try the [Authenticate the CLI with HCP Terraform](/terraform/tutorials/cloud/cloud-login?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial.
[Terraform Cloud](https://cloud.hashicorp.com/products/terraform) and
[HCP Terraform](https://cloud.hashicorp.com/products/terraform) and
[Terraform Enterprise](/terraform/enterprise) are platforms that perform
Terraform runs to provision infrastructure, offering a collaboration-focused
environment that makes it easier for teams to use Terraform together. (For
expediency, the content below refers to both products as "Terraform Cloud.")
expediency, the content below refers to both products as "HCP Terraform.")

Terraform CLI integrates with Terraform Cloud in several ways — it can be a
front-end for [CLI-driven runs](/terraform/cloud-docs/run/cli) in Terraform Cloud,
and can also use Terraform Cloud as a state backend and a private module
Terraform CLI integrates with HCP Terraform in several ways — it can be a
front-end for [CLI-driven runs](/terraform/cloud-docs/run/cli) in HCP Terraform,
and can also use HCP Terraform as a state backend and a private module
registry. All of these integrations require you to authenticate Terraform CLI
with your Terraform Cloud account.
with your HCP Terraform account.

The best way to handle CLI authentication is with the `login` and `logout`
commands, which help automate the process of getting an API token for your
Terraform Cloud user account.
HCP Terraform user account.

For details, see:

Expand Down
2 changes: 1 addition & 1 deletion website/docs/cli/cloud/command-line-arguments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ accept the following option to modify that behavior:
remote execution environment cannot decode.

We recommend against using this option unless absolutely necessary. Overriding this check can result
in a Terraform Cloud workspace that is no longer able to complete remote operations with the currently
in an HCP Terraform workspace that is no longer able to complete remote operations with the currently
selected version of Terraform.
22 changes: 11 additions & 11 deletions website/docs/cli/cloud/index.mdx
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
page_title: Using Terraform Cloud - Terraform CLI
page_title: Using HCP Terraform - Terraform CLI
description: >-
Learn how to use Terraform Cloud and Terraform Enterprise on the command line with the Terraform CLI.
Learn how to use HCP Terraform and Terraform Enterprise on the command line with the Terraform CLI.
---

# Using Terraform Cloud with Terraform CLI
# Using HCP Terraform with Terraform CLI

The Terraform CLI integration with Terraform Cloud lets you use Terraform Cloud and Terraform Enterprise on the command line. In the documentation Terraform Cloud instructions also apply to Terraform Enterprise, except where explicitly stated.
The Terraform CLI integration with HCP Terraform lets you use HCP Terraform and Terraform Enterprise on the command line. In the documentation HCP Terraform instructions also apply to Terraform Enterprise, except where explicitly stated.

Using Terraform Cloud through the command line is called the [CLI-driven run workflow](/terraform/cloud-docs/run/cli). When you use the CLI workflow, operations like `terraform plan` or `terraform apply` are remotely executed in Terraform Cloud's run environment by default, with log output streaming to the local terminal. This lets you use Terraform Cloud features within the familiar Terraform CLI workflow, including variables encrypted at rest in a Terraform Cloud workspace, cost estimates, and policy checking.
Using HCP Terraform through the command line is called the [CLI-driven run workflow](/terraform/cloud-docs/run/cli). When you use the CLI workflow, operations like `terraform plan` or `terraform apply` are remotely executed in HCP Terraform's run environment by default, with log output streaming to the local terminal. This lets you use HCP Terraform features within the familiar Terraform CLI workflow, including variables encrypted at rest in an HCP Terraform workspace, cost estimates, and policy checking.

> **Hands On:** Try the [Migrate State to Terraform Cloud](/terraform/tutorials/cloud/cloud-migrate) tutorial.
> **Hands On:** Try the [Migrate State to HCP Terraform](/terraform/tutorials/cloud/cloud-migrate) tutorial.
Workspaces can also be configured for local execution, in which case Terraform Cloud only stores state. In this mode, Terraform Cloud behaves just like a standard state backend.
Workspaces can also be configured for local execution, in which case HCP Terraform only stores state. In this mode, HCP Terraform behaves just like a standard state backend.

-> **Note:** The CLI integration is available in Terraform 1.1.0 and later, and Terraform Enterprise 202201-1 and later. Previous versions can use the [`remote` backend](/terraform/language/settings/backends/remote). Refer to [Migrating from the remote
backend](/terraform/cli/cloud/migrating) for details about switching to the CLI integration.

## Documentation Summary

- [Terraform Cloud Settings](/terraform/cli/cloud/settings) documents the `cloud` block that you must add to your configuration to enable Terraform Cloud support.
- [HCP Terraform Settings](/terraform/cli/cloud/settings) documents the `cloud` block that you must add to your configuration to enable HCP Terraform support.
- [Initializing and Migrating](/terraform/cli/cloud/migrating) describes
how to start using Terraform Cloud with a working directory that already has state data.
- [Command Line Arguments](/terraform/cli/cloud/command-line-arguments) lists the Terraform command flags that are specific to using Terraform with Terraform Cloud.
how to start using HCP Terraform with a working directory that already has state data.
- [Command Line Arguments](/terraform/cli/cloud/command-line-arguments) lists the Terraform command flags that are specific to using Terraform with HCP Terraform.

Refer to the [CLI-driven Run Workflow](/terraform/cloud-docs/run/cli) for more details about how to use Terraform Cloud from the command line.
Refer to the [CLI-driven Run Workflow](/terraform/cloud-docs/run/cli) for more details about how to use HCP Terraform from the command line.
Loading

0 comments on commit d1f9d3b

Please sign in to comment.