Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add links and headers #3594

Merged
merged 10 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ contact_links:
- name: ❓ Question
url: https://discuss.hashicorp.com/c/terraform-core/cdk-for-terraform/47
about: 🙋 For usage questions that may not require a core maintainer to answer, post in our community forum
- name: Terraform Cloud/Enterprise Troubleshooting
- name: HCP Terraform/Enterprise Troubleshooting
rkoron007 marked this conversation as resolved.
Show resolved Hide resolved
url: https://support.hashicorp.com/hc/en-us/requests/new
about: For issues related to the Terraform Cloud/Enterprise platform, please submit a HashiCorp support request or email [email protected]
about: For issues related to the HCP Terraform/Enterprise platform, please submit a HashiCorp support request or email [email protected]
rkoron007 marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ If you have questions about CDK for Terraform (CDKTF) usage, please feel free to

## Enterprise/Commercial Support

If you are an existing Terraform Enterprise or Terraform Cloud for Business customer, please submit a HashiCorp support request or email [email protected]
If you are an existing Terraform Enterprise or HCP Terraform for Business customer, please submit a HashiCorp support request or email [email protected]
2 changes: 1 addition & 1 deletion examples/python/aws-eks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Commands:
cdktf diff [OPTIONS] Perform a diff (terraform plan) for the given stack
cdktf get [OPTIONS] Generate CDK Constructs for Terraform providers and modules.
cdktf init [OPTIONS] Create a new cdktf project from a template.
cdktf login Retrieves an API token to connect to Terraform Cloud.
cdktf login Retrieves an API token to connect to HCP Terraform.
cdktf synth [OPTIONS] Synthesizes Terraform code for the given app in a directory.
```

Expand Down
4 changes: 2 additions & 2 deletions website/data/cdktf-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@
"path": "create-and-deploy/environment-variables"
},
{
"title": "Terraform Cloud",
"path": "create-and-deploy/terraform-cloud"
"title": "HCP Terraform",
"path": "create-and-deploy/hcp-terraform"
},
{
"title": "Deployment Patterns",
Expand Down
16 changes: 8 additions & 8 deletions website/docs/cdktf/api-reference/csharp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ public string FriendlyUniqueId { get; }

### CloudBackend <a name="CloudBackend" id="cdktf.CloudBackend"></a>

The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.
The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which HCP Terraform workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When HCP Terraform uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.

#### Initializers <a name="Initializers" id="cdktf.CloudBackend.Initializer"></a>

Expand Down Expand Up @@ -12931,7 +12931,7 @@ must be set to true (which is the default).

### CloudBackendConfig <a name="CloudBackendConfig" id="cdktf.CloudBackendConfig"></a>

The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.
The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which HCP Terraform workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When HCP Terraform uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.

https://developer.hashicorp.com/terraform/cli/cloud/settings#arguments

Expand All @@ -12953,9 +12953,9 @@ new CloudBackendConfig {
| **Name** | **Type** | **Description** |
| --------------------------------------------------------------------------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------- |
| <code><a href="#cdktf.CloudBackendConfig.property.organization">Organization</a></code> | <code>string</code> | The name of the organization containing the workspace(s) the current configuration should use. |
| <code><a href="#cdktf.CloudBackendConfig.property.workspaces">Workspaces</a></code> | <code>object</code> | A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration. |
| <code><a href="#cdktf.CloudBackendConfig.property.workspaces">Workspaces</a></code> | <code>object</code> | A nested block that specifies which remote HCP Terraform workspaces to use for the current configuration. |
| <code><a href="#cdktf.CloudBackendConfig.property.hostname">Hostname</a></code> | <code>string</code> | The hostname of a Terraform Enterprise installation, if using Terraform Enterprise. |
| <code><a href="#cdktf.CloudBackendConfig.property.token">Token</a></code> | <code>string</code> | The token used to authenticate with Terraform Cloud. |
| <code><a href="#cdktf.CloudBackendConfig.property.token">Token</a></code> | <code>string</code> | The token used to authenticate with HCP Terraform. |

---

Expand All @@ -12979,7 +12979,7 @@ public object Workspaces { get; set; }

- _Type:_ object

A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration.
A nested block that specifies which remote HCP Terraform workspaces to use for the current configuration.

The workspaces block must contain exactly one of the following arguments, each denoting a strategy for how workspaces should be mapped:

Expand All @@ -13006,7 +13006,7 @@ public string Token { get; set; }

- _Type:_ string

The token used to authenticate with Terraform Cloud.
The token used to authenticate with HCP Terraform.

We recommend omitting the token from the configuration, and instead using terraform login or manually configuring credentials in the CLI config file.

Expand Down Expand Up @@ -31389,7 +31389,7 @@ All aspects can visit an IConstruct.

### NamedCloudWorkspace <a name="NamedCloudWorkspace" id="cdktf.NamedCloudWorkspace"></a>

The name of a single Terraform Cloud workspace.
The name of a single HCP Terraform workspace.

You will only be able to use the workspace specified in the configuration with this working directory, and cannot manage workspaces from the CLI (e.g. terraform workspace select or terraform workspace new).

Expand Down Expand Up @@ -33489,7 +33489,7 @@ public string Fqn { get; }

### TaggedCloudWorkspaces <a name="TaggedCloudWorkspaces" id="cdktf.TaggedCloudWorkspaces"></a>

A set of Terraform Cloud workspace tags.
A set of HCP Terraform workspace tags.

You will be able to use this working directory with any workspaces that have all of the specified tags, and can use the terraform workspace commands to switch between them or create new workspaces. New workspaces will automatically have the specified tags. This option conflicts with name.

Expand Down
16 changes: 8 additions & 8 deletions website/docs/cdktf/api-reference/go.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ func FriendlyUniqueId() *string

### CloudBackend <a name="CloudBackend" id="cdktf.CloudBackend"></a>

The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.
The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which HCP Terraform workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When HCP Terraform uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.

#### Initializers <a name="Initializers" id="cdktf.CloudBackend.Initializer"></a>

Expand Down Expand Up @@ -12931,7 +12931,7 @@ must be set to true (which is the default).

### CloudBackendConfig <a name="CloudBackendConfig" id="cdktf.CloudBackendConfig"></a>

The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.
The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which HCP Terraform workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When HCP Terraform uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.

https://developer.hashicorp.com/terraform/cli/cloud/settings#arguments

Expand All @@ -12953,9 +12953,9 @@ import "github.com/hashicorp/terraform-cdk-go/cdktf"
| **Name** | **Type** | **Description** |
| --------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------- |
| <code><a href="#cdktf.CloudBackendConfig.property.organization">Organization</a></code> | <code>\*string</code> | The name of the organization containing the workspace(s) the current configuration should use. |
| <code><a href="#cdktf.CloudBackendConfig.property.workspaces">Workspaces</a></code> | <code>interface{}</code> | A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration. |
| <code><a href="#cdktf.CloudBackendConfig.property.workspaces">Workspaces</a></code> | <code>interface{}</code> | A nested block that specifies which remote HCP Terraform workspaces to use for the current configuration. |
| <code><a href="#cdktf.CloudBackendConfig.property.hostname">Hostname</a></code> | <code>\*string</code> | The hostname of a Terraform Enterprise installation, if using Terraform Enterprise. |
| <code><a href="#cdktf.CloudBackendConfig.property.token">Token</a></code> | <code>\*string</code> | The token used to authenticate with Terraform Cloud. |
| <code><a href="#cdktf.CloudBackendConfig.property.token">Token</a></code> | <code>\*string</code> | The token used to authenticate with HCP Terraform. |

---

Expand All @@ -12979,7 +12979,7 @@ Workspaces interface{}

- _Type:_ interface{}

A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration.
A nested block that specifies which remote HCP Terraform workspaces to use for the current configuration.

The workspaces block must contain exactly one of the following arguments, each denoting a strategy for how workspaces should be mapped:

Expand All @@ -13006,7 +13006,7 @@ Token *string

- _Type:_ \*string

The token used to authenticate with Terraform Cloud.
The token used to authenticate with HCP Terraform.

We recommend omitting the token from the configuration, and instead using terraform login or manually configuring credentials in the CLI config file.

Expand Down Expand Up @@ -31395,7 +31395,7 @@ All aspects can visit an IConstruct.

### NamedCloudWorkspace <a name="NamedCloudWorkspace" id="cdktf.NamedCloudWorkspace"></a>

The name of a single Terraform Cloud workspace.
The name of a single HCP Terraform workspace.

You will only be able to use the workspace specified in the configuration with this working directory, and cannot manage workspaces from the CLI (e.g. terraform workspace select or terraform workspace new).

Expand Down Expand Up @@ -33497,7 +33497,7 @@ func Fqn() *string

### TaggedCloudWorkspaces <a name="TaggedCloudWorkspaces" id="cdktf.TaggedCloudWorkspaces"></a>

A set of Terraform Cloud workspace tags.
A set of HCP Terraform workspace tags.

You will be able to use this working directory with any workspaces that have all of the specified tags, and can use the terraform workspace commands to switch between them or create new workspaces. New workspaces will automatically have the specified tags. This option conflicts with name.

Expand Down
Loading
Loading