From 51ea6b9e3c24ecc2497eaea1b8c948f94c9dc3c5 Mon Sep 17 00:00:00 2001 From: Brian McClain Date: Tue, 22 Apr 2025 15:48:44 -0400 Subject: [PATCH] Add callout for private policy evaluation --- .../v1.22.x/docs/cloud-docs/agents/agents.mdx | 1 + .../v1.22.x/docs/cloud-docs/agents/metrics.mdx | 2 ++ .../v1.22.x/docs/cloud-docs/agents/telemetry.mdx | 11 ++++++++++- .../v1.22.x/docs/partials/policy.mdx | 1 + 4 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 content/terraform-docs-agents/v1.22.x/docs/partials/policy.mdx diff --git a/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/agents.mdx b/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/agents.mdx index a2c520127a..8b04a23b5a 100644 --- a/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/agents.mdx +++ b/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/agents.mdx @@ -247,6 +247,7 @@ After initiating a graceful shutdown by either of these methods, the terminal us Environment variable: `TFC_AGENT_ACCEPT` +@include 'policy.mdx' * `-request-forwarding`: Enable handling of forwarded HTTP requests. Enable this option only if you diff --git a/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/metrics.mdx b/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/metrics.mdx index fec1e51344..24c0d4bf25 100644 --- a/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/metrics.mdx +++ b/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/metrics.mdx @@ -152,6 +152,8 @@ metrics in this section are prefixed by `tfc-agent.core.terraform.`. ## Policy component metrics +@include 'policy.mdx' + The following metrics are emitted by the `policy` component, which is responsible for handling OPA policy enforcement operations. All metrics in this section are prefixed by `tfc-agent.core.policy.`. diff --git a/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/telemetry.mdx b/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/telemetry.mdx index cbe9ae92f7..4a19a0bc01 100644 --- a/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/telemetry.mdx +++ b/content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/telemetry.mdx @@ -20,7 +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](/img/telemetry-arch-dark.png) + + +![telemetry architecture diagram](/public/img/telemetry-arch-dark.png) ## Agent Configuration @@ -143,6 +149,9 @@ Terraform fields are present on telemetry once an Agent begins handling a Terraf | `workspace_name` | Name of a workspace. | "workspace1" | ### Policy + +@include 'policy.mdx' + Policy fields are present on telemetry once an Agent begins handling policy evaluation. | Telemetry Key | Description | Example Value | diff --git a/content/terraform-docs-agents/v1.22.x/docs/partials/policy.mdx b/content/terraform-docs-agents/v1.22.x/docs/partials/policy.mdx new file mode 100644 index 0000000000..017c2d2336 --- /dev/null +++ b/content/terraform-docs-agents/v1.22.x/docs/partials/policy.mdx @@ -0,0 +1 @@ +-> **Note:** Private policy evaluation is available in HCP Terraform **Premium** edition. Refer to [HCP Terraform pricing](https://www.hashicorp.com/products/terraform/pricing) for details. \ No newline at end of file