@cdk8s/awscdk-resolver 0.0.153 → 0.0.155

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -3585,7 +3585,7 @@
3585
3585
  "stability": "stable"
3586
3586
  },
3587
3587
  "homepage": "https://github.com/cdk8s-team/cdk8s-awscdk-resolver.git",
3588
- "jsiiVersion": "5.5.0 (build b69ed87)",
3588
+ "jsiiVersion": "5.5.1 (build 91e7053)",
3589
3589
  "license": "Apache-2.0",
3590
3590
  "metadata": {
3591
3591
  "jsii": {
@@ -3674,6 +3674,6 @@
3674
3674
  "symbolId": "src/resolve:AwsCdkResolver"
3675
3675
  }
3676
3676
  },
3677
- "version": "0.0.153",
3678
- "fingerprint": "IwxJkXNSRenZ89FxmokHQQ/TgM+9+OBZbd+iB096gQE="
3677
+ "version": "0.0.155",
3678
+ "fingerprint": "okvD04A2Mz1su0EdSsFt61jfMkbQlyCogGYkCzKe2J8="
3679
3679
  }
package/API.md CHANGED
@@ -1,151 +1,3 @@
1
- # AWS CDK Resolver
2
-
3
- The `AwsCdkResolver` is able to resolve any [`CfnOutput`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnOutput.html)
4
- defined by your AWS CDK application. In this example, we create an S3 `Bucket` with the AWS CDK, and pass its (deploy time generated)
5
- name as an environment variable to a Kubernetes `CronJob` resource.
6
-
7
- ```ts
8
- import * as aws from 'aws-cdk-lib';
9
- import * as k8s from 'cdk8s';
10
- import * as kplus from 'cdk8s-plus-27';
11
-
12
- import { AwsCdkResolver } from '@cdk8s/awscdk-resolver';
13
-
14
- const awsApp = new aws.App();
15
- const stack = new aws.Stack(awsApp, 'aws');
16
-
17
- const k8sApp = new k8s.App({ resolvers: [new AwsCdkResolver()] });
18
- const manifest = new k8s.Chart(k8sApp, 'Manifest');
19
-
20
- const bucket = new aws.aws_s3.Bucket(stack, 'Bucket');
21
- const bucketName = new aws.CfnOutput(stack, 'BucketName', {
22
- value: bucket.bucketName,
23
- });
24
-
25
- new kplus.CronJob(manifest, 'CronJob', {
26
- schedule: k8s.Cron.daily(),
27
- containers: [{
28
- image: 'job',
29
- envVariables: {
30
- // directly passing the value of the `CfnOutput` containing
31
- // the deploy time bucket name
32
- BUCKET_NAME: kplus.EnvValue.fromValue(bucketName.value),
33
- }
34
- }]
35
- });
36
-
37
- awsApp.synth();
38
- k8sApp.synth();
39
- ```
40
-
41
- During cdk8s synthesis, the custom resolver will detect that `bucketName.value` is not a concrete value,
42
- but rather a value of a `CfnOutput`. It will then perform AWS service calls in order to fetch the
43
- actual value from the deployed infrastructure in your account. This means that in order
44
- for `cdk8s synth` to succeed, it must be executed *after* the AWS CDK resources
45
- have been deployed. So your deployment workflow should (conceptually) be:
46
-
47
- 1. `cdk deploy`
48
- 2. `cdk8s synth`
49
-
50
- > Note that the `AwsCdkResolver` is **only** able to fetch tokens that have a `CfnOutput` defined for them.
51
-
52
- ##### Permissions
53
-
54
- Since running `cdk8s synth` will now require performing AWS service calls, it must have access
55
- to a set of AWS credentials. Following are the set of actions the credentials must allow:
56
-
57
- - `cloudformation:DescribeStacks`
58
-
59
- Note that the actions cdk8s require are far more scoped down than those normally required for the
60
- deployment of AWS CDK applications. It is therefore recommended to not reuse the same set of credentials,
61
- and instead create a scoped down `ReadOnly` role dedicated for cdk8s resolvers.
62
-
63
- ## Cross Repository Workflow
64
-
65
- As we've seen, your `cdk8s` application needs access to the objects defined in your cloud application. If both applications
66
- are defined within the same file, this is trivial to achieve. If they are in different files, a simple `import` statement will suffice.
67
- However, what if the applications are managed in two separate repositories? This makes it a little trickier, but still possible.
68
-
69
- In this scenario, `cdk.ts` in the AWS CDK application, stored in a dedicated repository.
70
-
71
- ```ts
72
- import * as aws from 'aws-cdk-lib';
73
-
74
- const awsApp = new aws.App();
75
- const stack = new aws.Stack(awsApp, 'aws');
76
-
77
- const bucket = new aws.aws_s3.Bucket(stack, 'Bucket');
78
- const bucketName = new aws.CfnOutput(stack, 'BucketName', {
79
- value: bucket.bucketName,
80
- });
81
-
82
- awsApp.synth();
83
- ```
84
-
85
- In order for the `cdk8s` application to have cross repository access, the AWS CDK object instances that we want to expose need to be available
86
- via a package repository. To do this, break up the AWS CDK application into the following files:
87
-
88
- `app.ts`
89
-
90
- ```ts
91
- import * as aws from 'aws-cdk-lib';
92
-
93
- const awsApp = new aws.App();
94
- const stack = new aws.Stack(awsApp, 'aws');
95
-
96
- const bucket = new aws.aws_s3.Bucket(stack, 'Bucket');
97
- // export the thing we want to have available for cdk8s applications
98
- export const bucketName = new aws.CfnOutput(stack, 'BucketName', {
99
- value: bucket.bucketName,
100
- });
101
-
102
- // note that we don't call awsApp.synth here
103
- ```
104
-
105
- `main.ts`
106
-
107
- ```ts
108
- import { awsApp } from './app.ts'
109
-
110
- awsApp.synth();
111
- ```
112
-
113
- Now, publish the `app.ts` file to a package manager, so that your `cdk8s` application can install and import it.
114
- This approach might be somewhat counter intuitive, because normally we only publish classes to the package manager,
115
- not instances. Indeed, these types of applications introduce a new use-case that requires the sharing of instances.
116
- Conceptually, this is no different than writing state<sup>*</sup> to an SSM parameter or an S3 bucket, and it allows us to remain
117
- in the boundaries of our programming language, and the typing guarantees it provides.
118
-
119
- > <sup>*</sup> Actually, we are only publishing instructions for fetching state, not the state itself.
120
-
121
- Assuming `app.ts` was published as the `my-cdk-app` package, our `cdk8s` application will now look like so:
122
-
123
- ```ts
124
- import * as k8s from 'cdk8s';
125
- import * as kplus from 'cdk8s-plus-27';
126
-
127
- // import the desired instance from the AWS CDK app.
128
- import { bucketName } from 'my-cdk-app';
129
-
130
- import { AwsCdkResolver } from '@cdk8s/awscdk-resolver';
131
-
132
- const k8sApp = new k8s.App({ resolvers: [new AwsCdkResolver()] });
133
- const manifest = new k8s.Chart(k8sApp, 'Manifest');
134
-
135
- new kplus.CronJob(manifest, 'CronJob', {
136
- schedule: k8s.Cron.daily(),
137
- containers: [{
138
- image: 'job',
139
- envVariables: {
140
- // directly passing the value of the `CfnOutput` containing
141
- // the deploy time bucket name
142
- BUCKET_NAME: kplus.EnvValue.fromValue(bucketName.value),
143
- }
144
- }]
145
- });
146
-
147
- k8sApp.synth();
148
- ```
149
1
  # API Reference <a name="API Reference" id="api-reference"></a>
