Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix headers and links #97

Merged
merged 4 commits into from
May 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
_If items do not apply to your changes, add (N/A) and mark them as complete._

#### Pull Request
- [ ] One or more labels describe the type of change (e.g. clarification) and associated product (e.g. tfc).
- [ ] One or more labels describe the type of change (e.g. clarification) and associated product (e.g. HCP Terraform).
- [ ] Description links to related pull requests or issues, if any.

#### Content
Expand Down
2 changes: 1 addition & 1 deletion website/data/cloud-docs-agents-nav-data.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[
{
"heading": "Terraform Cloud Agents"
"heading": "HCP Terraform Agents"
},
{ "title": "Overview", "path": "" },
{ "title": "Requirements", "path": "requirements" },
Expand Down
22 changes: 11 additions & 11 deletions website/docs/cloud-docs/agents/agent-pools.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
page_title: Terraform Cloud Agents - Managing Agent Pools - Terraform Cloud and Terraform Enterprise
page_title: HCP Terraform Agents - Managing Agent Pools - HCP Terraform and Terraform Enterprise
description: >-
Agent pools are groups of one or more agents in Terraform Cloud. Create agent pools and assign them to one or more workspaces.
Agent pools are groups of one or more agents in HCP Terraform. Create agent pools and assign them to one or more workspaces.
---

# Manage Agent Pools

Terraform Cloud organizes agents into pools. Each workspace can specify which agent pool should run its workloads.
HCP Terraform organizes agents into pools. Each workspace can specify which agent pool should run its workloads.

## Permissions

Expand All @@ -15,7 +15,7 @@ Managing agent pools requires the following permissions:
- You must be a member of the **Owners** team within your organization to manage an organization's agents.
- You must have **Admin** access to a workspace before you can change its [execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode) to use an agent pool.

Refer to [Permissions](/terraform/cloud-docs/users-teams-organizations/permissions) in the Terraform Cloud documentation for details.
Refer to [Permissions](/terraform/cloud-docs/users-teams-organizations/permissions) in the HCP Terraform documentation for details.

[permissions-citation]: #intentionally-unused---keep-for-maintainers

Expand All @@ -25,11 +25,11 @@ To create an agent pool:

1. Go to your organization's settings, click **Agents**, and then click **Create agent pool**.

1. Enter an **Agent Pool Name**, and then click **Continue**. Terraform Cloud uses this name to distinguish agent pools in a workspace's settings.
1. Enter an **Agent Pool Name**, and then click **Continue**. HCP Terraform uses this name to distinguish agent pools in a workspace's settings.

1. Enter a token **Description**, and then click **Create Token**.

1. Save your token information in a secure location. You need the token to connect an agent to this Terraform Cloud agent pool, and Terraform Cloud does not display the token again after this step.
1. Save your token information in a secure location. You need the token to connect an agent to this HCP Terraform agent pool, and HCP Terraform does not display the token again after this step.

1. Click **Finish**.

Expand Down Expand Up @@ -76,7 +76,7 @@ To configure the workspace to execute runs using an agent:
1. Select **Agent** as the [execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode), and select the agent pool this workspace should use.
1. Click **Save Settings**.

The workspace begins using the agent for Terraform runs. Runs involving an agent include information about that agent in the run details. Terraform Cloud may use different agents for the plan and apply operations, depending on agent availability within the pool.
The workspace begins using the agent for Terraform runs. Runs involving an agent include information about that agent in the run details. HCP Terraform may use different agents for the plan and apply operations, depending on agent availability within the pool.


## Revoke an Agent Token
Expand Down Expand Up @@ -113,18 +113,18 @@ To view agent statuses, go to your organization's settings and click **Agents**.
- **Idle**: The agent is running normally and waiting for jobs to be available.
- **Busy**: The agent is running normally and currently executing a job.
- **Unknown**: The agent has not reported any status for an unexpected period of time. The agent may yet recover if the agent's situation is temporary, such as a short-lived network partition.
- **Errored**: The agent encountered an unrecoverable error or has been in an Unknown state for long enough that Terraform Cloud considers it errored. This status may indicate that something interrupted the agent process, the process crashed, a permanent network partition exists, or another similar problem. If the agent was in the process of running an operation (such as a plan or apply), the agent marks that operation as errored. If the current agent process recovers, it exits immediately.
- **Errored**: The agent encountered an unrecoverable error or has been in an Unknown state for long enough that HCP Terraform considers it errored. This status may indicate that something interrupted the agent process, the process crashed, a permanent network partition exists, or another similar problem. If the agent was in the process of running an operation (such as a plan or apply), the agent marks that operation as errored. If the current agent process recovers, it exits immediately.
- **Exited**: The agent exited normally and successfully informed Terraform of it doing so.

## Agent Capacity Usage

Refer to [Terraform Cloud pricing](https://www.hashicorp.com/products/terraform/pricing) for more information about Terraform Cloud Agents.
Refer to [HCP Terraform pricing](https://www.hashicorp.com/products/terraform/pricing) for more information about HCP Terraform Agents.

Agents count towards the organization's purchased agent capacity if they are in the **Idle**, **Busy**, or **Unknown** state. Agents that are in the **Errored** or **Exited** state do not count towards the organization's total agent capacity.

Agents in the **Unknown** state continue to count against the organization's total agent allowance, as this status is typically an indicator of a temporary communication issue between the agent and Terraform Cloud. **Unknown** agents that do not respond after a period of 5 minutes automatically transition to an **Errored** state, at which point they do not count against the agent allowance.
Agents in the **Unknown** state continue to count against the organization's total agent allowance, as this status is typically an indicator of a temporary communication issue between the agent and HCP Terraform. **Unknown** agents that do not respond after a period of 5 minutes automatically transition to an **Errored** state, at which point they do not count against the agent allowance.

Agents may have an **Unknown** status if they terminate without gracefully exiting. Agents should always be shut down according to the [Stop the Agent](/terraform/cloud-docs/agents/agents#stop-the-agent) section to allow them to deregister from Terraform Cloud. To minimize **Unknown** agent statuses, we strongly recommend configuring any process supervisor, application scheduler, or other runtime manager to follow this procedure.
Agents may have an **Unknown** status if they terminate without gracefully exiting. Agents should always be shut down according to the [Stop the Agent](/terraform/cloud-docs/agents/agents#stop-the-agent) section to allow them to deregister from HCP Terraform. To minimize **Unknown** agent statuses, we strongly recommend configuring any process supervisor, application scheduler, or other runtime manager to follow this procedure.

You can deregister agents that are **Unknown**, **Errored**, or **Exited** through either the **Organization Settings > Agents** page or through the [Agent API](/terraform/cloud-docs/api-docs/agents#delete-an-agent). Deregistered agents no longer appear in the settings page or count against the organization's agent allowance.

14 changes: 7 additions & 7 deletions website/docs/cloud-docs/agents/hooks.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
page_title: Hooks - Terraform Cloud Agents - Terraform Cloud and Terraform Enterprise
page_title: Hooks - HCP Terraform Agents - HCP Terraform and Terraform Enterprise
description: >-
Terraform Cloud Agent hooks are custom programs that run at strategic points
HCP Terraform Agent hooks are custom programs that run at strategic points
during Terraform runs.
---

# Hooks

Terraform Cloud Agents support running custom programs, or hooks, during
HCP Terraform Agents support running custom programs, or _hooks_, during
strategic points of a Terraform run. These hooks allow you to extend the
functionality of Terraform runs. For example, you may create a hook to
dynamically download software required by the Terraform run or send an HTTP
request to a system to kick off an external workflow.

## Supported Hooks

Terraform Cloud Agents support the following hooks:
HCP Terraform Agents support the following hooks:

- `pre-plan` - Runs before `terraform init` during a `plan` operation.

Expand All @@ -34,7 +34,7 @@ Please note the following behavior when using hooks:
- If a hook exits with a non-zero exit code, the Terraform run will fail
immediately.
- The standard output and standard error from the hook will be printed
alongside the Terraform run output in the Terraform Cloud/Enterprise user
alongside the Terraform run output in the HCP Terraform or Terraform Enterprise user
interface.
- The hook name must match one of the [supported hooks](#supported-hooks). You
cannot customize or change these names. Because of this, there can only be
Expand Down Expand Up @@ -120,7 +120,7 @@ example creates a `pre-plan` hook that prints a message when it runs.

1. The agent will now trigger configured hooks at the appropriate points
during Terraform runs. The standard output and standard error from the hook
will be printed alongside the Terraform run in the Terraform Cloud/Enterprise
will be printed alongside the Terraform run in the HCP Terraform or Terraform Enterprise
user interface.

```
Expand Down Expand Up @@ -188,7 +188,7 @@ example creates a `pre-plan` hook that prints a message when it runs.

1. The agent will now trigger configured hooks at the appropriate points
during Terraform runs. The standard output and standard error from the hook
will be printed alongside the Terraform run in the Terraform Cloud/Enterprise
will be printed alongside the Terraform run in the HCP Terraform or Terraform Enterprise
user interface.

```
Expand Down
16 changes: 8 additions & 8 deletions website/docs/cloud-docs/agents/index.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
page_title: Terraform Cloud Agents - Terraform Cloud and Terraform Enterprise
page_title: HCP Terraform Agents - HCP Terraform and Terraform Enterprise
description: >-
Cloud agents let Terraform manage isolated, private, or on-premises
infrastructure. Learn to install, configure, and manage cloud agents.
---

# Terraform Cloud Agents
# HCP Terraform Agents

> **Hands-on:** Try the [Manage Private Environments with Terraform Cloud Agents](/terraform/tutorials/cloud/cloud-agents) tutorial.
> **Hands-on:** Try the [Manage Private Environments with HCP Terraform Agents](/terraform/tutorials/cloud/cloud-agents) tutorial.

-> **Note:** Refer to [Terraform Cloud pricing](https://www.hashicorp.com/products/terraform/pricing) for more information about Terraform Cloud Agents.
-> **Note:** Refer to [HCP Terraform pricing](https://www.hashicorp.com/products/terraform/pricing) for more information about HCP Terraform Agents.

Terraform Cloud Agents allow Terraform Cloud to communicate with isolated, private, or on-premises infrastructure. By deploying lightweight agents within a specific network segment, you can establish a simple connection between your environment and Terraform Cloud which allows for provisioning operations and management. This is useful for on-premises infrastructure types such as vSphere, Nutanix, OpenStack, enterprise networking providers, and anything you might have in a protected enclave.
HCP Terraform Agents allow HCP Terraform to communicate with isolated, private, or on-premises infrastructure. By deploying lightweight agents within a specific network segment, you can establish a simple connection between your environment and HCP Terraform which allows for provisioning operations and management. This is useful for on-premises infrastructure types such as vSphere, Nutanix, OpenStack, enterprise networking providers, and anything you might have in a protected enclave.

The agent only requires outbound connectivity to Terraform Cloud, enabling private networks to remain secure and typically requiring no special networking configuration or exceptions.
The agent only requires outbound connectivity to HCP Terraform, enabling private networks to remain secure and typically requiring no special networking configuration or exceptions.

## Terraform Enterprise

Terraform Enterprise supports Terraform Cloud Agents. Refer to
[Terraform Cloud Agents on TFE](/terraform/enterprise/application-administration/agents-on-tfe) for Terraform Enterprise specific documentation and requirements.
Terraform Enterprise supports HCP Terraform Agents. Refer to
[HCP Terraform Agents on Terraform Enterprise](/terraform/enterprise/application-administration/agents-on-tfe) for Terraform Enterprise specific documentation and requirements.
18 changes: 9 additions & 9 deletions website/docs/cloud-docs/agents/logging.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
page_title: Logging - Terraform Cloud Agents - Terraform Cloud and Terraform Enterprise
page_title: Logging - HCP Terraform Agents - HCP Terraform and Terraform Enterprise
description: >-
Monitor agent log output and flash messages from HashiCorp that communicate important changes.
---

# Logging

Terraform Cloud Agents log helpful messages that tell operators about
agent behavior, including communication with Terraform Cloud APIs, specific
HCP Terraform Agents log helpful messages that tell operators about
agent behavior, including communication with HCP Terraform APIs, specific
commands run, actions taken, and runtime management.

## Log output

Terraform Cloud Agents write log messages directly to stdout/stderr. This
HCP Terraform Agents write log messages directly to stdout/stderr. This
lets the operator capture the logs in a variety of
different logging systems, gives CLI users a way
to see a log of the agent's behavior directly in their terminal. By default,
Expand All @@ -28,7 +28,7 @@ levels. There are 5 levels supported by the agent:
* `error` contains only critical error messages. The agent process is otherwise
silent.
* `warn` contains all error-level messages, as well as informational messages
such as system messages directly from the Terraform Cloud platform.
such as system messages directly from the HCP Terraform platform.
* `info` contains all warn-level messages and high-level information about the
agent and the workflows it is executing. In normal circumstances, this is
the safest and most helpful log level for day to day operation.
Expand All @@ -39,8 +39,8 @@ levels. There are 5 levels supported by the agent:

## Data format

By default, Terraform Cloud Agents emit log lines in a human-friendly text
format. This is convenient for running the TFC Agent locally and streaming the
By default, HCP Terraform Agents emit log lines in a human-readable text
format. This is convenient for running the HCP Terraform Agent locally and streaming the
logs directly to a terminal, or for use in log systems where raw logs are
consumed directly by operators. The default text format looks something like
the following:
Expand All @@ -49,7 +49,7 @@ the following:
2023-04-14T17:12:43.002Z [INFO] core: Job received: job_type=plan job_id=run-xxx
```

It is also possible to configure the Terraform Cloud Agent to produce JSON-
It is also possible to configure the HCP Terraform Agent to produce JSON-
formatted logs. This format will cause each log line to be serialized as an
individual JSON object, and is more ideal for logging systems which are capable
of parsing and performing post-processing on log data for each line. JSON
Expand Down Expand Up @@ -81,4 +81,4 @@ Flash Messages are a type of log that HashiCorp may send to agents from time to

Flash Messages are version specific, and may only apply to the specific version of the agent you are running.

Adding monitoring and alerting for these `notice` messages may help you operate Terraform Cloud Agents more easily.
Adding monitoring and alerting for these `notice` messages may help you operate HCP Terraform Agents more easily.
Loading
Loading