terraform-google-modules / terraform-example-foundation

Shows how the CFT modules can be composed to build a secure cloud foundation
https://cloud.google.com/architecture/security-foundations
Apache License 2.0
1.18k stars 701 forks source link

Rename stage 5-app-infra for internal consistency on pipeline layers (foundation vs infra vs application) #1287

Open eeaton opened 6 days ago

eeaton commented 6 days ago

TL;DR

Terminology and concepts are not used consistently for different pipeline layers, and it breaks down at stage 5-app-infra. This should be renamed to help clarify how the enterprise foundation blueprint has modular support for other blueprints, particularly the enterprise application blueprint.

The enterprise foundations blueprint guide that describes the reference architecture and recommendations deployed by this repo states the following about pipeline layers:

This repo creates confusion by calling stage 5 as 5-app-infra, suggesting it is an example of an application pipeline. We can make the repo easier to use and understand by being explicit about what it covers and what it does not, we should avoid suggesting this example foundation covers application pipeline or internal developer platform capabilities.

Terraform Resources

No response

Detailed design

A spot check of some references in code to update (not necessarily exhaustive)
 - 5-app-infra (directory) --> 5-app-infra
 - app_infra_test.go --> project_infra_test.go
 - TestAppInfra  --> testProjectInfra
 - appInfra --> projectInfra
 - terraform/app-infra/business_unit_1/development --> terraform/project-infra/business_unit_1/development
 - "UPDATE_APP_INFRA_BUCKET"
 - gcp-policies-app-infra
 - AppInfraRepo

Additional information

No response