150
2
 
151
3
 
package/lib/resolve.js CHANGED
@@ -61,5 +61,5 @@ class AwsCdkResolver {
61
61
  }
62
62
  exports.AwsCdkResolver = AwsCdkResolver;
63
63
  _a = JSII_RTTI_SYMBOL_1;
64
- AwsCdkResolver[_a] = { fqn: "@cdk8s/awscdk-resolver.AwsCdkResolver", version: "0.0.153" };
64
+ AwsCdkResolver[_a] = { fqn: "@cdk8s/awscdk-resolver.AwsCdkResolver", version: "0.0.155" };
65
65
  //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVzb2x2ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9yZXNvbHZlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsaURBQTZDO0FBQzdDLDZCQUE2QjtBQUM3Qiw2Q0FBK0U7QUFJL0UsTUFBYSxjQUFjO0lBRWxCLE9BQU8sQ0FBQyxPQUEwQjtRQUV2QyxJQUFJLENBQUMsbUJBQUssQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDdkMsT0FBTztRQUNULENBQUM7UUFFRCxJQUFJLE9BQU8sT0FBTyxDQUFDLEtBQUssS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUN0QywrREFBK0Q7WUFDL0QsbUJBQW1CO1lBQ25CLE1BQU0sSUFBSSxLQUFLLENBQUMsdUJBQXVCLE9BQU0sQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLHNCQUFzQixDQUFDLENBQUM7UUFDdEYsQ0FBQztRQUVELE1BQU0sTUFBTSxHQUFHLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQzlDLElBQUksQ0FBQztZQUNILE1BQU0sV0FBVyxHQUFHLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUNsRCxPQUFPLENBQUMsWUFBWSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQ3BDLENBQUM7UUFBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO1lBQ2IsMkVBQTJFO1lBQzNFLGtFQUFrRTtZQUNsRSwyRUFBMkU7WUFDM0UsK0VBQStFO1lBQy9FLCtDQUErQztZQUMvQyxPQUFPLENBQUMsWUFBWSxDQUFDLG9DQUFvQyxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksS0FBSyxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQ3ZGLENBQUM7SUFFSCxDQUFDO0lBRU8sVUFBVSxDQUFDLEtBQWE7UUFFOUIsTUFBTSxlQUFlLEdBQVksRUFBRSxDQUFDO1FBRXBDLEtBQUssTUFBTSxLQUFLLElBQUksMEJBQVksQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDN0QsSUFBSSx1QkFBUyxDQUFDLFdBQVcsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDO2dCQUNqQyxNQUFNLEtBQUssR0FBRyxtQkFBSyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUM7Z0JBQ3JDLGVBQWUsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7Z0JBQzVCLE1BQU0sTUFBTSxHQUFHLEtBQUssQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxZQUFZLHVCQUFTLElBQUksQ0FBQyxDQUFDLEtBQUssS0FBSyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQWMsQ0FBQztnQkFDN0csa0ZBQWtGO2dCQUNsRix3REFBd0Q7Z0JBQ3hELElBQUksTUFBTTtvQkFBRSxPQUFPLE1BQU0sQ0FBQztZQUM1QixDQUFDO1FBQ0gsQ0FBQztRQUVELDZCQUE2QjtRQUM3Qiw2QkFBNkI7UUFDN0Isb0NBQW9DO1FBQ3BDLG9GQUFvRjtRQUNwRiwrREFBK0Q7UUFDL0QsTUFBTSxJQUFJLEtBQUssQ0FBQyxxQ0FBcUMsS0FBSyx1QkFBdUIsZUFBZSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBRXZJLENBQUM7SUFFTyxnQkFBZ0IsQ0FBQyxNQUFpQjtRQUV4QyxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLHVCQUF1QixDQUFDLENBQUM7UUFDMUUsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUEsNEJBQVksRUFBQyxPQUFPLENBQUMsUUFBUSxFQUFFO1lBQy9DLE1BQU07WUFDTixtQkFBSyxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxTQUFTO1lBQzFCLE1BQU0sQ0FBQyxJQUFJLENBQUMsRUFBRTtTQUNmLEVBQUUsRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBRWhFLENBQUM7O0FBOURILHdDQWdFQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IGV4ZWNGaWxlU3luYyB9IGZyb20gJ2NoaWxkX3Byb2Nlc3MnO1xuaW1wb3J0ICogYXMgcGF0aCBmcm9tICdwYXRoJztcbmltcG9ydCB7IFRva2VuLCBTdGFjaywgVG9rZW5pemF0aW9uLCBSZWZlcmVuY2UsIENmbk91dHB1dCB9IGZyb20gJ2F3cy1jZGstbGliJztcbmltcG9ydCB7IElSZXNvbHZlciwgUmVzb2x1dGlvbkNvbnRleHQgfSBmcm9tICdjZGs4cyc7XG5cblxuZXhwb3J0IGNsYXNzIEF3c0Nka1Jlc29sdmVyIGltcGxlbWVudHMgSVJlc29sdmVyIHtcblxuICBwdWJsaWMgcmVzb2x2ZShjb250ZXh0OiBSZXNvbHV0aW9uQ29udGV4dCkge1xuXG4gICAgaWYgKCFUb2tlbi5pc1VucmVzb2x2ZWQoY29udGV4dC52YWx1ZSkpIHtcbiAgICAgIHJldHVybjtcbiAgICB9XG5cbiAgICBpZiAodHlwZW9mIGNvbnRleHQudmFsdWUgIT09ICdzdHJpbmcnKSB7XG4gICAgICAvLyBzaG91bGQgYmUgb2sgYmVjYXVzZSB3ZSBvbmx5IHJlc29sdmUgQ2ZuT3V0cHV0IHZhbHVlcywgd2hpY2hcbiAgICAgIC8vIG11c3QgYmUgc3RyaW5ncy5cbiAgICAgIHRocm93IG5ldyBFcnJvcihgSW52YWxpZCB2YWx1ZSB0eXBlOiAke3R5cGVvZihjb250ZXh0LnZhbHVlKX0gKEV4cGVjdGVkICdzdHJpbmcnKWApO1xuICAgIH1cblxuICAgIGNvbnN0IG91dHB1dCA9IHRoaXMuZmluZE91dHB1dChjb250ZXh0LnZhbHVlKTtcbiAgICB0cnkge1xuICAgICAgY29uc3Qgb3V0cHV0VmFsdWUgPSB0aGlzLmZldGNoT3V0cHV0VmFsdWUob3V0cHV0KTtcbiAgICAgIGNvbnRleHQucmVwbGFjZVZhbHVlKG91dHB1dFZhbHVlKTtcbiAgICB9IGNhdGNoIChlcnIpIHtcbiAgICAgIC8vIGlmIGJvdGggY2RrOHMgYW5kIEFXUyBDREsgYXBwbGljYXRpb25zIGFyZSBkZWZpbmVkIHdpdGhpbiB0aGUgc2FtZSBmaWxlLFxuICAgICAgLy8gYSBjZGs4cyBzeW50aCBpcyBnb2luZyB0byBoYXBwZW4gYmVmb3JlIHRoZSBBV1MgQ0RLIGRlcGxveW1lbnQuXG4gICAgICAvLyBpbiB0aGlzIGNhc2Ugd2UgbXVzdCBzd2FsbG93IHRoZSBlcnJvciwgb3RoZXJ3aXNlIHRoZSBBV1MgQ0RLIGRlcGxveW1lbnRcbiAgICAgIC8vIHdvbid0IGJlIGFibGUgdG8gZ28gdGhyb3VnaC4gd2UgcmVwbGFjZSB0aGUgdmFsdWUgd2l0aCBzb21ldGhpbmcgdG8gaW5kaWNhdGVcbiAgICAgIC8vIHRoYXQgYSBmZXRjaGluZyBhdHRlbXB0IHdhcyBtYWRlIGFuZCBmYWlsZWQuXG4gICAgICBjb250ZXh0LnJlcGxhY2VWYWx1ZShgRmFpbGVkIGZldGNoaW5nIHZhbHVlIGZvciBvdXRwdXQgJHtvdXRwdXQubm9kZS5wYXRofTogJHtlcnJ9YCk7XG4gICAgfVxuXG4gIH1cblxuICBwcml2YXRlIGZpbmRPdXRwdXQodmFsdWU6IHN0cmluZykge1xuXG4gICAgY29uc3QgaW5zcGVjdGVkU3RhY2tzOiBTdGFja1tdID0gW107XG5cbiAgICBmb3IgKGNvbnN0IHRva2VuIG9mIFRva2VuaXphdGlvbi5yZXZlcnNlU3RyaW5nKHZhbHVlKS50b2tlbnMpIHtcbiAgICAgIGlmIChSZWZlcmVuY2UuaXNSZWZlcmVuY2UodG9rZW4pKSB7XG4gICAgICAgIGNvbnN0IHN0YWNrID0gU3RhY2sub2YodG9rZW4udGFyZ2V0KTtcbiAgICAgICAgaW5zcGVjdGVkU3RhY2tzLnB1c2goc3RhY2spO1xuICAgICAgICBjb25zdCBvdXRwdXQgPSBzdGFjay5ub2RlLmZpbmRBbGwoKS5maWx0ZXIoYyA9PiBjIGluc3RhbmNlb2YgQ2ZuT3V0cHV0ICYmIGMudmFsdWUgPT09IHZhbHVlKVswXSBhcyBDZm5PdXRwdXQ7XG4gICAgICAgIC8vIHdlIGRvbid0IHJlYWxseSBjYXJlIGlmIHRoZXJlIGFyZSBtb3JlIG91dHB1dHMgKHBvc3NpYmx5IGZyb20gZGlmZmVyZW50IHN0YWNrcylcbiAgICAgICAgLy8gdGhhdCBwb2ludCB0byB0aGUgc2FtZSB2YWx1ZS4gdGhlIGZpcnN0IHdpbGwgc3VmZmljZS5cbiAgICAgICAgaWYgKG91dHB1dCkgcmV0dXJuIG91dHB1dDtcbiAgICAgIH1cbiAgICB9XG5cbiAgICAvLyBUaGlzIGNhbiBoYXBwZW4gaWYgZWl0aGVyOlxuICAgIC8vIC0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tXG4gICAgLy8gIDEuIFVzZXIgZGlkbid0IGRlZmluZSBhbiBvdXRwdXQuXG4gICAgLy8gIDIuIE91dHB1dCB3YXMgZGVmaW5lZCBpbiBhIGRpZmZlcmVudCBzdGFjayB0aGFuIHRoZSB0b2tlbnMgY29tcHJpc2luZyBpdHMgdmFsdWUuXG4gICAgLy8gIDMuIE5vbmUgb2YgdGhlIHRva2VucyBjb21wcmlzaW5nIHRoZSB2YWx1ZSBhcmUgYSBSZWZlcmVuY2UuXG4gICAgdGhyb3cgbmV3IEVycm9yKGBVbmFibGUgdG8gZmluZCBvdXRwdXQgZGVmaW5lZCBmb3IgJHt2YWx1ZX0gKEluc3BlY3RlZCBzdGFja3M6ICR7aW5zcGVjdGVkU3RhY2tzLm1hcChzID0+IHMuc3RhY2tOYW1lKS5qb2luKCcsJyl9KWApO1xuXG4gIH1cblxuICBwcml2YXRlIGZldGNoT3V0cHV0VmFsdWUob3V0cHV0OiBDZm5PdXRwdXQpIHtcblxuICAgIGNvbnN0IHNjcmlwdCA9IHBhdGguam9pbihfX2Rpcm5hbWUsICcuLicsICdsaWInLCAnZmV0Y2gtb3V0cHV0LXZhbHVlLmpzJyk7XG4gICAgcmV0dXJuIEpTT04ucGFyc2UoZXhlY0ZpbGVTeW5jKHByb2Nlc3MuZXhlY1BhdGgsIFtcbiAgICAgIHNjcmlwdCxcbiAgICAgIFN0YWNrLm9mKG91dHB1dCkuc3RhY2tOYW1lLFxuICAgICAgb3V0cHV0Lm5vZGUuaWQsXG4gICAgXSwgeyBlbmNvZGluZzogJ3V0Zi04Jywgc3RkaW86IFsncGlwZSddIH0pLnRvU3RyaW5nKCkudHJpbSgpKTtcblxuICB9XG5cbn1cbiJdfQ==
