Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 4 additions & 3 deletions .github/workflows/build-pr-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
branches:
- main
- develop
- rm/lychee-results-to-gh-artifacts # delete this later
# paths:
# Hello Security 👋, we are checking to make sure forked repo PR changed paths are only in content/** inside the job security-check.
# We are doing this so we can also reuse this workflow for internal PRs, as pull_request_target also triggers on internal PRs. (As does pull_request)
Expand Down Expand Up @@ -337,14 +338,14 @@ jobs:
# artifacts and just link to that instead
- name: Upload lychee report to GitHub artifacts
id: upload-artifact
if: steps.lychee.outputs.exit_code != 0 && steps.char-count.outputs.size >= vars.BROKEN_LINK_REPORT_CHAR_MAX
if: steps.lychee.outputs.exit_code != 0 && fromJson(steps.char-count.outputs.size) >= fromJson(vars.BROKEN_LINK_REPORT_CHAR_MAX)
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # 4.6.2
with:
path: ./lychee/out.md
name: Link Checker Report

- name: Comment on PR with link to full link checker report
if: steps.lychee.outputs.exit_code != 0 && steps.char-count.outputs.size >= vars.BROKEN_LINK_REPORT_CHAR_MAX
if: steps.lychee.outputs.exit_code != 0 && fromJson(steps.char-count.outputs.size) >= fromJson(vars.BROKEN_LINK_REPORT_CHAR_MAX)
uses: marocchino/sticky-pull-request-comment@52423e01640425a022ef5fd42c6fb5f633a02728 # v2.9.1
with:
header: Link Checker Report
Expand All @@ -353,7 +354,7 @@ jobs:
Report exceeds max length of ${{vars.BROKEN_LINK_REPORT_CHAR_MAX}} characters. See ${{steps.upload-artifact.outputs.artifact-url}} for full report

