Skip to content

Commit 95e5b76

Browse files
Resolve WIT-278 "Release for MWAA SP"
# New features and improvements Release notes # Related issue Closes WIT-278 # Definition of Done for Feature/Hotfixes ## All Developments - [x] Feature was implemented as per the requirements - [x] If some code parts are complex they must be commented with code documentation - [x] CI/CD is successful - [x] Code coverage is not reduced, any new code is covered - [x] E2E/integration tests are successful (whether run locally or in CI/CD) - [x] If dependencies were changed, be sure that they will not impact the project, that their license is compatible, and that they introduce no vulnerabilities - [x] Documentation have been updated * Documentation has been updated with explanation of the new feature if it is user-facing (eg component now has additional setting) or it impacts him in some other way (eg optional field that becomes mandatory) * If it is a breaking change, we have documented it as such in the MR description in a "Breaking Changes" section - [x] Check that you are not affecting any existing environments with these changes, especially the Sandbox/Playground. This means that merging it to master and deploying it to these environments will not break them and **no manual operations that are not reported in the documentation will be needed** - [x] Check that nothing is out of order and nothing problematic is included in the changes (sensitive information, credentials, customer information or other intellectual property) as they could end up being public (we have Open Source SP already published and automatically mirrored) - [x] Security, Authentication and Authorization have been considered. No SQL injection, tokens handling, RBAC integration. Common security vulnerabilities identified and resolved ## API Development - [x] Semantic of API has been checked, it is comprehensible, meaningful, with no redundant information and user oriented - [x] Meaningful unit and integration tests are present - [x] API Parameters are checked and errors are handled - [x] Returned errors are meaningful to the user - [x] API contract has been defined and documented. Documentation means explaining the meaning of all fields and including at least one example - [x] Exceptions and errors are handled, without letting the underlying framework to respond with a generic Internal Server Error - [x] API Performance has been assessed and is good for real world use cases. Database accesses have been optimized. - [x] API is logging in compliance with audit standards, presence of sensitive information for GDPR has been assessed and removed or managed in case is needed ## DB Development - [x] The database schema is designed to accurately represent the data model and meet the requirements - [x] Tables, relationships, and constraints (e.g. primary keys, foreign keys, unique constraints) are defined appropriately and following a common convention - [x] Normalization principles are applied to eliminate data redundancy and ensure data integrity - [x] Schema semantic is meaningful - [x] Fields naming are following naming convention ( Ex. camelCase or snake_case) - [x] No fields with mixed behaviors and meaning. If a field is representing an enum, enum values are strongly mutually exclusive - [x] Data Types have been reviewed and they are a good fit for each field - [x] Indexes are defined to optimize query performance for frequently accessed data, paying attention to do not affect too much write path and the overall complexity - [x] Sensitive data is stored securely, encrypted if required, and access is restricted to authorized users - [x] Backup and restore procedures have been updated to introduce new or changed tables - [x] Migration scripts to upgrade and downgrade the database have been implemented and tested
1 parent 828ddf2 commit 95e5b76

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

RELEASE_NOTES.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## v1.0.0
6+
7+
### Commits
8+
9+
- **[WIT-249] Some SPs provisioning status endpoint incorrectly reports completed for non existent tokens**
10+
>
11+
> ##### New features and improvements
12+
>
13+
> - Aligns the interface specification version to version 2.2.0
14+
> - Includes a Postman collections with some examples
15+
>
16+
> ##### Related issue
17+
>
18+
> Closes WIT-249
19+
>
20+
>
21+
22+
- **[WIT-249] Some SPs provisioning status endpoint incorrectly reports completed for non existent tokens**
23+
24+
- **Resolve WIT-287 "Update mwaa deployment"**
25+
26+
- **[WIT-204] HLD documentation for MWAA SP**
27+
28+
- **[WIT-195] API version field in OpenAPI spec is set to implementing server version**
29+
30+
- **[WIT-199] Documentation**
31+
32+
- **Resolve WIT-50 "Update mwaa helm chart"**
33+
34+
- **[WIP] feature: custom-changes-mwaa**
35+
36+
- **[#8] Resolve "Add file name prefix in the unprovision method"**
37+
38+
- **Resolve "Minor improvements"**
39+
>
40+
> ##### New features and improvements
41+
>
42+
> - Inserted a prefix folder dags and source inside the mwaa manager `executeProvision` function call
43+
> - Prefix also for the dag file name that ends up in the airflow so it looks like $componentIdentifier(without componentName).$dag_name
44+
>
45+
> ##### Related issues
46+
>
47+
> Closes #7
48+
49+
- **[#6] Resolve "Deploy MWAA sp"**
50+
>
51+
> ##### New features and improvements
52+
>
53+
> - Implemented k8s deployment
54+
> - Changed s3Client initialization in order to include WebIdentity
55+
>
56+
> ##### Related issues
57+
>
58+
> Closes #6
59+
60+
- **[#5] Resolve "Fix a little bug inside provision and unprovision"**
61+
>
62+
> ##### Bugs fixed
63+
>
64+
> - Fixed a bug for subfolders handling
65+
>
66+
> ##### Related issues
67+
>
68+
> Closes #5
69+
70+
- **[#2] Resolve "Import aws sdk the right way"**
71+
>
72+
> ##### New features and improvements
73+
>
74+
> - Added provision API
75+
> - Added unprovision API
76+
> - Imported aws sdk library
77+
> - Added an example of descriptor to pass to the provision and unprovision API (it is called pr_descriptor_mwaasp.yaml)
78+
>
79+
> ##### Related issues
80+
>
81+
> Closes #2
82+
83+
- **[#3] Resolve "Make akka http request to airflow"**
84+
>
85+
> ##### New features and improvements
86+
>
87+
> - Added `/provision` API
88+
> - Added docker-compose to start airflow locally
89+
> - Set up the logs
90+
> - Updated README with how to run airflow locally
91+
>
92+
> ##### Related issues
93+
>
94+
> Closes #3
95+
96+
- **Init**

0 commit comments

Comments
 (0)