Skip to content

Commit e587801

Browse files
authored
Merge pull request #1 from aws-samples/v1.1.0
Add Japanese documents
2 parents 7fe1d64 + 0750076 commit e587801

File tree

10 files changed

+1108
-120
lines changed

10 files changed

+1108
-120
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.1.0] - 2021-05-10
9+
10+
### Added
11+
12+
- Add Japanese documentation
13+
814
## [1.0.0] - 2021-04-26
915

1016
### Added

README.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,52 @@
11
# Baseline Environment on AWS
22

3+
[View this page in Japanese (日本語)](README_ja.md)
4+
35
Baseline Environment on AWS(BLEA) is a set of reference CDK template to establish secure baseline on standalone-account or ControlTower based multi-account AWS environment. This solution provides basic and extensible guardrail with AWS security services and end-to-end sample CDK code for typical system architecture. This template is also useful to learn more about AWS architecting best practices and how to customize CDK code as we incorporated comments in detail so that users can know why and how to customize.
46

7+
Jump to | [Changelog](CHANGELOG.md) | [Deployment Pipeline](tools/cicd/README.md) | [Standalone to ControlTower](doc/Standalone2ControlTower.md) |
8+
59
# Governance Architecture
610

711
## Operation patterns
812

9-
![BLEA-OpsPatterns](/doc/images/BLEA-OpsPatterns.png)
13+
![BLEA-OpsPatterns](doc/images/BLEA-OpsPatterns.png)
1014

11-
## Multi-Account Governance (With ControlTower)
15+
## Multi-Account Governance (with ControlTower)
1216

13-
![BLEA-GovOverviewMultiAccount](/doc/images/BLEA-GovOverviewMultiAccount.png)
17+
![BLEA-GovOverviewMultiAccount](doc/images/BLEA-GovOverviewMultiAccount.png)
1418

15-
## Standalone Governance (With Individual account)
19+
## Standalone Governance (with Individual account)
1620

17-
![BLEA-GovOverviewSingleAccount](/doc/images/BLEA-GovOverviewSingleAccount.png)
21+
![BLEA-GovOverviewSingleAccount](doc/images/BLEA-GovOverviewSingleAccount.png)
1822

1923
# Baseline Architecture
2024

2125
## Multi-Account (With ControlTower)
2226

23-
![BLEA-ArchMultiAccount](/doc/images/BLEA-ArchMultiAccount.png)
27+
![BLEA-ArchMultiAccount](doc/images/BLEA-ArchMultiAccount.png)
2428

2529
## Standalone (With Individual account)
2630

27-
![BLEA-ArchSingleAccount](/doc/images/BLEA-ArchSingleAccount.png)
31+
![BLEA-ArchSingleAccount](doc/images/BLEA-ArchSingleAccount.png)
2832

2933
## Stack Architecture (Standalone)
3034

31-
![BLEA-StackDependency](/doc/images/BLEA-StackDependency.png)
35+
![BLEA-StackDependency](doc/images/BLEA-StackDependency.png)
3236

3337
# Sample Architectures on Guest Account
3438

3539
## ECS
3640

37-
![BLEA-GuestSampleECS](/doc/images/BLEA-GuestSampleECS.png)
41+
![BLEA-GuestSampleECS](doc/images/BLEA-GuestSampleECS.png)
3842

3943
## AutoSacling
4044

41-
![BLEA-GuestSampleASG](/doc/images/BLEA-GuestSampleASG.png)
45+
![BLEA-GuestSampleASG](doc/images/BLEA-GuestSampleASG.png)
4246

4347
## EC2
4448

45-
![BLEA-GuestSampleEC2](/doc/images/BLEA-GuestSampleEC2.png)
49+
![BLEA-GuestSampleEC2](doc/images/BLEA-GuestSampleEC2.png)
4650

4751
# Deployment
4852

@@ -75,7 +79,7 @@ npm run build
7579

7680
## (OPTIONAL) Use latest CDK modules
7781

