Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cdktf/projen-cdktf-hybrid-construct
Projen template for CDKTF Constructs that should also be used as Terraform Modules.
https://github.com/cdktf/projen-cdktf-hybrid-construct
cdk cdktf constructs projen terraform-cdk terraform-modules
Last synced: about 1 month ago
JSON representation
Projen template for CDKTF Constructs that should also be used as Terraform Modules.
- Host: GitHub
- URL: https://github.com/cdktf/projen-cdktf-hybrid-construct
- Owner: cdktf
- License: mpl-2.0
- Created: 2022-03-23T15:14:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T00:34:14.000Z (7 months ago)
- Last Synced: 2024-04-08T01:52:28.945Z (7 months ago)
- Topics: cdk, cdktf, constructs, projen, terraform-cdk, terraform-modules
- Language: TypeScript
- Homepage:
- Size: 2.17 MB
- Stars: 10
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Projen-CDKTF-Hybrid-Construct
 [](https://github.com/cdktf/projen-cdktf-hybrid-construct/releases)
[](https://github.com/cdktf/projen-cdktf-hybrid-construct/blob/main/LICENSE)
[](https://github.com/cdktf/projen-cdktf-hybrid-construct/actions/workflows/build.yml)
Projen template for CDKTF Constructs that should also be used as Terraform Modules and for republishing Terraform Modules as Constructs.
_projen-cdktf-hybrid-construct_ is in technical preview, which means it's a community supported project. It still requires extensive testing and polishing to mature into a HashiCorp officially supported project. Please [file issues](https://github.com/cdktf/projen-cdktf-hybrid-construct/issues/new/choose) generously and detail your experience while using the library. We welcome your feedback.
By using the software in this repository, you acknowledge that:
* _projen-cdktf-hybrid-construct_ is still in development, may change, and has not been released as a commercial product by HashiCorp and is not currently supported in any way by HashiCorp.
* _projen-cdktf-hybrid-construct_ is provided on an "as-is" basis, and may include bugs, errors, or other issues.
* _projen-cdktf-hybrid-construct_ is NOT INTENDED FOR PRODUCTION USE, use of the Software may result in unexpected results, loss of data, or other unexpected results, and HashiCorp disclaims any and all liability resulting from use of _projen-cdktf-hybrid-construct_.
* HashiCorp reserves all rights to make all decisions about the features, functionality and commercial release (or non-release) of _projen-cdktf-hybrid-construct_, at any time and without any obligation or liability whatsoever.
## Compatibility
- `cdktf` >= 0.20.0
- `constructs` >= 10.3.0
- `projen` >= 0.85.0
## Usage
### `HybridModule`
If you want to write a CDKTF construct and also publish it as a Terraform Module you can use the `HybridModule` template.
You can initialize such a project using `npx projen new --from projen-cdktf-hybrid-construct hybrid-module`.
A configuration might look like this:
```js
const { HybridModule } = require("projen-cdktf-hybrid-construct");
const project = new HybridModule({
// The name of the module & repository need to start with terraform-cdk-
name: "terraform-cdk-my-new-hybrid-construct",
repositoryUrl:
"github.com/DanielMSchmidt/terraform-cdk-my-new-hybrid-construct",
author: "Daniel Schmidt",
authorAddress: "[email protected]",
// If enabled an example folder with terraform code will be created
terraformExamples: {
enabled: true,
folder: "terraform",
// The configuration to add to the example terraform file
providerConfig: `
terraform {
required_providers {
aws = {
source = "hashicorp/aws"
version = "~> 3.74"
}
}
# Terraform binary version constraint
required_version = ">= 1.2.0"
}
provider "aws" {
region = "eu-central-1"
}
`,
},
// If enabled a constructs example folder will be created
constructExamples: {
enabled: true,
folder: "construct-examples",
},
});
project.synth();
```
### `TerraformModule`
If you want to republish an existing Terraform module as a CDKTF construct or if you want to repackage them with an easier to use API you can use the `TerraformModule` template.
You can initialize such a project using `npx projen new --from projen-cdktf-hybrid-construct terraform-module`.
A configutation might look like this:
```js
const { TerraformModule } = require("projen-cdktf-hybrid-construct");
const project = new TerraformModule({
name: "my-module",
author: "Daniel Schmidt",
authorAddress: "[email protected]",
repositoryUrl: "github.com/DanielMSchmidt/my-module",
terraformModules: [
{
name: "eks",
source: "terraform-aws-modules/eks/aws",
version: "~> 18.0",
},
{
name: "eks-managed-nodegroup",
source: "terraform-aws-modules/eks/aws//modules/eks-managed-node-group",
version: "~> 18.0",
},
],
});
project.synth();
```
## Publishing
### Open Source
We have a helper method for easy configuration, but there are still some manual steps required.
```js
const {
HybridModule,
publishToRegistries,
} = require("projen-cdktf-hybrid-construct");
const project = new HybridModule({
// ... all the other options
...publishToRegistries({
name: "my-new-hybrid-construct",
namespace: "my-org",
registries: ["npm", "pypi", "nuget", "maven"],
}),
});
```
#### Terraform
1. [Sign in at the registry](https://registry.terraform.io/sign-in)
2. [Select your repository](https://registry.terraform.io/github/create) and create the module
Please make sure your repository name starts with `terraform-cdk-`.
#### npm (Typescript)
1. Create an account at [npmjs.com](https://npmjs.com/)
2. Create an [automation token](https://docs.npmjs.com/creating-and-viewing-access-tokens) on npm
3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `NPM_TOKEN` and the value of the token
#### pypi (Python)
1. Create an account at [pypi.org](https://pypi.org/)
2. Create an [API token](https://pypi.org/help/#apitoken) on pypi
3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `TWINE_USERNAME` and the value `__token__` and a second one with the name `TWINE_PASSWORD` and the value of the token
4. Set the `publishToPypi` section in the options of `HybridModule` or `TerraformModule` (or use the helper mentioned above)
```js
const name = "name-of-my-hybrid-construct";
new HybridModule({
name,
// ... other options
publishToPypi: {
distName: name,
module: name.replace(/-/g, "_"),
},
});
```
#### Maven (Java)
1. [Create a Sonatype account and repository](https://central.sonatype.org/publish/publish-guide/#introduction)
2. Create [GitHub Action Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to configure maven:
- `MAVEN_USERNAME`
- `MAVEN_PASSWORD`
- `MAVEN_STAGING_PROFILE_ID`
- `MAVEN_GPG_PRIVATE_KEY_PASSPHRASE`
- `MAVEN_GPG_PRIVATE_KEY_PASSPHRASE`
3. Setup the `publishToMaven` section in the options of `HybridModule` or `TerraformModule` (or use the helper mentioned above)
```js
const githubNamespace = "my-org";
const name = "name-of-my-hybrid-construct";
new HybridModule({
name,
// ... other options
publishToMaven: {
javaPackage: name.replace(/-/g, "_"),
mavenGroupId: `com.${githubNamespace}`,
mavenArtifactId: name,
},
});
```
#### NuGet (C#)
1. [Create a NuGet account](https://www.nuget.org/users/account/LogOn) (you might need to create a Microsoft Account if you don't have one)
2. [Create API keys](https://docs.microsoft.com/en-us/nuget/nuget-org/publish-a-package#create-api-keys)
3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `NUGET_API_KEY` and the value of the token
4. Setup the `publishToNuget` section in the options of `HybridModule` or `TerraformModule` (or use the helper mentioned above)
```js
const githubNamespace = "my-org";
const name = "name-of-my-hybrid-construct";
new HybridModule({
name,
// ... other options
publishToNuget: {
dotNetNamespace: `MyOrg.NameOfMyHybridConstruct`,
packageId: `MyOrg.NameOfMyHybridConstruct`,
},
});
```
### Github Packages
We have a helper method for easy configuration, no extra steps needed:
```js
const {
HybridModule,
publishToGithubPackages,
} = require("projen-cdktf-hybrid-construct");
const project = new HybridModule({
// ... all the other options
...publishToGithubPackages({
name: "my-new-hybrid-construct",
namespace: "my-org",
registries: ["npm", "maven"], // pypi and nuget are not yet supported
}),
});
```
### Artifactory
We have a helper method for easy configuration, but there are also some manual steps required.
```js
const {
HybridModule,
publishToGithubPackages,
} = require("projen-cdktf-hybrid-construct");
const project = new HybridModule({
// ... all the other options
...publishToGithubPackages({
name: "my-new-hybrid-construct",
namespace: "my-org",
registries: ["npm", "pypi", "nuget"], // maven is currently not supported, PRs welcome
artifactoryApiUrl: "https://artifactory.my-org.com/api/",
artifactoryRepository: "my-repo", // needs to be the same across all registries, defaults to namespace so "my-org" in this case
}),
});
```
#### Terraform
You can find more information about publishing Terraform Modules to Artifactory [here](https://www.jfrog.com/confluence/display/JFROG/Terraform+Registry#TerraformRegistry-SettingupaLocalModule/ProviderRegistry).
#### npm (Typescript)
1. [Create a virtual npm registry](https://www.jfrog.com/confluence/display/JFROG/npm+Registry#npmRegistry-VirtualnpmRegistry)
2. [Authenticate against artifactory to get a token](https://www.jfrog.com/confluence/display/JFROG/npm+Registry#npmRegistry-AuthenticatingthenpmClient)
3. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `NPM_TOKEN` and the value of the token
#### pypi (Python)
1. Create a [local repository](https://www.jfrog.com/confluence/display/JFROG/PyPI+Repositories#PyPIRepositories-LocalRepositories)
2. Create a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `TWINE_USERNAME` and the artifactory user name and a second one with the name `TWINE_PASSWORD` and the artifactory password