Skip to content

Commit d0ed40a

Browse files
authored
(docs)tweaks (#625)
* tweak docs and firewall config - what we do where updates - a/a multi-tunnel firewall tweaks * tweak customization doc * doc tweaks * spelling fixes * fix tabs
1 parent 8c5e015 commit d0ed40a

File tree

4 files changed

+143
-87
lines changed

4 files changed

+143
-87
lines changed

docs/installation/customization-index.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
- Sample config files can be found in [this](../../reference-artifacts/SAMPLE_CONFIGS/) folder
1212
- Unsure where to start, use the [config.lite-example.json](../../reference-artifacts/SAMPLE_CONFIGS/config.lite-example.json) file
1313

14-
Descriptions:
14+
Samples with Descriptions:
1515

1616
1. Full PBMM configuration [file](../../reference-artifacts/SAMPLE_CONFIGS/config.example.json) (`config.example.json`)
1717
- The full PBMM configuration file was based on feedback from customers moving into AWS at scale and at a rapid pace. Customers of this nature have indicated that they do not want to have to upsize their perimeter firewalls or add Interface endpoints as their developers start to use new AWS services. These are the two most expensive components of the deployed architecture solution.
@@ -46,16 +46,22 @@ Descriptions:
4646

4747
## 1.2. **Deployment Customizations**
4848

49-
- The sample configuration files are provided as single, all encompassing, json files. The Accelerator also supports both splitting the config file into multiple component files and configuration files built using YAML instead of json. This is documented [here](./multi-file-config-capabilities.md)
49+
- Multi-file config file and YAML formatting [option](./multi-file-config-capabilities.md):
5050

51-
- The sample configuration files do not include the full range of supported configuration file parameters and values, additional configuration file parameters and values can be found [here](../../reference-artifacts/SAMPLE_CONFIGS/sample_snippets.md)
51+
- The sample configuration files are provided as single, all encompassing, json files. The Accelerator also supports both splitting the config file into multiple component files and configuration files built using YAML instead of json. This is documented
5252

53-
- 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.
54-
- Automated firewall configuration [customization](../../reference-artifacts/SAMPLE_CONFIGS/firewall_file_available_variables.md) possibilities
55-
- Sample Fortinet Fortigate firewall config [file](../../reference-artifacts/Third-Party/firewall-example.txt)
53+
- Sample Snippets:
54+
55+
- The sample configuration files do not include the full range of supported configuration file parameters and values, additional configuration file parameters and values can be found [here](../../reference-artifacts/SAMPLE_CONFIGS/sample_snippets.md)
56+
57+
- Third Party Firewall example configs:
58+
- 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.
59+
- Automated firewall configuration [customization](../../reference-artifacts/SAMPLE_CONFIGS/firewall_file_available_variables.md) possibilities
60+
- Sample Fortinet Fortigate firewall config [file](../../reference-artifacts/Third-Party/firewall-example.txt)
5661

5762
## 1.3. Other Configuration File Hints and Tips
5863

64+
- It is critical that all accounts that are leveraged by other accounts (i.e. accounts that any workload accounts are dependant on), are included in the mandatory-accounts section of the config file (i.e. shared-network, log-archive, operations)
5965
- You cannot supply (or change) configuration file values to something not supported by the AWS platform
6066
- For example, CWL retention only supports specific retention values (not any number)
6167
- Shard count - can only increase/reduce by half the current limit. i.e. you can change from `1`-`2`, `2`-`3`, `4`-`6`

0 commit comments

Comments
 (0)