Skip to content

Commit

Permalink
Merge pull request #797 from hashicorp/project-maturity-readme
Browse files Browse the repository at this point in the history
chore(docs): Add Project Maturity section to README
  • Loading branch information
ansgarm authored Jun 29, 2021
2 parents 8a93ffe + be02585 commit 50476e9
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@

# CDK for Terraform

> This experimental repository contains software which is still being developed
> and in the alpha testing stage. It is not ready for production use.
[Learn more about this product’s maturity and production readiness](#maturity)

CDK (Cloud Development Kit) for Terraform allows developers to use familiar
programming languages to define cloud infrastructure and provision it through
Expand Down Expand Up @@ -111,6 +110,18 @@ Choose a language:
- Writing own [remote templates](./docs/working-with-cdk-for-terraform/remote-templates.md) for init.
- Using [assets](./docs/working-with-cdk-for-terraform/terraform-assets.md) to transfer files into the Terraform context.

<a name="maturity"></a>

## Project Maturity and Production Readiness

CDK for Terraform is under active development; we’re still working out key workflows and best practices. We’re iterating fast and are likely to introduce breaking changes to existing APIs to improve the overall user experience of the product.

This tool can be used with Terraform Cloud and Terraform Enterprise, but is not eligible for commercial support, and is not officially recommended for production use cases. Like other HashiCorp pre-1.0 tools, some early-adopter users are already using CDK for Terraform in production, and we are working with those users to validate and improve workflows.

Early adopters of CDK for Terraform should expect to encounter and work around bugs occasionally, may need to refactor their codebase with each major release, and will intermittently need to use HCL and understand how JSON Terraform configurations are generated, for example to use [overrides](https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/escape-hatch.md) to use Terraform functionality that cannot currently be expressed using CDK for Terraform. Our goal is to provide a user experience where this is an exceptional edge case. If you’re comfortable with this level of troubleshooting, we’re very interested in your feedback and practical experience.

These caveats apply to CDK for Terraform itself, which generates Terraform configurations. Generated Terraform configurations are applied using Terraform Core, a well established / mature tool to provision infrastructure.

## Contributing and Feedback

CDK for Terraform is an early experimental project and the development team would love your feedback to help guide the project.
Expand Down

0 comments on commit 50476e9

Please sign in to comment.