aws-syndicate 1.16.2__tar.gz
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.
- aws_syndicate-1.16.2/LICENSE +201 -0
- aws_syndicate-1.16.2/PKG-INFO +457 -0
- aws_syndicate-1.16.2/README.md +423 -0
- aws_syndicate-1.16.2/aws_syndicate.egg-info/PKG-INFO +457 -0
- aws_syndicate-1.16.2/aws_syndicate.egg-info/SOURCES.txt +202 -0
- aws_syndicate-1.16.2/aws_syndicate.egg-info/dependency_links.txt +1 -0
- aws_syndicate-1.16.2/aws_syndicate.egg-info/entry_points.txt +2 -0
- aws_syndicate-1.16.2/aws_syndicate.egg-info/requires.txt +10 -0
- aws_syndicate-1.16.2/aws_syndicate.egg-info/top_level.txt +1 -0
- aws_syndicate-1.16.2/setup.cfg +7 -0
- aws_syndicate-1.16.2/setup.py +62 -0
- aws_syndicate-1.16.2/syndicate/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/commons/__init__.py +23 -0
- aws_syndicate-1.16.2/syndicate/commons/log_helper.py +117 -0
- aws_syndicate-1.16.2/syndicate/connection/__init__.py +248 -0
- aws_syndicate-1.16.2/syndicate/connection/api_gateway_connection.py +893 -0
- aws_syndicate-1.16.2/syndicate/connection/application_autoscaling_connection.py +184 -0
- aws_syndicate-1.16.2/syndicate/connection/appsync_connection.py +447 -0
- aws_syndicate-1.16.2/syndicate/connection/batch_connection.py +262 -0
- aws_syndicate-1.16.2/syndicate/connection/cloud_watch_connection.py +643 -0
- aws_syndicate-1.16.2/syndicate/connection/cloudfront_connection.py +67 -0
- aws_syndicate-1.16.2/syndicate/connection/cognito_identity_connection.py +163 -0
- aws_syndicate-1.16.2/syndicate/connection/cognito_identity_provider_connection.py +208 -0
- aws_syndicate-1.16.2/syndicate/connection/dax_connection.py +105 -0
- aws_syndicate-1.16.2/syndicate/connection/documentdb_connection.py +160 -0
- aws_syndicate-1.16.2/syndicate/connection/dynamo_connection.py +1097 -0
- aws_syndicate-1.16.2/syndicate/connection/ec2_connection.py +653 -0
- aws_syndicate-1.16.2/syndicate/connection/elastic_beanstalk_connection.py +185 -0
- aws_syndicate-1.16.2/syndicate/connection/eventbridge_scheduler_connection.py +53 -0
- aws_syndicate-1.16.2/syndicate/connection/firehose_connection.py +59 -0
- aws_syndicate-1.16.2/syndicate/connection/helper.py +150 -0
- aws_syndicate-1.16.2/syndicate/connection/iam_connection.py +671 -0
- aws_syndicate-1.16.2/syndicate/connection/kinesis_connection.py +77 -0
- aws_syndicate-1.16.2/syndicate/connection/kms_connection.py +87 -0
- aws_syndicate-1.16.2/syndicate/connection/lambda_connection.py +826 -0
- aws_syndicate-1.16.2/syndicate/connection/resource_groups_tagging_api_connection.py +58 -0
- aws_syndicate-1.16.2/syndicate/connection/s3_connection.py +577 -0
- aws_syndicate-1.16.2/syndicate/connection/ses_connection.py +80 -0
- aws_syndicate-1.16.2/syndicate/connection/sns_connection.py +280 -0
- aws_syndicate-1.16.2/syndicate/connection/sqs_connection.py +135 -0
- aws_syndicate-1.16.2/syndicate/connection/step_functions_connection.py +138 -0
- aws_syndicate-1.16.2/syndicate/connection/sts_connection.py +83 -0
- aws_syndicate-1.16.2/syndicate/core/__init__.py +230 -0
- aws_syndicate-1.16.2/syndicate/core/build/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/build/artifact_processor.py +75 -0
- aws_syndicate-1.16.2/syndicate/core/build/bundle_processor.py +349 -0
- aws_syndicate-1.16.2/syndicate/core/build/deployment_processor.py +935 -0
- aws_syndicate-1.16.2/syndicate/core/build/helper.py +131 -0
- aws_syndicate-1.16.2/syndicate/core/build/meta_processor.py +693 -0
- aws_syndicate-1.16.2/syndicate/core/build/profiler_processor.py +248 -0
- aws_syndicate-1.16.2/syndicate/core/build/runtime/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/build/runtime/appsync.py +115 -0
- aws_syndicate-1.16.2/syndicate/core/build/runtime/dotnet.py +274 -0
- aws_syndicate-1.16.2/syndicate/core/build/runtime/java.py +69 -0
- aws_syndicate-1.16.2/syndicate/core/build/runtime/nodejs.py +214 -0
- aws_syndicate-1.16.2/syndicate/core/build/runtime/python.py +472 -0
- aws_syndicate-1.16.2/syndicate/core/build/runtime/swagger_ui.py +84 -0
- aws_syndicate-1.16.2/syndicate/core/build/validator/__init__.py +24 -0
- aws_syndicate-1.16.2/syndicate/core/build/validator/batch_compenv_validator.py +415 -0
- aws_syndicate-1.16.2/syndicate/core/build/validator/batch_jobdef_validator.py +454 -0
- aws_syndicate-1.16.2/syndicate/core/build/validator/dynamodb_validator.py +204 -0
- aws_syndicate-1.16.2/syndicate/core/build/validator/ec2_launch_template_validator.py +69 -0
- aws_syndicate-1.16.2/syndicate/core/build/validator/lambda_validator.py +76 -0
- aws_syndicate-1.16.2/syndicate/core/build/validator/mapping.py +75 -0
- aws_syndicate-1.16.2/syndicate/core/build/warmup_processor.py +290 -0
- aws_syndicate-1.16.2/syndicate/core/conf/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/conf/bucket_view.py +168 -0
- aws_syndicate-1.16.2/syndicate/core/conf/generator.py +166 -0
- aws_syndicate-1.16.2/syndicate/core/conf/processor.py +439 -0
- aws_syndicate-1.16.2/syndicate/core/conf/validator.py +447 -0
- aws_syndicate-1.16.2/syndicate/core/constants.py +264 -0
- aws_syndicate-1.16.2/syndicate/core/decorators.py +143 -0
- aws_syndicate-1.16.2/syndicate/core/export/__init__.py +15 -0
- aws_syndicate-1.16.2/syndicate/core/export/configuration_exporter.py +127 -0
- aws_syndicate-1.16.2/syndicate/core/export/export_processor.py +72 -0
- aws_syndicate-1.16.2/syndicate/core/generators/__init__.py +71 -0
- aws_syndicate-1.16.2/syndicate/core/generators/appsync.py +80 -0
- aws_syndicate-1.16.2/syndicate/core/generators/contents.py +921 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/__init__.py +67 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/api_gateway_generator.py +296 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/appsync_generator.py +481 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/base_generator.py +239 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/batch_compenv_generator.py +38 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/batch_jobdef_generator.py +21 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/batch_jobqueue_generator.py +48 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/cloudwatch_alarm_generator.py +47 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/cloudwatch_event_rule_generator.py +33 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/cognito_federated_generator.py +14 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/cognito_user_pool_generator.py +37 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/dax_cluster_generator.py +18 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/docdb_cluster_generator.py +38 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/docdb_instance_generator.py +38 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/dynamodb_generator.py +100 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/ec2_instance_generator.py +26 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/ec2_launch_template_generator.py +43 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/eventbridge_rule_generator.py +7 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/iam_policy_generator.py +27 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/iam_role_generator.py +52 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/kinesis_stream_generator.py +11 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/s3_bucket_generator.py +50 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/sns_application_generator.py +24 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/sns_topic_generator.py +12 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/sqs_queue_generator.py +32 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/step_function_activity_generator.py +10 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/step_function_generator.py +22 -0
- aws_syndicate-1.16.2/syndicate/core/generators/deployment_resources/web_socket_api_gateway_generator.py +42 -0
- aws_syndicate-1.16.2/syndicate/core/generators/lambda_function.py +733 -0
- aws_syndicate-1.16.2/syndicate/core/generators/project.py +115 -0
- aws_syndicate-1.16.2/syndicate/core/generators/swagger_ui.py +97 -0
- aws_syndicate-1.16.2/syndicate/core/generators/tests.py +49 -0
- aws_syndicate-1.16.2/syndicate/core/groups/__init__.py +31 -0
- aws_syndicate-1.16.2/syndicate/core/groups/appsync.py +229 -0
- aws_syndicate-1.16.2/syndicate/core/groups/generate.py +306 -0
- aws_syndicate-1.16.2/syndicate/core/groups/meta.py +1112 -0
- aws_syndicate-1.16.2/syndicate/core/groups/tags.py +81 -0
- aws_syndicate-1.16.2/syndicate/core/handlers.py +1208 -0
- aws_syndicate-1.16.2/syndicate/core/helper.py +872 -0
- aws_syndicate-1.16.2/syndicate/core/project_state/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/project_state/project_state.py +656 -0
- aws_syndicate-1.16.2/syndicate/core/project_state/status_processor.py +196 -0
- aws_syndicate-1.16.2/syndicate/core/project_state/sync_processor.py +53 -0
- aws_syndicate-1.16.2/syndicate/core/resources/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/resources/abstract_external_resource.py +73 -0
- aws_syndicate-1.16.2/syndicate/core/resources/api_gateway_resource.py +1265 -0
- aws_syndicate-1.16.2/syndicate/core/resources/appsync_resource.py +763 -0
- aws_syndicate-1.16.2/syndicate/core/resources/base_resource.py +72 -0
- aws_syndicate-1.16.2/syndicate/core/resources/batch_compenv_resource.py +200 -0
- aws_syndicate-1.16.2/syndicate/core/resources/batch_jobdef_resource.py +99 -0
- aws_syndicate-1.16.2/syndicate/core/resources/batch_jobqueue_resource.py +94 -0
- aws_syndicate-1.16.2/syndicate/core/resources/cloud_watch_alarm_resource.py +123 -0
- aws_syndicate-1.16.2/syndicate/core/resources/cloud_watch_resource.py +201 -0
- aws_syndicate-1.16.2/syndicate/core/resources/cognito_identity_resource.py +105 -0
- aws_syndicate-1.16.2/syndicate/core/resources/cognito_user_pool_resource.py +189 -0
- aws_syndicate-1.16.2/syndicate/core/resources/dax_resource.py +117 -0
- aws_syndicate-1.16.2/syndicate/core/resources/docdb_cluster_resource.py +111 -0
- aws_syndicate-1.16.2/syndicate/core/resources/docdb_instance_resource.py +91 -0
- aws_syndicate-1.16.2/syndicate/core/resources/dynamo_db_resource.py +413 -0
- aws_syndicate-1.16.2/syndicate/core/resources/ebs_resource.py +242 -0
- aws_syndicate-1.16.2/syndicate/core/resources/ec2_resource.py +400 -0
- aws_syndicate-1.16.2/syndicate/core/resources/eventbridge_scheduler_resource.py +153 -0
- aws_syndicate-1.16.2/syndicate/core/resources/firehose_resource.py +78 -0
- aws_syndicate-1.16.2/syndicate/core/resources/group_tagging_api_resource.py +261 -0
- aws_syndicate-1.16.2/syndicate/core/resources/helper.py +185 -0
- aws_syndicate-1.16.2/syndicate/core/resources/iam_resource.py +342 -0
- aws_syndicate-1.16.2/syndicate/core/resources/kinesis_resource.py +79 -0
- aws_syndicate-1.16.2/syndicate/core/resources/lambda_resource.py +1465 -0
- aws_syndicate-1.16.2/syndicate/core/resources/processors_mapping.py +313 -0
- aws_syndicate-1.16.2/syndicate/core/resources/resources_provider.py +371 -0
- aws_syndicate-1.16.2/syndicate/core/resources/s3_resource.py +208 -0
- aws_syndicate-1.16.2/syndicate/core/resources/sns_resource.py +309 -0
- aws_syndicate-1.16.2/syndicate/core/resources/sqs_resource.py +147 -0
- aws_syndicate-1.16.2/syndicate/core/resources/step_functions_resource.py +230 -0
- aws_syndicate-1.16.2/syndicate/core/resources/swagger_ui_resource.py +165 -0
- aws_syndicate-1.16.2/syndicate/core/transform/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/transform/build_meta_transformer.py +150 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/cf_transform_utils.py +93 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/cloudformation_transformer.py +145 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_api_gateway_converter.py +498 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_batch_compenv_converter.py +99 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_batch_job_defeinition.py +106 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_batch_job_queue_converter.py +47 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_cloudwatch_alarm_converter.py +49 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_cloudwatch_rule_converter.py +126 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_cognito_converter.py +61 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_dynamodb_table_converter.py +222 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_iam_managed_policy_converter.py +29 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_iam_role_converter.py +102 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_kinesis_stream_converter.py +31 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_lambda_function_converter.py +394 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_lambda_layer_converter.py +44 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_resource_converter.py +34 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_s3_converter.py +141 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_sns_application_converter.py +25 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_sns_converter.py +96 -0
- aws_syndicate-1.16.2/syndicate/core/transform/cloudformation/converter/cf_sqs_converter.py +107 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/__init__.py +0 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_api_gateway_converter.py +700 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_batch_compenv_converter.py +179 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_batch_jobdef_converter.py +85 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_batch_jobqueue_converter.py +55 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_cloud_watch_alram_converter.py +86 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_cloud_watch_rule_converter.py +150 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_cognito_converter.py +100 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_dynamo_db_converter.py +283 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_iam_policy_converter.py +42 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_iam_role_converter.py +80 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_kinesis_stream_converter.py +37 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_lambda_converter.py +573 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_lambda_layer_converter.py +68 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_resource_converter.py +32 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_s3_bucket_converter.py +99 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_sns_app_converter.py +52 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_sns_topic_converter.py +142 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/converter/tf_sqs_converter.py +228 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/terraform_template.py +478 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/terraform_transformer.py +163 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/tf_helper.py +41 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/tf_resource_name_builder.py +27 -0
- aws_syndicate-1.16.2/syndicate/core/transform/terraform/tf_resource_reference_builder.py +147 -0
- aws_syndicate-1.16.2/syndicate/core/transform/transform_processor.py +70 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
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.
|
|
@@ -0,0 +1,457 @@
|
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
|
+
Name: aws-syndicate
|
|
3
|
+
Version: 1.16.2
|
|
4
|
+
Summary: AWS-syndicate is an Amazon Web Services deployment framework written in Python, which allows to easily deploy serverless applications using resource descriptions.
|
|
5
|
+
Home-page: https://github.com/epam/aws-syndicate
|
|
6
|
+
Author: EPAM Systems
|
|
7
|
+
Author-email: support@syndicate.team
|
|
8
|
+
Keywords: AWS,SERVERLESS,CLOUD,LAMBDA,DEPLOY
|
|
9
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Topic :: Software Development :: Build Tools
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
13
|
+
Description-Content-Type: text/markdown
|
|
14
|
+
License-File: LICENSE
|
|
15
|
+
Requires-Dist: click==7.1.2
|
|
16
|
+
Requires-Dist: botocore==1.29.80
|
|
17
|
+
Requires-Dist: boto3==1.26.80
|
|
18
|
+
Requires-Dist: tqdm==4.65.2
|
|
19
|
+
Requires-Dist: pyyaml==6.0.1
|
|
20
|
+
Requires-Dist: requests-aws-sign==0.1.6
|
|
21
|
+
Requires-Dist: requests==2.31.0
|
|
22
|
+
Requires-Dist: tabulate==0.9.0
|
|
23
|
+
Requires-Dist: troposphere==4.1.0
|
|
24
|
+
Requires-Dist: setuptools<=70.0.0,>65.5.0
|
|
25
|
+
Dynamic: author
|
|
26
|
+
Dynamic: author-email
|
|
27
|
+
Dynamic: classifier
|
|
28
|
+
Dynamic: description
|
|
29
|
+
Dynamic: description-content-type
|
|
30
|
+
Dynamic: home-page
|
|
31
|
+
Dynamic: keywords
|
|
32
|
+
Dynamic: requires-dist
|
|
33
|
+
Dynamic: summary
|
|
34
|
+
|
|
35
|
+
[](http://www.apache.org/licenses/LICENSE-2.0.txt)
|
|
36
|
+
|
|
37
|
+
[](https://pypi.org/project/aws-syndicate)
|
|
38
|
+
[](https://pypi.org/project/aws-syndicate)
|
|
39
|
+
|
|
40
|
+
[](https://maven-badges.herokuapp.com/maven-central/net.sf.aws-syndicate/deployment-configuration-processor)
|
|
41
|
+
|
|
42
|
+
# Syndicate
|
|
43
|
+
|
|
44
|
+
aws-syndicate is an Amazon Web Services deployment framework written in Python,
|
|
45
|
+
which allows to easily deploy serverless applications using resource
|
|
46
|
+
descriptions.
|
|
47
|
+
|
|
48
|
+
## Changelog
|
|
49
|
+
|
|
50
|
+
[See CHANGELOG here](https://github.com/epam/aws-syndicate/blob/master/CHANGELOG.md "aws-syndicate changelog")
|
|
51
|
+
|
|
52
|
+
## 1. Installation
|
|
53
|
+
|
|
54
|
+
### 1.1 Installation from PyPI
|
|
55
|
+
|
|
56
|
+
[Install aws-syndicate from PyPI](https://pypi.org/project/aws-syndicate/ "aws-syndicate on PyPI")
|
|
57
|
+
|
|
58
|
+
### 1.2 Installation from source code
|
|
59
|
+
|
|
60
|
+
#### 1.2.1 Prerequisites
|
|
61
|
+
|
|
62
|
+
1) [Python 3.10](https://www.python.org/downloads/ "Python 3.10") version;
|
|
63
|
+
2) Package manager [PIP 22.0](https://pypi.org/project/pip/ "PIP 22.0")
|
|
64
|
+
or higher version;
|
|
65
|
+
3) [Apache Maven 3.3.9](https://maven.apache.org/download.cgi "Apache Maven 3.3.9")
|
|
66
|
+
or higher version (for Java projects).
|
|
67
|
+
4) [SDK 8.0.402](https://dotnet.microsoft.com/en-us/download/dotnet/8.0 "SDK 8.0.402")
|
|
68
|
+
or higher version (for .NET projects).
|
|
69
|
+
|
|
70
|
+
#### 1.2.2 Installation on macOS
|
|
71
|
+
|
|
72
|
+
Detailed guide how to install Python you can find
|
|
73
|
+
[here](https://docs.python-guide.org/starting/install3/osx/ "here").
|
|
74
|
+
Also [here](https://www.baeldung.com/install-maven-on-windows-linux-mac "here")
|
|
75
|
+
you can find detailed guild how to install
|
|
76
|
+
the [latest Apache Maven](https://maven.apache.org/download.cgi "latest Apache Maven").
|
|
77
|
+
.NET installation guide can be found [here](https://learn.microsoft.com/en-us/dotnet/core/install/macos ".NET installation guide"), it is needed if you plan to work with runtime `.NET`.
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
1. Pull the project
|
|
81
|
+
```shell
|
|
82
|
+
git clone https://github.com/epam/aws-syndicate.git
|
|
83
|
+
```
|
|
84
|
+
2. Create virtual environment:
|
|
85
|
+
```shell
|
|
86
|
+
python3 -m venv syndicate_venv
|
|
87
|
+
```
|
|
88
|
+
3. Activate your virtual environment:
|
|
89
|
+
```shell
|
|
90
|
+
source syndicate_venv/bin/activate
|
|
91
|
+
```
|
|
92
|
+
4. Install Syndicate framework with pip from GitHub:
|
|
93
|
+
```shell
|
|
94
|
+
pip3 install aws-syndicate/.
|
|
95
|
+
```
|
|
96
|
+
5. Set up a Syndicate Java [plugin](https://github.com/epam/aws-syndicate/tree/master/plugin "plugin"):
|
|
97
|
+
```shell
|
|
98
|
+
mvn install -f aws-syndicate/plugin/
|
|
99
|
+
```
|
|
100
|
+
6. Go to the `2. Usage guide`
|
|
101
|
+
|
|
102
|
+
#### 1.2.2 Installation on Linux
|
|
103
|
+
|
|
104
|
+
Detailed guide how to install Python you can
|
|
105
|
+
find [here](https://docs.python-guide.org/starting/install3/linux/ "here").
|
|
106
|
+
Also [here](https://www.baeldung.com/install-maven-on-windows-linux-mac "here")
|
|
107
|
+
you can find detailed guild how to install
|
|
108
|
+
the [latest Apache Maven](https://maven.apache.org/download.cgi "latest Apache Maven").
|
|
109
|
+
.NET installation guide can be found [here](https://learn.microsoft.com/en-us/dotnet/core/install/linux ".NET installation guide"), it is needed if you plan to work with runtime `.NET`.
|
|
110
|
+
|
|
111
|
+
1. Pull the project
|
|
112
|
+
```shell
|
|
113
|
+
git clone https://github.com/epam/aws-syndicate.git
|
|
114
|
+
```
|
|
115
|
+
2. Create virtual environment:
|
|
116
|
+
```shell
|
|
117
|
+
python3 -m venv syndicate_venv
|
|
118
|
+
```
|
|
119
|
+
3. Activate your virtual environment:
|
|
120
|
+
```shell
|
|
121
|
+
source syndicate_venv/bin/activate
|
|
122
|
+
```
|
|
123
|
+
4. Install Syndicate framework with pip from GitHub:
|
|
124
|
+
```shell
|
|
125
|
+
pip3 install aws-syndicate/.
|
|
126
|
+
```
|
|
127
|
+
5. Set up a Syndicate Java [plugin](https://github.com/epam/aws-syndicate/tree/master/plugin "plugin"):
|
|
128
|
+
```shell
|
|
129
|
+
mvn install -f aws-syndicate/plugin/
|
|
130
|
+
```
|
|
131
|
+
6. Go to the `2. Usage guide`
|
|
132
|
+
|
|
133
|
+
#### 1.2.3 Installation on Windows
|
|
134
|
+
|
|
135
|
+
Detailed guide how to install Python you can
|
|
136
|
+
find [here](https://docs.python-guide.org/starting/install3/win/ "here").
|
|
137
|
+
Also [here](https://www.baeldung.com/install-maven-on-windows-linux-mac "here")
|
|
138
|
+
you can find detailed guild how to install
|
|
139
|
+
the [latest Apache Maven](https://maven.apache.org/download.cgi "latest Apache Maven").
|
|
140
|
+
.NET installation guide can be found [here](https://learn.microsoft.com/en-us/dotnet/core/install/windows ".NET installation guide"), it is needed if you plan to work with runtime `.NET`.
|
|
141
|
+
|
|
142
|
+
1. Pull the project
|
|
143
|
+
```shell
|
|
144
|
+
git clone https://github.com/epam/aws-syndicate.git
|
|
145
|
+
```
|
|
146
|
+
2. Create virtual environment:
|
|
147
|
+
```shell
|
|
148
|
+
python3 -m venv syndicate_venv
|
|
149
|
+
```
|
|
150
|
+
3. Activate your virtual environment:
|
|
151
|
+
```shell
|
|
152
|
+
syndicate_venv\Scripts\activate.bat
|
|
153
|
+
```
|
|
154
|
+
4. Install Syndicate framework with pip from GitHub:
|
|
155
|
+
```shell
|
|
156
|
+
pip3 install aws-syndicate/.
|
|
157
|
+
```
|
|
158
|
+
5. Set up a Syndicate Java [plugin](https://github.com/epam/aws-syndicate/tree/master/plugin "plugin"):
|
|
159
|
+
```shell
|
|
160
|
+
mvn install -f aws-syndicate/plugin/
|
|
161
|
+
```
|
|
162
|
+
6. Go to the `2. Usage guide`
|
|
163
|
+
|
|
164
|
+
## 2. Usage guide
|
|
165
|
+
|
|
166
|
+
### 2.1 Creating Project files
|
|
167
|
+
|
|
168
|
+
Execute `syndicate generate project` command to generate the project with all the
|
|
169
|
+
necessary components and in a right folders/files hierarchy to start developing
|
|
170
|
+
in a min. Command example:
|
|
171
|
+
```shell
|
|
172
|
+
syndicate generate project
|
|
173
|
+
--name $project_name
|
|
174
|
+
--config_path $path_to_project
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
All the provided information is validated. After the project folder will be
|
|
178
|
+
generated the command will return the following message:
|
|
179
|
+
```shell
|
|
180
|
+
Project name: $project_name
|
|
181
|
+
Project path: $path_to_project
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
The following files will be created in this folder: .gitignore, .syndicate,
|
|
185
|
+
CHANGELOG.md, deployment_resources.json, README.md.
|
|
186
|
+
|
|
187
|
+
Command sample:
|
|
188
|
+
```shell
|
|
189
|
+
syndicate generate project --name DemoSyndicateJava && cd DemoSyndicateJava
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
For more details please execute `syndicate generate project --help`
|
|
193
|
+
|
|
194
|
+
### 2.2 Creating configuration files for environment
|
|
195
|
+
|
|
196
|
+
Execute the `syndicate generate config` command to create Syndicate configuration
|
|
197
|
+
files. Command example:
|
|
198
|
+
|
|
199
|
+
```shell
|
|
200
|
+
syndicate generate config
|
|
201
|
+
--name $configuration_name [required]
|
|
202
|
+
--region $region_name [required]
|
|
203
|
+
--bundle_bucket_name $s3_bucket_name [required]
|
|
204
|
+
--access_key $access_key
|
|
205
|
+
--secret_key $secret_key
|
|
206
|
+
--config_path $path_to_store_config
|
|
207
|
+
--project_path $relative_path_to_project
|
|
208
|
+
--prefix $prefix
|
|
209
|
+
--suffix $suffix
|
|
210
|
+
--extended_prefix $extended_prefix_mode
|
|
211
|
+
--use_temp_creds $use_temp_creds #Specify,if use mfa or access_role
|
|
212
|
+
--access_role $role_name
|
|
213
|
+
--serial_number $serial_number
|
|
214
|
+
--tags $KEY:VALUE
|
|
215
|
+
--iam_permissions_boundary $ARN
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
All the provided information is validated.
|
|
219
|
+
|
|
220
|
+
*Note:* you may not specify `--access_key` and `--secret_key` params. In this
|
|
221
|
+
case Syndicate will try to find your credentials by the path `~/.aws`.
|
|
222
|
+
|
|
223
|
+
*Note:* You can force Syndicate to generate temporary credentials and use them
|
|
224
|
+
for deployment. For such cases, set `use_temp_creds` parameter to `True` and
|
|
225
|
+
specify serial number if IAM user which will be used for deployment has a policy
|
|
226
|
+
that requires MFA authentication. Syndicate will prompt you to enter MFA code to
|
|
227
|
+
generate new credentials, save and use them until expiration.
|
|
228
|
+
|
|
229
|
+
After the configuration files will be generated the command will return the
|
|
230
|
+
following message:
|
|
231
|
+
```shell
|
|
232
|
+
Syndicate initialization has been completed.
|
|
233
|
+
Set SDCT_CONF:
|
|
234
|
+
Unix: export SDCT_CONF=$path_to_store_config
|
|
235
|
+
Windows: setx SDCT_CONF $path_to_store_config
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
Just copy one of the last two lines, depending on your OS, and execute the
|
|
239
|
+
command. The commands set the environment variable SDCT_CONF required by
|
|
240
|
+
aws-syndicate to operate.
|
|
241
|
+
|
|
242
|
+
> Pay attention that the default syndicate_aliases.yaml file has been generated.
|
|
243
|
+
> Your application may require additional aliases to be deployed - please add them to the file.
|
|
244
|
+
|
|
245
|
+
Command sample:
|
|
246
|
+
```shell
|
|
247
|
+
SYNDICATE_AWS_ACCESS_KEY=# enter your aws_access_key_id here
|
|
248
|
+
SYNDICATE_AWS_SECRET_KEY=# enter your aws_secret_access_key here
|
|
249
|
+
syndicate generate config --name dev --region eu-central-1 --bundle_bucket_name syndicate-artifacts-eu-central-1 --access_key $SYNDICATE_AWS_ACCESS_KEY --secret_key $SYNDICATE_AWS_SECRET_KEY --config_path $(pwd) --prefix syn- --suffix -dev --tags ENV:DEV
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
For more details please execute `syndicate generate config --help`
|
|
253
|
+
|
|
254
|
+
### 2.3 Creating lambda files
|
|
255
|
+
|
|
256
|
+
Execute `syndicate generate lambda` command to generate required environment for
|
|
257
|
+
lambda function except business logic. Command example:
|
|
258
|
+
```shell
|
|
259
|
+
syndicate generate lambda
|
|
260
|
+
--name $lambda_name_1
|
|
261
|
+
--runtime python|java|nodejs|dotnet
|
|
262
|
+
--project_path $project_path
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
All the provided information is validated. Different environments will be
|
|
266
|
+
created for different runtimes:
|
|
267
|
+
|
|
268
|
+
* for Python
|
|
269
|
+
|
|
270
|
+
```
|
|
271
|
+
.
|
|
272
|
+
├── $project_path
|
|
273
|
+
│ └── src
|
|
274
|
+
│ ├── commons
|
|
275
|
+
│ │ ├── __init__.py
|
|
276
|
+
│ │ ├── abstract_lambda.py
|
|
277
|
+
│ │ ├── exception.py
|
|
278
|
+
│ │ └── log_helper.py
|
|
279
|
+
│ └── lambdas
|
|
280
|
+
│ ├── $lambda_name_1
|
|
281
|
+
│ │ ├── __init__.py
|
|
282
|
+
│ │ ├── deployment_resources.json
|
|
283
|
+
│ │ ├── handler.py
|
|
284
|
+
│ │ ├── lambda_config.json
|
|
285
|
+
│ │ ├── local_requirements.txt
|
|
286
|
+
│ │ └── requirements.txt
|
|
287
|
+
│ ├── $lambda_name_2
|
|
288
|
+
│ │ ├── __init__.py
|
|
289
|
+
│ │ ├── deployment_resources.json
|
|
290
|
+
│ │ ├── handler.py
|
|
291
|
+
│ │ ├── lambda_config.json
|
|
292
|
+
│ │ ├── local_requirements.txt
|
|
293
|
+
│ │ └── requirements.txt
|
|
294
|
+
│ ├── __init__.py
|
|
295
|
+
│ └── ...
|
|
296
|
+
└── ...
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
* for Java
|
|
300
|
+
|
|
301
|
+
```
|
|
302
|
+
.
|
|
303
|
+
├── $project_path
|
|
304
|
+
│ └── jsrc
|
|
305
|
+
│ └── main
|
|
306
|
+
│ └── java
|
|
307
|
+
│ └── com
|
|
308
|
+
│ └── $projectpath
|
|
309
|
+
│ ├── $lambda_name_1.java
|
|
310
|
+
│ └── $lambda_name_2.java
|
|
311
|
+
└── ...
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
* for NodeJS
|
|
315
|
+
|
|
316
|
+
```
|
|
317
|
+
.
|
|
318
|
+
├── $project_path
|
|
319
|
+
│ └── app
|
|
320
|
+
│ └── lambdas
|
|
321
|
+
│ ├── $lambda_name_1
|
|
322
|
+
│ │ ├── deployment_resources.json
|
|
323
|
+
│ │ ├── lambda_config.json
|
|
324
|
+
│ │ ├── index.js
|
|
325
|
+
│ │ ├── package.json
|
|
326
|
+
│ │ └── package-lock.json
|
|
327
|
+
│ └── $lambda_name_2
|
|
328
|
+
│ ├── deployment_resources.json
|
|
329
|
+
│ ├── lambda_config.json
|
|
330
|
+
│ ├── index.js
|
|
331
|
+
│ ├── package.json
|
|
332
|
+
│ └── package-lock.json
|
|
333
|
+
└── ...
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
* for .NET
|
|
337
|
+
|
|
338
|
+
```
|
|
339
|
+
.
|
|
340
|
+
├── $project_path
|
|
341
|
+
│ └── dnapp
|
|
342
|
+
│ └── lambdas
|
|
343
|
+
│ └── $lambda_name
|
|
344
|
+
│ ├── deployment_resources.json
|
|
345
|
+
│ ├── lambda_config.json
|
|
346
|
+
│ ├── Function.cs
|
|
347
|
+
│ └── Function.csproj
|
|
348
|
+
└── ...
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
Command sample:
|
|
352
|
+
```shell
|
|
353
|
+
syndicate generate lambda --name DemoLambda --runtime java --project_path $(pwd)
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
For more details please execute `syndicate generate lambda --help`
|
|
357
|
+
|
|
358
|
+
### 2.4 Add other infrastructure components
|
|
359
|
+
|
|
360
|
+
This step is optional and could be skipped while getting familiar with syndicate.
|
|
361
|
+
|
|
362
|
+
All the resources syndicate works with could be generated in the same way as lambda.
|
|
363
|
+
Invoke the `syndicate generate meta --help` command to find out which resources are available.
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
### 2.5 Open project in your IDE
|
|
367
|
+
|
|
368
|
+
Now the project is ready to be adjusted. Consider opening your favourite IDE and observe the files created by syndicate.
|
|
369
|
+
|
|
370
|
+
## 3. Deployment
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
### 3.1 Create an S3 bucket for aws-syndicate artifacts:
|
|
374
|
+
```shell
|
|
375
|
+
syndicate create_deploy_target_bucket
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
### 3.2 Build project artifacts
|
|
379
|
+
```shell
|
|
380
|
+
syndicate build
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
### 3.3 Deploy project resources to AWS account
|
|
384
|
+
```shell
|
|
385
|
+
syndicate deploy
|
|
386
|
+
```
|
|
387
|
+
Now the DemoLambda is created and available to be tested.
|
|
388
|
+
|
|
389
|
+
### 3.4 Update resources
|
|
390
|
+
In order to be sure your latest changes works well on the AWS account the application should be deployed to the AWS account.
|
|
391
|
+
To do this use the following commands set:
|
|
392
|
+
```shell
|
|
393
|
+
syndicate build
|
|
394
|
+
syndicate update
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
### 3.5 Lambdas invocations metrics
|
|
398
|
+
```shell
|
|
399
|
+
syndicate profiler
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
### 3.6 Clean up project resources from AWS Account
|
|
403
|
+
```shell
|
|
404
|
+
syndicate clean
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
### 3.7 Observing the environment manipulation history
|
|
408
|
+
```shell
|
|
409
|
+
syndicate status # this shows the general CLI dashboard where latest modification, locks state, latest event, project resources are shown
|
|
410
|
+
syndicate status --events # this returns all the history of what happened to the environment
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
## 4. Examples
|
|
414
|
+
|
|
415
|
+
If you are just getting familiar with the functionality, you can use one of the
|
|
416
|
+
pre-prepared examples that contain a minimum set of AWS resources and lambdas.
|
|
417
|
+
|
|
418
|
+
The aws-syndicate/examples folder contains structure examples for different
|
|
419
|
+
runtimes. Go to any example you like best and set the environment
|
|
420
|
+
variable `SDCT_CONF=$path_to_the_selected_example`.
|
|
421
|
+
|
|
422
|
+
Add your account details to `syndicate.yml` file - account id,
|
|
423
|
+
secret access key, access key and bucket name for deployment.
|
|
424
|
+
To `syndicate_aliases.yml` add your account id, region
|
|
425
|
+
name (eu-central-1, us-west-1, etc.) and other values in the file that start
|
|
426
|
+
with a `$` sign.
|
|
427
|
+
|
|
428
|
+
Documentation
|
|
429
|
+
------------
|
|
430
|
+
Documentation you can find [here](https://github.com/epam/aws-syndicate/wiki)
|
|
431
|
+
|
|
432
|
+
Getting Help
|
|
433
|
+
------------
|
|
434
|
+
|
|
435
|
+
We use GitHub issues for tracking bugs and feature requests. You can find our
|
|
436
|
+
public backlog [here](https://github.com/epam/aws-syndicate/projects/1). If it
|
|
437
|
+
turns out that you may have found a bug,
|
|
438
|
+
please [open an issue](https://github.com/epam/aws-syndicate/issues/new/choose)
|
|
439
|
+
with some of existing templates.
|
|
440
|
+
|
|
441
|
+
Default label for bugs, improvements and feature requests is `To-Think-About`,
|
|
442
|
+
it defines that ticket requires additional information about what should be done
|
|
443
|
+
in scope of this issue.
|
|
444
|
+
`To-Do` label should be added only for tickets with clear and reviewed issue
|
|
445
|
+
scope.
|
|
446
|
+
|
|
447
|
+
But before creating new issues - check existing, they may cover your problem or
|
|
448
|
+
question. For increasing issue priority - just add "+1" comment.
|
|
449
|
+
|
|
450
|
+
Would like to contribute?
|
|
451
|
+
-------------------------
|
|
452
|
+
|
|
453
|
+
Please,
|
|
454
|
+
check [contributor guide](https://github.com/epam/aws-syndicate/blob/master/CONTRIBUTING.md)
|
|
455
|
+
before starting.
|
|
456
|
+
|
|
457
|
+
# [](https://sonarcloud.io/dashboard?id=aws-syndicate)
|