Add docs on log retention and allowed origins, fix cdkproxy docs #1554
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dlpzx
reviewed
Sep 17, 2024
pages/code.md
Outdated
| When a data.all resource is created, the API sends an HTTP request | ||
| to the docker service and the code runs the appropriate stack using `cdk` cli. | ||
| When an API request is made to create a data.all resource, such as a new dataset, the data.all backend sends a new message to an SQS Queue to asynchronously be read off the queue and start a new cdkproxy ECS task. | ||
| The code uses a `cdk` cli wrapper to register infrastructure and maange cdk commands, and runs the appropriate stack using `cdk` cli to deploy the IaC of the respective data.all resource. |
dlpzx
reviewed
Sep 17, 2024
pages/code.md
Outdated
|
|
||
| The webserver is running on docker, using Python's [FASTAPI](https://fastapi.tiangolo.com/) | ||
| web framework and running using [uvicorn](https://www.uvicorn.org/) ASGI server. | ||
| For local data.all deployments, a webserver is run on docker using Python's [FASTAPI](https://fastapi.tiangolo.com/) web framework and running using [uvicorn](https://www.uvicorn.org/) ASGI server. Subsequnetly, data.all sends POST API Requests to the `cdkproxy` web server to start the data.all infrastructure task. |
dlpzx
reviewed
Sep 17, 2024
pages/deploy/deploy_aws.md
Outdated
| @@ -235,6 +237,8 @@ and find 2 examples of cdk.json files. | |||
| | source | Optional | The version control source for the repository. It can take 2 values 'codecommit' or 'codestar_connection'. (default: 'codecommit') | | |||
| | repo_string | Optional | The repository path as string. Required if source='codestar_connection' (default: 'awslabs/aws-dataall') | | |||
| | repo_connection_arn | Optional | The arn of the CodeStar connection connecting with the source repository. Required if source='codestar_connection'(default: None) | | |||
| | log_retention_duration | Optional | The CloudWatch log retention days - as a string enum value one of AWS CDK RetentionDays members (default: `TWO_YEARS`) | | |||
There was a problem hiding this comment.
it would be good to mention for which log groups - all data.all deployed log groups, environment accounts, infra accounts?
|
addressed the above comments - let me know if good to go @dlpzx |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Detail
Relates
Security
Please answer the questions below briefly where applicable, or write
N/A. Based onOWASP 10.
fetching data from storage outside the application (e.g. a database, an S3 bucket)?
evalor similar functions are used?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.