Merge pull request #1167 from hashicorp/d-cdktf-docs-7161173285-48

cdktf: update documentation
hashicorp · Dec 14, 2023 · 8785413 · 8785413
2 parents da52dd3 + 7d45da9
commit 8785413
Show file tree

Hide file tree

Showing 10 changed files with 466 additions and 8 deletions.
diff --git a/website/docs/cdktf/python/d/registry_gpg_key.html.markdown b/website/docs/cdktf/python/d/registry_gpg_key.html.markdown
@@ -0,0 +1,47 @@
+---
+layout: "tfe"
+page_title: "Terraform Enterprise: tfe_registry_gpg_key"
+description: |-
+  Get information on a private registry GPG key.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: tfe_registry_gpg_key
+
+Use this data source to get information about a private registry GPG key.
+
+## Example Usage
+
+```python
+# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
+from constructs import Construct
+from cdktf import TerraformStack
+#
+# Provider bindings are generated by running `cdktf get`.
+# See https://cdk.tf/provider-generation for more details.
+#
+from imports.tfe. import DataTfeRegistryGpgKey
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        DataTfeRegistryGpgKey(self, "example",
+            id="13DFECCA3B58CE4A",
+            organization="my-org-name"
+        )
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `id` - (Required) ID of the GPG key.
+* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
+
+## Attributes Reference
+
+* `ascii_armor` - ASCII-armored representation of the GPG key.
+* `created_at` - The time when the GPG key was created.
+* `updated_at` - The time when the GPG key was last updated.
+
+<!-- cache-key: cdktf-0.19.0 input-7cf721398cc48785bd0ab8f949360d917b2cadf37b1f704b8747ee2c07ced5d4 -->
diff --git a/website/docs/cdktf/python/d/registry_gpg_keys.html.markdown b/website/docs/cdktf/python/d/registry_gpg_keys.html.markdown
@@ -0,0 +1,48 @@
+---
+layout: "tfe"
+page_title: "Terraform Enterprise: tfe_registry_gpg_keys"
+description: |-
+  Get information on private registry GPG keys of an organization.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: tfe_registry_gpg_key
+
+Use this data source to get information about all private registry GPG keys of an organization.
+
+## Example Usage
+
+```python
+# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
+from constructs import Construct
+from cdktf import TerraformStack
+#
+# Provider bindings are generated by running `cdktf get`.
+# See https://cdk.tf/provider-generation for more details.
+#
+from imports.tfe. import DataTfeRegistryGpgKeys
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        DataTfeRegistryGpgKeys(self, "all",
+            organization="my-org-name"
+        )
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
+
+## Attributes Reference
+
+* `keys` - List of GPG keys in the organization. Each element contains the following attributes:
+  * `id` - ID of the GPG key.
+  * `organization` - Name of the organization.
+  * `ascii_armor` - ASCII-armored representation of the GPG key.
+  * `created_at` - The time when the GPG key was created.
+  * `updated_at` - The time when the GPG key was last updated.
+
+<!-- cache-key: cdktf-0.19.0 input-985032e5d21704bbf9d65466c89a423c9765fcddc79c819677b5b011797a49e7 -->
diff --git a/website/docs/cdktf/python/r/registry_gpg_key.html.markdown b/website/docs/cdktf/python/r/registry_gpg_key.html.markdown
@@ -0,0 +1,59 @@
+---
+layout: "tfe"
+page_title: "Terraform Enterprise: tfe_registry_gpg_key"
+description: |-
+  Manages private registry GPG keys.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# tfe_registry_gpg_key
+
+Manages a public key of the GPG key pair used to sign releases of private providers in the private registry.
+
+The provided GPG key must be ASCII-armored, i.e. starting with:
+"`-----BEGIN PGP PUBLIC KEY BLOCK-----\n\n...`".
+
+## Example Usage
+
+```python
+# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
+from constructs import Construct
+from cdktf import Fn, TerraformStack
+#
+# Provider bindings are generated by running `cdktf get`.
+# See https://cdk.tf/provider-generation for more details.
+#
+from imports.tfe. import RegistryGpgKey
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        RegistryGpgKey(self, "example",
+            ascii_armor=Fn.file("my-public-key.asc"),
+            organization="my-org-name"
+        )
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `ascii_armor` - (Required) ASCII-armored representation of the GPG key.
+* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
+
+## Attributes Reference
+
+* `id` - ID of the GPG key.
+* `created_at` - The time when the GPG key was created.
+* `updated_at` - The time when the GPG key was last updated.
+
+## Import
+
+Keys can be imported; use `<ORGANIZATION NAME>/<KEY ID>` as the import ID. For
+example:
+
+```shell
+terraform import tfe_registry_gpg_key.example my-org-name/34365D9472D7468F
+```
+
+<!-- cache-key: cdktf-0.19.0 input-730b5a234f42b288032d37e5a9ddea76c748a891a6ac2df444a35f192edf1bc4 -->
diff --git a/website/docs/cdktf/python/r/tfe_organization_default_execution_mode.html.markdown b/website/docs/cdktf/python/r/tfe_organization_default_execution_mode.html.markdown
@@ -0,0 +1,66 @@
+---
+layout: "tfe"
+page_title: "Terraform Enterprise: tfe_organization_default_execution_mode"
+description: |-
+  Sets the default execution mode of an organization
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# tfe_organization_default_execution_mode
+
+Sets the default execution mode of an organization. This default execution mode will be used as the default execution mode for all workspaces in the organization.
+
+## Example Usage
+
+Basic usage:
+
+```python
+# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
+from constructs import Construct
+from cdktf import TerraformStack
+#
+# Provider bindings are generated by running `cdktf get`.
+# See https://cdk.tf/provider-generation for more details.
+#
+from imports.tfe. import OrganizationDefaultExecutionMode
+from imports.tfe.agent_pool import AgentPool
+from imports.tfe.organization import Organization
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        test = Organization(self, "test",
+            email="[email protected]",
+            name="my-org-name"
+        )
+        my_agents = AgentPool(self, "my_agents",
+            name="agent_smiths",
+            organization=test.name
+        )
+        OrganizationDefaultExecutionMode(self, "org_default",
+            default_agent_pool_id=my_agents.id,
+            default_execution_mode="agent",
+            organization=test.name
+        )
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `default_execution_mode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode)
+  to use as the default for all workspaces in the organization. Valid values are `remote`, `local` or`agent`.
+* `agent_pool_id` - (Optional) The ID of an agent pool to assign to the workspace. Requires `default_execution_mode`
+  to be set to `agent`. This value _must not_ be provided if `default_execution_mode` is set to any other value or if `operations` is
+  provided.
+* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
+
+
+## Import
+
+Organization default execution mode can be imported; use `<ORGANIZATION NAME>` as the import ID. For example:
+
+```shell
+terraform import tfe_organization_default_execution_mode.test my-org-name
+```
+<!-- cache-key: cdktf-0.19.0 input-ed8965a40d18f988022c7c7aac067a018e5fa24eec1e6d94abd36c11a0971d1a -->
diff --git a/website/docs/cdktf/python/r/workspace.html.markdown b/website/docs/cdktf/python/r/workspace.html.markdown
@@ -87,8 +87,8 @@ The following arguments are supported:
 * `auto_apply_run_trigger` - (Optional) Whether to automatically apply changes for runs that were created by run triggers from another workspace. Defaults to `false`.
 * `description` - (Optional) A description for the workspace.
 * `execution_mode` - (Optional) Which [execution mode](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#execution-mode)
-  to use. Using Terraform Cloud, valid values are `remote`, `local` or`agent`.
-  Defaults to `remote`. Using Terraform Enterprise, only `remote`and `local`
+  to use. Using Terraform Cloud, valid values are `remote`, `local` or `agent`.
+  Defaults  your organization's default execution mode, or `remote` if no organization default is set. Using Terraform Enterprise, only `remote` and `local`
   execution modes are valid.  When set to `local`, the workspace will be used
   for state storage only. This value _must not_ be provided if `operations`
   is provided.
@@ -169,7 +169,10 @@ In addition to all arguments above, the following attributes are exported:
 
 * `id` - The workspace ID.
 * `resource_count` - The number of resources managed by the workspace.
-* `html_url` - The URL to the browsable HTML overview of the workspace
+* `html_url` - The URL to the browsable HTML overview of the workspace.
+* `setting_overwrites` - Can be used to check whether a setting is currently inheriting its value from another resource.
+  - `execution_mode` - Set to `true` if the execution mode of the workspace is being determined by the setting on the workspace itself. It will be `false` if the execution mode is inherited from another resource (e.g. the organization's default execution mode)   
+  - `agent_pool` - Set to `true` if the agent pool of the workspace is being determined by the setting on the workspace itself. It will be `false` if the agent pool is inherited from another resource (e.g. the organization's default agent pool)
 
 ## Import
 
@@ -184,4 +187,4 @@ terraform import tfe_workspace.test ws-CH5in3chf8RJjrVd
 terraform import tfe_workspace.test my-org-name/my-wkspace-name
 ```
 
