Skip to content

Commit 4ba61ab

Browse files
authored
Sync ptfe-releases and terraform-docs-common docs (#440)
* terraform-docs-common * terraform-enterprise
1 parent 03434a8 commit 4ba61ab

File tree

616 files changed

+76439
-68
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

616 files changed

+76439
-68
lines changed

content/terraform-docs-common/data/cloud-docs-nav-data.json

Lines changed: 45 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[
22
{ "heading": "HCP Terraform" },
33
{ "title": "Overview", "path": "" },
4-
{ "title": "Plans and Features",
4+
{ "title": "Plans and Features",
55
"routes": [
66
{
77
"title": "Overview",
8-
"path": "overview"
8+
"path": "overview"
99
},
1010
{
1111
"title": "Estimate HCP Terraform Cost",
@@ -359,8 +359,8 @@
359359
"routes": [
360360
{"title": "Overview","path": "users-teams-organizations/organizations"},
361361
{
362-
"title": "Manage reserved tag keys",
363-
"path": "users-teams-organizations/organizations/manage-reserved-tags"
362+
"title": "Manage reserved tag keys",
363+
"path": "users-teams-organizations/organizations/manage-reserved-tags"
364364
},
365365
{ "title": "VCS Status Checks", "path": "users-teams-organizations/organizations/vcs-status-checks" },
366366
{ "title": "Automatically cancel plan-only runs", "path": "users-teams-organizations/organizations/vcs-speculative-plan-management" }
@@ -493,6 +493,25 @@
493493
"title": "Configuration Designer",
494494
"path": "registry/design"
495495
}
496+
]
497+
},
498+
{ "title": "Public Registry Namespaces", "routes": [
499+
{
500+
"title": "Overview",
501+
"path": "public-namespace"
502+
},
503+
{
504+
"title": "Create or claim a namespace",
505+
"path": "public-namespace/create_or_claim"
506+
},
507+
{
508+
"title": "Manage namespaces",
509+
"path": "public-namespace/manage"
510+
},
511+
{
512+
"title": "Manage namespace artifacts",
513+
"path": "public-namespace/artifacts"
514+
}
496515
]
497516
},
498517
{
@@ -509,13 +528,13 @@
509528
]
510529
},
511530
{
512-
"title": "Policy enforcement",
531+
"title": "Policy Enforcement",
513532
"routes": [
514-
{
515-
"title": "Overview",
516-
"path": "policy-enforcement"
533+
{
534+
"title": "Overview",
535+
"path": "policy-enforcement"
517536
},
518-
{
537+
{
519538
"title": "Define policies",
520539
"routes": [
521540
{
@@ -529,8 +548,8 @@
529548
{
530549
"title": "OPA policies",
531550
"path": "policy-enforcement/define-policies/opa"
532-
}
533-
]
551+
}
552+
]
534553
},
535554
{
536555
"title": "Create and manage policy sets",
@@ -552,7 +571,7 @@
552571
{
553572
"title": "Run pre-written Sentinel policies",
554573
"path": "policy-enforcement/prewritten-sentinel"
555-
},
574+
},
556575
{
557576
"title": "Test Sentinel policies",
558577
"path": "policy-enforcement/test-sentinel"
@@ -581,33 +600,33 @@
581600
"title": "Overview",
582601
"path": "policy-enforcement/import-reference"
583602
},
584-
{
585-
"title": "tfconfig",
586-
"path": "policy-enforcement/import-reference/tfconfig"
603+
{
604+
"title": "tfconfig",
605+
"path": "policy-enforcement/import-reference/tfconfig"
587606
},
588607
{
589608
"title": "tfconfig/v2",
590609
"path": "policy-enforcement/import-reference/tfconfig-v2"
591610
},
592-
{
593-
"title": "tfplan",
594-
"path": "policy-enforcement/import-reference/tfplan"
611+
{
612+
"title": "tfplan",
613+
"path": "policy-enforcement/import-reference/tfplan"
595614
},
596615
{
597616
"title": "tfplan/v2",
598617
"path": "policy-enforcement/import-reference/tfplan-v2"
599618
},
600-
{
601-
"title": "tfstate",
602-
"path": "policy-enforcement/import-reference/tfstate"
619+
{
620+
"title": "tfstate",
621+
"path": "policy-enforcement/import-reference/tfstate"
603622
},
604623
{
605624
"title": "tfstate/v2",
606625
"path": "policy-enforcement/import-reference/tfstate-v2"
607626
},
608-
{
609-
"title": "tfrun",
610-
"path": "policy-enforcement/import-reference/tfrun"
627+
{
628+
"title": "tfrun",
629+
"path": "policy-enforcement/import-reference/tfrun"
611630
}
612631
]
613632
}
@@ -626,7 +645,7 @@
626645
"title": "Integrations",
627646
"routes": [
628647
{
629-
"title": "Overview",
648+
"title": "Overview",
630649
"path": "integrations"
631650
},
632651
{
@@ -687,7 +706,7 @@
687706
"title": "Service Graph Connector for Terraform",
688707
"routes": [
689708
{
690-
"title": "Overview",
709+
"title": "Overview",
691710
"path": "integrations/service-now/service-graph"
692711
},
693712
{

content/terraform-docs-common/data/docs-nav-data.json

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,36 @@
1515
"title": "Integration Program",
1616
"path": "partnerships"
1717
},
18-
{ "title": "Terraform Tools", "path": "terraform-tools" },
18+
{
19+
"title": "Terraform Tools",
20+
"routes": [
21+
{
22+
"title": "Overview",
23+
"path": "tools"
24+
},
25+
{
26+
"title": "Terraform MCP server",
27+
"badge": {
28+
"text": "BETA",
29+
"type": "outlined",
30+
"color": "neutral"
31+
},
32+
"routes": [
33+
{
34+
"title": "Overview",
35+
"path": "tools/mcp-server"
36+
},
37+
{
38+
"title": "Deploy server",
39+
"path": "tools/mcp-server/deploy"
40+
},
41+
{
42+
"title": "Prompt model",
43+
"path": "tools/mcp-server/prompt"
44+
}
45+
]
46+
}
47+
]
48+
},
1949
{ "title": "Glossary", "path": "glossary" }
2050
]

content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,17 @@ This endpoint supports pagination [with standard URL query parameters](/terrafor
7373
| `page[size]` | **Optional.** If omitted, the endpoint will return 20 agent pools per page. |
7474
| `filter[allowed_workspaces][name]` | **Optional.** Filters agent pools to those associated with the given workspace. The workspace must have permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Workspaces](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-workspaces). | |
7575

76+
77+
### Response fields
78+
79+
Responses for this endpoint can contain an `attributes` object with the following fields:
80+
81+
| Field name | Type | Description |
82+
|-------------------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------|
83+
| `data.attributes.agent-count` | number | The number of agents in `Idle`, `Busy` or `Unknown` states. Agents that are `Exited` or `Errored` are excluded. |
84+
| `data.attributes.meta.status-counts.total` | number | The total number of resources the filter was applied to. |
85+
| `data.attributes.meta.status-counts.matching` | number | The total number of resources returned, which match the filter you applied. |
86+
7687
### Sample Request
7788

7889
```shell

content/terraform-docs-common/docs/cloud-docs/api-docs/audit-trails.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ HCP Terraform retains 14 days of audit log information. The audit trails API exp
4949

5050
`GET /organization/audit-trail`
5151

52-
-> **Note:** This endpoint cannot be accessed with a [user token](/terraform/cloud-docs/users-teams-organizations/users#api-tokens) or [team token](/terraform/cloud-docs/users-teams-organizations/api-tokens#team-api-tokens). You must access it with an [organization token](/terraform/cloud-docs/users-teams-organizations/api-tokens#organization-api-tokens).
52+
-> **Note:** This endpoint cannot be accessed with a [user token](/terraform/cloud-docs/users-teams-organizations/users#api-tokens) or [team token](/terraform/cloud-docs/users-teams-organizations/api-tokens#team-api-tokens). You must access it with an [organization token](/terraform/cloud-docs/users-teams-organizations/api-tokens#organization-api-tokens) or an [audit trail token](/terraform/cloud-docs/users-teams-organizations/api-tokens#audit-trail-tokens).
5353

5454
### Query Parameters
5555

@@ -454,4 +454,4 @@ An HCP Terraform organization emits this event when someone in your organization
454454

455455
| Key | Data Type | Description |
456456
| --- | --- | --- |
457-
| `team` | string | The name or identifier of the team. |
457+
| `team` | string | The name or identifier of the team. |

content/terraform-docs-common/docs/cloud-docs/api-docs/no-code-provisioning.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -792,7 +792,7 @@ Properties without a default value are required.
792792
"value": "eu-central-1",
793793
"category": "terraform",
794794
"hcl": true,
795-
"sensitive": false,
795+
"sensitive": false
796796
}
797797
},
798798
{
@@ -802,7 +802,7 @@ Properties without a default value are required.
802802
"value": "ami‑077062",
803803
"category": "terraform",
804804
"hcl": true,
805-
"sensitive": false,
805+
"sensitive": false
806806
}
807807
}
808808
]

content/terraform-docs-common/docs/cloud-docs/api-docs/notification-configurations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The following triggers are available for workspace notifications.
6565
| Drifted | `"assessment:drifted"` | HCP Terraform detected configuration drift. This option is only available if you enabled drift detection for the workspace. |
6666
| Checks Failed | `"assessment:check_failure"` | One or more continuous validation checks did not pass. This option is only available if you enabled drift detection for the workspace. |
6767
| Health Assessment Failed | `"assessment:failed"` | A health assessment failed. This option is only available if you enable health assessments for the workspace. |
68-
| Auto Destroy Reminder | `"workspace:auto_destro_reminder"` | An automated workspace destroy run is imminent. |
68+
| Auto Destroy Reminder | `"workspace:auto_destroy_reminder"` | An automated workspace destroy run is imminent. |
6969
| Auto Destroy Results | `"workspace:auto_destroy_run_results"` | HCP Terraform attempted an automated workspace destroy run. |
7070

7171
### Team notification triggers

content/terraform-docs-common/docs/cloud-docs/api-docs/private-registry/modules.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,8 @@ Properties without a default value are required.
262262
| `data.attributes.vcs-repo.github-app-installation-id` | string | | The VCS Connection GitHub App Installation to use. Find this ID on the account settings page. Requires previously authorizing the GitHub App and generating a user-to-server token. Manage the token from **Account Settings** within HCP Terraform. You can not specify this value if `oauth-token-id` is specified. |
263263
| `data.attributes.vcs-repo.display_identifier` | string | | The display identifier for the repository. For most VCS providers outside of Bitbucket Cloud, this identifier matches the `data.attributes.vcs-repo.identifier` string. |
264264
| `data.attributes.no-code` | boolean | | Allows you to enable or disable the no-code publishing workflow for a module. |
265+
| `data.attributes.initial-version` | string | 0.0.0 | The initial version of module. |
266+
| `data.attributes.test-config.tests-enabled` | boolean | false | Allows you to enable or disable the test configuration for a module. |
265267
| `data.attributes.vcs-repo.branch` | string | | The repository branch to publish the module from if you are using the branch-based publishing workflow. If omitted, the module will be published using the tag-based publishing workflow. |
266268

267269
A VCS repository identifier is a reference to a VCS repository in the format `:org/:repo`, where `:org` and `:repo` refer to the organization, or project key for Bitbucket Data Center, and repository in your VCS provider. The format for Azure DevOps is `:org/:project/_git/:repo`.

content/terraform-docs-common/docs/cloud-docs/api-docs/workspaces.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,12 +175,10 @@ _With Key/Value Tags_
175175
"type": "workspaces",
176176
"relationships": {
177177
"tag-bindings": {
178-
{
179178
"data": [{
180179
"type": "tag-bindings",
181180
"attributes": { "key": "env", "value": "test"}
182181
}]
183-
}
184182
}
185183
}
186184
}

content/terraform-docs-common/docs/cloud-docs/architectural-details/security-model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ All organizations in HCP Terraform contain an “owners” team, which grants ad
5252

5353
~> **Note:** Teams are not available to free-tier users on HCP Terraform. Organizations at the free-level will only have an owners team.
5454

55-
All workspaces in an organization belong to a project. You can grant teams [read, write, maintain, admin, or a customized set of permissions for the project](/terraform/cloud-docs/users-teams-organizations/permissions#project-permissions), which grants specific permissions on on all workspaces within the project. You can also grant teams [read, plan, write, admin, or a customized set of permissions](/terraform/cloud-docs/users-teams-organizations/permissions#workspace-permissions) for a specific workspace. It’s important to note that, from a security perspective, the plan permission is equivalent to the write permission. The plan permission is provided to protect against accidental Terraform runs but is not intended to stop malicious actors from accessing sensitive data within a workspace. Terraform `plan` and `apply` operations can execute arbitrary code within the ephemeral build environment. Both of these operations happen in the same security context with access to the full set of workspace variables, Terraform configuration, and Terraform state.
55+
All workspaces in an organization belong to a project. You can grant teams [read, write, maintain, admin, or a customized set of permissions for the project](/terraform/cloud-docs/users-teams-organizations/permissions#project-permissions), which grants specific permissions on all workspaces within the project. You can also grant teams [read, plan, write, admin, or a customized set of permissions](/terraform/cloud-docs/users-teams-organizations/permissions#workspace-permissions) for a specific workspace. It’s important to note that, from a security perspective, the plan permission is equivalent to the write permission. The plan permission is provided to protect against accidental Terraform runs but is not intended to stop malicious actors from accessing sensitive data within a workspace. Terraform `plan` and `apply` operations can execute arbitrary code within the ephemeral build environment. Both of these operations happen in the same security context with access to the full set of workspace variables, Terraform configuration, and Terraform state.
5656

5757
By default, Teams with read privileges within a workspace can view the workspace's state. You can remove this access by using [customized workspace permissions](/terraform/cloud-docs/users-teams-organizations/permissions#custom-workspace-permissions); however, this will only apply to state file access through the API or UI. Terraform must access the state file in order to perform plan and apply operations, so any user with the ability to upload Terraform configurations and initiate runs will transitively have access to the workspaces' state.
5858

content/terraform-docs-common/docs/cloud-docs/cost-estimation/aws.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ Cost estimation supports the following resources. Not all possible values for at
1717
| Resource | Incurs Cost |
1818
| ----------- | ----------- |
1919
| `aws_alb` | X |
20-
| `aws_autoscaling_group` | X |
2120
| `aws_cloudhsm_v2_hsm` | X |
2221
| `aws_cloudwatch_dashboard` | X |
2322
| `aws_cloudwatch_metric_alarm` | X |
@@ -46,6 +45,7 @@ Cost estimation supports the following resources. Not all possible values for at
4645
| `aws_api_gateway_usage_plan_key` | |
4746
| `aws_appautoscaling_policy` | |
4847
| `aws_appautoscaling_target` | |
48+
| `aws_autoscaling_group` | |
4949
| `aws_autoscaling_lifecycle_hook` | |
5050
| `aws_autoscaling_policy` | |
5151
| `aws_cloudformation_stack` | |

content/terraform-docs-common/docs/cloud-docs/cost-estimation/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ if delta_monthly_cost.greater_than(100) {
4242
}
4343

4444
main = rule {
45-
delta_monthly_cost.less_than(100)
45+
delta_monthly_cost.less_than_or_equals(100)
4646
}
4747
```
4848

0 commit comments

Comments
 (0)