- name: Comment on PR with link checker report
if: steps.lychee.outputs.exit_code != 0 && steps.char-count.outputs.size < vars.BROKEN_LINK_REPORT_CHAR_MAX
if: steps.lychee.outputs.exit_code != 0 && fromJson(steps.char-count.outputs.size) < fromJson(vars.BROKEN_LINK_REPORT_CHAR_MAX)
uses: marocchino/sticky-pull-request-comment@52423e01640425a022ef5fd42c6fb5f633a02728 # v2.9.1
with:
header: Link Checker Report
Expand Down
2 changes: 1 addition & 1 deletion content/terraform-cdk/v0.10.x/data/cdktf-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{ "title": "Overview", "path": "" },
{
"title": "Get Started",
"href": "https://learn.hashicorp.com/tutorials/terraform/cdktf-install?in=terraform/cdktf"
"href": "https://learn.hashicorp-broken-link.com/tutorials/terraform/cdktf-install?in=terraform/cdktf"
},
{
"title": "Concepts",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can configure the behavior of the Terraform CDK CLI by modifying the `cdktf.

## Telemetry

The CDKTF CLI ([cdktf-cli](https://github.com/hashicorp/terraform-cdk/tree/main/packages/cdktf-cli) interacts with a HashiCorp service called [Checkpoint](https://checkpoint.hashicorp.com)
to report project metrics such as cdktf version, project language, provider name, platform name, and other details that help guide the project maintainers with feature and roadmap decisions. The [code that interacts with Checkpoint](https://github.com/hashicorp/terraform-cdk/tree/main/packages/cdktf-cli/lib/checkpoint.ts) is part of the CDK for Terraform CLI.
The CDKTF CLI ([cdktf-cli](https://github.com/hashicorp-broken-link/terraform-cdk/tree/main/packages/cdktf-cli) interacts with a HashiCorp service called [Checkpoint](https://checkpoint.hashicorp-broken-link.com)
to report project metrics such as cdktf version, project language, provider name, platform name, and other details that help guide the project maintainers with feature and roadmap decisions. The [code that interacts with Checkpoint](https://github.com/hashicorp-broken-link/terraform-cdk/tree/main/packages/cdktf-cli/lib/checkpoint.ts) is part of the CDK for Terraform CLI.

The use of Checkpoint is completely optional. Refer to the [telemetry documentation](/cdktf/telemetry) for more information about Checkpoint and you can disable it if desired.
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ Options:

Examples:
cat main.tf | cdktf convert --provider integrations/github Takes the HCL content of main.tf and converts it to CDK for Terraform content and prints it
cat main.tf | cdktf convert --provider hashicorp/aws > imported.ts Takes the HCL content of main.tf and converts it to CDK for Terraform content in imported.ts
cat main.tf | cdktf convert --provider 'hashicorp/aws@ ~>3.62.0' 'integrations/github@ ~>4.16.0' --language Takes the HCL content of main.tf and converts it to CDK for Terraform content in imported.ts
cat main.tf | cdktf convert --provider hashicorp-broken-link/aws > imported.ts Takes the HCL content of main.tf and converts it to CDK for Terraform content in imported.ts
cat main.tf | cdktf convert --provider 'hashicorp-broken-link/aws@ ~>3.62.0' 'integrations/github@ ~>4.16.0' --language Takes the HCL content of main.tf and converts it to CDK for Terraform content in imported.ts
python > imported.py
```

Expand Down
6 changes: 3 additions & 3 deletions content/terraform-cdk/v0.10.x/docs/cdktf/community.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ CDK for Terraform (CDKTF) is under active development, and we would love your fe

## Questions & Issues

If you have questions, the HashiCorp [Discuss](https://discuss.hashicorp.com/) platform using the [terraform-cdk](https://discuss.hashicorp.com/c/terraform-core/cdk-for-terraform/) category is the best place for general discussion. If you run into issues or have ideas for improvements, please file a [bug](https://github.com/hashicorp/terraform-cdk/issues/new?assignees=&labels=bug&template=bug-report.md&title=) or request a new [feature](https://github.com/hashicorp/terraform-cdk/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=). Please let us know if you'd like to talk - we are very interested in learning how people use CDKTF in practice.
If you have questions, the HashiCorp [Discuss](https://discuss.hashicorp-broken-link.com/) platform using the [terraform-cdk](https://discuss.hashicorp-broken-link.com/c/terraform-core/cdk-for-terraform/) category is the best place for general discussion. If you run into issues or have ideas for improvements, please file a [bug](https://github.com/hashicorp-broken-link/terraform-cdk/issues/new?assignees=&labels=bug&template=bug-report.md&title=) or request a new [feature](https://github.com/hashicorp-broken-link/terraform-cdk/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=). Please let us know if you'd like to talk - we are very interested in learning how people use CDKTF in practice.

## Contributing

The CDKTF project is very open to community contributions. The easiest ways to help are by filing bugs for issues, commenting on existing issues you encounter, and commenting on or upvoting feature requests when you have use cases where they would be helpful. Hearing _why_ you are interested is extremely useful, and we appreciate your feedback.

If you are interested in contributing code, please look at the [CONTRIBUTING.md](https://github.com/hashicorp/terraform-cdk/blob/main/CONTRIBUTING.md) guide. Before you file a large pull request, please file a feature request to tell us what you're interested in building. We're happy to work with you on the design to make sure we can review and accept your PR quickly.
If you are interested in contributing code, please look at the [CONTRIBUTING.md](https://github.com/hashicorp-broken-link/terraform-cdk/blob/main/CONTRIBUTING.md) guide. Before you file a large pull request, please file a feature request to tell us what you're interested in building. We're happy to work with you on the design to make sure we can review and accept your PR quickly.

## Roadmap

We release CDKTF on a monthly cadence. The [GitHub milestones](https://github.com/hashicorp/terraform-cdk/milestones) for the project show what is planned for the next release and tentatively planned for subsequent releases. Issues labeled `committed` will land in the planned release, and all others are implicitly stretch goals that may shift to a future release as needed.
We release CDKTF on a monthly cadence. The [GitHub milestones](https://github.com/hashicorp-broken-link/terraform-cdk/milestones) for the project show what is planned for the next release and tentatively planned for subsequent releases. Issues labeled `committed` will land in the planned release, and all others are implicitly stretch goals that may shift to a future release as needed.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Assets are especially useful for:

## Usage Example

> **Hands-on:** Try the [Deploy Multiple Lambda Functions with TypeScript](https://learn.hashicorp.com/tutorials/terraform/cdktf-assets-stacks-lambda?in=terraform/cdktf) tutorial on HashiCorp Learn. This tutorial guides you through using a `TerraformAsset` to archive a Lambda function, uploading the archive to an S3 bucket, then deploying the Lambda function.
> **Hands-on:** Try the [Deploy Multiple Lambda Functions with TypeScript](https://learn.hashicorp-broken-link.com/tutorials/terraform/cdktf-assets-stacks-lambda?in=terraform/cdktf) tutorial on HashiCorp Learn. This tutorial guides you through using a `TerraformAsset` to archive a Lambda function, uploading the archive to an S3 bucket, then deploying the Lambda function.

The TypeScript example below uses `TerraformAsset` to upload the contents of the specified directory into an S3 Bucket. The `TerraformAsset` is responsible for making sure the directory ends up in the correct output folder as a zip file that the `S3BucketObject` can reference.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Constructs also provide a way to logically structure a set of resources, but you

## Use Constructs

> **Hands On:** Try [Deploy Applications with CDK for Terraform](https://learn.hashicorp.com/tutorials/terraform/cdktf-applications?in=terraform/cdktf) tutorial on HashiCorp Learn to use a custom construct. It includes the example code below.
> **Hands On:** Try [Deploy Applications with CDK for Terraform](https://learn.hashicorp-broken-link.com/tutorials/terraform/cdktf-applications?in=terraform/cdktf) tutorial on HashiCorp Learn to use a custom construct. It includes the example code below.

You can import any [CDKTF-compatible](#available-constructs) construct that is available in your project’s programming language. Then, you can create new instances of the construct and use any exposed properties to customize the construct configuration.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export class HelloTerraform extends TerraformStack {

.....
const remoteState = new DataTerraformRemoteState(this, {
organization: 'hashicorp',
organization: 'hashicorp-broken-link',
workspaces: {
name: 'vpc-prod'
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This page shows how you can interoperate HCL and CDK for Terraform configuration

## CDKTF to HCL

The TypeScript example below is a CDKTF application that uses the `hashicorp/random` provider to generate a random name.
The TypeScript example below is a CDKTF application that uses the `hashicorp-broken-link/random` provider to generate a random name.

```typescript
import { Construct } from "constructs";
Expand Down Expand Up @@ -59,7 +59,7 @@ After you transfer the `cdktf.json` file, you can reference the pet name module
terraform {
required_providers {
docker = {
source = "hashicorp/random"
source = "hashicorp-broken-link/random"
version = "~> 3.1"
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: >-

# Providers and Resources

A [provider](/language/providers) is a Terraform plugin that allows users to manage an external API. Provider plugins like the [AWS provider](https://registry.terraform.io/providers/hashicorp/aws/latest) or the [cloud-init provider](https://registry.terraform.io/providers/hashicorp/cloudinit/latest/docs) act as a translation layer that allows Terraform to communicate with many different cloud providers, databases, and services.
A [provider](/language/providers) is a Terraform plugin that allows users to manage an external API. Provider plugins like the [AWS provider](https://registry.terraform.io/providers/hashicorp-broken-link/aws/latest) or the [cloud-init provider](https://registry.terraform.io/providers/hashicorp-broken-link/cloudinit/latest/docs) act as a translation layer that allows Terraform to communicate with many different cloud providers, databases, and services.

![diagram: How Terraform uses plugins](/img/terraform-plugin-overview.png)

Expand Down Expand Up @@ -192,7 +192,7 @@ cdktf synth --json

### Install Pre-built Providers

It can take several minutes to generate the code bindings for providers with very large schemas, so we offer several popular providers as pre-built packages. Pre-built providers are a completely optional performance optimization, and you may prefer to generate the code bindings for these providers yourself. For example, you may want to use a different version of that provider than the one in the pre-built package. The [Terraform CDK Providers](https://github.com/orgs/hashicorp/repositories?q=cdktf-provider-) page has a complete list, but available pre-built providers include:
It can take several minutes to generate the code bindings for providers with very large schemas, so we offer several popular providers as pre-built packages. Pre-built providers are a completely optional performance optimization, and you may prefer to generate the code bindings for these providers yourself. For example, you may want to use a different version of that provider than the one in the pre-built package. The [Terraform CDK Providers](https://github.com/orgs/hashicorp-broken-link/repositories?q=cdktf-provider-) page has a complete list, but available pre-built providers include:

- [AWS Provider](https://github.com/terraform-cdk-providers/cdktf-provider-aws)
- [Google Provider](https://github.com/terraform-cdk-providers/cdktf-provider-google)
Expand Down Expand Up @@ -237,7 +237,7 @@ Resources are the most important element when defining infrastructure in CDKTF a

Resource definitions and properties vary depending on the type of resource and the provider. Consult your provider's documentation for a full list of available resources and their configuration options.

The TypeScript example below defines a [DynamoDB table](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) resource on the AWS provider.
The TypeScript example below defines a [DynamoDB table](https://registry.terraform.io/providers/hashicorp-broken-link/aws/latest/docs/resources/dynamodb_table) resource on the AWS provider.

```typescript
export class HelloTerra extends TerraformStack {
Expand Down
6 changes: 3 additions & 3 deletions content/terraform-cdk/v0.10.x/docs/cdktf/concepts/stacks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: >-

A stack represents a collection of infrastructure that CDK for Terraform (CDKTF) synthesizes as a dedicated Terraform configuration. Stacks allow you to separate the state management for multiple environments within an application.

> **Hands-on:** Try the [Deploy Applications with CDK for Terraform](https://learn.hashicorp.com/tutorials/terraform/cdktf-applications?in=terraform/cdktf&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn.
> **Hands-on:** Try the [Deploy Applications with CDK for Terraform](https://learn.hashicorp-broken-link.com/tutorials/terraform/cdktf-applications?in=terraform/cdktf&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn.

## Scope

Expand Down Expand Up @@ -48,7 +48,7 @@ app.synth();

## Multiple Stacks

> **Hands-on:** Try the [Deploy Multiple Lambda Functions with TypeScript](https://learn.hashicorp.com/tutorials/terraform/cdktf-assets-stacks-lambda?in=terraform/cdktf) tutorial on HashiCorp Learn. This tutorial guides you through a multi-stack application.
> **Hands-on:** Try the [Deploy Multiple Lambda Functions with TypeScript](https://learn.hashicorp-broken-link.com/tutorials/terraform/cdktf-assets-stacks-lambda?in=terraform/cdktf) tutorial on HashiCorp Learn. This tutorial guides you through a multi-stack application.

You can specify multiple stacks in your application. For example, you may want a separate configuration for development, testing, and production environments.

Expand Down Expand Up @@ -110,7 +110,7 @@ multiple-stacks-production-us cdktf.out/stacks/multiple-stacks-production-us
multiple-stacks-production-eu cdktf.out/stacks/multiple-stacks-production-eu
```

All Terraform operations are currently limited to a single stack, so you must specify a target stack directory to run `diff`, `deploy` or `destroy`. CDKTF emits an error if you omit the target stack and run a plain `cdktf deploy`. Please track this [issue](https://github.com/hashicorp/terraform-cdk/issues/650) if you're interested in deploying multiple stacks at once.
All Terraform operations are currently limited to a single stack, so you must specify a target stack directory to run `diff`, `deploy` or `destroy`. CDKTF emits an error if you omit the target stack and run a plain `cdktf deploy`. Please track this [issue](https://github.com/hashicorp-broken-link/terraform-cdk/issues/650) if you're interested in deploying multiple stacks at once.

To run multiple stacks at once, move them into the same directory and run `cdktf deploy`. For example, you could create a combined directory called `multiple-stacks-dev`, run `cdktf deploy multiple-stacks-dev`, and all Terraform operations will run in the folder `cdktf.out/stacks/multiple-stacks-dev`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ class Producer extends TerraformStack {
super(scope, name);

new RemoteBackend(this, {
organization: "hashicorp",
organization: "hashicorp-broken-link",
workspaces: {
name: "producer",
},
Expand All @@ -221,14 +221,14 @@ class Consumer extends TerraformStack {
super(scope, name);

new RemoteBackend(this, {
organization: "hashicorp",
organization: "hashicorp-broken-link",
workspaces: {
name: "consumer",
},
});

const remoteState = new DataTerraformRemoteState(this, "remote-pet", {
organization: "hashicorp",
organization: "hashicorp-broken-link",
workspaces: {
name: "producer",
},
Expand Down
Loading
Loading