[](http://www.apache.org/licenses/LICENSE-2.0.txt)
[](https://pypi.org/project/aws-syndicate)
[](https://pypi.org/project/aws-syndicate)
[](https://maven-badges.herokuapp.com/maven-central/net.sf.aws-syndicate/deployment-configuration-processor)
# Syndicate
aws-syndicate is an Amazon Web Services deployment framework written in Python,
which allows to easily deploy serverless applications using resource
descriptions.
## Changelog
[See CHANGELOG here](https://github.com/epam/aws-syndicate/blob/master/CHANGELOG.md "aws-syndicate changelog")
## 1. Installation
### 1.1 Installation from PyPI
[Install aws-syndicate from PyPI](https://pypi.org/project/aws-syndicate/ "aws-syndicate on PyPI")
### 1.2 Installation from source code
#### 1.2.1 Prerequisites
1) [Python 3.10](https://www.python.org/downloads/ "Python 3.10") version;
2) Package manager [PIP 22.0](https://pypi.org/project/pip/ "PIP 22.0")
or higher version;
3) [Apache Maven 3.3.9](https://maven.apache.org/download.cgi "Apache Maven 3.3.9")
or higher version (for Java projects).
4) [SDK 8.0.402](https://dotnet.microsoft.com/en-us/download/dotnet/8.0 "SDK 8.0.402")
or higher version (for .NET projects).
#### 1.2.2 Installation on macOS
Detailed guide how to install Python you can find
[here](https://docs.python-guide.org/starting/install3/osx/ "here").
Also [here](https://www.baeldung.com/install-maven-on-windows-linux-mac "here")
you can find detailed guild how to install
the [latest Apache Maven](https://maven.apache.org/download.cgi "latest Apache Maven").
.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`.
1. Pull the project
```shell
git clone https://github.com/epam/aws-syndicate.git
```
2. Create virtual environment:
```shell
python3 -m venv syndicate_venv
```
3. Activate your virtual environment:
```shell
source syndicate_venv/bin/activate
```
4. Install Syndicate framework with pip from GitHub:
```shell
pip3 install aws-syndicate/.
```
5. Set up a Syndicate Java [plugin](https://github.com/epam/aws-syndicate/tree/master/plugin "plugin"):
```shell
mvn install -f aws-syndicate/plugin/
```
6. Go to the `2. Usage guide`
#### 1.2.2 Installation on Linux
Detailed guide how to install Python you can
find [here](https://docs.python-guide.org/starting/install3/linux/ "here").
Also [here](https://www.baeldung.com/install-maven-on-windows-linux-mac "here")
you can find detailed guild how to install
the [latest Apache Maven](https://maven.apache.org/download.cgi "latest Apache Maven").
.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`.
1. Pull the project
```shell
git clone https://github.com/epam/aws-syndicate.git
```
2. Create virtual environment:
```shell
python3 -m venv syndicate_venv
```
3. Activate your virtual environment:
```shell
source syndicate_venv/bin/activate
```
4. Install Syndicate framework with pip from GitHub:
```shell
pip3 install aws-syndicate/.
```
5. Set up a Syndicate Java [plugin](https://github.com/epam/aws-syndicate/tree/master/plugin "plugin"):
```shell
mvn install -f aws-syndicate/plugin/
```
6. Go to the `2. Usage guide`
#### 1.2.3 Installation on Windows
Detailed guide how to install Python you can
find [here](https://docs.python-guide.org/starting/install3/win/ "here").
Also [here](https://www.baeldung.com/install-maven-on-windows-linux-mac "here")
you can find detailed guild how to install
the [latest Apache Maven](https://maven.apache.org/download.cgi "latest Apache Maven").
.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`.
1. Pull the project
```shell
git clone https://github.com/epam/aws-syndicate.git
```
2. Create virtual environment:
```shell
python3 -m venv syndicate_venv
```
3. Activate your virtual environment:
```shell
syndicate_venv\Scripts\activate.bat
```
4. Install Syndicate framework with pip from GitHub:
```shell
pip3 install aws-syndicate/.
```
5. Set up a Syndicate Java [plugin](https://github.com/epam/aws-syndicate/tree/master/plugin "plugin"):
```shell
mvn install -f aws-syndicate/plugin/
```
6. Go to the `2. Usage guide`
## 2. Usage guide
### 2.1 Creating Project files
Execute `syndicate generate project` command to generate the project with all the
necessary components and in a right folders/files hierarchy to start developing
in a min. Command example:
```shell
syndicate generate project
--name $project_name
--config_path $path_to_project
```
All the provided information is validated. After the project folder will be
generated the command will return the following message:
```shell
Project name: $project_name
Project path: $path_to_project
```
The following files will be created in this folder: .gitignore, .syndicate,
CHANGELOG.md, deployment_resources.json, README.md.
Command sample:
```shell
syndicate generate project --name DemoSyndicateJava && cd DemoSyndicateJava
```
For more details please execute `syndicate generate project --help`
### 2.2 Creating configuration files for environment
Execute the `syndicate generate config` command to create Syndicate configuration
files. Command example:
```shell
syndicate generate config
--name $configuration_name [required]
--region $region_name [required]
--bundle_bucket_name $s3_bucket_name [required]
--access_key $access_key
--secret_key $secret_key
--config_path $path_to_store_config
--project_path $relative_path_to_project
--prefix $prefix
--suffix $suffix
--extended_prefix $extended_prefix_mode
--use_temp_creds $use_temp_creds #Specify,if use mfa or access_role
--access_role $role_name
--serial_number $serial_number
--tags $KEY:VALUE
--iam_permissions_boundary $ARN
```
All the provided information is validated.
*Note:* you may not specify `--access_key` and `--secret_key` params. In this
case Syndicate will try to find your credentials by the path `~/.aws`.
*Note:* You can force Syndicate to generate temporary credentials and use them
for deployment. For such cases, set `use_temp_creds` parameter to `True` and
specify serial number if IAM user which will be used for deployment has a policy
that requires MFA authentication. Syndicate will prompt you to enter MFA code to
generate new credentials, save and use them until expiration.
After the configuration files will be generated the command will return the
following message:
```shell
Syndicate initialization has been completed.
Set SDCT_CONF:
Unix: export SDCT_CONF=$path_to_store_config
Windows: setx SDCT_CONF $path_to_store_config
```
Just copy one of the last two lines, depending on your OS, and execute the
command. The commands set the environment variable SDCT_CONF required by
aws-syndicate to operate.
> Pay attention that the default syndicate_aliases.yaml file has been generated.
> Your application may require additional aliases to be deployed - please add them to the file.
Command sample:
```shell
SYNDICATE_AWS_ACCESS_KEY=# enter your aws_access_key_id here
SYNDICATE_AWS_SECRET_KEY=# enter your aws_secret_access_key here
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
```
For more details please execute `syndicate generate config --help`
### 2.3 Creating lambda files
Execute `syndicate generate lambda` command to generate required environment for
lambda function except business logic. Command example:
```shell
syndicate generate lambda
--name $lambda_name_1
--runtime python|java|nodejs|dotnet
--project_path $project_path
```
All the provided information is validated. Different environments will be
created for different runtimes:
* for Python
```
.
├── $project_path
│ └── src
│ ├── commons
│ │ ├── __init__.py
│ │ ├── abstract_lambda.py
│ │ ├── exception.py
│ │ └── log_helper.py
│ └── lambdas
│ ├── $lambda_name_1
│ │ ├── __init__.py
│ │ ├── deployment_resources.json
│ │ ├── handler.py
│ │ ├── lambda_config.json
│ │ ├── local_requirements.txt
│ │ └── requirements.txt
│ ├── $lambda_name_2
│ │ ├── __init__.py
│ │ ├── deployment_resources.json
│ │ ├── handler.py
│ │ ├── lambda_config.json
│ │ ├── local_requirements.txt
│ │ └── requirements.txt
│ ├── __init__.py
│ └── ...
└── ...
```
* for Java
```
.
├── $project_path
│ └── jsrc
│ └── main
│ └── java
│ └── com
│ └── $projectpath
│ ├── $lambda_name_1.java
│ └── $lambda_name_2.java
└── ...
```
* for NodeJS
```
.
├── $project_path
│ └── app
│ └── lambdas
│ ├── $lambda_name_1
│ │ ├── deployment_resources.json
│ │ ├── lambda_config.json
│ │ ├── index.js
│ │ ├── package.json
│ │ └── package-lock.json
│ └── $lambda_name_2
│ ├── deployment_resources.json
│ ├── lambda_config.json
│ ├── index.js
│ ├── package.json
│ └── package-lock.json
└── ...
```
* for .NET
```
.
├── $project_path
│ └── dnapp
│ └── lambdas
│ └── $lambda_name
│ ├── deployment_resources.json
│ ├── lambda_config.json
│ ├── Function.cs
│ └── Function.csproj
└── ...
```
Command sample:
```shell
syndicate generate lambda --name DemoLambda --runtime java --project_path $(pwd)
```
For more details please execute `syndicate generate lambda --help`
### 2.4 Add other infrastructure components
This step is optional and could be skipped while getting familiar with syndicate.
All the resources syndicate works with could be generated in the same way as lambda.
Invoke the `syndicate generate meta --help` command to find out which resources are available.
### 2.5 Open project in your IDE
Now the project is ready to be adjusted. Consider opening your favourite IDE and observe the files created by syndicate.
## 3. Deployment
### 3.1 Create an S3 bucket for aws-syndicate artifacts:
```shell
syndicate create_deploy_target_bucket
```
### 3.2 Build project artifacts
```shell
syndicate build
```
### 3.3 Deploy project resources to AWS account
```shell
syndicate deploy
```
Now the DemoLambda is created and available to be tested.
### 3.4 Update resources
In order to be sure your latest changes works well on the AWS account the application should be deployed to the AWS account.
To do this use the following commands set:
```shell
syndicate build
syndicate update
```
### 3.5 Lambdas invocations metrics
```shell
syndicate profiler
```
### 3.6 Clean up project resources from AWS Account
```shell
syndicate clean
```
### 3.7 Observing the environment manipulation history
```shell
syndicate status # this shows the general CLI dashboard where latest modification, locks state, latest event, project resources are shown
syndicate status --events # this returns all the history of what happened to the environment
```
## 4. Examples
If you are just getting familiar with the functionality, you can use one of the
pre-prepared examples that contain a minimum set of AWS resources and lambdas.
The aws-syndicate/examples folder contains structure examples for different
runtimes. Go to any example you like best and set the environment
variable `SDCT_CONF=$path_to_the_selected_example`.
Add your account details to `syndicate.yml` file - account id,
secret access key, access key and bucket name for deployment.
To `syndicate_aliases.yml` add your account id, region
name (eu-central-1, us-west-1, etc.) and other values in the file that start
with a `$` sign.
Documentation
------------
Documentation you can find [here](https://github.com/epam/aws-syndicate/wiki)
Getting Help
------------
We use GitHub issues for tracking bugs and feature requests. You can find our
public backlog [here](https://github.com/epam/aws-syndicate/projects/1). If it
turns out that you may have found a bug,
please [open an issue](https://github.com/epam/aws-syndicate/issues/new/choose)
with some of existing templates.
Default label for bugs, improvements and feature requests is `To-Think-About`,
it defines that ticket requires additional information about what should be done
in scope of this issue.
`To-Do` label should be added only for tickets with clear and reviewed issue
scope.
But before creating new issues - check existing, they may cover your problem or
question. For increasing issue priority - just add "+1" comment.
Would like to contribute?
-------------------------
Please,
check [contributor guide](https://github.com/epam/aws-syndicate/blob/master/CONTRIBUTING.md)
before starting.
# [](https://sonarcloud.io/dashboard?id=aws-syndicate)
Raw data
{
"_id": null,
"home_page": "https://github.com/epam/aws-syndicate",
"name": "aws-syndicate",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "AWS, SERVERLESS, CLOUD, LAMBDA, DEPLOY",
"author": "EPAM Systems",
"author_email": "support@syndicate.team",
"download_url": "https://files.pythonhosted.org/packages/ff/4c/a57f8d51c38ddf1517cf02e96eecb466a9c180cc13013ec7d401772c2f15/aws_syndicate-1.14.1.tar.gz",
"platform": null,
"description": "[](http://www.apache.org/licenses/LICENSE-2.0.txt)\n\n[](https://pypi.org/project/aws-syndicate)\n[](https://pypi.org/project/aws-syndicate)\n\n[](https://maven-badges.herokuapp.com/maven-central/net.sf.aws-syndicate/deployment-configuration-processor)\n\n# Syndicate\n\naws-syndicate is an Amazon Web Services deployment framework written in Python,\nwhich allows to easily deploy serverless applications using resource\ndescriptions.\n\n## Changelog\n\n[See CHANGELOG here](https://github.com/epam/aws-syndicate/blob/master/CHANGELOG.md \"aws-syndicate changelog\")\n\n## 1. Installation\n\n### 1.1 Installation from PyPI\n\n[Install aws-syndicate from PyPI](https://pypi.org/project/aws-syndicate/ \"aws-syndicate on PyPI\")\n\n### 1.2 Installation from source code\n\n#### 1.2.1 Prerequisites\n\n1) [Python 3.10](https://www.python.org/downloads/ \"Python 3.10\") version;\n2) Package manager [PIP 22.0](https://pypi.org/project/pip/ \"PIP 22.0\")\n or higher version;\n3) [Apache Maven 3.3.9](https://maven.apache.org/download.cgi \"Apache Maven 3.3.9\")\nor higher version (for Java projects).\n4) [SDK 8.0.402](https://dotnet.microsoft.com/en-us/download/dotnet/8.0 \"SDK 8.0.402\")\nor higher version (for .NET projects).\n\n#### 1.2.2 Installation on macOS\n\nDetailed guide how to install Python you can find\n[here](https://docs.python-guide.org/starting/install3/osx/ \"here\").\nAlso [here](https://www.baeldung.com/install-maven-on-windows-linux-mac \"here\") \nyou can find detailed guild how to install\nthe [latest Apache Maven](https://maven.apache.org/download.cgi \"latest Apache Maven\"). \n.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`.\n\n\n1. Pull the project\n```shell\ngit clone https://github.com/epam/aws-syndicate.git\n```\n2. Create virtual environment:\n```shell\npython3 -m venv syndicate_venv\n```\n3. Activate your virtual environment:\n```shell\nsource syndicate_venv/bin/activate\n```\n4. Install Syndicate framework with pip from GitHub:\n```shell\npip3 install aws-syndicate/.\n```\n5. Set up a Syndicate Java [plugin](https://github.com/epam/aws-syndicate/tree/master/plugin \"plugin\"):\n```shell\nmvn install -f aws-syndicate/plugin/\n```\n6. Go to the `2. Usage guide`\n\n#### 1.2.2 Installation on Linux\n\nDetailed guide how to install Python you can\nfind [here](https://docs.python-guide.org/starting/install3/linux/ \"here\").\nAlso [here](https://www.baeldung.com/install-maven-on-windows-linux-mac \"here\")\nyou can find detailed guild how to install\nthe [latest Apache Maven](https://maven.apache.org/download.cgi \"latest Apache Maven\"). \n.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`.\n\n1. Pull the project\n```shell\ngit clone https://github.com/epam/aws-syndicate.git\n```\n2. Create virtual environment:\n```shell\npython3 -m venv syndicate_venv\n```\n3. Activate your virtual environment:\n```shell\nsource syndicate_venv/bin/activate\n```\n4. Install Syndicate framework with pip from GitHub:\n```shell\npip3 install aws-syndicate/.\n```\n5. Set up a Syndicate Java [plugin](https://github.com/epam/aws-syndicate/tree/master/plugin \"plugin\"):\n```shell\nmvn install -f aws-syndicate/plugin/\n```\n6. Go to the `2. Usage guide`\n\n#### 1.2.3 Installation on Windows\n\nDetailed guide how to install Python you can\nfind [here](https://docs.python-guide.org/starting/install3/win/ \"here\").\nAlso [here](https://www.baeldung.com/install-maven-on-windows-linux-mac \"here\")\nyou can find detailed guild how to install\nthe [latest Apache Maven](https://maven.apache.org/download.cgi \"latest Apache Maven\").\n.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`.\n\n1. Pull the project\n```shell\ngit clone https://github.com/epam/aws-syndicate.git\n```\n2. Create virtual environment:\n```shell\npython3 -m venv syndicate_venv\n```\n3. Activate your virtual environment:\n```shell\nsyndicate_venv\\Scripts\\activate.bat\n```\n4. Install Syndicate framework with pip from GitHub:\n```shell\npip3 install aws-syndicate/.\n```\n5. Set up a Syndicate Java [plugin](https://github.com/epam/aws-syndicate/tree/master/plugin \"plugin\"):\n```shell\nmvn install -f aws-syndicate/plugin/\n```\n6. Go to the `2. Usage guide`\n\n## 2. Usage guide\n\n### 2.1 Creating Project files\n\nExecute `syndicate generate project` command to generate the project with all the\nnecessary components and in a right folders/files hierarchy to start developing\nin a min. Command example:\n```shell\nsyndicate generate project \n --name $project_name\n --config_path $path_to_project\n```\n\nAll the provided information is validated. After the project folder will be\ngenerated the command will return the following message:\n```shell\n Project name: $project_name\n Project path: $path_to_project\n```\n\nThe following files will be created in this folder: .gitignore, .syndicate,\nCHANGELOG.md, deployment_resources.json, README.md.\n\nCommand sample:\n```shell\nsyndicate generate project --name DemoSyndicateJava && cd DemoSyndicateJava\n```\n\nFor more details please execute `syndicate generate project --help`\n\n### 2.2 Creating configuration files for environment\n\nExecute the `syndicate generate config` command to create Syndicate configuration\nfiles. Command example:\n\n```shell\nsyndicate generate config\n --name $configuration_name [required]\n --region $region_name [required]\n --bundle_bucket_name $s3_bucket_name [required]\n --access_key $access_key \n --secret_key $secret_key \n --config_path $path_to_store_config\n --project_path $relative_path_to_project\n --prefix $prefix\n --suffix $suffix\n --extended_prefix $extended_prefix_mode\n --use_temp_creds $use_temp_creds #Specify,if use mfa or access_role\n --access_role $role_name\n --serial_number $serial_number\n --tags $KEY:VALUE\n --iam_permissions_boundary $ARN \n```\n\nAll the provided information is validated.\n\n*Note:* you may not specify `--access_key` and `--secret_key` params. In this\ncase Syndicate will try to find your credentials by the path `~/.aws`.\n\n*Note:* You can force Syndicate to generate temporary credentials and use them\nfor deployment. For such cases, set `use_temp_creds` parameter to `True` and\nspecify serial number if IAM user which will be used for deployment has a policy\nthat requires MFA authentication. Syndicate will prompt you to enter MFA code to\ngenerate new credentials, save and use them until expiration.\n\nAfter the configuration files will be generated the command will return the\nfollowing message:\n```shell\n Syndicate initialization has been completed. \n Set SDCT_CONF:\n Unix: export SDCT_CONF=$path_to_store_config\n Windows: setx SDCT_CONF $path_to_store_config\n```\n\nJust copy one of the last two lines, depending on your OS, and execute the\ncommand. The commands set the environment variable SDCT_CONF required by\naws-syndicate to operate.\n\n> Pay attention that the default syndicate_aliases.yaml file has been generated.\n> Your application may require additional aliases to be deployed - please add them to the file.\n\nCommand sample:\n```shell\nSYNDICATE_AWS_ACCESS_KEY=# enter your aws_access_key_id here\nSYNDICATE_AWS_SECRET_KEY=# enter your aws_secret_access_key here\nsyndicate 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\n```\n\nFor more details please execute `syndicate generate config --help`\n\n### 2.3 Creating lambda files\n\nExecute `syndicate generate lambda` command to generate required environment for\nlambda function except business logic. Command example:\n```shell\nsyndicate generate lambda\n --name $lambda_name_1\n --runtime python|java|nodejs|dotnet\n --project_path $project_path\n```\n\nAll the provided information is validated. Different environments will be\ncreated for different runtimes:\n\n* for Python\n\n```\n .\n \u251c\u2500\u2500 $project_path\n \u2502 \u2514\u2500\u2500 src\n \u2502 \u251c\u2500\u2500 commons\n \u2502 \u2502 \u251c\u2500\u2500 __init__.py\n \u2502 \u2502 \u251c\u2500\u2500 abstract_lambda.py\n \u2502 \u2502 \u251c\u2500\u2500 exception.py\n \u2502 \u2502 \u2514\u2500\u2500 log_helper.py\n \u2502 \u2514\u2500\u2500 lambdas\n \u2502 \u251c\u2500\u2500 $lambda_name_1\n \u2502 \u2502 \u251c\u2500\u2500 __init__.py\n \u2502 \u2502 \u251c\u2500\u2500 deployment_resources.json\n \u2502 \u2502 \u251c\u2500\u2500 handler.py\n \u2502 \u2502 \u251c\u2500\u2500 lambda_config.json\n \u2502 \u2502 \u251c\u2500\u2500 local_requirements.txt\n \u2502 \u2502 \u2514\u2500\u2500 requirements.txt\n \u2502 \u251c\u2500\u2500 $lambda_name_2\n \u2502 \u2502 \u251c\u2500\u2500 __init__.py\n \u2502 \u2502 \u251c\u2500\u2500 deployment_resources.json\n \u2502 \u2502 \u251c\u2500\u2500 handler.py\n \u2502 \u2502 \u251c\u2500\u2500 lambda_config.json\n \u2502 \u2502 \u251c\u2500\u2500 local_requirements.txt\n \u2502 \u2502 \u2514\u2500\u2500 requirements.txt\n \u2502 \u251c\u2500\u2500 __init__.py\n \u2502 \u2514\u2500\u2500 ...\n \u2514\u2500\u2500 ...\n```\n\n* for Java\n\n```\n .\n \u251c\u2500\u2500 $project_path\n \u2502 \u2514\u2500\u2500 jsrc\n \u2502 \u2514\u2500\u2500 main\n \u2502 \u2514\u2500\u2500 java\n \u2502 \u2514\u2500\u2500 com\n \u2502 \u2514\u2500\u2500 $projectpath\n \u2502 \u251c\u2500\u2500 $lambda_name_1.java\n \u2502 \u2514\u2500\u2500 $lambda_name_2.java\n \u2514\u2500\u2500 ...\n```\n\n* for NodeJS\n\n```\n .\n \u251c\u2500\u2500 $project_path\n \u2502 \u2514\u2500\u2500 app\n \u2502 \u2514\u2500\u2500 lambdas\n \u2502 \u251c\u2500\u2500 $lambda_name_1\n \u2502 \u2502 \u251c\u2500\u2500 deployment_resources.json\n \u2502 \u2502 \u251c\u2500\u2500 lambda_config.json\n \u2502 \u2502 \u251c\u2500\u2500 index.js\n \u2502 \u2502 \u251c\u2500\u2500 package.json\n \u2502 \u2502 \u2514\u2500\u2500 package-lock.json\n \u2502 \u2514\u2500\u2500 $lambda_name_2\n \u2502 \u251c\u2500\u2500 deployment_resources.json\n \u2502 \u251c\u2500\u2500 lambda_config.json\n \u2502 \u251c\u2500\u2500 index.js\n \u2502 \u251c\u2500\u2500 package.json\n \u2502 \u2514\u2500\u2500 package-lock.json\n \u2514\u2500\u2500 ...\n```\n\n* for .NET\n\n```\n .\n \u251c\u2500\u2500 $project_path\n \u2502 \u2514\u2500\u2500 dnapp\n \u2502 \u2514\u2500\u2500 lambdas\n \u2502 \u2514\u2500\u2500 $lambda_name\n \u2502 \u251c\u2500\u2500 deployment_resources.json\n \u2502 \u251c\u2500\u2500 lambda_config.json\n \u2502 \u251c\u2500\u2500 Function.cs\n \u2502 \u2514\u2500\u2500 Function.csproj\n \u2514\u2500\u2500 ...\n```\n\nCommand sample:\n```shell\nsyndicate generate lambda --name DemoLambda --runtime java --project_path $(pwd)\n```\n\nFor more details please execute `syndicate generate lambda --help`\n\n### 2.4 Add other infrastructure components \n\nThis step is optional and could be skipped while getting familiar with syndicate.\n\nAll the resources syndicate works with could be generated in the same way as lambda. \nInvoke the `syndicate generate meta --help` command to find out which resources are available. \n\n\n### 2.5 Open project in your IDE\n\nNow the project is ready to be adjusted. Consider opening your favourite IDE and observe the files created by syndicate. \n\n## 3. Deployment\n\n\n### 3.1 Create an S3 bucket for aws-syndicate artifacts:\n```shell\nsyndicate create_deploy_target_bucket\n```\n\n### 3.2 Build project artifacts\n```shell\nsyndicate build\n```\n\n### 3.3 Deploy project resources to AWS account\n```shell\nsyndicate deploy\n```\nNow the DemoLambda is created and available to be tested. \n\n### 3.4 Update resources\nIn order to be sure your latest changes works well on the AWS account the application should be deployed to the AWS account.\nTo do this use the following commands set:\n```shell\nsyndicate build\nsyndicate update\n```\n\n### 3.5 Lambdas invocations metrics\n```shell\nsyndicate profiler\n```\n\n### 3.6 Clean up project resources from AWS Account\n```shell\nsyndicate clean \n```\n\n### 3.7 Observing the environment manipulation history\n```shell\nsyndicate status # this shows the general CLI dashboard where latest modification, locks state, latest event, project resources are shown\nsyndicate status --events # this returns all the history of what happened to the environment\n```\n\n## 4. Examples\n\nIf you are just getting familiar with the functionality, you can use one of the\npre-prepared examples that contain a minimum set of AWS resources and lambdas.\n\nThe aws-syndicate/examples folder contains structure examples for different\nruntimes. Go to any example you like best and set the environment\nvariable `SDCT_CONF=$path_to_the_selected_example`.\n\nAdd your account details to `syndicate.yml` file - account id,\nsecret access key, access key and bucket name for deployment.\nTo `syndicate_aliases.yml` add your account id, region\nname (eu-central-1, us-west-1, etc.) and other values in the file that start\nwith a `$` sign.\n\nDocumentation\n------------\nDocumentation you can find [here](https://github.com/epam/aws-syndicate/wiki)\n\nGetting Help\n------------\n\nWe use GitHub issues for tracking bugs and feature requests. You can find our\npublic backlog [here](https://github.com/epam/aws-syndicate/projects/1). If it\nturns out that you may have found a bug,\nplease [open an issue](https://github.com/epam/aws-syndicate/issues/new/choose)\nwith some of existing templates.\n\nDefault label for bugs, improvements and feature requests is `To-Think-About`,\nit defines that ticket requires additional information about what should be done\nin scope of this issue.\n`To-Do` label should be added only for tickets with clear and reviewed issue\nscope.\n\nBut before creating new issues - check existing, they may cover your problem or\nquestion. For increasing issue priority - just add \"+1\" comment.\n\nWould like to contribute?\n-------------------------\n\nPlease,\ncheck [contributor guide](https://github.com/epam/aws-syndicate/blob/master/CONTRIBUTING.md)\nbefore starting.\n\n# [](https://sonarcloud.io/dashboard?id=aws-syndicate)\n",
"bugtrack_url": null,
"license": null,
"summary": "AWS-syndicate is an Amazon Web Services deployment framework written in Python, which allows to easily deploy serverless applications using resource descriptions.",
"version": "1.14.1",
"project_urls": {
"Homepage": "https://github.com/epam/aws-syndicate"
},
"split_keywords": [
"aws",
" serverless",
" cloud",
" lambda",
" deploy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bd29d943cbce6babd302b530efd8f4168b957305af6d3f05c62632a64fff42f0",
"md5": "e4687d33cb32f6a73bd24fb814cd27ac",
"sha256": "08a57ef9d4fc1ecda0d18b19c25797ac059e328f6253a1b2177670a70401c63a"
},
"downloads": -1,
"filename": "aws_syndicate-1.14.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4687d33cb32f6a73bd24fb814cd27ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 401568,
"upload_time": "2024-10-15T07:50:45",
"upload_time_iso_8601": "2024-10-15T07:50:45.440308Z",
"url": "https://files.pythonhosted.org/packages/bd/29/d943cbce6babd302b530efd8f4168b957305af6d3f05c62632a64fff42f0/aws_syndicate-1.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff4ca57f8d51c38ddf1517cf02e96eecb466a9c180cc13013ec7d401772c2f15",
"md5": "6ca856ca57d8e58dd76a10b4ef4f83a4",
"sha256": "34f30c96241ff3aa15df29a6fe38097a775ecde101ddeef52ec5bfbc816e7813"
},
"downloads": -1,
"filename": "aws_syndicate-1.14.1.tar.gz",
"has_sig": false,
"md5_digest": "6ca856ca57d8e58dd76a10b4ef4f83a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 271583,
"upload_time": "2024-10-15T07:50:48",
"upload_time_iso_8601": "2024-10-15T07:50:48.666928Z",
"url": "https://files.pythonhosted.org/packages/ff/4c/a57f8d51c38ddf1517cf02e96eecb466a9c180cc13013ec7d401772c2f15/aws_syndicate-1.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 07:50:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "epam",
"github_project": "aws-syndicate",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
"==",
"7.1.2"
]
]
},
{
"name": "botocore",
"specs": [
[
"==",
"1.29.80"
]
]
},
{
"name": "boto3",
"specs": [
[
"==",
"1.26.80"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.65.2"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.5"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "tabulate",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "troposphere",
"specs": [
[
"==",
"4.1.0"
]
]
},
{
"name": "requests-aws-sign",
"specs": [
[
"==",
"0.1.6"
]
]
},
{
"name": "setuptools",
"specs": [
[
"<=",
"70.0.0"
],
[
">",
"65.5.0"
]
]
}
],
"lcname": "aws-syndicate"
}
JSON
