cdk8s-aws-cdk 0.0.5

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,201 @@
+# cdk8s-aws-cdk
+
+AWS CDK Adapter for cdk8s allows you to define AWS CDK constructs within a cdk8s application.
+The AWS resources will be provisioned using the [AWS Controllers for Kubernetes](https://aws-controllers-k8s.github.io/community/docs/community/overview/).
+
+## DO NOT USE THIS IN PRODUCTION
+
+This project is in very early alpha stages of development and is subject to frequent breaking changes.
+
+## Pre-requisites
+
+In you Kubernetes cluster, [install the appropriate ACK controllers](https://aws-controllers-k8s.github.io/community/docs/user-docs/install/),
+depending on which resources you want to provision.
+
+## Getting Started
+
+Install the adapter and the AWS CDK in your cdk8s project.
+
+```console
+npm install cdk8s-aws-cdk aws-cdk-lib
+```
+
+The adapter provides a special `Chart`, that allows defining AWS CDK resources. You must extend this chart,
+in place of the normal `cdk8s.Chart` object.
+
+```ts
+import * as awscdkadapter from 'cdk8s-aws-cdk'
+import * as k from 'cdk8s';
+import * as kplus from 'cdk8s-plus-24';
+import { aws_s3 as s3 } from 'aws-cdk-lib';
+
+export class MyChart extends awscdkadapter.Chart {
+
+  constructor(scope: Construct, id: string, props: k.ChartProps = {}) {
+    super(scope, id, props);
+
+    // define an s3 bucket with aws-cdk
+    new s3.Bucket(this, 'Bucket');
+
+    // define a kubernetes deployment with cdk8s+
+    new kplus.Deployment(this, 'Deployment', {
+      containers: [{ image: 'image' }],
+    });
+
+  }
+
+}
+```
+
+Synthesizing this chart will produce:
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: s3sample-deployment-c828e7a5
+spec:
+  minReadySeconds: 0
+  progressDeadlineSeconds: 600
+  replicas: 1
+  selector:
+    matchLabels:
+      cdk8s.io/metadata.addr: S3Sample-Deployment-c8c2c08d
+  strategy:
+    rollingUpdate:
+      maxSurge: 25%
+      maxUnavailable: 25%
+    type: RollingUpdate
+  template:
+    metadata:
+      labels:
+        cdk8s.io/metadata.addr: S3Sample-Deployment-c8c2c08d
+    spec:
+      automountServiceAccountToken: true
+      containers:
+        - image: image
+          imagePullPolicy: Always
+          name: main
+          securityContext:
+            privileged: false
+            readOnlyRootFilesystem: false
+            runAsNonRoot: false
+      dnsPolicy: ClusterFirst
+      securityContext:
+        fsGroupChangePolicy: Always
+        runAsNonRoot: false
+      setHostnameAsFQDN: false
+---
+apiVersion: s3.services.k8s.aws/v1alpha1
+kind: Bucket
+metadata:
+  name: s3sample-bucket83908e77-c80d1127
+spec:
+  name: s3sample-bucket83908e77-c80d1127
+```
+
+You can then apply this manifest to the cluster by any means.
+
+## Limitations
+
+The are quite a few limitations at the moment.
+
+### Resource Coverage
+
+There are two layers of resource coverage that are involved in the process:
+
+#### ACK Resources
+
+The adapter maps every AWS CDK resource to its corresponding ACK resource.
+This means resources that aren't currently supported by ACK cannot be defined.
+
+#### Adapter Mappers
+
+For resources that are supported by ACK, this adapter contains [mappers](./src/mappers/) that
+can do the translation. Not all supported resources have been mapped yet, the built-in mapped resources are:
+
+- EC2 Security Group
+- IAM Policy
+- IAM Role
+- Lambda Function
+- RDS DB Instance
+- RDS Subnet Group
+- S3 Bucket
+
+If your application contains additional resources, that are supported by ACK but haven't been mapped by the adapter, you
+can register customer mappers:
+
+First you implement a custom mapper:
+
+```ts
+import * as awscdkadapter from 'cdk8s-aws-cdk'
+
+export class KmsKeyMapper extends awscdkadapter.CloudFormationResourceMapper {
+
+  /**
+   * @see CloudFormationResourceMapper.type
+   */
+  public readonly type: string = 'AWS::KMS::Key';
+
+  // implement the additional required methods and properties
+  ...
+}
+```
+
+Then you register it:
+
+```ts
+import * as awscdkadapter from 'cdk8s-aws-cdk'
+import * as k from 'cdk8s';
+import { aws_kms as kms } from 'aws-cdk-lib';
+
+export class MyChart extends awscdkadapter.Chart {
+
+  constructor(scope: Construct, id: string, props: k.ChartProps = {}) {
+    super(scope, id, props);
+
+    this.registerMapper(new KmsKeyMapper(this))
+
+    // now you can define a kms key
+    new kms.Key(this, 'Key');
+
+  }
+
+}
+```
+
+### Attributes
+
+CDK Tokens that represent CloudFormation attributes (i.e `Fn::GetAttr`) can be used as Kubernetes environment variables
+when defining containers, but **they cannot be used for anything else**.
+
+For example, you can pass an attribute to a container like so:
+
+```ts
+const dbInstance = new rds.DatabaseInstance(...);
+const container = deployment.addContainer(...);
+
+container.env.addVariable('DB_ADDRESS', kplus.EnvValue.fromValue(dbInstance.dbInstanceEndpointAddress))
+```
+
+But you **cannot** pass the same attribute to, for example, lambda function environment variables:
+
+```ts
+const dbInstance = new rds.DatabaseInstance(...);
+const func = new lambda.Function(...);
+
+func.addEnvironment('DB_ADDRESS', dbInstance.dbInstanceEndpointAddress);
+```
+
+This is because attribute mapping is implemented by exporting them
+using [ACK Field Exports](https://aws-controllers-k8s.github.io/community/docs/user-docs/field-export/).
+These field exports can only be imported in a select number of resources, and currently the adapter only supports
+kubernetes environment variables.
+
+### Assets
+
+AWS CDK assets are currently not supported.
+
+## Examples
+
+- [Kubernetes deployment that writes to an RDS PostgreSQL database](./examples/rds-db-instance/).

package/changelog.md

@@ -0,0 +1,2 @@
+
+### [0.0.5](https://github.com/cdk8s-team/cdk8s-aws-cdk/compare/v0.0.4...v0.0.5) (2022-05-26)

package/examples/rds-db-instance/cdk.out/RdsDBInstanceStack.assets.json

@@ -0,0 +1,19 @@
+{
+  "version": "19.0.0",
+  "files": {
+    "c537ecb04ef38f43b566cad1cbb335a9c9c4762b4aa36157a74ef158a3e64673": {
+      "source": {
+        "path": "RdsDBInstanceStack.template.json",
+        "packaging": "file"
+      },
+      "destinations": {
+        "current_account-current_region": {
+          "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
+          "objectKey": "c537ecb04ef38f43b566cad1cbb335a9c9c4762b4aa36157a74ef158a3e64673.json",
+          "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
+        }
+      }
+    }
+  },
+  "dockerImages": {}
+}

package/examples/rds-db-instance/cdk.out/RdsDBInstanceStack.template.json

@@ -0,0 +1,86 @@
+{
+ "Resources": {
+  "PostgreSQLDatabaseInstanceSubnetGroup3673DBAE": {
+   "Type": "AWS::RDS::DBSubnetGroup",
+   "Properties": {
+    "DBSubnetGroupDescription": "Subnet group for DatabaseInstance database",
+    "SubnetIds": [
+     "subnet-065321f51cb2ac562",
+     "subnet-0d72f4230848972e9"
+    ]
+   }
+  },
+  "PostgreSQLDatabaseInstanceECD6DE4B": {
+   "Type": "AWS::RDS::DBInstance",
+   "Properties": {
+    "DBInstanceClass": "db.m5.large",
+    "AllocatedStorage": "100",
+    "CopyTagsToSnapshot": true,
+    "DBSubnetGroupName": {
+     "Ref": "PostgreSQLDatabaseInstanceSubnetGroup3673DBAE"
+    },
+    "Engine": "postgres",
+    "MasterUsername": "postgres",
+    "MasterUserPassword": "password",
+    "StorageType": "gp2",
+    "VPCSecurityGroups": [
+     "sg-022f93d53709f83b2"
+    ]
+   },
+   "UpdateReplacePolicy": "Snapshot",
+   "DeletionPolicy": "Snapshot"
+  }
+ },
+ "Outputs": {
+  "PostgreSQLAddress": {
+   "Value": {
+    "Fn::GetAtt": [
+     "PostgreSQLDatabaseInstanceECD6DE4B",
+     "Endpoint.Address"
+    ]
+   }
+  },
+  "PostgreSQLPort": {
+   "Value": {
+    "Fn::GetAtt": [
+     "PostgreSQLDatabaseInstanceECD6DE4B",
+     "Endpoint.Port"
+    ]
+   }
+  }
+ },
+ "Parameters": {
+  "BootstrapVersion": {
+   "Type": "AWS::SSM::Parameter::Value<String>",
+   "Default": "/cdk-bootstrap/hnb659fds/version",
+   "Description": "Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]"
+  }
+ },
+ "Rules": {
+  "CheckBootstrapVersion": {
+   "Assertions": [
+    {
+     "Assert": {
+      "Fn::Not": [
+       {
+        "Fn::Contains": [
+         [
+          "1",
+          "2",
+          "3",
+          "4",
+          "5"
+         ],
+         {
+          "Ref": "BootstrapVersion"
+         }
+        ]
+       }
+      ]
+     },
+     "AssertDescription": "CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI."
+    }
+   ]
+  }
+ }
+}

package/examples/rds-db-instance/cdk.out/cdk.out

@@ -0,0 +1 @@
+{"version":"19.0.0"}