@cdklabs/deploy-time-build 0.0.1 → 0.0.2
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 +9563 -0
- package/.jsii.tabl.json +1 -0
- package/API.md +1673 -0
- package/AmazonQ.md +65 -0
- package/LICENSE +202 -0
- package/README.md +212 -45
- package/example/README.md +18 -0
- package/example/cdk.json +3 -0
- package/example/example-app/index.html +12 -0
- package/example/example-app/package-lock.json +1804 -0
- package/example/example-app/package.json +21 -0
- package/example/example-app/src/App.css +42 -0
- package/example/example-app/src/App.tsx +43 -0
- package/example/example-app/src/index.css +13 -0
- package/example/example-app/src/main.tsx +10 -0
- package/example/example-app/src/vite.env.d.ts +1 -0
- package/example/example-app/tsconfig.json +21 -0
- package/example/example-app/tsconfig.node.json +8 -0
- package/example/example-app/vite.config.ts +7 -0
- package/example/example-image/Dockerfile +6 -0
- package/example/index.ts +156 -0
- package/imgs/architecture.png +0 -0
- package/imgs/demo.png +0 -0
- package/imgs/soci-architecture.png +0 -0
- package/lambda/trigger-codebuild/dist/index.js +279 -0
- package/lambda/trigger-codebuild/index.ts +269 -0
- package/lambda/trigger-codebuild/package-lock.json +2904 -0
- package/lambda/trigger-codebuild/package.json +17 -0
- package/lib/container-image-build.d.ts +84 -0
- package/lib/container-image-build.js +221 -0
- package/lib/index.d.ts +4 -0
- package/lib/index.js +21 -0
- package/lib/nodejs-build.d.ts +84 -0
- package/lib/nodejs-build.js +221 -0
- package/lib/singleton-project.d.ts +28 -0
- package/lib/singleton-project.js +43 -0
- package/lib/soci-index-build.d.ts +30 -0
- package/lib/soci-index-build.js +118 -0
- package/lib/soci-index-v2-build.d.ts +41 -0
- package/lib/soci-index-v2-build.js +131 -0
- package/lib/types.d.ts +44 -0
- package/lib/types.js +3 -0
- package/package.json +156 -6
- package/rosetta/default.ts-fixture +24 -0
- package/rosetta/imported.ts-fixture +25 -0
package/AmazonQ.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# Developer Notes for deploy-time-build
|
|
2
|
+
|
|
3
|
+
This document contains helpful information for developers working on the `deploy-time-build` project.
|
|
4
|
+
|
|
5
|
+
## Pull Request Guidelines
|
|
6
|
+
|
|
7
|
+
### PR Title Format
|
|
8
|
+
|
|
9
|
+
All text in PR title or description must be written in English.
|
|
10
|
+
|
|
11
|
+
Pull request titles must follow the [Conventional Commits](https://www.conventionalcommits.org/) format. Only the following prefixes are allowed:
|
|
12
|
+
|
|
13
|
+
- `feat:` - For new features
|
|
14
|
+
- `fix:` - For bug fixes
|
|
15
|
+
- `chore:` - For maintenance tasks, dependencies updates, etc.
|
|
16
|
+
|
|
17
|
+
Examples:
|
|
18
|
+
- `feat: add support for arm64 instances`
|
|
19
|
+
- `fix: resolve build failure on Windows`
|
|
20
|
+
- `chore: update dependency versions`
|
|
21
|
+
|
|
22
|
+
PRs with titles not following this format will fail validation checks.
|
|
23
|
+
|
|
24
|
+
## Project Structure
|
|
25
|
+
|
|
26
|
+
- `src/` - Main source code
|
|
27
|
+
- `container-image-build.ts` - Container image building functionality
|
|
28
|
+
- `nodejs-build.ts` - NodeJS build functionality
|
|
29
|
+
- `soci-index-build.ts` - SOCI index functionality
|
|
30
|
+
- `singleton-project.ts` - Utility for creating singleton CodeBuild projects
|
|
31
|
+
- `types.ts` - Type definitions
|
|
32
|
+
|
|
33
|
+
## Build
|
|
34
|
+
|
|
35
|
+
You should make sure the build succeeds by the following command before commiting a change:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm run build
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
After a successful build, several files such as API.md might be updated. Please check git status and commit them if there are any changes.
|
|
42
|
+
|
|
43
|
+
## Testing
|
|
44
|
+
|
|
45
|
+
The project uses snapshot tests for integration testing. When making infrastructure changes that affect the generated CloudFormation templates, you'll need to update the snapshot tests.
|
|
46
|
+
|
|
47
|
+
### Updating Snapshot Tests
|
|
48
|
+
|
|
49
|
+
When you make changes that intentionally alter the infrastructure (like adding new resources or changing existing ones), the snapshot tests will fail. This is expected behavior.
|
|
50
|
+
|
|
51
|
+
After your changes are approved and merged, update the snapshot tests by running:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npx integ-runner --update-on-failed
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Common Issues
|
|
58
|
+
|
|
59
|
+
### Breaking Changes in Infrastructure
|
|
60
|
+
|
|
61
|
+
Some changes will create new resources and destroy old ones. This should be clearly noted in PRs.
|
|
62
|
+
|
|
63
|
+
## CI/CD Pipeline
|
|
64
|
+
|
|
65
|
+
The CI pipeline runs tests that verify the snapshot templates. Breaking changes will cause these tests to fail. When submitting PRs with intentional breaking changes, clearly document that these failures are expected.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,45 +1,212 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
1
|
+
# Deploy-time Build
|
|
2
|
+
AWS CDK L3 construct that allows you to run a build job for specific purposes. Currently this library supports the following use cases:
|
|
3
|
+
|
|
4
|
+
* Build web frontend static files
|
|
5
|
+
* Build a container image
|
|
6
|
+
* Build Seekable OCI (SOCI) indices for container images
|
|
7
|
+
|
|
8
|
+
[](https://constructs.dev/packages/@cdklabs/deploy-time-build)
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
Install from npm:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
npm i @cdklabs/deploy-time-build
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
This library defines several L3 constructs for specific use cases. Here is the usage for each case.
|
|
18
|
+
|
|
19
|
+
### Build Node.js apps
|
|
20
|
+
|
|
21
|
+
You can build a Node.js app such as a React frontend app on deploy time by the `NodejsBuild` construct.
|
|
22
|
+
|
|
23
|
+

|
|
24
|
+
|
|
25
|
+
The following code is an example to use the construct:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import { NodejsBuild } from '@cdklabs/deploy-time-build';
|
|
29
|
+
|
|
30
|
+
new NodejsBuild(this, 'ExampleBuild', {
|
|
31
|
+
assets: [
|
|
32
|
+
{
|
|
33
|
+
path: 'example-app',
|
|
34
|
+
exclude: ['dist', 'node_modules'],
|
|
35
|
+
},
|
|
36
|
+
],
|
|
37
|
+
destinationBucket,
|
|
38
|
+
distribution,
|
|
39
|
+
outputSourceDirectory: 'dist',
|
|
40
|
+
buildCommands: ['npm ci', 'npm run build'],
|
|
41
|
+
buildEnvironment: {
|
|
42
|
+
VITE_API_ENDPOINT: api.url,
|
|
43
|
+
},
|
|
44
|
+
});
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Note that it is possible to pass environment variable `VITE_API_ENDPOINT: api.url` to the construct, which is resolved on deploy time, and injected to the build environment (a vite process in this case.)
|
|
48
|
+
The resulting build artifacts will be deployed to `destinationBucket` from CodeBuild.
|
|
49
|
+
|
|
50
|
+
You can specify multiple input assets by `assets` property. These assets are extracted to respective sub directories. For example, assume you specified assets like the following:
|
|
51
|
+
|
|
52
|
+
```ts fixture=imported
|
|
53
|
+
new NodejsBuild(this, 'ExampleBuild', {
|
|
54
|
+
assets: [
|
|
55
|
+
{
|
|
56
|
+
// directory containing source code and package.json
|
|
57
|
+
path: 'example-app',
|
|
58
|
+
exclude: ['dist', 'node_modules'],
|
|
59
|
+
commands: ['npm install'],
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
// directory that is also required for the build
|
|
63
|
+
path: 'module1',
|
|
64
|
+
},
|
|
65
|
+
],
|
|
66
|
+
destinationBucket,
|
|
67
|
+
distribution,
|
|
68
|
+
outputSourceDirectory: 'dist',
|
|
69
|
+
});
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Then, the extracted directories will be located as the following:
|
|
73
|
+
|
|
74
|
+
```sh
|
|
75
|
+
. # a temporary directory (automatically created)
|
|
76
|
+
├── example-app # extracted example-app assets
|
|
77
|
+
│ ├── src/ # dist or node_modules directories are excluded even if they exist locally.
|
|
78
|
+
│ ├── package.json # npm install will be executed since its specified in `commands` property.
|
|
79
|
+
│ └── package-lock.json
|
|
80
|
+
└── module1 # extracted module1 assets
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
You can also override the path where assets are extracted by `extractPath` property for each asset.
|
|
84
|
+
|
|
85
|
+
With `outputEnvFile` property enabled, a `.env` file is automatically generated and uploaded to your S3 bucket. This file can be used running you frontend project locally. You can download the file to your local machine by running the command added in the stack output.
|
|
86
|
+
|
|
87
|
+
Please also check [the example directory](./example/) for a complete example.
|
|
88
|
+
|
|
89
|
+
#### Allowing access from the build environment to other AWS resources
|
|
90
|
+
Since `NodejsBuild` construct implements [`iam.IGrantable`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IGrantable.html) interface, you can use `grant*` method of other constructs to allow access from the build environment.
|
|
91
|
+
|
|
92
|
+
```ts fixture=imported
|
|
93
|
+
declare const someBucket: s3.IBucket;
|
|
94
|
+
declare const build: NodejsBuild;
|
|
95
|
+
someBucket.grantReadWrite(build);
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
You can also use [`iam.Grant`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Grant.html) class to allow any actions and resources.
|
|
99
|
+
|
|
100
|
+
```ts fixture=imported
|
|
101
|
+
declare const build: NodejsBuild;
|
|
102
|
+
iam.Grant.addToPrincipal({ grantee: build, actions: ['s3:ListBucket'], resourceArns:['*'] })
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
#### Motivation - why do we need the `NodejsBuild` construct?
|
|
106
|
+
I talked about why this construct can be useful in some situations at CDK Day 2023. See the recording or slides below:
|
|
107
|
+
|
|
108
|
+
[Recording](https://www.youtube.com/live/b-nSH18gFQk?si=ogEZ2x1NixOj6J6j&t=373) | [Slides](https://speakerdeck.com/tmokmss/deploy-web-frontend-apps-with-aws-cdk)
|
|
109
|
+
|
|
110
|
+
#### Considerations
|
|
111
|
+
Since this construct builds your frontend apps every time you deploy the stack and there is any change in input assets (and currently there's even no build cache in the Lambda function!), the time a deployment takes tends to be longer (e.g. a few minutes even for the simple app in `example` directory.) This might results in worse developer experience if you want to deploy changes frequently (imagine `cdk watch` deployment always re-build your frontend app).
|
|
112
|
+
|
|
113
|
+
To mitigate this issue, you can separate the stack for frontend construct from other stacks especially for a dev environment. Another solution would be to set a fixed string as an asset hash, and avoid builds on every deployment.
|
|
114
|
+
|
|
115
|
+
```ts fixture=imported
|
|
116
|
+
new NodejsBuild(this, 'ExampleBuild', {
|
|
117
|
+
assets: [
|
|
118
|
+
{
|
|
119
|
+
path: '../frontend',
|
|
120
|
+
exclude: ['node_modules', 'dist'],
|
|
121
|
+
commands: ['npm ci'],
|
|
122
|
+
// Set a fixed string as a asset hash to prevent deploying changes.
|
|
123
|
+
// This can be useful for an environment you use to develop locally.
|
|
124
|
+
assetHash: 'frontend_asset',
|
|
125
|
+
},
|
|
126
|
+
],
|
|
127
|
+
destinationBucket,
|
|
128
|
+
distribution,
|
|
129
|
+
outputSourceDirectory: 'dist',
|
|
130
|
+
});
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Build a container image
|
|
134
|
+
You can build a container image at deploy time by the following code:
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
import { ContainerImageBuild } from '@cdklabs/deploy-time-build';
|
|
138
|
+
|
|
139
|
+
const image = new ContainerImageBuild(this, 'Build', {
|
|
140
|
+
directory: 'example-image',
|
|
141
|
+
buildArgs: { DUMMY_FILE_SIZE_MB: '15' },
|
|
142
|
+
tag: 'my-image-tag',
|
|
143
|
+
});
|
|
144
|
+
new DockerImageFunction(this, 'Function', {
|
|
145
|
+
code: image.toLambdaDockerImageCode(),
|
|
146
|
+
});
|
|
147
|
+
const armImage = new ContainerImageBuild(this, 'BuildArm', {
|
|
148
|
+
directory: 'example-image',
|
|
149
|
+
platform: Platform.LINUX_ARM64,
|
|
150
|
+
repository: image.repository,
|
|
151
|
+
zstdCompression: true,
|
|
152
|
+
});
|
|
153
|
+
new FargateTaskDefinition(this, 'TaskDefinition', {
|
|
154
|
+
runtimePlatform: { cpuArchitecture: CpuArchitecture.ARM64 }
|
|
155
|
+
}).addContainer('main', {
|
|
156
|
+
image: armImage.toEcsDockerImageCode(),
|
|
157
|
+
});
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
The third argument (props) are a superset of DockerImageAsset's properties. You can set a few additional properties such as `tag`, `repository`, and `zstdCompression`.
|
|
161
|
+
|
|
162
|
+
### Build SOCI index for a container image
|
|
163
|
+
[Seekable OCI (SOCI)](https://aws.amazon.com/about-aws/whats-new/2022/09/introducing-seekable-oci-lazy-loading-container-images/) is a way to help start tasks faster for Amazon ECS tasks on Fargate 1.4.0. You can build and push a SOCI index using the `SociIndexV2Build` construct.
|
|
164
|
+
|
|
165
|
+

|
|
166
|
+
|
|
167
|
+
The following code is an example to use the construct:
|
|
168
|
+
|
|
169
|
+
```ts
|
|
170
|
+
import { SociIndexV2Build } from '@cdklabs/deploy-time-build';
|
|
171
|
+
|
|
172
|
+
const asset = new DockerImageAsset(this, 'Image', { directory: 'example-image' });
|
|
173
|
+
const sociIndex = new SociIndexV2Build(this, 'SociV2Index', {
|
|
174
|
+
repository: asset.repository,
|
|
175
|
+
inputImageTag: asset.assetHash,
|
|
176
|
+
outputImageTag: `${asset.assetHash}-soci`,
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
// Use with ECS Fargate
|
|
180
|
+
const taskDefinition = new FargateTaskDefinition(this, 'TaskDefinition');
|
|
181
|
+
taskDefinition.addContainer('main', {
|
|
182
|
+
image: sociIndex.toEcsDockerImageCode(),
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
// Or create from DockerImageAsset using utility method
|
|
186
|
+
const sociIndexFromAsset = SociIndexV2Build.fromDockerImageAsset(this, 'SociV2Index2', asset);
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
The `SociIndexV2Build` construct:
|
|
190
|
+
- Takes an input container image and builds a SOCI v2 index for it
|
|
191
|
+
- Outputs a new image tag with the embedded SOCI index
|
|
192
|
+
- Provides `toEcsDockerImageCode()` method to easily use with ECS tasks
|
|
193
|
+
- Uses the same ECR repository for input and output images
|
|
194
|
+
|
|
195
|
+
We currently use [`soci-wrapper`](https://github.com/tmokmss/soci-wrapper) to build and push SOCI indices.
|
|
196
|
+
|
|
197
|
+
> [!WARNING]
|
|
198
|
+
> The previous `SocideIndexBuild` construct is now deprecated. Customers new to SOCI on AWS Fargate can only use SOCI index manifest v2. See [this article](https://aws.amazon.com/blogs/containers/improving-amazon-ecs-deployment-consistency-with-soci-index-manifest-v2/) for more details.
|
|
199
|
+
|
|
200
|
+
#### Motivation - why do we need the `SociIndexBuild` construct?
|
|
201
|
+
|
|
202
|
+
Currently there are several other ways to build a SOCI index; 1. use `soci-snapshotter` CLI, or 2. use [cfn-ecr-aws-soci-index-builder](https://github.com/aws-ia/cfn-ecr-aws-soci-index-builder) solution, none of which can be directly used from AWS CDK. If you are familiar with CDK, you should often deploy container images as CDK assets, which is an ideal way to integrate with other L2 constructs such as ECS. To make the developer experience for SOCI as close as the ordinary container images, the `SociIndexBuild` allows you to deploying a SOCI index directly from CDK, without any dependencies outside of CDK context.
|
|
203
|
+
|
|
204
|
+
## Development
|
|
205
|
+
Commands for maintainers:
|
|
206
|
+
|
|
207
|
+
```sh
|
|
208
|
+
# run test locally
|
|
209
|
+
npx tsc -p tsconfig.dev.json
|
|
210
|
+
npx integ-runner
|
|
211
|
+
npx integ-runner --update-on-failed
|
|
212
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
## How to Deploy
|
|
2
|
+
```sh
|
|
3
|
+
# Assume current directory is the example directory
|
|
4
|
+
cd ../lambda/trigger-codebuild
|
|
5
|
+
npm ci
|
|
6
|
+
npm run build
|
|
7
|
+
cd -
|
|
8
|
+
npx cdk deploy NodejsTestStack
|
|
9
|
+
npx cdk deploy SociIndexTestStack
|
|
10
|
+
npx cdk deploy ContainerImageTestStack
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Description
|
|
14
|
+
After a successful deployment, you will get a CloudFront URL from the stack output.
|
|
15
|
+
|
|
16
|
+

|
|
17
|
+
|
|
18
|
+
You can see the API endpoint is successfully injected to the sample frontend app.
|
package/example/cdk.json
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8" />
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
6
|
+
<title>Vite App</title>
|
|
7
|
+
</head>
|
|
8
|
+
<body>
|
|
9
|
+
<div id="root"></div>
|
|
10
|
+
<script type="module" src="/src/main.tsx"></script>
|
|
11
|
+
</body>
|
|
12
|
+
</html>
|