-<!-- cache-key: cdktf-0.19.0 input-ce8c5d41ebbc57c1df647c807e38b748d12221b61915ccc24e4f1530f58312b5 -->
+<!-- cache-key: cdktf-0.19.0 input-25e2316b67d698d4aec45557feedf54b6a8dfa43a6381d9c433cf7afabed73c9 -->
diff --git a/website/docs/cdktf/typescript/d/registry_gpg_key.html.markdown b/website/docs/cdktf/typescript/d/registry_gpg_key.html.markdown
@@ -0,0 +1,50 @@
+---
+layout: "tfe"
+page_title: "Terraform Enterprise: tfe_registry_gpg_key"
+description: |-
+  Get information on a private registry GPG key.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: tfe_registry_gpg_key
+
+Use this data source to get information about a private registry GPG key.
+
+## Example Usage
+
+```typescript
+// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
+import { Construct } from "constructs";
+import { TerraformStack } from "cdktf";
+/*
+ * Provider bindings are generated by running `cdktf get`.
+ * See https://cdk.tf/provider-generation for more details.
+ */
+import { DataTfeRegistryGpgKey } from "./.gen/providers/tfe/";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    new DataTfeRegistryGpgKey(this, "example", {
+      id: "13DFECCA3B58CE4A",
+      organization: "my-org-name",
+    });
+  }
+}
+
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `id` - (Required) ID of the GPG key.
+* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
+
+## Attributes Reference
+
+* `asciiArmor` - ASCII-armored representation of the GPG key.
+* `createdAt` - The time when the GPG key was created.
+* `updatedAt` - The time when the GPG key was last updated.
+
+<!-- cache-key: cdktf-0.19.0 input-7cf721398cc48785bd0ab8f949360d917b2cadf37b1f704b8747ee2c07ced5d4 -->
diff --git a/website/docs/cdktf/typescript/d/registry_gpg_keys.html.markdown b/website/docs/cdktf/typescript/d/registry_gpg_keys.html.markdown
@@ -0,0 +1,51 @@
+---
+layout: "tfe"
+page_title: "Terraform Enterprise: tfe_registry_gpg_keys"
+description: |-
+  Get information on private registry GPG keys of an organization.
+---
+
+
+<!-- Please do not edit this file, it is generated. -->
+# Data Source: tfe_registry_gpg_key
+
+Use this data source to get information about all private registry GPG keys of an organization.
+
+## Example Usage
+
+```typescript
+// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
+import { Construct } from "constructs";
+import { TerraformStack } from "cdktf";
+/*
+ * Provider bindings are generated by running `cdktf get`.
+ * See https://cdk.tf/provider-generation for more details.
+ */
+import { DataTfeRegistryGpgKeys } from "./.gen/providers/tfe/";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    new DataTfeRegistryGpgKeys(this, "all", {
+      organization: "my-org-name",
+    });
+  }
+}
+
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
+
+## Attributes Reference
+
+* `keys` - List of GPG keys in the organization. Each element contains the following attributes:
+  * `id` - ID of the GPG key.
+  * `organization` - Name of the organization.
+  * `ascii_armor` - ASCII-armored representation of the GPG key.
+  * `created_at` - The time when the GPG key was created.
+  * `updated_at` - The time when the GPG key was last updated.
+
+<!-- cache-key: cdktf-0.19.0 input-985032e5d21704bbf9d65466c89a423c9765fcddc79c819677b5b011797a49e7 -->