Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update diagrams and add region info in deployment pre-reqs + docs for v2.1.0 #821

Merged
merged 7 commits into from
Nov 8, 2023

Conversation

dlpzx
Copy link
Contributor

@dlpzx dlpzx commented Oct 19, 2023

Feature or Bugfix

  • Feature

Detail

  • Add regions info in deploy to AWS guide
  • Replace backend diagrams with the correct relationship between AWS Worker Lambda and ECS tasks. In the original diagram it looks like the GraphQL API handler Lambda triggers the ECS tasks, but in fact the ECS tasks are triggered by the AWS Worker Lambdas

Relates

Security

Please answer the questions below briefly where applicable, or write N/A. Based on
OWASP 10.
N/A

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@dlpzx dlpzx linked an issue Oct 19, 2023 that may be closed by this pull request
### Feature or Bugfix
<!-- please choose -->
- Documentation

### Detail
- Add to gh pages for v2.1 additional `cdk.json` and `config.json`
parameters

### Relates
- NA

### Security
NA
```
Please answer the questions below briefly where applicable, or write `N/A`. Based on
[OWASP 10](https://owasp.org/Top10/en/).

- Does this PR introduce or modify any input fields or queries - this includes
fetching data from storage outside the application (e.g. a database, an S3 bucket)?
  - Is the input sanitized?
  - What precautions are you taking before deserializing the data you consume?
  - Is injection prevented by parametrizing queries?
  - Have you ensured no `eval` or similar functions are used?
- Does this PR introduce any functionality or component that requires authorization?
  - How have you ensured it respects the existing AuthN/AuthZ mechanisms?
  - Are you logging failed auth attempts?
- Are you using or adding any cryptographic features?
  - Do you use a standard proven implementations?
  - Are the used keys controlled by the customer? Where are they stored?
- Are you introducing any new policies/roles/users?
  - Have you used the least-privilege principle? How?
```

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
@dlpzx dlpzx changed the title feat: update diagrams and add region info in deployment pre-reqs feat: update diagrams and add region info in deployment pre-reqs + docs for v2.1.0 Oct 26, 2023
lorchda and others added 4 commits October 27, 2023 10:02
### Feature or Bugfix
- Bugfix

### Detail
- Make `hosted_zone_id` optional, documentation update

### Relates
- #797

### Security
Please answer the questions below briefly where applicable, or write
`N/A`. Based on
[OWASP 10](https://owasp.org/Top10/en/).

- Does this PR introduce or modify any input fields or queries - this
includes
fetching data from storage outside the application (e.g. a database, an
S3 bucket)? N/A
  - Is the input sanitized? N/A
- What precautions are you taking before deserializing the data you
consume? N/A
  - Is injection prevented by parametrizing queries? N/A
  - Have you ensured no `eval` or similar functions are used? N/A
- Does this PR introduce any functionality or component that requires
authorization? N/A
- How have you ensured it respects the existing AuthN/AuthZ mechanisms?
N/A
  - Are you logging failed auth attempts? N/A
- Are you using or adding any cryptographic features? N/A
  - Do you use a standard proven implementations? N/A
- Are the used keys controlled by the customer? Where are they stored?
N/A
- Are you introducing any new policies/roles/users? N/A
  - Have you used the least-privilege principle? How? N/A


By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license. YES, YES

Co-authored-by: dlpzx <[email protected]>
### Feature or Bugfix
- Feature ( Documentation ) 

### Detail

When enabling email notification on share workflow, an SES identity is
created on AWS SES. This PR contains documentation about the manual
steps that need to be taken towards setting up SES and also additional
steps to setup monitoring.

### Relates
- #734
- #785

### Security
Please answer the questions below briefly where applicable, or write
`N/A`. Based on
[OWASP 10](https://owasp.org/Top10/en/).

- Does this PR introduce or modify any input fields or queries - this
includes
fetching data from storage outside the application (e.g. a database, an
S3 bucket)? N/A
  - Is the input sanitized?
- What precautions are you taking before deserializing the data you
consume?
  - Is injection prevented by parametrizing queries?
  - Have you ensured no `eval` or similar functions are used?
- Does this PR introduce any functionality or component that requires
authorization? N/A
- How have you ensured it respects the existing AuthN/AuthZ mechanisms?
  - Are you logging failed auth attempts?
- Are you using or adding any cryptographic features? N/A
  - Do you use a standard proven implementations?
- Are the used keys controlled by the customer? Where are they stored?
- Are you introducing any new policies/roles/users? N/A
  - Have you used the least-privilege principle? How?


By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
Copy link
Contributor

@noah-paige noah-paige left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v2.1 docs look good - approving

@dlpzx dlpzx merged commit 24ada0c into gh-pages Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation request to add more info about AWS regions needed
4 participants