pre-commit run -a

HicResearch · Jun 13, 2023 · 5de4909 · 5de4909
1 parent f4b612b
commit 5de4909
Show file tree

Hide file tree

Showing 40 changed files with 1,167 additions and 1,131 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,5 +1,5 @@
 # Description
 
-----
+---
 
 Declaration : _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_
diff --git a/README.md b/README.md
@@ -13,10 +13,10 @@ Open Original Science Exploration
 
 ## What is TREEHOOSE
 
-Trusted Research Environments (TREs) are secure computing environments providing 
-secure access to sensitive data for research purposes. HDR UK has a set of 
-[resources and guides](https://www.hdruk.ac.uk/access-to-health-data/trusted-research-environments/) 
-explaining TREs in more detail in terms of health data research, although TREs 
+Trusted Research Environments (TREs) are secure computing environments providing
+secure access to sensitive data for research purposes. HDR UK has a set of
+[resources and guides](https://www.hdruk.ac.uk/access-to-health-data/trusted-research-environments/)
+explaining TREs in more detail in terms of health data research, although TREs
 are not exclusive to health data.
 
 TREEHOOSE is an open-source platform for deploying TREs on Amazon Web Services
@@ -53,9 +53,9 @@ and discuss future enhancements.
 
 ## Use cases
 
-TREEHOOSE was originally developed for use with confidential healthcare data 
-such as patient electronic health records, but is designed to be used and 
-customised for all research and analysis disciplines which require access to 
+TREEHOOSE was originally developed for use with confidential healthcare data
+such as patient electronic health records, but is designed to be used and
+customised for all research and analysis disciplines which require access to
 sensitive data.
 
 ---
@@ -101,7 +101,6 @@ This project is licensed under the [Apache-2.0 License](./LICENSE).
 
 ## Funding
 
-This work was funded by UK Research & Innovation Grant Number MC_PC_21032 as 
+This work was funded by UK Research & Innovation Grant Number MC_PC_21032 as
 part of Phase 1 of the DARE UK (Data and Analytics Research Environments UK)
 programme, delivered in partnership with HDR UK and ADRUK.
-
diff --git a/doc/architecture/Architecture.md b/doc/architecture/Architecture.md
@@ -57,19 +57,19 @@ of the numbered steps in the diagram.
    with a comprehensive review process with multiple approvers
    before the data is available for download.
 1. Egress requests that are approved can be downloaded by Data Egress Managers
-  and shared with the Researcher who requested the data egress.
-  There is a configurable limit to the number of downloads which can be made.
+   and shared with the Researcher who requested the data egress.
+   There is a configurable limit to the number of downloads which can be made.
 1. Audit & Compliance teams get full visibility into all
-    user activities resulting in AWS API calls through centralised
-    CloudTrail logs. Additionally, they get breakglass
-    access to all TRE projects/accounts in the TRE through
-    a Lambda function role in the Audit account.
+   user activities resulting in AWS API calls through centralised
+   CloudTrail logs. Additionally, they get breakglass
+   access to all TRE projects/accounts in the TRE through
+   a Lambda function role in the Audit account.
 
 ## Component Overview
 
 ---
 
-### *AWS Control Tower*
+### _AWS Control Tower_
 
 ---
 
@@ -87,7 +87,7 @@ that will be setup by using the TREEHOOSE solution.
 
 ![Multi-account structure](../../res/images/multi-account-setup.png)
 
-### *Service Workbench on AWS Solution*
+### _Service Workbench on AWS Solution_
 
 ---
 
@@ -107,7 +107,7 @@ Key Components :
   (more services as desired; this is customisable by providing Service Catalog templates).
 - For the secure access environment: AWS AppStream 2.0
 
-### *Data Lake*
+### _Data Lake_
 
 ---
 
@@ -122,7 +122,7 @@ Key Components :
 
 - AWS Lake Formation, Amazon S3, AWS KMS, AWS Glue, Amazon Athena
 
-### *Data Egress Application*
+### _Data Egress Application_
 
 ---
 
@@ -149,7 +149,7 @@ Key Components :
 - For the backend: AWS Step Functions, Amazon EFS,
   AWS Lambda, Amazon DynamoDB, Amazon SES, Amazon S3, AWS KMS, Amazon SNS, Amazon Cognito, AWS AppSync
 
-### *Workspace backup*
+### _Workspace backup_
 
 ---
 
@@ -189,7 +189,7 @@ Key Components:
 - For the backend: AWS Step Functions,
   AWS Lambda, Amazon CloudWatch Events, AWS CloudFormation, AWS Backup, Amazon S3
 
-### *Budget controls*
+### _Budget controls_
 
 ---
 
@@ -204,7 +204,7 @@ each TRE project and allows to
 - **Respond** : automate actions to avoid over-spending
 
 The component uses [AWS Budgets](https://aws.amazon.com/aws-cost-management/aws-budgets/)
- to plan and set expectations around TRE project costs.
+to plan and set expectations around TRE project costs.
 
 Key Components:
 

diff --git a/doc/architecture/Cost.md b/doc/architecture/Cost.md
@@ -8,7 +8,7 @@ in the EU West (London) AWS Region is approximately **$30** for TRE account with
 Prices are subject to change.
 For full details, see the pricing page for each AWS service used in this solution.
 
-> **_NOTE:_**  Many AWS Services include a Free Tier – a baseline amount of the service that customers can use at no charge.
+> **_NOTE:_** Many AWS Services include a Free Tier – a baseline amount of the service that customers can use at no charge.
 > Actual costs may be more or less than the pricing examples provided.
 
 The baseline cost is just for spinning up the infrastructure.
@@ -42,20 +42,20 @@ solution with the default settings in EU West (Ireland) AWS Region.
 
 An installation of TRE without any workspaces and users.
 
-|AWS Service|Monthly cost|
-|----|----|
-|Networking services|$11|
-|KMS|$6|
-|Config|$4|
-|CloudTrail|$3.5|
-|EC2-other|$1.5|
-|DynamoDB|$6|
-|Service Catalog|$1|
-|Step Functions|$0.09|
-|Lambdas|$0.003|
-|CloudFront|$0.0002|
-|CloudWatch|$0.0003|
-|Total|$33.0935|
+| AWS Service         | Monthly cost |
+| ------------------- | ------------ |
+| Networking services | $11          |
+| KMS                 | $6           |
+| Config              | $4           |
+| CloudTrail          | $3.5         |
+| EC2-other           | $1.5         |
+| DynamoDB            | $6           |
+| Service Catalog     | $1           |
+| Step Functions      | $0.09        |
+| Lambdas             | $0.003       |
+| CloudFront          | $0.0002      |
+| CloudWatch          | $0.0003      |
+| Total               | $33.0935     |
 
 ### EC2 Usage
 

diff --git a/doc/architecture/Design-Considerations.md b/doc/architecture/Design-Considerations.md
@@ -42,6 +42,7 @@ TREEHOOSE should make based on their functional and
 non-functional requirements.
 
 - Centralise and enable AWS Security services like:
+
   - [AWS Security Hub](https://aws.amazon.com/security-hub/)
   - [Amazon GuardDuty](https://aws.amazon.com/guardduty/)
   - [Amazon Macie](https://aws.amazon.com/macie/)