Skip to content

Commit 6e9b194

Browse files
fredboninBrian Mycroft
authored andcommitted
(docs) updates
1 parent d010563 commit 6e9b194

File tree

4 files changed

+9
-6
lines changed

4 files changed

+9
-6
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ reported the issue. Please try to include as much information as you can. Detail
2929

3030
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
3131

32-
1. You are working against the latest source on the _master_ branch.
32+
1. You are working against the latest source on the _main_ branch.
3333
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3434
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
3535
4. You have reviewed and are aligned with the `Accelerator Development First Principles`

docs/faq/faq.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,9 @@ The preferred and recommended method to connect to instances within the Accelera
285285
- If you want to remove the region from your command line, you can:
286286
- Type: “aws configure” from command prompt, hit {enter} (key), {enter} (secret), enter: ca-central-1, {enter}
287287

288+
### 1.1.14. I ran the state machine but it failed when it tried to delete the default VPC? The state machine cannot delete the default VPC (Error : VPC has dependencies and cannot be deleted) ?
289+
- You need to ensure that resources don’t exist in the default VPC or else the state machine won't be able to delete it. If you encounter this error, you can either delete the resources within the VPC or delete the default VPC manually and run the state machine again.
290+
288291
## 1.2. Existing Accounts/Organizations
289292

290293
### 1.2.1. How do I import an existing AWS account into my Accelerator managed AWS Organization (or what if I created a new AWS account with a different Organization trust role)?

docs/installation/customization-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989
- Third Party Firewall example configs:
9090
- The Accelerator is provided with a sample 3rd party configuration file to demonstrate automated deployment of 3rd party firewall technologies. Given the code is vendor agnostic, this process should be able to be leveraged to deploy other vendors firewall appliances. When and if other options become available, we will add them here as well.
9191
- Automated [firewall configuration customization](../../reference-artifacts/SAMPLE_CONFIGS/firewall_file_available_variables.md) possibilities
92-
- Sample Fortinet Fortigate firewall config [file](../../reference-artifacts/Third-Party/firewall-example.txt)
92+
- Sample Fortinet Fortigate firewall config [file](../../reference-artifacts/Third-Party)
9393

9494
## 1.3. Other Configuration File Hints and Tips
9595

docs/installation/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Before installing, you must first:
174174
9. Type `Dev`, click `Add`, wait until the OU is finished provisioning (or it will error)
175175
10. Repeat step 9 for each OU (i.e. `Test`, `Prod`, `Central`, `Sandbox`)
176176
11. Select `Account factory`, Edit, Subnets: 0, Deselect all regions, click `Save`
177-
12. In Organizations, move the Management account from the `root` OU into the `Security` OU
177+
12. In AWS Organizations, move the Management account from the `root` OU into the `Security` OU
178178
4. Verify:
179179
1. AWS Organizations is enabled in `All features` mode
180180
- if required, navigate to AWS Organizations, click `Create Organization`, `Create Organization`
@@ -280,7 +280,7 @@ If deploying to an internal AWS employee account and installing the solution wit
280280
- If deploying the Managed AD, update the dns-domain, netbios-domain, log-group-name, as well as the AD users and groups that will be created;
281281
- For a test deployment, the remainder of the values can be used as-is;
282282
- While it is generally supported, we recommend not adding more than 1 or 2 workload accounts to the config file during the initial deployment as it will increase risks of hitting a limit. Once the Accelerator is successfully deployed, add the additional accounts to the config file and rerun the state machine.
283-
- More information [here](./customization-index.md#15-config-file-minimum-changes) on the fields in the config file that need to be updated.
283+
- More information [here](./customization-index.md#15-summary-of-example-config-file-minimum-changes-for-new-installs) on the fields in the config file that need to be updated.
284284
3. A successful deployment of the prescriptive architecture requires VPC access to 9 AWS endpoints, you cannot remove both the perimeter firewalls (all public endpoints) and the 9 required central VPC endpoints from the config file (ec2, ec2messages, ssm, ssmmessages, cloudformation, secretsmanager, kms, logs, monitoring).
285285
4. When deploying to regions other than `ca-central-1`, you need to modify your config file as follows (for Canada Central 1, the AMI ids are pre-populated for you):
286286
1. Update the firewall and firewall manager AMI id's to reflect your home regions regional AMI id's (see 2.3.3, item 13), making sure you select the right version and region per the recommendations.
@@ -293,7 +293,7 @@ If deploying to an internal AWS employee account and installing the solution wit
293293
- the bucket must be `S3-KMS` encrypted using the `ASEA-Source-Bucket-Key` created above
294294
6. Place your customized config file(s), named `config.json` (or `config.yaml`), in your new bucket
295295
7. If required, place the firewall configuration and license files in the folder and path defined in the config file
296-
- For AWS Network Firewall: `nfw/nfw-example-policy.json`
296+
- For AWS Network Firewall: `nfw/nfw-example-policy.json`
297297
- For Fortinet: `firewall/firewall-example.txt`, `firewall/license1.lic` and `firewall/license2.lic`
298298
- We have made several samples available [here](../../reference-artifacts/Third-Party): `./reference-artifacts/Third-Party/`
299299
- Both samples comprise an active / active firewall pair. Until recently we only brought up one tunnel per firewall, you now also have an example which brings up both tunnels per firewall
@@ -318,7 +318,7 @@ If deploying to an internal AWS employee account and installing the solution wit
318318
3. Use the provided CloudFormation template to deploy a new stack in your Management (root) AWS account
319319
- As previously stated we do not support installation in sub-accounts
320320
4. Login to your Organization Management account and **_make sure you are in your desired `home` region_** (i.e. `ca-central-1`) (your desired primary or control region)
321-
5. Navigate to **CloudFormation** in the AWS Console and click `Create stack`, then
321+
5. Navigate to **CloudFormation** in the AWS Console and click `Create stack with new resources (standard)`, then
322322
- Select "Template is ready"
323323
- For the "Specify template" select "Upload a template file"
324324
- Select the `*.template.json` file you downloaded in step 2 above

0 commit comments

Comments
 (0)