Currently only aws cloud is suported in the project with some definite resources.
Refer ARCHITECTURE.md
Refer README.md
- To add a new cloud like azure or gcp, creta the respective folders inside
../cloud directory
in the format of
cloud
└── <new_cloud>
├── README.md
├── __init__.py
├── <new_cloud>_main.py
├── resource_classes
│ ├── README.md
│ ├── __init__.py
│ ├── base.py
│ ├── <resource_1>.py
│ ├── <resource_2>.py
│ └── template.py
└── utils
├── alarms.py
├── <accessing the cloud>_client.py
├── constants.py
├── secret.py
└── utils.py
- Add the corresponding code to invoke the new cloud code in alarm_checker.py
- Add the corresponding yaml input file with
spec.cloud: <new_cloud>
under../inputs/<new_cloud>
- Add the corresponding script in
../notification
. - Add the corresponding code to invoke the new cloud code in alarm_checker.py
- Add the corresponding inputs in
../inputs/<cloud>/*yaml
underspec.outputNotifications.<new_channel>
Make sure, every new dependency are added in Requirements.txt
Please make sure that all the documentation present in ../docs/*.md
are updated after any development
- To know how to use the scripts refer to HOW_TO_USE.md
- Make sure that proper testing is performed before raising the PR or mering the PRs a. Make sure the google sheet is preparing fine b. Make sure that sheet link is sent to slack channel correctly
- Add any new deployment method in `../deployments/prod/<deployment_type>
- Make sure you have aded proper steps in accessing the method in README.md
- If you are making changes in existing deployment methods, make sure the proper testing is done and keep it as generic as possible.
Refer Contributing.md for more details
Refer Reviewing.md for more details
After every merge, follow the steps present in CHANGELOG.md to create new tag
Please mail to opensource@moengage.com for any query and issue/feature request
IMP NOTE - Make sure the code remains generic as much as possible.