Skip to content

Commit c5faf93

Browse files
authored
tweak docs for v1.3.8 (#791)
* tweak docs for v1.3.8 * push rest of develop script to repo
1 parent 4185ef3 commit c5faf93

File tree

6 files changed

+63
-5
lines changed

6 files changed

+63
-5
lines changed

docs/installation/customization-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Samples with Descriptions:
5757
- reduced various log retention periods and the VPCFlow log interval
5858
- removes the two example workload accounts
5959
- The most expensive individual component of this sample is the perimeter 3rd party firewalls
60-
- this example will be updated in the near future, removing the 3rd party firewalls
60+
- this example will be updated in the v1.5.0 release, removing the 3rd party firewalls
6161
- we will add a NATGW for egress. For ingress, customers will need to manually target the perimeter ALB to point to each backend-ALB's IP's and manually update the IP's when they change (the next major SEA code release will include functionality to automate this capability)
6262

6363
## 1.2. **Deployment Customizations**

docs/installation/installation.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ If deploying to an internal AWS employee account, to successfully install the so
238238
8. Add an `Email` address to be used for State Machine Status notification
239239
9. The `GithubBranch` should point to the release you selected
240240
- if upgrading, change it to point to the desired release
241-
- the latest stable branch is currently `release/v1.3.7`, case sensitive
241+
- the latest stable branch is currently `release/v1.3.8`, case sensitive
242242
10. Apply a tag on the stack, Key=`Accelerator`, Value=`PBMM` (case sensitive).
243243
11. **ENABLE STACK TERMINATION PROTECTION** under `Stack creation options`
244244
12. The stack typically takes under 5 minutes to deploy.
@@ -280,8 +280,6 @@ Issues in Older Releases:
280280

281281
- New installs and upgrades to releases prior to v1.3.6 are no longer supported.
282282

283-
- In v1.3.6 the Macie issue from v1.3.5 has been resolved, but Guardduty continues to cause the state machine to fail. Simply rerun the state machine. We are working on a fix.
284-
285283
## 2.6. Post-Installation
286284

287285
1. The Accelerator installation is complete, but several manual steps remain:
@@ -382,7 +380,7 @@ Issues in Older Releases:
382380
- The pipeline will automatically run and trigger the upgraded state machine
383381
9. If you are using a pre-existing GitHub token:
384382

385-
- Update the Installer CloudFormation stack using the template downloaded in step 5, updating the `GithubBranch` to the latest release (eg. `release/v1.3.7`)
383+
- Update the Installer CloudFormation stack using the template downloaded in step 5, updating the `GithubBranch` to the latest release (eg. `release/v1.3.8`)
386384
- Go to AWS CloudFormation and select the stack: `PBMMAccel-what-you-provided`
387385
- Select Update, select Replace current template, Select Upload a template file
388386
- Select Choose File and select the template you downloaded in step 5 (`AcceleratorInstallerXYZ.template.json`)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## AWS SEA Developer Script
2+
3+
The script is intended for use by Accelerator developers to automate the generation of files required for LOCAL development.
4+
5+
This script is a work in-progress and was designed for use by our development and test teams. This script grabs the latest outputs from an installed SEA environment from DynamoDB and stores them in the local/offline outputs.json file. ** Use at your own risk **
6+
7+
## Requirements
8+
9+
- This script requires the Accelerator to have completed one full/complete and successful state machine execution. It is NOT designed for use during the initial deployment process.
10+
- This script is written in Typescript, given the entire codebase is Typescript
11+
12+
## Instructions
13+
14+
1. Paste AWS temporary credentials (or set AWS_PROFILE) in the command terminal which will be used to execute the script
15+
16+
2. Set the AWS_DEFAULT_REGION
17+
18+
3. Execute the script `ts-node src/load-outputs.json`
19+
20+
4. On successful execution, this script generates the file: `accelerator/src/deployments/cdk/outputs.json`
21+
22+
## Use
23+
24+
1. Install the Accelerator (with a full successful SM execution)
25+
2. Execute this script to populate the local outputs.json to enable local mode development
26+
3. Locally execute and test the code/Phase being modified (i.e. Phase1)
27+
4. Manually execute storeoutputs for the phase (i.e. Phase1)
28+
5. Re-run this script to update the local outputs.json file
29+
6. Execute or test other Phases (i.e. Phase2)
30+
31+
Note: Steps 4 and 5 are only required if the executed Phase altered the outputs, if outputs remained identical, this is not required.
32+
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name": "@aws-accelerator/initial-script",
3+
"version": "0.0.1",
4+
"private": true,
5+
"main": "src/index.ts",
6+
"scripts": {
7+
"lint:typecheck": "pnpx tsc --noEmit",
8+
"lint:eslint": "pnpx eslint '{cdk,lib,src}/**/*.{js,ts}'"
9+
},
10+
"dependencies": {
11+
"aws-sdk": "2.804.0"
12+
},
13+
"devDependencies": {
14+
"@types/node": "14.14.31",
15+
"esbuild": "0.11.18",
16+
"ts-node": "9.1.1",
17+
"typescript": "4.2.4"
18+
},
19+
"peerDependencies": {
20+
}
21+
}

reference-artifacts/Custom-Scripts/Developer-Scripts/src/index.ts

Whitespace-only changes.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"compilerOptions": {
3+
"target": "es5",
4+
"module": "commonjs",
5+
"strict": true
6+
}
7+
}

0 commit comments

Comments
 (0)