78-
After install CDK, Use below commands instead of "npm ci".
82+
After install CDK, Use below commands instead of `npm ci`.
7983

8084
- Install ncu
8185

@@ -194,7 +198,7 @@ You need to define deployment parameters on CDK Context. Context values are defi
194198

195199
These files define `dev`, `prod`, `ctaudit`, `my` context. cdk.json is managed by git. cdk.context.json doesn't managed by git so you can use it just for your local environmen only.
196200

197-
For production stacks, we recommend that you explicitly specify the environment in cdk.json using the `env` property. If you not specified env property, to use CDK_DEFAULT_ACCOUNT and CDK_DEFAULT_REGION variables.
201+
For production stacks, we recommend that you explicitly specify the environment in cdk.json using the `env` property. If you not specified env property, to use CDK_DEFAULT_ACCOUNT and CDK_DEFAULT_REGION variables.
198202

199203
cdk.json
200204

@@ -317,7 +321,7 @@ We provide several guardrail templates and sample application templates. They ar
317321
- Governance Base for ControlTower Audit Account.
318322
319323
- blea-base-ct-guest.ts
320-
- Guest Base(for eatch guest account). Setup log bucket, IAM User, Monitoring Chatbot for the account you specified.
324+
- Guest Base(for each guest account). Setup log bucket, IAM User, Monitoring Chatbot for the account you specified.
321325
322326
## Base for Santdalone
323327
@@ -424,7 +428,7 @@ See `Appendix B`
424428
425429
### Deploy
426430
427-
Login to Management Account with SSO.
431+
Login to Management Account with AWS SSO.
428432
429433
> Audit account can configure only with AWSControlTowerExecution Role on Management Account
430434
@@ -450,7 +454,7 @@ Create new account with Account Vending Machine provided by ControlTower.
450454
451455
## 5. Deploy Guest Base for CT (to guest account)
452456
453-
Login to Guest Account with SSO.
457+
Login to Guest Account with AWS SO.
454458
455459
```
456460
aws sso login --profile ct-guest-sso
@@ -479,7 +483,7 @@ How to setup: https://docs.aws.amazon.com/systems-manager/latest/userguide/quick
479483
480484
Quick Setup provides below:
481485
482-
- WS Identity and Access Management (IAM) instance profile roles for Systems Manager.
486+
- AWS Identity and Access Management (IAM) instance profile roles for Systems Manager.
483487
- A scheduled, bi-weekly update of SSM Agent.
484488
- A scheduled collection of Inventory metadata every 30 minutes.
485489
- A daily scan of your instances to identify missing patches.
@@ -540,12 +544,12 @@ Deploy BLEA via CloudShell on AWS Console.
540544
Please note that CloudShell will delete environment if you do not use that for 120 days.
541545
see: https://docs.aws.amazon.com/cloudshell/latest/userguide/limits.html
542546
543-
## 0. Open CloudShell
547+
## 1. Open CloudShell
544548
545549
- Open CloudShell from [>_] icon on your AWS console (top right, near by account name)
546-
![OpenConsole](/doc/images/OpenConsole.png)
550+
![OpenConsole](doc/images/CloudShell-OpenConsole.png)
547551
548-
## 1. Setup CDK prerequisities
552+
## 2. Setup CDK prerequisities
549553
550554
See: https://docs.aws.amazon.com/ja_jp/cdk/latest/guide/getting_started.html
551555
@@ -567,11 +571,11 @@ sudo npm -g install typescript
567571
sudo npm install -g aws-cdk
568572
```
569573
570-
## 2. Upload and extract BLEA file
574+
## 2. Upload and extract template files
571575
572576
- Get BLEA source file from git repository and archive it
573577
- Upload BLEA file from [Action]-[Upload File] Button
574-
![UploadFiles](/doc/images/UploadFiles.png)
578+
![UploadFiles](doc/images/CloudShell-UploadFiles.png)
575579
576580
- Extract and delete uploaded file
577581

0 commit comments

Comments
 (0)