From d5e56ce1531320e6435aaf2f6f875223dbeea9f7 Mon Sep 17 00:00:00 2001 From: Rose M Koron <32436232+rkoron007@users.noreply.github.com> Date: Tue, 17 Dec 2024 08:42:27 -0800 Subject: [PATCH] [Draft] Improving SEO for agents (#124) --- website/docs/cloud-docs/agents/agent-pools.mdx | 4 ++-- website/docs/cloud-docs/agents/agents.mdx | 4 ++-- website/docs/cloud-docs/agents/changelog.mdx | 6 +++--- website/docs/cloud-docs/agents/hooks.mdx | 7 +++---- website/docs/cloud-docs/agents/index.mdx | 5 ++--- website/docs/cloud-docs/agents/logging.mdx | 6 +++--- website/docs/cloud-docs/agents/metrics.mdx | 7 ++++--- .../docs/cloud-docs/agents/request-forwarding.mdx | 15 +++++++++------ website/docs/cloud-docs/agents/requirements.mdx | 7 ++++--- website/docs/cloud-docs/agents/telemetry.mdx | 11 ++++++++--- website/docs/cloud-docs/agents/tracing.mdx | 4 ++-- 11 files changed, 42 insertions(+), 34 deletions(-) diff --git a/website/docs/cloud-docs/agents/agent-pools.mdx b/website/docs/cloud-docs/agents/agent-pools.mdx index 6067ab6..ac619ef 100644 --- a/website/docs/cloud-docs/agents/agent-pools.mdx +++ b/website/docs/cloud-docs/agents/agent-pools.mdx @@ -1,7 +1,7 @@ --- -page_title: HCP Terraform Agents - Managing Agent Pools - HCP Terraform and Terraform Enterprise +page_title: Manage HCP Terraform agent pools description: >- - Agent pools are groups of one or more agents in HCP Terraform. Create agent pools and assign them to one or more workspaces. + Agent pools are groups of one or more agents. Learn how to manage agent pools and assign them to specific workspaces. --- # Manage Agent Pools diff --git a/website/docs/cloud-docs/agents/agents.mdx b/website/docs/cloud-docs/agents/agents.mdx index 9d45ffc..b1d52b7 100644 --- a/website/docs/cloud-docs/agents/agents.mdx +++ b/website/docs/cloud-docs/agents/agents.mdx @@ -1,7 +1,7 @@ --- -page_title: HCP Terraform Agents - Install and Run Agents - HCP Terraform and Terraform Enterprise +page_title: Install and run HCP Terraform agents description: >- - Install, configure, and run agents on your own infrastructure. + Use HCP Terraform agents to manage infrastructure in private networks. Learn how to install, configure, and run agents on your own infrastructure. --- # Install and Run Agents diff --git a/website/docs/cloud-docs/agents/changelog.mdx b/website/docs/cloud-docs/agents/changelog.mdx index 0fe49ca..36f5db3 100644 --- a/website/docs/cloud-docs/agents/changelog.mdx +++ b/website/docs/cloud-docs/agents/changelog.mdx @@ -1,10 +1,10 @@ --- -page_title: Changelog - HCP Terraform Agents - HCP Terraform and Terraform Enterprise +page_title: Changelog - HCP Terraform agents description: >- - Keep track of changes to the HCP Terraform Agent + Review changes to the HCP Terraform agent. --- -# HCP Terraform Agent Changelog +# Agent changelog 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: diff --git a/website/docs/cloud-docs/agents/hooks.mdx b/website/docs/cloud-docs/agents/hooks.mdx index b8a8412..49390c4 100644 --- a/website/docs/cloud-docs/agents/hooks.mdx +++ b/website/docs/cloud-docs/agents/hooks.mdx @@ -1,11 +1,10 @@ --- -page_title: Hooks - HCP Terraform Agents - HCP Terraform and Terraform Enterprise +page_title: HCP Terraform agent hooks description: >- - HCP Terraform Agent hooks are custom programs that run at strategic points - during Terraform runs. + Use HCP Terraform agent hooks to run custom programs at specific stages of Terraform runs. --- -# Hooks +# Agent Hooks HCP Terraform Agents support running custom programs, or _hooks_, during strategic points of a Terraform run. These hooks allow you to extend the diff --git a/website/docs/cloud-docs/agents/index.mdx b/website/docs/cloud-docs/agents/index.mdx index bc81c51..6419cdf 100644 --- a/website/docs/cloud-docs/agents/index.mdx +++ b/website/docs/cloud-docs/agents/index.mdx @@ -1,8 +1,7 @@ --- -page_title: HCP Terraform Agents - HCP Terraform and Terraform Enterprise +page_title: HCP Terraform agents description: >- - Cloud agents let Terraform manage isolated, private, or on-premises - infrastructure. Learn to install, configure, and manage cloud agents. + HCP Terraform agents let you manage isolated, private, or on-premises infrastructure while keeping your network secure. --- # HCP Terraform Agents diff --git a/website/docs/cloud-docs/agents/logging.mdx b/website/docs/cloud-docs/agents/logging.mdx index 9934725..28c3bfc 100644 --- a/website/docs/cloud-docs/agents/logging.mdx +++ b/website/docs/cloud-docs/agents/logging.mdx @@ -1,10 +1,10 @@ --- -page_title: Logging - HCP Terraform Agents - HCP Terraform and Terraform Enterprise +page_title: HCP Terraform agent logging description: >- - Monitor agent log output and flash messages from HashiCorp that communicate important changes. + HCP Terraform agent logs contain output and flash messages about agent operations. Learn about agent verbosity levels and format. --- -# Logging +# Agent logging HCP Terraform Agents log helpful messages that tell operators about agent behavior, including communication with HCP Terraform APIs, specific diff --git a/website/docs/cloud-docs/agents/metrics.mdx b/website/docs/cloud-docs/agents/metrics.mdx index d5689cc..fec1e51 100644 --- a/website/docs/cloud-docs/agents/metrics.mdx +++ b/website/docs/cloud-docs/agents/metrics.mdx @@ -1,14 +1,15 @@ --- -page_title: Metrics - HCP Terraform Agents - HCP Terraform and Terraform Enterprise +page_title: HCP Terraform agent metrics description: >- - 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. + Use metrics to analyze HCP Terraform agent performance. Learn about supported core, runtime, and Terraform and policy component metrics. --- -# Metrics +# Agent metrics The HCP Terraform Agent emits numerous metrics describing the agent's performance. + ## Metric naming conventions All metrics emitted by the HCP Terraform Agent follow some general naming diff --git a/website/docs/cloud-docs/agents/request-forwarding.mdx b/website/docs/cloud-docs/agents/request-forwarding.mdx index 9728643..a520618 100644 --- a/website/docs/cloud-docs/agents/request-forwarding.mdx +++ b/website/docs/cloud-docs/agents/request-forwarding.mdx @@ -1,12 +1,10 @@ --- -page_title: HCP Terraform Agents - Request Forwarding +page_title: HCP Terraform agent request forwarding description: >- - Access private network resources using agents with request forwarding. + Learn how request forwarding enables accessing private network resources. --- -# Request Forwarding - -~> **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. +# Request forwarding You can configure HCP Terraform Agents to handle HTTP and HTTPS request forwarding on behalf of HCP Terraform. This enables HCP Terraform to access @@ -24,8 +22,13 @@ 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 HCP Terraform. + + +![Request forwarding architecture diagram](/public/img/request-forwarding-arch-dark.png) ## Forwarded Request Routing diff --git a/website/docs/cloud-docs/agents/requirements.mdx b/website/docs/cloud-docs/agents/requirements.mdx index 090f9f4..c640b64 100644 --- a/website/docs/cloud-docs/agents/requirements.mdx +++ b/website/docs/cloud-docs/agents/requirements.mdx @@ -1,10 +1,11 @@ --- -page_title: HCP Terraform Agents - Requirements - HCP Terraform and Terraform Enterprise +page_title: HCP Terraform agent requirements description: >- - Supported operating systems, Terraform versions, hardware requirements, and networking requirements for HCP Terraform Agents. + Use HCP Terraform agents to manage infrastructure in private networks. Learn about supported operating systems and hardware and networking requirements. --- -# Requirements +# Agent 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 HCP Terraform Agents. Refer to [HCP Terraform Agents on Terraform Enterprise](/terraform/enterprise/admin/agents-on-tfe) for additional Terraform Enterprise requirements. diff --git a/website/docs/cloud-docs/agents/telemetry.mdx b/website/docs/cloud-docs/agents/telemetry.mdx index 9494115..08b95ca 100644 --- a/website/docs/cloud-docs/agents/telemetry.mdx +++ b/website/docs/cloud-docs/agents/telemetry.mdx @@ -1,7 +1,7 @@ --- -page_title: Telemetry - HCP Terraform Agents - HCP Terraform and Terraform Enterprise +page_title: HCP Terraform agent telemetry description: >- - 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. + Use telemetry data to analyze the HCP Terraform agent performance. Learn about telemetry architecture and how to run and configure telemetry for your agents. --- # Telemetry @@ -20,8 +20,13 @@ 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. + + +![telemetry architecture diagram](/public/img/telemetry-arch-dark.png) ## Agent Configuration diff --git a/website/docs/cloud-docs/agents/tracing.mdx b/website/docs/cloud-docs/agents/tracing.mdx index 00722a4..42116d2 100644 --- a/website/docs/cloud-docs/agents/tracing.mdx +++ b/website/docs/cloud-docs/agents/tracing.mdx @@ -1,7 +1,7 @@ --- -page_title: Tracing - HCP Terraform Agents - HCP Terraform and Terraform Enterprise +page_title: HCP Terraform agents tracing description: >- - Use tracing spans to understand and debug operations performed by HCP Terraform Agents. Learn about supported tools and rules for tracing spans. + Use tracing spans to analyze and debug HCP Terraform agent operations. Learn about supported tools and rules for tracing spans. --- # Tracing