From 6f996bb7c2d0375c2bb3bb24f1b7590aa2bd571e Mon Sep 17 00:00:00 2001 From: Rose Date: Tue, 16 Apr 2024 16:27:17 -0700 Subject: [PATCH 1/4] Fix headers --- .github/pull_request_template.md | 2 +- website/data/cloud-docs-agents-nav-data.json | 2 +- .../docs/cloud-docs/agents/agent-pools.mdx | 22 +++++++-------- website/docs/cloud-docs/agents/agents.mdx | 24 ++++++++-------- website/docs/cloud-docs/agents/changelog.mdx | 8 +++--- website/docs/cloud-docs/agents/hooks.mdx | 14 +++++----- website/docs/cloud-docs/agents/index.mdx | 16 +++++------ website/docs/cloud-docs/agents/logging.mdx | 18 ++++++------ website/docs/cloud-docs/agents/metrics.mdx | 26 ++++++++--------- .../cloud-docs/agents/request-forwarding.mdx | 28 +++++++++---------- .../docs/cloud-docs/agents/requirements.mdx | 14 +++++----- website/docs/cloud-docs/agents/telemetry.mdx | 22 +++++++-------- website/docs/cloud-docs/agents/tracing.mdx | 4 +-- 13 files changed, 100 insertions(+), 100 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 10e2f57..952955b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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 diff --git a/website/data/cloud-docs-agents-nav-data.json b/website/data/cloud-docs-agents-nav-data.json index 2ff46f4..6e6a3d5 100644 --- a/website/data/cloud-docs-agents-nav-data.json +++ b/website/data/cloud-docs-agents-nav-data.json @@ -1,6 +1,6 @@ [ { - "heading": "Terraform Cloud Agents" + "heading": "HCP Terraform Agents" }, { "title": "Overview", "path": "" }, { "title": "Requirements", "path": "requirements" }, diff --git a/website/docs/cloud-docs/agents/agent-pools.mdx b/website/docs/cloud-docs/agents/agent-pools.mdx index 461b96e..6067ab6 100644 --- a/website/docs/cloud-docs/agents/agent-pools.mdx +++ b/website/docs/cloud-docs/agents/agent-pools.mdx @@ -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 @@ -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 @@ -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**. @@ -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 @@ -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. diff --git a/website/docs/cloud-docs/agents/agents.mdx b/website/docs/cloud-docs/agents/agents.mdx index 8ffd7a5..321d01e 100644 --- a/website/docs/cloud-docs/agents/agents.mdx +++ b/website/docs/cloud-docs/agents/agents.mdx @@ -1,12 +1,12 @@ --- -page_title: Terraform Cloud Agents - Install and Run Agents - Terraform Cloud and Terraform Enterprise +page_title: HCP Terraform Agents - Install and Run Agents - HCP Terraform and Terraform Enterprise description: >- Install, configure, and run agents on your own infrastructure. --- # Install and Run Agents -The agent software runs on your own infrastructure. The token you provide when starting the agent assigns it to a Terraform Cloud [agent pool](/terraform/cloud-docs/agents/agent-pools). +The agent software runs on your own infrastructure. The token you provide when starting the agent assigns it to an HCP Terraform [agent pool](/terraform/cloud-docs/agents/agent-pools). ## Operational Considerations @@ -14,13 +14,13 @@ Agents do not guarantee a clean working environment per Terraform execution. Eac ### Run Multiple Agents -You may choose to run multiple agents within your network, up to the organization's purchased agent limit. If there are multiple agents available within an organization, Terraform Cloud selects the first available agent within the target pool. +You may choose to run multiple agents within your network, up to the organization's purchased agent limit. If there are multiple agents available within an organization, HCP Terraform selects the first available agent within the target pool. Each agent process runs a single Terraform run at a time. Multiple agent processes can be concurrently run on a single instance, license limit permitting. ### Resilience -The agent distributes as a standalone binary that runs on any supported system. By default, the agent runs in the foreground as a long-running process that continuously polls for workloads from Terraform Cloud. An agent process may terminate unexpectedly due to stopping the process forcefully, power cycling the host machine, and other methods. We strongly recommend pairing the agent with a process supervisor to ensure that it automatically restarts in case of an error. +The agent distributes as a standalone binary that runs on any supported system. By default, the agent runs in the foreground as a long-running process that continuously polls for workloads from HCP Terraform. An agent process may terminate unexpectedly due to stopping the process forcefully, power cycling the host machine, and other methods. We strongly recommend pairing the agent with a process supervisor to ensure that it automatically restarts in case of an error. ## Download and Install the Agent @@ -42,9 +42,9 @@ To customize this update behavior, pass the flag `-auto-update` or set the envir ## Start the Agent -To start the agent and connect it to a Terraform Cloud agent pool: +To start the agent and connect it to an HCP Terraform agent pool: -1. Retrieve the [token](/terraform/cloud-docs/agents/agent-pools#create-an-agent-pool) from the Terraform Cloud agent pool you want to use. +1. Retrieve the [token](/terraform/cloud-docs/agents/agent-pools#create-an-agent-pool) from the HCP Terraform agent pool you want to use. 1. Set the `TFC_AGENT_TOKEN` environment variable. 1. (Optional) Set the `TFC_AGENT_NAME` environment variable. This name is for your reference only. The agent ID appears in logs and API requests. @@ -53,7 +53,7 @@ export TFC_AGENT_TOKEN=your-token export TFC_AGENT_NAME=your-agent-name ./tfc-agent ``` -Once complete, your agent and its status appear on the **Agents** page in the Terraform Cloud UI. Workspaces can now use this agent pool for runs. Refer to [Configure Workspaces to Use the Agent](/terraform/cloud-docs/agents/agent-pools#configure-workspaces-to-use-the-agent) for details. +Once complete, your agent and its status appear on the **Agents** page in the HCP Terraform UI. Workspaces can now use this agent pool for runs. Refer to [Configure Workspaces to Use the Agent](/terraform/cloud-docs/agents/agent-pools#configure-workspaces-to-use-the-agent) for details. ### Optional Configuration: Run an Agent Using Docker @@ -91,7 +91,7 @@ To use single-execution mode, start the agent with the `-single` command line ar ### Optional Configuration: Request Forwarding -You can configure the agent to accept forwarded requests from Terraform Cloud. Request forwarding enables Terraform Cloud to securely access private infrastructure resources, such as private VCS systems. See [Request Forwarding](/terraform/cloud-docs/agents/request-forwarding) for more details. By default, request forwarding is disabled. To enable it, start the agent with the `-request-forwarding` command line argument. +You can configure the agent to accept forwarded requests from HCP Terraform. Request forwarding enables HCP Terraform to securely access private infrastructure resources, such as private VCS systems. See [Request Forwarding](/terraform/cloud-docs/agents/request-forwarding) for more details. By default, request forwarding is disabled. To enable it, start the agent with the `-request-forwarding` command line argument. Agents handle forwarded requests separately from other workloads and may process requests in parallel to plans, applies, policy checks, etc. You can modify this behavior by enabling or disabling certain workload types via the `-accept` parameter, and selectively setting the `-request-forwarding` flag on certain agent(s) only. For example, you may have a pool of 4 agents, where two are configured to handle only plans and applies, and the other two are configured to handle only request forwarding. @@ -99,7 +99,7 @@ Agents handle forwarded requests separately from other workloads and may process ~> **Important:** We strongly recommend that you only terminate the agent using one of these methods. Abruptly terminating an agent by forcefully stopping the process or power cycling the host does not let the agent deregister and results in an **Unknown** agent status. Abrupt termination may cause further capacity issues. Refer to [capacity issues](/terraform/cloud-docs/agents/agent-pools#agent-capacity-usage) for details. -The agent maintains a registration and a liveness indicator within Terraform Cloud during the entire course of its runtime. When an agent retires, it must deregister itself from Terraform Cloud. The agent deregisters automatically as part of its shutdown procedure in the following scenarios: +The agent maintains a registration and a liveness indicator within HCP Terraform during the entire course of its runtime. When an agent retires, it must deregister itself from HCP Terraform. The agent deregisters automatically as part of its shutdown procedure in the following scenarios: - You enter `Ctrl-C` in an interactive terminal. - The agent process ID receives one of `SIGINT`, `SIGTERM`, or `SIGQUIT`. It is important to send only one signal. The agent interprets a second signal as forceful termination signal exits immediately. @@ -117,7 +117,7 @@ After initiating a graceful shutdown by either of these methods, the terminal us * `-name `: An optional user-specified name for the agent. This name may be used in - the Terraform Cloud user interface to help easily identify the agent. + the HCP Terraform user interface to help easily identify the agent. Default: `The agent's ephemeral ID, assigned during boot.` @@ -190,7 +190,7 @@ After initiating a graceful shutdown by either of these methods, the terminal us * `-address `: - The HTTP or HTTPS address of the Terraform Cloud API. + The HTTP or HTTPS address of the HCP Terraform API. Default: `https://app.terraform.io` @@ -198,7 +198,7 @@ After initiating a graceful shutdown by either of these methods, the terminal us * `-token `: - The agent token to use when making requests to the Terraform Cloud API. + The agent token to use when making requests to the HCP Terraform API. This token must be obtained from the API or UI. It is recommended to use the environment variable whenever possible for configuring this setting due to the sensitive nature of API tokens. diff --git a/website/docs/cloud-docs/agents/changelog.mdx b/website/docs/cloud-docs/agents/changelog.mdx index cd4f035..3d1130b 100644 --- a/website/docs/cloud-docs/agents/changelog.mdx +++ b/website/docs/cloud-docs/agents/changelog.mdx @@ -1,12 +1,12 @@ --- -page_title: Changelog - Terraform Cloud Agents - Terraform Cloud and Terraform Enterprise +page_title: Changelog - HCP Terraform Agents - HCP Terraform and Terraform Enterprise description: >- - Keep track of changes to the Terraform Cloud Agent + Keep track of changes to the HCP Terraform Agent --- -# Terraform Cloud Agent Changelog +# HCP Terraform Agent Changelog -These are the release notes from the Terraform Cloud Agent application. Changes +These are the release notes from the HCP Terraform Agent application. Changes within each release are categorized into one or more of the following labels: * `FEATURES` - Used for net-new features being added to the agent. diff --git a/website/docs/cloud-docs/agents/hooks.mdx b/website/docs/cloud-docs/agents/hooks.mdx index 002970d..0956291 100644 --- a/website/docs/cloud-docs/agents/hooks.mdx +++ b/website/docs/cloud-docs/agents/hooks.mdx @@ -1,13 +1,13 @@ --- -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 @@ -15,7 +15,7 @@ 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. @@ -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 @@ -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. ``` @@ -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. ``` diff --git a/website/docs/cloud-docs/agents/index.mdx b/website/docs/cloud-docs/agents/index.mdx index 36b6548..bc81c51 100644 --- a/website/docs/cloud-docs/agents/index.mdx +++ b/website/docs/cloud-docs/agents/index.mdx @@ -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. diff --git a/website/docs/cloud-docs/agents/logging.mdx b/website/docs/cloud-docs/agents/logging.mdx index 1c75e0b..7065e9b 100644 --- a/website/docs/cloud-docs/agents/logging.mdx +++ b/website/docs/cloud-docs/agents/logging.mdx @@ -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, @@ -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. @@ -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-friendly 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: @@ -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 @@ -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. diff --git a/website/docs/cloud-docs/agents/metrics.mdx b/website/docs/cloud-docs/agents/metrics.mdx index 7558d58..256dce4 100644 --- a/website/docs/cloud-docs/agents/metrics.mdx +++ b/website/docs/cloud-docs/agents/metrics.mdx @@ -1,17 +1,17 @@ --- -page_title: Metrics - Terraform Cloud Agents - Terraform Cloud and Terraform Enterprise +page_title: Metrics - HCP Terraform Agents - HCP Terraform and Terraform Enterprise description: >- - Use metrics to understand the performance of Terraform Cloud Agents. Learn about metric naming conventions, data types, core metrics, runtime metrics, and Terraform and policy component metrics. + Use metrics to understand the performance of HCP Terraform Agents. Learn about metric naming conventions, data types, core metrics, runtime metrics, and Terraform and policy component metrics. --- # Metrics -The Terraform Cloud Agent emits numerous metrics describing the agent's +The HCP Terraform Agent emits numerous metrics describing the agent's performance. ## Metric naming conventions -All metrics emitted by the Terraform Cloud Agent follow some general naming +All metrics emitted by the HCP Terraform Agent follow some general naming conventions which convey useful context about the measurements. * All metrics are prefixed by `tfc-agent.` to distinguish them from any @@ -26,7 +26,7 @@ conventions which convey useful context about the measurements. ## Metric data types -Terraform Cloud agents emit three types of metric data: +HCP Terraform agents emit three types of metric data: * Gauges submit an absolute number value at the end of a measurement period. * Counters accumulate number values during a measurement period. The sum of the @@ -36,7 +36,7 @@ Terraform Cloud agents emit three types of metric data: ## Core metrics -The following metrics are generated by the Terraform Cloud Agent core program, +The following metrics are generated by the HCP Terraform Agent core program, and are related to generic operations performed regularly by all agents. All metrics in this section are prefixed by `tfc-agent.core.`. @@ -44,14 +44,14 @@ metrics in this section are prefixed by `tfc-agent.core.`. | ---------------------------- | ----- | -------------------------------------------------------------------- | | `status.busy` | Gauge | Number of agents in `busy` status. | | `status.idle` | Gauge | Number of agents in `idle` status. | -| `register.milliseconds` | Timer | Time to register the agent with Terraform Cloud. | +| `register.milliseconds` | Timer | Time to register the agent with HCP Terraform. | | `fetch_job.milliseconds` | Timer | Time to complete a job dequeue request. | -| `update_status.milliseconds` | Timer | Time to send a status update over from the agent to Terraform Cloud. | +| `update_status.milliseconds` | Timer | Time to send a status update over from the agent to HCP Terraform. | ## Runtime metrics -The Terraform Cloud Agent produces a number of metrics which are generated by -the application runtime, and are primarily useful in debugging the TFC Agent. +The HCP Terraform Agent produces a number of metrics which are generated by +the application runtime, and are primarily useful in debugging the HCP Terraform Agent. These metrics are emitted periodically throughout the entire agent process lifecycle. It is important to note that these metrics do not represent a complete picture of resource utilization by the agent. The agent may fork child @@ -86,7 +86,7 @@ metrics in this section are prefixed by `tfc-agent.core.terraform.`. | Metric name | Type | Description | | ---------------------------------------------- | ----- | ----------------------------------------------------------------------------------- | | `configure_terraform_cli.milliseconds` | Timer | Time spent configuring the Terraform CLI utility prior to execution. | -| `handle_signal.milliseconds` | Timer | Time spent handling a signal from Terraform Cloud. | +| `handle_signal.milliseconds` | Timer | Time spent handling a signal from HCP Terraform. | | `execute.milliseconds` | Timer | Time spent handling a Terraform operation. | | `output_stream.upload_chunk.bytes` | Gauge | Size of a chunk of Terraform output uploaded. | | `output_stream.upload_chunk.milliseconds` | Timer | Time spent uploading a single chunk of Terraform output. | @@ -94,7 +94,7 @@ metrics in this section are prefixed by `tfc-agent.core.terraform.`. | `output_stream.upload_full.milliseconds` | Timer | Time spent uploading the full Terraform log. | | `output_stream.close.milliseconds` | Timer | Time spent finalizing a Terraform output stream. | | `override_sensitive_variables.milliseconds` | Timer | Time spent generating a configuration file to override variable sensitivity. | -| `override_sensitive_variables.count` | Gauge | Number of variables in a run of which Terraform Cloud modified the sensitivty flag. | +| `override_sensitive_variables.count` | Gauge | Number of variables in a run of which HCP Terraform modified the sensitivty flag. | | `persist_filesystem.milliseconds` | Timer | Time spent packing and uploading a filesystem image. | | `persist_filesystem.pack.bytes` | Gauge | Size of a packed up filesystem image. | | `persist_filesystem.pack.milliseconds` | Timer | Time spent packing the contents of a filesystem. | @@ -112,7 +112,7 @@ metrics in this section are prefixed by `tfc-agent.core.terraform.`. | `run_meta.additions` | Gauge | Number of resources added or proposed to be added in a Terraform operation. | | `run_meta.changes` | Gauge | Number of resources changed or proposed to change in a Terraform operation. | | `run_meta.destructions` | Gauge | Number of resources destroyed or proposed to be destroyed in a Terraform operation. | -| `setup_backend.milliseconds` | Timer | Time spent configuring Terraform CLI for Terraform Cloud. | +| `setup_backend.milliseconds` | Timer | Time spent configuring Terraform CLI for HCP Terraform. | | `setup_ssh_key.milliseconds` | Timer | Time spent configuring an SSH key for Terraform to use while downloading modules. | | `setup_ssh_key.check_git_version.milliseconds` | Timer | Time spent ensuring the local version of "git" is adequate for leveraging SSH auth. | | `setup_terraform_binary.milliseconds` | Timer | Time spent downloading and unpacking a Terraform Community release. | diff --git a/website/docs/cloud-docs/agents/request-forwarding.mdx b/website/docs/cloud-docs/agents/request-forwarding.mdx index c598c0f..3682e55 100644 --- a/website/docs/cloud-docs/agents/request-forwarding.mdx +++ b/website/docs/cloud-docs/agents/request-forwarding.mdx @@ -1,15 +1,15 @@ --- -page_title: Terraform Cloud Agents - Request Forwarding +page_title: HCP Terraform Agents - Request Forwarding description: >- Access private network resources using agents with request forwarding. --- # Request Forwarding -~> **Coming Soon**: We intend to use request forwarding in future Terraform Cloud features. We will update this page when a feature using request forwarding is generally available. +~> **Coming Soon**: We intend to use request forwarding in future HCP Terraform features. We will update this page when a feature using request forwarding is generally available. -You can configure Terraform Cloud Agents to handle HTTP and HTTPS -request forwarding on behalf of Terraform Cloud. This enables Terraform Cloud to access +You can configure HCP Terraform Agents to handle HTTP and HTTPS +request forwarding on behalf of HCP Terraform. This enables HCP Terraform to access services in private networks without requiring direct inbound network access. Only specific features and use cases use agent request forwarding to @@ -20,9 +20,9 @@ fulfill requests. Request forwarding is an additional function that you can enable on a per-agent basis. Agents are deployed into private networks where they have direct access to the target private services, such as private version control systems or other APIs. -Agents register with Terraform Cloud via outbound-only connections. Terraform Cloud +Agents register with HCP Terraform via outbound-only connections. HCP Terraform holds these connections open and uses them to transmit requests and responses -between the target API and Terraform Cloud. +between the target API and HCP Terraform. ![Request forwarding architecture diagram](/img/request-forwarding-arch.png) @@ -30,9 +30,9 @@ between the target API and Terraform Cloud. Request forwarding requires the use of [agent pools](/terraform/cloud-docs/agents/agent-pools). Each agent pool may have multiple agents registered with request forwarding enabled. The agent pool is -then selected by the user in Terraform Cloud as the target for various features +then selected by the user in HCP Terraform as the target for various features which require access to private network resources. This creates the mapping from -Terraform Cloud resources (such as VCS connections) to a pool of agents capable +HCP Terraform resources (such as VCS connections) to a pool of agents capable of accessing the target API. ## Agent Configuration @@ -46,7 +46,7 @@ the agent starts, you will see the following log messages: [INFO] grpc_connector: Connected to broker, awaiting requests ``` -These log messages indicate that the agent has successfully connected to Terraform Cloud +These log messages indicate that the agent has successfully connected to HCP Terraform and is ready to start forwarding requests. ## Requirements and Limitations @@ -58,14 +58,14 @@ for request forwarding. This is in addition to the minimum [system requirements](/terraform/cloud-docs/agents/requirements). Forwarded requests are limited to a 10MB response body. This limit comfortably -supports all Terraform Cloud operations while providing protection against +supports all HCP Terraform operations while providing protection against unbounded responses. All forwarded requests are subject to a request timeout. The default timeout is 60 seconds, but this value is tuned for specific features and use cases and may be set slightly higher or lower depending on the type of request being made. -Agents must be able to connect to Terraform Cloud outbound over the internet, as +Agents must be able to connect to HCP Terraform outbound over the internet, as well as to private infrastructure targets for request forwarding via HTTP and HTTPS. ## Performance and Scaling @@ -86,15 +86,15 @@ Since an agent may handle more than one forwarded request simultaneously, both h ## Egress Proxy Support -If your agents require an egress proxy to reach Terraform Cloud over the internet, you can set the +If your agents require an egress proxy to reach HCP Terraform over the internet, you can set the `HTTPS_PROXY` environment variable with your proxy's address when starting the agent. Your proxy software must support the [HTTP CONNECT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/CONNECT) protocol, -which the agent will use to establish a secure tunnel through the proxy to Terraform Cloud. +which the agent will use to establish a secure tunnel through the proxy to HCP Terraform. ## Security considerations The agent application secures forwarded requests by ensuring that requests may -only be forwarded through the agent which originate from Terraform Cloud. The agent +only be forwarded through the agent which originate from HCP Terraform. The agent guarantees this by requiring an authenticated session to be established prior to forwarding any requests. Because forwarded requests and responses may contain sensitive information, diff --git a/website/docs/cloud-docs/agents/requirements.mdx b/website/docs/cloud-docs/agents/requirements.mdx index 15a185d..2b85d1d 100644 --- a/website/docs/cloud-docs/agents/requirements.mdx +++ b/website/docs/cloud-docs/agents/requirements.mdx @@ -1,17 +1,17 @@ --- -page_title: Terraform Cloud Agents - Requirements - Terraform Cloud and Terraform Enterprise +page_title: HCP Terraform Agents - Requirements - HCP Terraform and Terraform Enterprise description: >- - Supported operating systems, Terraform versions, hardware requirements, and networking requirements for Terraform Cloud Agents. + Supported operating systems, Terraform versions, hardware requirements, and networking requirements for HCP Terraform Agents. --- # Requirements ~> Important: All agents in an agent pool should have the same operating system and hardware resources available. If the agents are using different resources, run performance can vary significantly between each agent in the pool. -Ensure your system meets the following requirements before installing and configuring Terraform Cloud Agents. Refer to [Terraform Cloud Agents on TFE](/terraform/enterprise/admin/agents-on-tfe) for additional Terraform Enterprise requirements. +Ensure your system meets the following requirements before installing and configuring HCP Terraform Agents. Refer to [HCP Terraform Agents on Terraform Enterprise](/terraform/enterprise/admin/agents-on-tfe) for additional Terraform Enterprise requirements. ## Supported Operating Systems -[Agents](https://releases.hashicorp.com/tfc-agent/) currently only support x86_64 bit Linux operating systems. You can also run the agent within Docker using our official [Terraform Cloud Agent Docker container](https://hub.docker.com/r/hashicorp/tfc-agent). +[Agents](https://releases.hashicorp.com/tfc-agent/) currently only support x86_64 bit Linux operating systems. You can also run the agent within Docker using our official [HCP Terraform Agent Docker container](https://hub.docker.com/r/hashicorp/tfc-agent). ## Supported Terraform Versions @@ -28,17 +28,17 @@ Use the following specifications as a reference: - When using agents for private VCS operations, we recommend that the agent has storage capacity equal to at least twice the maximum expected repository size. - At least 2GB of system memory - This provides the agent with enough memory to complete run operations, such as `terraform plan`, `git clone`, and `sentinel apply`. This also supports operations such as uploading and downloading artifacts, constructing temporary execution environments, and parsing configurations. - - If you enable request forwarding, we recommend that you add at least 250MB of additional memory. The agent may hold multiple forwarded requests and responses in memory until they are successfully executed and relayed to Terraform Cloud. + - If you enable request forwarding, we recommend that you add at least 250MB of additional memory. The agent may hold multiple forwarded requests and responses in memory until they are successfully executed and relayed to HCP Terraform. ## Networking Requirements -In order for an agent to function properly, it must be able to make outbound TCP connections to the Terraform Cloud application APIs. These requests may require perimeter networking as well as container host networking changes, depending on your environment. Refer to the [Terraform Cloud IP Ranges documentation](/terraform/cloud-docs/architectural-details/ip-ranges) for more details on the IP ranges. +In order for an agent to function properly, it must be able to make outbound TCP connections to the HCP Terraform application APIs. These requests may require perimeter networking as well as container host networking changes, depending on your environment. Refer to the [HCP Terraform IP Ranges documentation](/terraform/cloud-docs/architectural-details/ip-ranges) for more details on the IP ranges. Additionally, the agent must also be able to communicate with any services required by the Terraform code it is executing. This includes the Terraform releases distribution service, [releases.hashicorp.com](https://releases.hashicorp.com), as well as any provider APIs. The following services run on these IP ranges: | Hostname | Port/Protocol | Directionality | Purpose | | ---------------------- | -------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| app.terraform.io | tcp/443, HTTPS | Outbound | Polling for new workloads, providing status updates, and downloading private modules from Terraform Cloud's Private Module Registry | +| app.terraform.io | tcp/443, HTTPS | Outbound | Polling for new workloads, providing status updates, and downloading private modules from HCP Terraform's Private Module Registry | | registry.terraform.io | tcp/443, HTTPS | Outbound | Downloading public modules from the Terraform Registry | | releases.hashicorp.com | tcp/443, HTTPS | Outbound | Updating agent components and downloading Terraform binaries | | archivist.terraform.io | tcp/443, HTTPS | Outbound | Blob Storage | diff --git a/website/docs/cloud-docs/agents/telemetry.mdx b/website/docs/cloud-docs/agents/telemetry.mdx index 144a013..f566c86 100644 --- a/website/docs/cloud-docs/agents/telemetry.mdx +++ b/website/docs/cloud-docs/agents/telemetry.mdx @@ -1,22 +1,22 @@ --- -page_title: Telemetry - Terraform Cloud Agents - Terraform Cloud and Terraform Enterprise +page_title: Telemetry - HCP Terraform Agents - HCP Terraform and Terraform Enterprise description: >- - Use telemetry data to understand the performance and behavior of Terraform Cloud Agents. Learn how to configure telemetry, configure and run the OpenTelemetry collector, and more. + Use telemetry data to understand the performance and behavior of HCP Terraform Agents. Learn how to configure telemetry, configure and run the OpenTelemetry collector, and more. --- # Telemetry -Terraform Cloud Agents may be configured to emit helpful telemetry data, +HCP Terraform Agents may be configured to emit helpful telemetry data, including both trace spans and metrics. ## Telemetry architecture -Terraform Cloud Agents emit telemetry data using the +HCP Terraform Agents emit telemetry data using the [OpenTelemetry](https://opentelemetry.io/) protocol. The agent is a simple producer of telemetry data, and relies on an OpenTelemetry Collector to perform aggregation, post-processing, and exporting of telemetry data to upstream technology and/or vendors. OpenTelemetry is an extensible telemetry protocol and -open source platform, which enables the Terraform Cloud Agent to remain +open source platform, which enables the HCP Terraform Agent to remain vendor-agnostic while producing high-value telemetry data for a wide array of platforms. @@ -49,14 +49,14 @@ Docker container labeled ## Compatibility -Each released version of the Terraform Cloud Agent ships with a specific version +Each released version of the HCP Terraform Agent ships with a specific version of the OpenTelemetry client libraries built in. As these libraries and implementations change, it is possible that certain versions of the agent will become incompatible with newer versions of the OpenTelemetry collector. To track version compatibility, the table below will be updated whenever these version constraints become known. -| Terraform Cloud Agent version | Compatible OpenTelemetry Collector version | +| HCP Terraform Agent version | Compatible OpenTelemetry Collector version | | ----------------------------- | ------------------------------------------ | | >= 0.1.12, <= 1.7.0 | <= 0.42.0 | | >= 1.7.1 | Tested up to 0.73.0 | @@ -72,7 +72,7 @@ docker run -p 127.0.0.1:4317:4317/tcp otel/opentelemetry-collector-contrib:0.42. ``` This will start an OpenTelemetry collector, and expose the gRPC interface (which -the Terraform Cloud Agent can talk to) on port 4317 of the local machine. +the HCP Terraform Agent can talk to) on port 4317 of the local machine. ### Configuring the collector @@ -96,7 +96,7 @@ The collector should start with your modified configuration. ## DataDog Agent -The Terraform Cloud Agent may target a DataDog agent directly instead of an +The HCP Terraform Agent may target a DataDog agent directly instead of an OpenTelemetry collector. To configure the DataDog agent to accept OTLP connections, refer to the [DataDog OpenTelemetry documentation](https://docs.datadoghq.com/opentelemetry/otlp_ingest_in_the_agent). @@ -109,13 +109,13 @@ collector address. ## Tracing The agent emits tracing spans which are useful in understanding and debugging -various operations performed by the Terraform Cloud Agent. +various operations performed by the HCP Terraform Agent. See the [Tracing](/terraform/cloud-docs/agents/tracing) documentation for details. ## Metrics -Terraform Cloud Agents emit granular metrics which are useful in understanding +HCP Terraform Agents emit granular metrics which are useful in understanding the behavior and performance of various operations in a high-level, aggregated view. diff --git a/website/docs/cloud-docs/agents/tracing.mdx b/website/docs/cloud-docs/agents/tracing.mdx index 37efbdd..00722a4 100644 --- a/website/docs/cloud-docs/agents/tracing.mdx +++ b/website/docs/cloud-docs/agents/tracing.mdx @@ -1,7 +1,7 @@ --- -page_title: Tracing - Terraform Cloud Agents - Terraform Cloud and Terraform Enterprise +page_title: Tracing - HCP Terraform Agents - HCP Terraform and Terraform Enterprise description: >- - Use tracing spans to understand and debug operations performed by Terraform Cloud Agents. Learn about supported tools and rules for tracing spans. + Use tracing spans to understand and debug operations performed by HCP Terraform Agents. Learn about supported tools and rules for tracing spans. --- # Tracing From 08037e21c338af6650d6a1c7b04790014fa9ec69 Mon Sep 17 00:00:00 2001 From: Rose Date: Wed, 17 Apr 2024 12:39:11 -0700 Subject: [PATCH 2/4] Reset auto-generated docs --- website/docs/cloud-docs/agents/changelog.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cloud-docs/agents/changelog.mdx b/website/docs/cloud-docs/agents/changelog.mdx index 3d1130b..7b1db58 100644 --- a/website/docs/cloud-docs/agents/changelog.mdx +++ b/website/docs/cloud-docs/agents/changelog.mdx @@ -1,4 +1,4 @@ ---- + --- page_title: Changelog - HCP Terraform Agents - HCP Terraform and Terraform Enterprise description: >- Keep track of changes to the HCP Terraform Agent From cddbbc4c1aa8923e879fd442711336f92aae46fb Mon Sep 17 00:00:00 2001 From: Rose Date: Wed, 17 Apr 2024 12:42:07 -0700 Subject: [PATCH 3/4] Make it stick --- website/docs/cloud-docs/agents/agents.mdx | 24 ++++++++++---------- website/docs/cloud-docs/agents/changelog.mdx | 10 ++++---- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/website/docs/cloud-docs/agents/agents.mdx b/website/docs/cloud-docs/agents/agents.mdx index 321d01e..8ffd7a5 100644 --- a/website/docs/cloud-docs/agents/agents.mdx +++ b/website/docs/cloud-docs/agents/agents.mdx @@ -1,12 +1,12 @@ --- -page_title: HCP Terraform Agents - Install and Run Agents - HCP Terraform and Terraform Enterprise +page_title: Terraform Cloud Agents - Install and Run Agents - Terraform Cloud and Terraform Enterprise description: >- Install, configure, and run agents on your own infrastructure. --- # Install and Run Agents -The agent software runs on your own infrastructure. The token you provide when starting the agent assigns it to an HCP Terraform [agent pool](/terraform/cloud-docs/agents/agent-pools). +The agent software runs on your own infrastructure. The token you provide when starting the agent assigns it to a Terraform Cloud [agent pool](/terraform/cloud-docs/agents/agent-pools). ## Operational Considerations @@ -14,13 +14,13 @@ Agents do not guarantee a clean working environment per Terraform execution. Eac ### Run Multiple Agents -You may choose to run multiple agents within your network, up to the organization's purchased agent limit. If there are multiple agents available within an organization, HCP Terraform selects the first available agent within the target pool. +You may choose to run multiple agents within your network, up to the organization's purchased agent limit. If there are multiple agents available within an organization, Terraform Cloud selects the first available agent within the target pool. Each agent process runs a single Terraform run at a time. Multiple agent processes can be concurrently run on a single instance, license limit permitting. ### Resilience -The agent distributes as a standalone binary that runs on any supported system. By default, the agent runs in the foreground as a long-running process that continuously polls for workloads from HCP Terraform. An agent process may terminate unexpectedly due to stopping the process forcefully, power cycling the host machine, and other methods. We strongly recommend pairing the agent with a process supervisor to ensure that it automatically restarts in case of an error. +The agent distributes as a standalone binary that runs on any supported system. By default, the agent runs in the foreground as a long-running process that continuously polls for workloads from Terraform Cloud. An agent process may terminate unexpectedly due to stopping the process forcefully, power cycling the host machine, and other methods. We strongly recommend pairing the agent with a process supervisor to ensure that it automatically restarts in case of an error. ## Download and Install the Agent @@ -42,9 +42,9 @@ To customize this update behavior, pass the flag `-auto-update` or set the envir ## Start the Agent -To start the agent and connect it to an HCP Terraform agent pool: +To start the agent and connect it to a Terraform Cloud agent pool: -1. Retrieve the [token](/terraform/cloud-docs/agents/agent-pools#create-an-agent-pool) from the HCP Terraform agent pool you want to use. +1. Retrieve the [token](/terraform/cloud-docs/agents/agent-pools#create-an-agent-pool) from the Terraform Cloud agent pool you want to use. 1. Set the `TFC_AGENT_TOKEN` environment variable. 1. (Optional) Set the `TFC_AGENT_NAME` environment variable. This name is for your reference only. The agent ID appears in logs and API requests. @@ -53,7 +53,7 @@ export TFC_AGENT_TOKEN=your-token export TFC_AGENT_NAME=your-agent-name ./tfc-agent ``` -Once complete, your agent and its status appear on the **Agents** page in the HCP Terraform UI. Workspaces can now use this agent pool for runs. Refer to [Configure Workspaces to Use the Agent](/terraform/cloud-docs/agents/agent-pools#configure-workspaces-to-use-the-agent) for details. +Once complete, your agent and its status appear on the **Agents** page in the Terraform Cloud UI. Workspaces can now use this agent pool for runs. Refer to [Configure Workspaces to Use the Agent](/terraform/cloud-docs/agents/agent-pools#configure-workspaces-to-use-the-agent) for details. ### Optional Configuration: Run an Agent Using Docker @@ -91,7 +91,7 @@ To use single-execution mode, start the agent with the `-single` command line ar ### Optional Configuration: Request Forwarding -You can configure the agent to accept forwarded requests from HCP Terraform. Request forwarding enables HCP Terraform to securely access private infrastructure resources, such as private VCS systems. See [Request Forwarding](/terraform/cloud-docs/agents/request-forwarding) for more details. By default, request forwarding is disabled. To enable it, start the agent with the `-request-forwarding` command line argument. +You can configure the agent to accept forwarded requests from Terraform Cloud. Request forwarding enables Terraform Cloud to securely access private infrastructure resources, such as private VCS systems. See [Request Forwarding](/terraform/cloud-docs/agents/request-forwarding) for more details. By default, request forwarding is disabled. To enable it, start the agent with the `-request-forwarding` command line argument. Agents handle forwarded requests separately from other workloads and may process requests in parallel to plans, applies, policy checks, etc. You can modify this behavior by enabling or disabling certain workload types via the `-accept` parameter, and selectively setting the `-request-forwarding` flag on certain agent(s) only. For example, you may have a pool of 4 agents, where two are configured to handle only plans and applies, and the other two are configured to handle only request forwarding. @@ -99,7 +99,7 @@ Agents handle forwarded requests separately from other workloads and may process ~> **Important:** We strongly recommend that you only terminate the agent using one of these methods. Abruptly terminating an agent by forcefully stopping the process or power cycling the host does not let the agent deregister and results in an **Unknown** agent status. Abrupt termination may cause further capacity issues. Refer to [capacity issues](/terraform/cloud-docs/agents/agent-pools#agent-capacity-usage) for details. -The agent maintains a registration and a liveness indicator within HCP Terraform during the entire course of its runtime. When an agent retires, it must deregister itself from HCP Terraform. The agent deregisters automatically as part of its shutdown procedure in the following scenarios: +The agent maintains a registration and a liveness indicator within Terraform Cloud during the entire course of its runtime. When an agent retires, it must deregister itself from Terraform Cloud. The agent deregisters automatically as part of its shutdown procedure in the following scenarios: - You enter `Ctrl-C` in an interactive terminal. - The agent process ID receives one of `SIGINT`, `SIGTERM`, or `SIGQUIT`. It is important to send only one signal. The agent interprets a second signal as forceful termination signal exits immediately. @@ -117,7 +117,7 @@ After initiating a graceful shutdown by either of these methods, the terminal us * `-name `: An optional user-specified name for the agent. This name may be used in - the HCP Terraform user interface to help easily identify the agent. + the Terraform Cloud user interface to help easily identify the agent. Default: `The agent's ephemeral ID, assigned during boot.` @@ -190,7 +190,7 @@ After initiating a graceful shutdown by either of these methods, the terminal us * `-address `: - The HTTP or HTTPS address of the HCP Terraform API. + The HTTP or HTTPS address of the Terraform Cloud API. Default: `https://app.terraform.io` @@ -198,7 +198,7 @@ After initiating a graceful shutdown by either of these methods, the terminal us * `-token `: - The agent token to use when making requests to the HCP Terraform API. + The agent token to use when making requests to the Terraform Cloud API. This token must be obtained from the API or UI. It is recommended to use the environment variable whenever possible for configuring this setting due to the sensitive nature of API tokens. diff --git a/website/docs/cloud-docs/agents/changelog.mdx b/website/docs/cloud-docs/agents/changelog.mdx index 7b1db58..cd4f035 100644 --- a/website/docs/cloud-docs/agents/changelog.mdx +++ b/website/docs/cloud-docs/agents/changelog.mdx @@ -1,12 +1,12 @@ - --- -page_title: Changelog - HCP Terraform Agents - HCP Terraform and Terraform Enterprise +--- +page_title: Changelog - Terraform Cloud Agents - Terraform Cloud and Terraform Enterprise description: >- - Keep track of changes to the HCP Terraform Agent + Keep track of changes to the Terraform Cloud Agent --- -# HCP Terraform Agent Changelog +# Terraform Cloud Agent Changelog -These are the release notes from the HCP Terraform Agent application. Changes +These are the release notes from the Terraform Cloud Agent application. Changes within each release are categorized into one or more of the following labels: * `FEATURES` - Used for net-new features being added to the agent. From cdce9b306848f758fb641eb61bdba5f70dd6ab0d Mon Sep 17 00:00:00 2001 From: Rose M Koron <32436232+rkoron007@users.noreply.github.com> Date: Tue, 30 Apr 2024 09:51:14 -0700 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cloud-docs/agents/hooks.mdx | 2 +- website/docs/cloud-docs/agents/logging.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/cloud-docs/agents/hooks.mdx b/website/docs/cloud-docs/agents/hooks.mdx index 0956291..4136bed 100644 --- a/website/docs/cloud-docs/agents/hooks.mdx +++ b/website/docs/cloud-docs/agents/hooks.mdx @@ -7,7 +7,7 @@ description: >- # Hooks -HCP Terraform 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 diff --git a/website/docs/cloud-docs/agents/logging.mdx b/website/docs/cloud-docs/agents/logging.mdx index 7065e9b..9934725 100644 --- a/website/docs/cloud-docs/agents/logging.mdx +++ b/website/docs/cloud-docs/agents/logging.mdx @@ -39,7 +39,7 @@ levels. There are 5 levels supported by the agent: ## Data format -By default, HCP Terraform Agents emit log lines in a human-friendly text +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