@cdk8s/cdktf-resolver 0.0.0

package/.gitattributes

@@ -0,0 +1,39 @@
+# ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen".
+
+*.snap linguist-generated
+/.eslintrc.json linguist-generated
+/.gitattributes linguist-generated
+/.github/ISSUE_TEMPLATE/bug.md linguist-generated
+/.github/ISSUE_TEMPLATE/config.yml linguist-generated
+/.github/ISSUE_TEMPLATE/feature-request.md linguist-generated
+/.github/pull_request_template.md linguist-generated
+/.github/workflows/auto-approve.yml linguist-generated
+/.github/workflows/build.yml linguist-generated
+/.github/workflows/pull-request-lint.yml linguist-generated
+/.github/workflows/release.yml linguist-generated
+/.github/workflows/security.yml linguist-generated
+/.github/workflows/stale.yml linguist-generated
+/.github/workflows/triage.yml linguist-generated
+/.github/workflows/upgrade-compiler-dependencies-main.yml linguist-generated
+/.github/workflows/upgrade-configuration-main.yml linguist-generated
+/.github/workflows/upgrade-dev-dependencies-main.yml linguist-generated
+/.github/workflows/upgrade-runtime-dependencies-main.yml linguist-generated
+/.gitignore linguist-generated
+/.mergify.yml linguist-generated
+/.npmignore linguist-generated
+/.npmrc linguist-generated
+/.projen/** linguist-generated
+/.projen/deps.json linguist-generated
+/.projen/files.json linguist-generated
+/.projen/tasks.json linguist-generated
+/API.md linguist-generated
+/CODE_OF_CONDUCT.md linguist-generated
+/DCO linguist-generated
+/git-hooks/prepare-commit-msg linguist-generated
+/git-hooks/README.md linguist-generated
+/git-hooks/setup.sh linguist-generated
+/LICENSE linguist-generated
+/package.json linguist-generated
+/SECURITY.md linguist-generated
+/tsconfig.dev.json linguist-generated
+/yarn.lock linguist-generated

package/.jsii

@@ -0,0 +1,236 @@
+{
+  "author": {
+    "name": "Amazon Web Services",
+    "roles": [
+      "author"
+    ],
+    "url": "https://aws.amazon.com"
+  },
+  "dependencies": {
+    "cdk8s": "^2.66.2",
+    "cdktf": "^0.18.0",
+    "constructs": "^10.2.70"
+  },
+  "dependencyClosure": {
+    "cdk8s": {
+      "targets": {
+        "dotnet": {
+          "namespace": "Org.Cdk8s",
+          "packageId": "Org.Cdk8s"
+        },
+        "go": {
+          "moduleName": "github.com/cdk8s-team/cdk8s-core-go"
+        },
+        "java": {
+          "maven": {
+            "artifactId": "cdk8s",
+            "groupId": "org.cdk8s"
+          },
+          "package": "org.cdk8s"
+        },
+        "js": {
+          "npm": "cdk8s"
+        },
+        "python": {
+          "distName": "cdk8s",
+          "module": "cdk8s"
+        }
+      }
+    },
+    "cdktf": {
+      "submodules": {
+        "cdktf.testingMatchers": {}
+      },
+      "targets": {
+        "dotnet": {
+          "namespace": "HashiCorp.Cdktf",
+          "packageId": "HashiCorp.Cdktf"
+        },
+        "go": {
+          "moduleName": "github.com/hashicorp/terraform-cdk-go",
+          "packageName": "cdktf"
+        },
+        "java": {
+          "maven": {
+            "artifactId": "cdktf",
+            "groupId": "com.hashicorp"
+          },
+          "package": "com.hashicorp.cdktf"
+        },
+        "js": {
+          "npm": "cdktf"
+        },
+        "python": {
+          "distName": "cdktf",
+          "module": "cdktf"
+        }
+      }
+    },
+    "constructs": {
+      "targets": {
+        "dotnet": {
+          "namespace": "Constructs",
+          "packageId": "Constructs"
+        },
+        "go": {
+          "moduleName": "github.com/aws/constructs-go"
+        },
+        "java": {
+          "maven": {
+            "artifactId": "constructs",
+            "groupId": "software.constructs"
+          },
+          "package": "software.constructs"
+        },
+        "js": {
+          "npm": "constructs"
+        },
+        "python": {
+          "distName": "constructs",
+          "module": "constructs"
+        }
+      }
+    }
+  },
+  "description": "@cdk8s/cdktf-resolver",
+  "docs": {
+    "stability": "stable"
+  },
+  "homepage": "https://github.com/cdk8s-team/cdk8s-cdktf-resolver.git",
+  "jsiiVersion": "5.2.11 (build f6c85b3)",
+  "license": "Apache-2.0",
+  "metadata": {
+    "jsii": {
+      "pacmak": {
+        "hasDefaultInterfaces": true
+      }
+    },
+    "tscRootDir": "src"
+  },
+  "name": "@cdk8s/cdktf-resolver",
+  "readme": {
+    "markdown": "# CDK For Terraform Resolver\n\nThe `CdkTfResolver` is able to resolve any [`TerraformOutput`](https://developer.hashicorp.com/terraform/cdktf/concepts/variables-and-outputs#output-values)\ndefined by your CDKTF application. In this example, we create an S3 `Bucket` with the CDKTF, and pass its (deploy time generated)\nname as an environment variable to a Kubernetes `CronJob` resource.\n\n```ts\nimport * as tf from \"cdktf\";\nimport * as aws from \"@cdktf/provider-aws\";\nimport * as k8s from 'cdk8s';\nimport * as kplus from 'cdk8s-plus-26';\n\nimport { CdkTfResolver } from '@cdk8s/cdktf-resolver';\n\nconst awsApp = new tf.App();\nconst stack = new tf.TerraformStack(awsApp, 'aws');\n\nconst k8sApp = new k8s.App({ resolvers: [new CdkTfResolver()] });\nconst manifest = new k8s.Chart(k8sApp, 'Manifest', { resolver });\n\nconst bucket = new aws.s3Bucket.S3Bucket(stack, 'Bucket');\nconst bucketName = new tf.TerraformOutput(constrcut, 'BucketName', {\n  value: bucket.bucket,\n});\n\nnew kplus.CronJob(manifest, 'CronJob', {\n  schedule: k8s.Cron.daily(),\n  containers: [{\n    image: 'job',\n    envVariables: {\n      // directly passing the value of the `TerraformOutput` containing\n      // the deploy time bucket name\n      BUCKET_NAME: kplus.EnvValue.fromValue(bucketName.value),\n    }\n }]\n});\n\nawsApp.synth();\nk8sApp.synth();\n```\n\nDuring cdk8s synthesis, the custom resolver will detect that `bucketName.value` is not a concrete value,\nbut rather a value of a `TerraformOutput`. It will then perform `cdktf` CLI commands in order to fetch the\nactual value from the deployed infrastructure in your account. This means that in order\nfor `cdk8s synth` to succeed, it must be executed *after* the CDKTF resources\nhave been deployed. So your deployment workflow should (conceptually) be:\n\n1. `cdktf deploy`\n2. `cdk8s synth`\n\n> Note that the `CdkTfResolver` is **only** able to fetch tokens that have a `TerraformOutput` defined for them.\n\n##### Permissions\n\nSince running `cdk8s synth` will now require reading terraform outputs, it must have permissions to do so.\nIn case a remote state file is used, this means providing a set of credentials for the account that have access\nto where the state is stored. This will vary depending on your cloud provider, but in most cases will involve giving\nread permissions on a blob storage device (e.g S3 bucket).\n\nNote that the permissions cdk8s require are far more scoped down than those normally required for the\ndeployment of CDKTF applications. It is therefore recommended to not reuse the same set of credentials,\nand instead create a scoped down `ReadOnly` role dedicated for cdk8s resolvers.\n\nFollowing are the set of commands the resolver will execute:\n\n- [`cdktf output`](https://developer.hashicorp.com/terraform/cdktf/cli-reference/commands#output)\n\n## Cross Repository Workflow\n\nAs we've seen, your `cdk8s` application needs access to the objects defined in your cloud application. If both applications\nare defined within the same file, this is trivial to achieve. If they are in different files, a simple `import` statement will suffice.\nHowever, what if the applications are managed in two separate repositories? This makes it a little trickier, but still possible.\n\nIn this scenario, `cdktf.ts` in the CDKTF application, stored in a dedicated repository.\n\n```ts\nimport * as tf from \"cdktf\";\nimport * as aws from \"@cdktf/provider-aws\";\n\nimport { CdkTfResolver } from '@cdk8s/cdktf-resolver';\n\nconst awsApp = new tf.App();\nconst stack = new tf.TerraformStack(awsApp, 'aws');\n\nconst bucket = new aws.s3Bucket.S3Bucket(stack, 'Bucket');\nconst bucketName = new tf.TerraformOutput(constrcut, 'BucketName', {\n  value: bucket.bucket,\n});\n\nawsApp.synth();\n```\n\nIn order for the `cdk8s` application to have cross repository access, the CDKTF object instances\nthat we want to expose need to be available via a package repository. To do this, break up the\nCDKTF application into the following files:\n\n`app.ts`\n\n```ts\nimport * as tf from \"cdktf\";\nimport * as aws from \"@cdktf/provider-aws\";\n\nimport { CdkTfResolver } from '@cdk8s/cdktf-resolver';\n\nconst awsApp = new tf.App();\nconst stack = new tf.TerraformStack(awsApp, 'aws');\n\nconst bucket = new aws.s3Bucket.S3Bucket(stack, 'Bucket');\n// export the thing we want to have available for cdk8s applications\nexport const bucketName = new tf.TerraformOutput(constrcut, 'BucketName', {\n  value: bucket.bucket,\n});\n\n// note that we don't call awsApp.synth here\n```\n\n`main.ts`\n\n```ts\nimport { awsApp } from './app.ts'\n\nawsApp.synth();\n```\n\nNow, publish the `app.ts` file to a package manager, so that your `cdk8s` application can install and import it.\nThis approach might be somewhat counter intuitive, because normally we only publish classes to the package manager,\nnot instances. Indeed, these types of applications introduce a new use-case that requires the sharing of instances.\nConceptually, this is no different than writing state<sup>*</sup> to an SSM parameter or an S3 bucket, and it allows us to remain\nin the boundaries of our programming language, and the typing guarantees it provides.\n\n> <sup>*</sup> Actually, we are only publishing instructions for fetching state, not the state itself.\n\nAssuming `app.ts` was published as the `my-cdktf-app` package, our `cdk8s` application will now look like so:\n\n```ts\nimport * as k8s from 'cdk8s';\nimport * as kplus from 'cdk8s-plus-27';\n\n// import the desired instance from the CDKTF app.\nimport { bucketName } from 'my-cdktf-app';\n\nimport { CdkTfResolver } from '@cdk8s/cdktf-resolver';\n\nconst k8sApp = new k8s.App({ resolvers: [new CdkTfResolver()] });\nconst manifest = new k8s.Chart(k8sApp, 'Manifest');\n\nnew kplus.CronJob(manifest, 'CronJob', {\n  schedule: k8s.Cron.daily(),\n  containers: [{\n    image: 'job',\n    envVariables: {\n      // directly passing the value of the `TerraformOutput` containing\n      // the deploy time bucket name\n      BUCKET_NAME: kplus.EnvValue.fromValue(bucketName.value),\n    }\n }]\n});\n\nk8sApp.synth();\n```"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cdk8s-team/cdk8s-cdktf-resolver.git"
+  },
+  "schema": "jsii/0.10.0",
+  "targets": {
+    "dotnet": {
+      "namespace": "Org.Cdk8s.CdktfResolver",
+      "packageId": "Org.Cdk8s.CdktfResolver"
+    },
+    "go": {
+      "moduleName": "github.com/cdk8s-team/cdk8s-cdktf-resolver-go"
+    },
+    "java": {
+      "maven": {
+        "artifactId": "cdk8s-cdktf-resolver",
+        "groupId": "org.cdk8s"
+      },
+      "package": "org.cdk8s.cdktfresolver"
+    },
+    "js": {
+      "npm": "@cdk8s/cdktf-resolver"
+    },
+    "python": {
+      "distName": "cdk8s-cdktf-resolver",
+      "module": "cdk8s_cdktf_resolver"
+    }
+  },
+  "types": {
+    "@cdk8s/cdktf-resolver.CdktfResolver": {
+      "assembly": "@cdk8s/cdktf-resolver",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@cdk8s/cdktf-resolver.CdktfResolver",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/resolve.ts",
+          "line": 22
+        },
+        "parameters": [
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@cdk8s/cdktf-resolver.CdktfResolverProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "cdk8s.IResolver"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/resolve.ts",
+        "line": 16
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "To replace a value, implementations must invoke `context.replaceValue`.",
+            "stability": "stable",
+            "summary": "This function is invoked on every property during cdk8s synthesis."
+          },
+          "locationInModule": {
+            "filename": "src/resolve.ts",
+            "line": 26
+          },
+          "name": "resolve",
+          "overrides": "cdk8s.IResolver",
+          "parameters": [
+            {
+              "name": "context",
+              "type": {
+                "fqn": "cdk8s.ResolutionContext"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "CdktfResolver",
+      "symbolId": "src/resolve:CdktfResolver"
+    },
+    "@cdk8s/cdktf-resolver.CdktfResolverProps": {
+      "assembly": "@cdk8s/cdktf-resolver",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@cdk8s/cdktf-resolver.CdktfResolverProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/resolve.ts",
+        "line": 8
+      },
+      "name": "CdktfResolverProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The CDKTF App instance in which the outputs are deinfed in."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/resolve.ts",
+            "line": 13
+          },
+          "name": "app",
+          "type": {
+            "fqn": "cdktf.App"
+          }
+        }
+      ],
+      "symbolId": "src/resolve:CdktfResolverProps"
+    }
+  },
+  "version": "0.0.0",
+  "fingerprint": "FqZZC54xY//nsfG/k9EjjuRj+gHkWDBkzDoTrH7BJnU="
+}

package/.projenrc.ts

@@ -0,0 +1,59 @@
+import { Cdk8sTeamJsiiProject } from '@cdk8s/projen-common';
+import { NpmAccess } from 'projen/lib/javascript';
+const project = new Cdk8sTeamJsiiProject({
+  defaultReleaseBranch: 'main',
+  name: '@cdk8s/cdktf-resolver',
+  projenrcTs: true,
+  release: true,
+  devDeps: ['@cdk8s/projen-common', 'cdktf-cli', 'cdk8s-cli', '@cdktf/provider-aws', 'fs-extra', '@types/fs-extra'],
+  peerDeps: ['cdktf', 'cdk8s', 'constructs'],
+  jsiiVersion: '^5',
+  releaseWorkflowSetupSteps: [
+    {
+      uses: 'aws-actions/configure-aws-credentials@v3',
+      with: {
+        'aws-region': 'us-east-1',
+        'role-to-assume': '${{ secrets.AWS_ROLE_TO_ASSUME }}',
+        'role-session-name': 'cdk8s-awscdk-resolver-release',
+      },
+    },
+    {
+      name: 'Install terraform | GPG',
+      run: 'wget -O- https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg',
+    },
+    {
+      name: 'Install terraform | Sources',
+      run: 'echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hashicorp.list',
+    },
+    {
+      name: 'Install terraform | Binary',
+      run: 'sudo apt update && sudo apt install terraform',
+    },
+  ],
+  npmAccess: NpmAccess.PUBLIC,
+});
+
+// ignore integ tests because we will add a dedicated task
+// for them that only runs on release
+project.jest?.addIgnorePattern('/test/integ/');
+
+const integTask = project.addTask('integ');
+integTask.exec(jest('integ/integ.test.ts'));
+
+// run integ on release.
+// we don't run it on each PR because it brings security and operational
+// issues which are not worth the effort at this moment.
+const releaseTask = project.tasks.tryFind('release')!;
+releaseTask.exec(`npx projen ${integTask.name}`);
+
+// required for OIDC authentication
+const releaseWorkflow = project.tryFindObjectFile('.github/workflows/release.yml');
+releaseWorkflow!.addOverride('jobs.release.permissions.id-token', 'write');
+
+project.synth();
+
+function jest(args: string) {
+  // we override 'testPathIgnorePatterns' and 'testMatch' so that it matches only integration tests
+  // see https://github.com/jestjs/jest/issues/7914
+  return `jest --verbose --testMatch "<rootDir>/test/integ/**/*.test.ts" --testPathIgnorePatterns "/node_modules/" --passWithNoTests --all --updateSnapshot --coverageProvider=v8 ${args}`;
+};