package/package.json CHANGED
@@ -51,21 +51,21 @@
51
51
  "aws-cdk": "^2.154.1",
52
52
  "aws-cdk-lib": "2.109.0",
53
53
  "cdk8s": "2.68.91",
54
- "cdk8s-cli": "^2.198.197",
54
+ "cdk8s-cli": "^2.198.202",
55
+ "commit-and-tag-version": "^12",
55
56
  "constructs": "10.3.0",
56
57
  "eslint": "^8",
57
- "eslint-import-resolver-typescript": "^3.6.1",
58
+ "eslint-import-resolver-typescript": "^3.6.3",
58
59
  "eslint-plugin-import": "^2.29.1",
59
60
  "fs-extra": "^11.2.0",
60
61
  "jest": "^27",
61
62
  "jest-junit": "^15",
62
63
  "jsii": "^5",
63
- "jsii-diff": "^1.102.0",
64
- "jsii-docgen": "^9.2.2",
65
- "jsii-pacmak": "^1.102.0",
64
+ "jsii-diff": "^1.103.0",
65
+ "jsii-docgen": "^10.5.0",
66
+ "jsii-pacmak": "^1.103.0",
66
67
  "jsii-rosetta": "^5",
67
- "projen": "^0.86.0",
68
- "standard-version": "^9",
68
+ "projen": "^0.86.5",
69
69
  "ts-jest": "^27",
70
70
  "ts-node": "^10.9.2",
71
71
  "typescript": "^5.5.4"
@@ -92,7 +92,7 @@
92
92
  "publishConfig": {
93
93
  "access": "public"
94
94
  },
95
- "version": "0.0.153",
95
+ "version": "0.0.155",
96
96
  "jest": {
97
97
  "coverageProvider": "v8",
98
98
  "testMatch": [