Skip to content

Commit

Permalink
feat(docs): Mention Maven examples in note on project setup page
Browse files Browse the repository at this point in the history
  • Loading branch information
ansgarm committed Jan 18, 2024
1 parent 35bf4f9 commit 7f9425e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
2 changes: 2 additions & 0 deletions website/docs/cdktf/create-and-deploy/project-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Use these template names for the available pre-built templates:
- `java`
- `go`

Note: Even though the CDKTF Java template sets up the Gradle build system for performance reasons, you can still use Maven to build your project. For more information refer to the Java examples which also include Maven examples: [Java Examples](/terraform/cdktf/examples-and-guides/examples#java).

### Use a Local Backend

Add the `--local` flag to created a scaffolded project that is pre-configured to use a [local backend](/terraform/language/settings/backends/local). This means that your application stores [Terraform state](/terraform/language/state) on your local machine and all Terraform operations run locally.
Expand Down
14 changes: 13 additions & 1 deletion website/docs/cdktf/examples-and-guides/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,26 @@ Each CDK for Terraform project can specify a [backend](/terraform/language/setti

### Java

#### Gradle

| Example | Description | Complexity |
| --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [aws-gradle](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/aws-gradle) | Provisions a DynamoDB table on the AWS provider. | Low |
| [azure-gradle](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/azure-gradle) | Provisions a Virtual Network on Microsoft Azure. | Low |
| [google-gradle](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/google-gradle) | Creates a simple Compute Instance with the Google Cloud Platform Provider. | Low |
| [gradle-shared-module](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/gradle-shared-module) | Uses gradle to build and share two AWS modules. [Modules](/terraform/cdktf/concepts/modules) are distinct configurations that you can package and reuse across projects and teams. | Low |
| [kubernetes-gradle](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/kubernetes-gradle) | Schedules and exposes a NGINX deployment on a Kubernetes cluster. | Low |
| [ucloud-gradle](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/ucloud-gradle) | Provisions a Linux base image on UCloud. | Low |

#### Maven

| Example | Description | Complexity |
| --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [aws-lambda-end-to-end](https://github.com/hashicorp/cdktf-integration-serverless-java-example) | An end-to-end example for a serverless web application hosted on AWS. | High |
| [aws](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/aws) | Provisions a DynamoDB table on the AWS provider. | Low |
| [azure](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/azure) | Provisions a Virtual Network on Microsoft Azure. | Low |
| [google-end-to-end](https://github.com/hashicorp/cdktf-integration-serverless-java-gcp-example) | An end-to-end example for a serverless web application hosted on the Google Cloud Provider. | High |
| [google](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/google) | Creates a simple Compute Instance with the Google Cloud Platform Provider. | Low |
| [gradle-shared-module](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/gradle-shared-module) | Uses gradle to build and share two AWS modules. [Modules](/terraform/cdktf/concepts/modules) are distinct configurations that you can package and reuse across projects and teams. | Low |
| [kubernetes](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/kubernetes) | Schedules and exposes a NGINX deployment on a Kubernetes cluster. | Low |
| [ucloud](https://github.com/hashicorp/terraform-cdk/tree/main/examples/java/ucloud) | Provisions a Linux base image on UCloud. | Low |

Expand Down

0 comments on commit 7f9425e

Please sign in to comment.