package/API.md

@@ -0,0 +1,249 @@
+# CDK For Terraform Resolver
+
+The `CdkTfResolver` is able to resolve any [`TerraformOutput`](https://developer.hashicorp.com/terraform/cdktf/concepts/variables-and-outputs#output-values)
+defined by your CDKTF application. In this example, we create an S3 `Bucket` with the CDKTF, and pass its (deploy time generated)
+name as an environment variable to a Kubernetes `CronJob` resource.
+
+```ts
+import * as tf from "cdktf";
+import * as aws from "@cdktf/provider-aws";
+import * as k8s from 'cdk8s';
+import * as kplus from 'cdk8s-plus-26';
+
+import { CdkTfResolver } from '@cdk8s/cdktf-resolver';
+
+const awsApp = new tf.App();
+const stack = new tf.TerraformStack(awsApp, 'aws');
+
+const k8sApp = new k8s.App({ resolvers: [new CdkTfResolver()] });
+const manifest = new k8s.Chart(k8sApp, 'Manifest', { resolver });
+
+const bucket = new aws.s3Bucket.S3Bucket(stack, 'Bucket');
+const bucketName = new tf.TerraformOutput(constrcut, 'BucketName', {
+  value: bucket.bucket,
+});
+
+new kplus.CronJob(manifest, 'CronJob', {
+  schedule: k8s.Cron.daily(),
+  containers: [{
+    image: 'job',
+    envVariables: {
+      // directly passing the value of the `TerraformOutput` containing
+      // the deploy time bucket name
+      BUCKET_NAME: kplus.EnvValue.fromValue(bucketName.value),
+    }
+ }]
+});
+
+awsApp.synth();
+k8sApp.synth();
+```
+
+During cdk8s synthesis, the custom resolver will detect that `bucketName.value` is not a concrete value,
+but rather a value of a `TerraformOutput`. It will then perform `cdktf` CLI commands in order to fetch the
+actual value from the deployed infrastructure in your account. This means that in order
+for `cdk8s synth` to succeed, it must be executed *after* the CDKTF resources
+have been deployed. So your deployment workflow should (conceptually) be:
+
+1. `cdktf deploy`
+2. `cdk8s synth`
+
+> Note that the `CdkTfResolver` is **only** able to fetch tokens that have a `TerraformOutput` defined for them.
+
+##### Permissions
+
+Since running `cdk8s synth` will now require reading terraform outputs, it must have permissions to do so.
+In case a remote state file is used, this means providing a set of credentials for the account that have access
+to where the state is stored. This will vary depending on your cloud provider, but in most cases will involve giving
+read permissions on a blob storage device (e.g S3 bucket).
+
+Note that the permissions cdk8s require are far more scoped down than those normally required for the
+deployment of CDKTF applications. It is therefore recommended to not reuse the same set of credentials,
+and instead create a scoped down `ReadOnly` role dedicated for cdk8s resolvers.
+
+Following are the set of commands the resolver will execute:
+
+- [`cdktf output`](https://developer.hashicorp.com/terraform/cdktf/cli-reference/commands#output)
+
+## Cross Repository Workflow
+
+As we've seen, your `cdk8s` application needs access to the objects defined in your cloud application. If both applications
+are defined within the same file, this is trivial to achieve. If they are in different files, a simple `import` statement will suffice.
+However, what if the applications are managed in two separate repositories? This makes it a little trickier, but still possible.
+
+In this scenario, `cdktf.ts` in the CDKTF application, stored in a dedicated repository.
+
+```ts
+import * as tf from "cdktf";
+import * as aws from "@cdktf/provider-aws";
+
+import { CdkTfResolver } from '@cdk8s/cdktf-resolver';
+
+const awsApp = new tf.App();
+const stack = new tf.TerraformStack(awsApp, 'aws');
+
+const bucket = new aws.s3Bucket.S3Bucket(stack, 'Bucket');
+const bucketName = new tf.TerraformOutput(constrcut, 'BucketName', {
+  value: bucket.bucket,
+});
+
+awsApp.synth();
+```
+
+In order for the `cdk8s` application to have cross repository access, the CDKTF object instances
+that we want to expose need to be available via a package repository. To do this, break up the
+CDKTF application into the following files:
+
+`app.ts`
+
+```ts
+import * as tf from "cdktf";
+import * as aws from "@cdktf/provider-aws";
+
+import { CdkTfResolver } from '@cdk8s/cdktf-resolver';
+
+const awsApp = new tf.App();
+const stack = new tf.TerraformStack(awsApp, 'aws');
+
+const bucket = new aws.s3Bucket.S3Bucket(stack, 'Bucket');
+// export the thing we want to have available for cdk8s applications
+export const bucketName = new tf.TerraformOutput(constrcut, 'BucketName', {
+  value: bucket.bucket,
+});
+
+// note that we don't call awsApp.synth here
+```
+
+`main.ts`
+
+```ts
+import { awsApp } from './app.ts'
+
+awsApp.synth();
+```
+
+Now, publish the `app.ts` file to a package manager, so that your `cdk8s` application can install and import it.
+This approach might be somewhat counter intuitive, because normally we only publish classes to the package manager,
+not instances. Indeed, these types of applications introduce a new use-case that requires the sharing of instances.
+Conceptually, this is no different than writing state<sup>*</sup> to an SSM parameter or an S3 bucket, and it allows us to remain
+in the boundaries of our programming language, and the typing guarantees it provides.
+
+> <sup>*</sup> Actually, we are only publishing instructions for fetching state, not the state itself.
+
+Assuming `app.ts` was published as the `my-cdktf-app` package, our `cdk8s` application will now look like so:
+
+```ts
+import * as k8s from 'cdk8s';
+import * as kplus from 'cdk8s-plus-27';
+
+// import the desired instance from the CDKTF app.
+import { bucketName } from 'my-cdktf-app';
+
+import { CdkTfResolver } from '@cdk8s/cdktf-resolver';
+
+const k8sApp = new k8s.App({ resolvers: [new CdkTfResolver()] });
+const manifest = new k8s.Chart(k8sApp, 'Manifest');
+
+new kplus.CronJob(manifest, 'CronJob', {
+  schedule: k8s.Cron.daily(),
+  containers: [{
+    image: 'job',
+    envVariables: {
+      // directly passing the value of the `TerraformOutput` containing
+      // the deploy time bucket name
+      BUCKET_NAME: kplus.EnvValue.fromValue(bucketName.value),
+    }
+ }]
+});
+
+k8sApp.synth();
+```
+# API Reference <a name="API Reference" id="api-reference"></a>
+
+
+## Structs <a name="Structs" id="Structs"></a>
+
+### CdktfResolverProps <a name="CdktfResolverProps" id="@cdk8s/cdktf-resolver.CdktfResolverProps"></a>
+
+#### Initializer <a name="Initializer" id="@cdk8s/cdktf-resolver.CdktfResolverProps.Initializer"></a>
+
+```typescript
+import { CdktfResolverProps } from '@cdk8s/cdktf-resolver'
+
+const cdktfResolverProps: CdktfResolverProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@cdk8s/cdktf-resolver.CdktfResolverProps.property.app">app</a></code> | <code>cdktf.App</code> | The CDKTF App instance in which the outputs are deinfed in. |
+
+---
+
+##### `app`<sup>Required</sup> <a name="app" id="@cdk8s/cdktf-resolver.CdktfResolverProps.property.app"></a>
+
+```typescript
+public readonly app: App;
+```
+
+- *Type:* cdktf.App
+
+The CDKTF App instance in which the outputs are deinfed in.
+
+---
+
+## Classes <a name="Classes" id="Classes"></a>
+
+### CdktfResolver <a name="CdktfResolver" id="@cdk8s/cdktf-resolver.CdktfResolver"></a>
+
+- *Implements:* cdk8s.IResolver
+
+#### Initializers <a name="Initializers" id="@cdk8s/cdktf-resolver.CdktfResolver.Initializer"></a>
+
+```typescript
+import { CdktfResolver } from '@cdk8s/cdktf-resolver'
+
+new CdktfResolver(props: CdktfResolverProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@cdk8s/cdktf-resolver.CdktfResolver.Initializer.parameter.props">props</a></code> | <code><a href="#@cdk8s/cdktf-resolver.CdktfResolverProps">CdktfResolverProps</a></code> | *No description.* |
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@cdk8s/cdktf-resolver.CdktfResolver.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@cdk8s/cdktf-resolver.CdktfResolverProps">CdktfResolverProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@cdk8s/cdktf-resolver.CdktfResolver.resolve">resolve</a></code> | This function is invoked on every property during cdk8s synthesis. |
+
+---
+
+##### `resolve` <a name="resolve" id="@cdk8s/cdktf-resolver.CdktfResolver.resolve"></a>
+
+```typescript
+public resolve(context: ResolutionContext): void
+```
+
+This function is invoked on every property during cdk8s synthesis.
+
+To replace a value, implementations must invoke `context.replaceValue`.
+
+###### `context`<sup>Required</sup> <a name="context" id="@cdk8s/cdktf-resolver.CdktfResolver.resolve.parameter.context"></a>
+
+- *Type:* cdk8s.ResolutionContext
+
+---
+
+
+
+
+

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+The cdk8s project follows the [CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

package/DCO

@@ -0,0 +1,34 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.