Skip to content

Commit

Permalink
#387 - docs - tef 20240511
Browse files Browse the repository at this point in the history
  • Loading branch information
obriensystems committed May 12, 2024
1 parent 3f3b646 commit be6c121
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ _named branches_. Pushing to a named branch causes the _apply_ command to be
run. Pushing to branches other than the named branches does not run _apply_.

* development
* non-production
* nonproduction
* production

## Which Terraform commands are run when I push to a branch?
Expand Down
2 changes: 1 addition & 1 deletion docs/TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ You will need to mark some Terraform resources as **tainted** in order to trigge

1. In a terminal, navigate to the path where the error is being reported.

For example, if the unknown project ID is `prj-bu1-p-sample-base-abcd`, you should go to ./gcp-projects/business_unit_1/production (`business_unit_1` due to `bu1` and `production` due to `p`, see the Security Foundations [naming conventions](https://cloud.google.com/architecture/security-foundations/using-example-terraform#naming_conventions) for more information on the projects naming guideline).
For example, if the unknown project ID is `prj-bu1-p-sample-base-shared`, you should go to ./gcp-projects/business_unit_1/production (`business_unit_1` due to `bu1` and `production` due to `p`, see the Security Foundations [naming conventions](https://cloud.google.com/architecture/security-foundations/using-example-terraform#naming_conventions) for more information on the projects naming guideline).

```bash
cd ./gcp-projects/<business_unit>/<environment>
Expand Down
8 changes: 4 additions & 4 deletions docs/change_resource_hierarchy.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ The current deployment scenario of Terraform Foundation Example blueprint consid
| common | Contains projects with common resources used by the organization like logging and Security Command Center. |
| network | Contains projects with common networks resources used by the organization like DNS Hub, hybrid connectivity, and Shared VPCs. |
| production | Environment folder that contains projects with cloud resources that have been promoted into production. |
| non-production | Environment folder that contains a replica of the production environment to let you test workloads before you put them into production. |
| nonproduction | Environment folder that contains a replica of the production environment to let you test workloads before you put them into production. |
| development | Environment folder that is used as a development and sandbox environment. |

This document covers a scenario where you can have two or more levels of folders, both from the source code point of view and the Cloud Resource Manager point of view, with an environment-centric focus: `environments -> ... -> business units`.

| Current Hierarchy | Changed Hierarchy |
| --- | --- |
| <pre>example-organization/<br>├── fldr-bootstrap<br>├── fldr-common<br>├── fldr-network<br>├── <b>fldr-development *</b><br>├── <b>fldr-non-production *</b><br>└── <b>fldr-production *</b><br></pre> | <pre>example-organization/<br>├── fldr-bootstrap<br>├── fldr-common<br>├── fldr-network<br>├── <b>fldr-development *</b><br>│ ├── finance<br>│ └── retail<br>├── <b>fldr-non-production *</b><br>│ ├── finance<br>│ └── retail<br>└── <b>fldr-production *</b><br> ├── finance<br> └── retail<br></pre> |
| <pre>example-organization/<br>├── fldr-bootstrap<br>├── fldr-common<br>├── fldr-network<br>├── <b>fldr-development *</b><br>├── <b>fldr-nonproduction *</b><br>└── <b>fldr-production *</b><br></pre> | <pre>example-organization/<br>├── fldr-bootstrap<br>├── fldr-common<br>├── fldr-network<br>├── <b>fldr-development *</b><br>│ ├── finance<br>│ └── retail<br>├── <b>fldr-nonproduction *</b><br>│ ├── finance<br>│ └── retail<br>└── <b>fldr-production *</b><br> ├── finance<br> └── retail<br></pre> |

## Code Changes - Build Files

Expand All @@ -44,7 +44,7 @@ example-organization/
├── <b>development *</b>
│ ├── finance
│ └── retail
├── <b>non-production *</b>
├── <b>nonproduction *</b>
│ ├── finance
│ └── retail
└── <b>production *</b>
Expand Down Expand Up @@ -175,7 +175,7 @@ example-organization/
...
```
1. Create your source code folder hierarchy above environment folders (development, non-production, production). Remember to keep the source code environment folders as leaves (latest level) in the source code folder hierarchy because this is the way `tf-wrapper.sh` - the bash script helper - works to apply terraform configurations.
1. Create your source code folder hierarchy above environment folders (development, nonproduction, production). Remember to keep the source code environment folders as leaves (latest level) in the source code folder hierarchy because this is the way `tf-wrapper.sh` - the bash script helper - works to apply terraform configurations.
1. Manually duplicate your source folder hierarchy to match your needs.
1. **(Optional)** To simplify the below changes renaming business_units here is helper script. **Remember to review the changes**. The below script assumes you are in `gcp-projects` folder:
Expand Down
8 changes: 4 additions & 4 deletions docs/upgrading_to_v4.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Before moving forward with adopting components of v4, review the list of breakin
- A new Network folder was created be used as parent by network projects:
- `prj-ENV-shared-base`
- `prj-ENV-shared-restricted`
- `prj-c-base-net-hub`
- `prj-c-restricted-net-hub`
- `prj-c-dns-hub`
- `prj-c-interconnect`
- `prj-net-hub-base`
- `prj-net-hub-restricted`
- `prj-net-dns`
- `prj-net-interconnect`
- Network Refactoring
- Network projects are now created under a new folder `network`
- VPC firewall rules (`google_compute_firewall`) resources were replaced with Compute Network firewall policy (`google_compute_network_firewall_policy`) resources
Expand Down

0 comments on commit be6c121

Please sign in to comment.