aws-architect 0.0.0 → 0.0.25
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/CHANGELOG.md +109 -1
- package/LICENSE +200 -27
- package/README.md +170 -5
- package/bin/aws-architect.js +40 -0
- package/bin/cloudwatch-event-trigger-with-permissions.json +35 -0
- package/bin/deployment-policy.json +35 -0
- package/bin/template/.editorconfig +9 -0
- package/bin/template/.eslintrc +3 -0
- package/bin/template/.gitignore +1 -0
- package/bin/template/CHANGELOG.md +5 -0
- package/bin/template/README.md +150 -0
- package/bin/template/cloudFormationHostedZoneTemplate.json +44 -0
- package/bin/template/cloudFormationServerlessTemplate.json +341 -0
- package/bin/template/cloudFormationWebsiteTemplate.json +193 -0
- package/bin/template/content/favicon.ico +0 -0
- package/bin/template/content/index.html +12 -0
- package/bin/template/make.js +224 -0
- package/bin/template/package.json +58 -0
- package/bin/template/src/index.js +88 -0
- package/bin/template/tests/index.js +74 -0
- package/bin/template/tests/make.js +19 -0
- package/bin/userrole-policy.json +14 -0
- package/bin/userrole-trust-relationship.json +20 -0
- package/index.d.ts +77 -0
- package/index.js +254 -2
- package/lib/ApiConfiguration.js +12 -0
- package/lib/ApiGatewayManager.js +109 -0
- package/lib/BucketManager.js +162 -0
- package/lib/CloudFormationDeployer.js +440 -0
- package/lib/LambdaManager.js +190 -0
- package/lib/appRedirect.html +16 -0
- package/lib/lockFinder.js +22 -0
- package/lib/server.js +298 -0
- package/package.json +61 -12
- package/.npmignore +0 -27
- package/.rspec +0 -2
- package/.travis.yml +0 -19
- package/Gemfile +0 -6
- package/Gemfile.lock +0 -63
- package/aws-architect.gemspec +0 -28
- package/lib/aws-architect/client.rb +0 -8
- package/lib/aws-architect/dsl.rb +0 -4
- package/lib/aws-architect.rb +0 -8
- package/rakefile.rb +0 -64
- package/spec/spec_helper.rb +0 -91
- package/test.rb +0 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,113 @@
|
|
|
1
1
|
# Change log
|
|
2
2
|
This is the changelog for [AWS Architect](readme.md).
|
|
3
3
|
|
|
4
|
+
## 6.6 ##
|
|
5
|
+
* Add support to `deleteWebsiteVersion(version)`
|
|
6
|
+
* Fix `The function must be in an Active state. The current state for function arn:aws:lambda:Function:514 is Pending`.
|
|
7
|
+
* Automatically delete existing ROLLBACK_COMPLETE stacks.
|
|
8
|
+
|
|
9
|
+
## 6.5 ##
|
|
10
|
+
* Support APIGW version 2
|
|
11
|
+
|
|
12
|
+
## 6.4 ##
|
|
13
|
+
* Add stackset support for AWS to cross regions
|
|
14
|
+
* Skip stack deployment if template body already matches stack
|
|
15
|
+
|
|
16
|
+
## 6.3 ##
|
|
17
|
+
* Automatically delete the stage lambda alias and version when deleting a stage by passing in the lambda function name as the second parameter to `awsArchitect.removeStagePromise`.
|
|
18
|
+
* Add support for all mime-types for S3 uploads
|
|
19
|
+
|
|
20
|
+
## 6.2 ##
|
|
21
|
+
* Allow setting upload zip file directly to support creating lambda layers
|
|
22
|
+
* Add `publishZipArchive` to publish layers and other zip files directly to S3, using the package name and version automatically.
|
|
23
|
+
* New option in `publishLambdaArtifactPromise` to allow turning off running npm or yarn for package deployment `autoHandleCompileOfSourceDirectory = false`.
|
|
24
|
+
* Now uploads to the S3 directory file that matches any directory that contains an index.html for automatic redirects to the index.html.
|
|
25
|
+
|
|
26
|
+
## 6.1 ##
|
|
27
|
+
* Deploy CF templates to S3 deployment bucket before deploying to CF to increase allow size of templates to 450KB.
|
|
28
|
+
* Allow cache control to be the full string, not just an number
|
|
29
|
+
* Dynamically inject `http` and `api` subpath into Location urls.
|
|
30
|
+
* `cacheControlRegexMap` supports array to keep order of regex mappings
|
|
31
|
+
* `deployTemplate` StackConfiguration `options` now accepts `automaticallyProtectStack` which defaults to be `true`, to protect stacks. This will only protect stacks which are successfully created.
|
|
32
|
+
|
|
33
|
+
## 6.0 ##
|
|
34
|
+
* Remove hosting index html, recommendation is to use nodemon and serve for that.
|
|
35
|
+
* Removed deprecated methods
|
|
36
|
+
* Now supports calling schedule and event triggers locally via the REST api.
|
|
37
|
+
* Nodejs8.10 by default
|
|
38
|
+
* Auto increment port starting at 8080 or specified up to 10 ports before falling back to a random port.
|
|
39
|
+
* Use `-`s in stage names instead of `_` so that more CIs can match their environments stages correctly.
|
|
40
|
+
* Added default override for S3 content type uploads.
|
|
41
|
+
* Allow deploying `.files` using the `bucketManager`
|
|
42
|
+
* Dynamically inject `http` and `api` subpath into url hrefs.
|
|
43
|
+
* Remove autocreation of api gateway when attempting to find it. The expectation is that "searching for the API" happens always after the CF stack creation.
|
|
44
|
+
* `awsArchitect.run` now returns the `server` which contains the only method `stop` allowing manual shutdown.
|
|
45
|
+
|
|
46
|
+
## 5.1 ##
|
|
47
|
+
* Provide lower case names for methods.
|
|
48
|
+
* Add deprecation warning to removal methods in **6.0**.
|
|
49
|
+
* Index.html is uploaded last.
|
|
50
|
+
* Add in dynamic resolving of ACM certs by domain name.
|
|
51
|
+
|
|
52
|
+
## 5.0 ##
|
|
53
|
+
* Upgrade to OpenAPI-factory 3.0, see [openapi factory](https://github.com/wparad/openapi-factory.js/blob/master/CHANGELOG.md#30) for breaking changes. This means that the authorizer now takes `event` and the authorization token must be manually extracted.
|
|
54
|
+
* Support authorizer resolution in express `server.run`
|
|
55
|
+
* Allow providing a custom logger to run function.
|
|
56
|
+
|
|
57
|
+
## 4.2 ##
|
|
58
|
+
* Include cloud formation deployment for standard resources.
|
|
59
|
+
* Added example cloud formation template to template service.
|
|
60
|
+
* New `RemoveStage` in AWS Architect.
|
|
61
|
+
* Add Support for `yarn.lock` files by assuming `yarn` should be executed.
|
|
62
|
+
|
|
63
|
+
## 4.1 ##
|
|
64
|
+
* Add `+AwsArchitect.prototype.publishLambdaArtifactPromise` to perform the action to deploy a microservice zip package to S3.
|
|
65
|
+
* Allow specifying S3 artifacts cache-control times as overrides.
|
|
66
|
+
|
|
67
|
+
## 4.0 ##
|
|
68
|
+
* Removed passing the bucket as configuration into `publishWebsite`. Bucket is required as part of `contentOptions`.
|
|
69
|
+
* Prevent overwriting the bucket configuration using the `options` parameter in `publishWebsite`.
|
|
70
|
+
|
|
71
|
+
## 3.7 ##
|
|
72
|
+
* Default to region set in aws config, rather than us-east-1.
|
|
73
|
+
|
|
74
|
+
## 3.6 ##
|
|
75
|
+
* Allow sending binary Buffer bodies via local server to match API Gateway functionality.
|
|
76
|
+
|
|
77
|
+
## 3.5 ##
|
|
78
|
+
* Upgrade default nodejs version to 6.10.
|
|
79
|
+
|
|
80
|
+
## 3.4 ##
|
|
81
|
+
* Upgrade jwt resolution to include by default RS256.
|
|
82
|
+
|
|
83
|
+
## 3.3 ##
|
|
84
|
+
* Remove CORS headers from local server.
|
|
85
|
+
|
|
86
|
+
## 3.2 ##
|
|
87
|
+
* Automatically create the service role to execute the lambda functions.
|
|
88
|
+
* Automatically create the s3 bucket with the website policy if it doesn't exist.
|
|
89
|
+
|
|
90
|
+
## 3.1 ##
|
|
91
|
+
* Moved website bucket configuration to contentOptions.
|
|
92
|
+
* Added `AwsArchitect.promoteToStage(source, stage)` function which will copy a bucket directory.
|
|
93
|
+
|
|
94
|
+
## 3.0 ##
|
|
95
|
+
* Upgrade to handle ANY on aws resources.
|
|
96
|
+
* Allow running just a website on port 8080, without any extra api files.
|
|
97
|
+
|
|
98
|
+
## 2.1 ##
|
|
99
|
+
* Add support for creating dynamoDB Tables.
|
|
100
|
+
* Separate policy examples into their own documents.
|
|
101
|
+
* Allow specifying specific port to run on.
|
|
102
|
+
* Deploy content directory to s3.
|
|
103
|
+
|
|
104
|
+
## 2.0 ##
|
|
105
|
+
* All configuration is now contained in the api files. Generation, run, and testing is completed via index.js. New templates created.
|
|
106
|
+
* A single lambda function is created, for the purpose of the whole microservice.
|
|
107
|
+
* Introduced configuration options for the api and content (s3).
|
|
108
|
+
|
|
109
|
+
## 1.1 ##
|
|
110
|
+
* Lambdas are not all specified in the file specified by the constructor call. Default is the `src/index.js` file in `make.js`. `aws-config.js` will be removed in version 2.0, and all configuration can be specified in the index.js composition root.
|
|
111
|
+
|
|
4
112
|
## 1.0 ##
|
|
5
|
-
Introduced commandline ruby tool for configuring a AWS Microservice instance using Cloud Formation and AWS API.
|
|
113
|
+
* Introduced commandline ruby tool `aws-architect` for configuring a AWS Microservice instance using Cloud Formation and AWS API.
|
package/LICENSE
CHANGED
|
@@ -1,28 +1,201 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
Redistribution and use in source and binary forms, with or without
|
|
5
|
-
modification, are permitted provided that the following conditions are met:
|
|
6
|
-
|
|
7
|
-
* Redistributions of source code must retain the above copyright notice, this
|
|
8
|
-
list of conditions and the following disclaimer.
|
|
9
|
-
|
|
10
|
-
* Redistributions in binary form must reproduce the above copyright notice,
|
|
11
|
-
this list of conditions and the following disclaimer in the documentation
|
|
12
|
-
and/or other materials provided with the distribution.
|
|
13
|
-
|
|
14
|
-
* Neither the name of AWS-Architect nor the names of its
|
|
15
|
-
contributors may be used to endorse or promote products derived from
|
|
16
|
-
this software without specific prior written permission.
|
|
17
|
-
|
|
18
|
-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
19
|
-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
20
|
-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
21
|
-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
22
|
-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
23
|
-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
24
|
-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
25
|
-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
26
|
-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
27
|
-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
28
4
|
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,10 +1,175 @@
|
|
|
1
1
|
# AWS Architect
|
|
2
|
-
|
|
2
|
+
It should be easy, and it also should be automated. But both of those things usually aren't free. The ideal world has magic AI which can communicate with each other. And to such a degree which doesn't require software architects to think about what the global picture is before an organization can deliver something of value. The AWS Architect, attempts to eliminate the burden of projecting your vision of software to AWS. AWS Architects your service using [Microservices](./docs/microservices/index.md).
|
|
3
3
|
|
|
4
|
-
[](https://badge.fury.io/js/aws-architect)
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
## Usage
|
|
7
|
+
### Creating a microservice: `init`
|
|
8
|
+
This will also configure your aws account to allow your build system to automatically deploy to AWS. Run locally
|
|
7
9
|
|
|
8
|
-
|
|
10
|
+
* Create git repository and clone locally
|
|
11
|
+
* `npm install aws-architect -g`
|
|
12
|
+
* `aws-architect init`
|
|
13
|
+
* `npm install`
|
|
14
|
+
* Update:
|
|
15
|
+
* `package.json`: package name, the package name is used to name your resources
|
|
16
|
+
* `make.js`: Deployment bucket, Resource, and DNS name parameters which are used for CF deployment
|
|
9
17
|
|
|
10
|
-
|
|
18
|
+
#### API Sample
|
|
19
|
+
Using `openapi-factory` we can create a declarative api to run inside the lambda function.
|
|
20
|
+
|
|
21
|
+
```javascript
|
|
22
|
+
let aws = require('aws-sdk');
|
|
23
|
+
let Api = require('openapi-factory');
|
|
24
|
+
let api = new Api();
|
|
25
|
+
module.exports = api;
|
|
26
|
+
|
|
27
|
+
api.get('/sample', (request) => {
|
|
28
|
+
return { statusCode: 200, body: { value: 1} };
|
|
29
|
+
});
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
##### Lambda with no API sample
|
|
33
|
+
Additionally, `openapi-factory` is not required, and executing the lambda handler directly can be done as well.
|
|
34
|
+
|
|
35
|
+
```javascript
|
|
36
|
+
exports.handler = (event, context, callback) => {
|
|
37
|
+
console.log(`event: ${JSON.stringify(event, null, 2)}`);
|
|
38
|
+
console.log(`context: ${JSON.stringify(context, null, 2)}`);
|
|
39
|
+
callback(null, {Event: event, Context: context});
|
|
40
|
+
};
|
|
41
|
+
```
|
|
42
|
+
##### Set a custom authorizer
|
|
43
|
+
In some cases authorization is necessary. Cognito is always an option, but for more fine grained control, your lambda can double as an authorizer.
|
|
44
|
+
|
|
45
|
+
```javascript
|
|
46
|
+
api.SetAuthorizer(event => {
|
|
47
|
+
return {
|
|
48
|
+
principalId: 'computed-authorized-principal-id',
|
|
49
|
+
policyDocument: {
|
|
50
|
+
Version: '2012-10-17',
|
|
51
|
+
Statement: [
|
|
52
|
+
{
|
|
53
|
+
Action: 'execute-api:Invoke',
|
|
54
|
+
Effect: 'Deny',
|
|
55
|
+
Resource: event.methodArn //'arn:aws:execute-api:*:*:*'
|
|
56
|
+
}
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
context: {
|
|
60
|
+
"stringKey": "string-val",
|
|
61
|
+
"numberKey": 123,
|
|
62
|
+
"booleanKey": true
|
|
63
|
+
}
|
|
64
|
+
};
|
|
65
|
+
});
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Library Functions
|
|
69
|
+
#### AwsArchitect class functions
|
|
70
|
+
|
|
71
|
+
```javascript
|
|
72
|
+
let packageMetadataFile = path.join(__dirname, 'package.json');
|
|
73
|
+
let packageMetadata = require(packageMetadataFile);
|
|
74
|
+
|
|
75
|
+
let apiOptions = {
|
|
76
|
+
sourceDirectory: path.join(__dirname, 'src'),
|
|
77
|
+
description: 'This is the description of the lambda function',
|
|
78
|
+
regions: ['eu-west-1']
|
|
79
|
+
};
|
|
80
|
+
let contentOptions = {
|
|
81
|
+
bucket: 'WEBSITE_BUCKET_NAME',
|
|
82
|
+
contentDirectory: path.join(__dirname, 'content')
|
|
83
|
+
};
|
|
84
|
+
let awsArchitect = new AwsArchitect(packageMetadata, apiOptions, contentOptions);
|
|
85
|
+
|
|
86
|
+
// Package a directory in a zip archive and deploy to an S3 bucket, required for stage deployment and CF stack deployment
|
|
87
|
+
let options = {
|
|
88
|
+
bucket: 'BUCKET_NAME'
|
|
89
|
+
};
|
|
90
|
+
publishLambdaArtifactPromise(options = {}) {...}
|
|
91
|
+
|
|
92
|
+
// Validate a cloud formation stack template using CloudFormation
|
|
93
|
+
validateTemplate(stackTemplate) {...}
|
|
94
|
+
|
|
95
|
+
// Deploy a Cloudformation template to AWS, should be used to create all the infrastructure required and run only on master branches
|
|
96
|
+
let stackConfiguration = {
|
|
97
|
+
stackName: 'STACK_NAME'
|
|
98
|
+
changeSetName: 'NAME_OF_CHANGE_SET'
|
|
99
|
+
};
|
|
100
|
+
let parameters = { /** PARAMETERS_FOR_YOUR_TEMPLATE, but also include these unless being overwritten in your template */
|
|
101
|
+
serviceName: packageMetadata.name,
|
|
102
|
+
serviceDescription: packageMetadata.description,
|
|
103
|
+
dnsName: packageMetadata.name.toLowerCase()
|
|
104
|
+
};
|
|
105
|
+
deployTemplate(stackTemplate, stackConfiguration, parameters) {...}
|
|
106
|
+
|
|
107
|
+
// Deploy the stage of your microservice stack, to be called for each build in master or a pull-request.
|
|
108
|
+
publishAndDeployStagePromise(options) {
|
|
109
|
+
// options.stage
|
|
110
|
+
// options.functionName
|
|
111
|
+
// options.deploymentBucketName
|
|
112
|
+
// options.deploymentKeyName
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
// Removes a deployed stage, to be used on pull-request created stages (API gateway has a limit fo 5 stages)
|
|
116
|
+
removeStagePromise(stage) {...}
|
|
117
|
+
|
|
118
|
+
// Creates a website, see below
|
|
119
|
+
publishWebsite(version, options) {...}
|
|
120
|
+
|
|
121
|
+
// Debug the running service on port at http://localhost:port/api
|
|
122
|
+
run(port, logger) {...}
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
#### S3 Website Deployment
|
|
127
|
+
AWS Architect has the ability to set up and configure an S3 bucket for static website hosting. It provides a mechanism as well to deploy your content files directly to S3.
|
|
128
|
+
Specify `bucket` in the configuration options for `contentOptions`, and configure the `PublishWebsite` function in the make.js file.
|
|
129
|
+
|
|
130
|
+
```javascript
|
|
131
|
+
awsArchitect.publishWebsite('deadc0de-1', options)
|
|
132
|
+
.then((result) => console.log(`${JSON.stringify(result, null, 2)}`))
|
|
133
|
+
.catch((failure) => console.log(`Failed to upload website ${failure} - ${JSON.stringify(failure, null, 2)}`));
|
|
134
|
+
|
|
135
|
+
.promoteToStage('deadc0de-1', 'production')
|
|
136
|
+
.then((result) => console.log(`${JSON.stringify(result, null, 2)}`))
|
|
137
|
+
.catch((failure) => console.log(`Failed copying stage to production ${failure} - ${JSON.stringify(failure, null, 2)}`));
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
##### Website publish options
|
|
141
|
+
Publishing the website has an `options` object which defaults to:
|
|
142
|
+
```js
|
|
143
|
+
{
|
|
144
|
+
// provide overrides for paths to change bucket cache control policy, default 600 seconds,
|
|
145
|
+
cacheControlRegexMap: [
|
|
146
|
+
{ regex: '/index.html/', value: 'public, max-age=10' },
|
|
147
|
+
{ explicit: 'only.this.static.file', value: 'public, max-age=10' }
|
|
148
|
+
{ value: 'public, max-age=600' }
|
|
149
|
+
]
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
## Built-in functionality
|
|
153
|
+
|
|
154
|
+
* Standardize CF template to deploy microservice to Lambda, API Gateway, Route 53, etc..
|
|
155
|
+
* Standardize CF template for S3 bucket hosting for a website
|
|
156
|
+
* Default configuration to automatically handle the creation of pull request deployments to test infrastructure before production
|
|
157
|
+
* Working templated sample and make.js file to run locally and CI build.
|
|
158
|
+
* Lambda/API Gateway setup for seamless integration.
|
|
159
|
+
* Automatic creation of AWS resources when using including:
|
|
160
|
+
* Lambda functions
|
|
161
|
+
* API Gateway resources
|
|
162
|
+
* Environments for managing resources in AWS
|
|
163
|
+
* S3 Buckets and directories
|
|
164
|
+
* S3 static website hosting
|
|
165
|
+
* Developer testing platform, to run lambdas and static content as a local express Node.js service, to test locally.
|
|
166
|
+
|
|
167
|
+
### Service Configuration
|
|
168
|
+
See [template service documentation](./bin/template/README.md) for how individual parts of the service are configured.
|
|
169
|
+
|
|
170
|
+
## Also
|
|
171
|
+
|
|
172
|
+
### AWS Documentation
|
|
173
|
+
|
|
174
|
+
* [Lambda](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Lambda.html)
|
|
175
|
+
* [Node SDK](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html)
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
let commander = require('commander');
|
|
4
|
+
let fs = require('fs-extra');
|
|
5
|
+
let path = require('path');
|
|
6
|
+
|
|
7
|
+
let version = require(path.join(__dirname, '../package.json')).version;
|
|
8
|
+
commander.version(version);
|
|
9
|
+
|
|
10
|
+
let displayHeader = () => {
|
|
11
|
+
console.log('AWS Architect (%s)', version);
|
|
12
|
+
console.log('---------------------------');
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
commander
|
|
16
|
+
.command('init')
|
|
17
|
+
.description('Setup microservice package from template.')
|
|
18
|
+
.action(() => {
|
|
19
|
+
displayHeader();
|
|
20
|
+
console.log('Creating new microservice.');
|
|
21
|
+
console.log('');
|
|
22
|
+
|
|
23
|
+
let currentWorkspace = path.resolve('.');
|
|
24
|
+
new Promise((resolve, reject) => {
|
|
25
|
+
fs.copy(path.join(__dirname, 'template'), currentWorkspace, error => {
|
|
26
|
+
return error ? reject({ Error: error.stack || error }) : resolve({ Result: `Template copied to ${path.resolve('.')}` });
|
|
27
|
+
});
|
|
28
|
+
}).then(result => console.log(`success: ${JSON.stringify(result, null, 2)}`))
|
|
29
|
+
.catch(result => console.log(`failure: ${JSON.stringify(result, null, 2)}`));
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
commander.on('*', () => {
|
|
33
|
+
if (commander.args.join(' ') === 'tests/**/*.js') { return; }
|
|
34
|
+
displayHeader();
|
|
35
|
+
console.log(`Unknown Command: ${commander.args.join(' ')}`);
|
|
36
|
+
commander.help();
|
|
37
|
+
process.exit(0);
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
commander.parse(process.argv[2] ? process.argv : process.argv.concat(['init']));
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"CloudWatchEventsRuleResource": {
|
|
3
|
+
"Type": "AWS::Events::Rule",
|
|
4
|
+
"Properties": {
|
|
5
|
+
"Description": { "Ref": "serviceDescription" },
|
|
6
|
+
"Name": {
|
|
7
|
+
"Fn::Join": [
|
|
8
|
+
"-",
|
|
9
|
+
[
|
|
10
|
+
{ "Ref": "serviceName" },
|
|
11
|
+
"Queue",
|
|
12
|
+
"prod"
|
|
13
|
+
]
|
|
14
|
+
]
|
|
15
|
+
},
|
|
16
|
+
"ScheduleExpression": "cron(0 15 ? * MON *)",
|
|
17
|
+
"State": "ENABLED",
|
|
18
|
+
"Targets": [
|
|
19
|
+
{
|
|
20
|
+
"Arn": { "Ref": "ProductionAlias" },
|
|
21
|
+
"Id": "QueueEventTargetId"
|
|
22
|
+
}
|
|
23
|
+
]
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"PermissionForCloudWatchToInvokeLambda": {
|
|
27
|
+
"Type": "AWS::Lambda::Permission",
|
|
28
|
+
"Properties": {
|
|
29
|
+
"FunctionName": { "Ref": "ProductionAlias" },
|
|
30
|
+
"Action": "lambda:InvokeFunction",
|
|
31
|
+
"Principal": "events.amazonaws.com",
|
|
32
|
+
"SourceArn": { "Fn::GetAtt": [ "CloudWatchEventsRuleResource", "Arn" ] }
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"Version": "2012-10-17",
|
|
3
|
+
"Statement": [
|
|
4
|
+
{
|
|
5
|
+
"Effect": "Allow",
|
|
6
|
+
"Action": "iam:*",
|
|
7
|
+
"Resource": "*"
|
|
8
|
+
},
|
|
9
|
+
{
|
|
10
|
+
"Effect": "Allow",
|
|
11
|
+
"Action": [
|
|
12
|
+
"lambda:CreateFunction",
|
|
13
|
+
"lambda:AddPermission",
|
|
14
|
+
"lambda:CreateAlias",
|
|
15
|
+
"lambda:PublishVersion",
|
|
16
|
+
"lambda:UpdateAlias",
|
|
17
|
+
"lambda:UpdateFunctionCode",
|
|
18
|
+
"lambda:ListVersionsByFunction",
|
|
19
|
+
"lambda:UpdateFunctionConfiguration",
|
|
20
|
+
"lambda:AddPermission"
|
|
21
|
+
],
|
|
22
|
+
"Resource": "*"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"Effect": "Allow",
|
|
26
|
+
"Action": "dynamoDB:*",
|
|
27
|
+
"Resource": "*"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"Effect": "Allow",
|
|
31
|
+
"Action": "apigateway:*",
|
|
32
|
+
"Resource": "arn:aws:apigateway:*::/restapis*"
|
|
33
|
+
}
|
|
34
|
+
]
|
|
35
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
node_modules
|