cloud-foundation-fabric/foundations/business-units
Julio Castillo 1e11c670f5 Update copyright to 2021 2021-02-15 09:38:10 +01:00
..
README.md switch project service from resourceviews to container in examples 2020-05-07 21:36:37 +02:00
backend.tf.sample Update copyright to 2021 2021-02-15 09:38:10 +01:00
diagram.png Rename 'organization-bootstrap' to 'foundations' 2019-09-11 14:46:07 +02:00
main.tf Update copyright to 2021 2021-02-15 09:38:10 +01:00
outputs.tf Update copyright to 2021 2021-02-15 09:38:10 +01:00
providers.tf Update copyright to 2021 2021-02-15 09:38:10 +01:00
terraform.tfvars.sample Update copyright to 2021 2021-02-15 09:38:10 +01:00
variables.tf Update copyright to 2021 2021-02-15 09:38:10 +01:00

README.md

Business-units based organizational sample

This sample creates an organizational layout with two folder levels, where the first level is usually mapped to one business unit or team (infra, data, analytics) and the second level represents enviroments (prod, test). It also sets up all prerequisites for automation (GCS state buckets, service accounts, etc.), and the correct roles on those to enforce separation of duties at the environment level.

This layout is well suited for medium-sized infrastructures managed by different sets of teams, and in cases where the core infrastructure is managed centrally, as the top-level automation service accounts for each environment allow cross-team management of the base resources (projects, IAM, etc.).

High-level diagram

Refer to the section-level README for general considerations about this type of samples, and usage instructions.

Managed resources and services

This sample creates several distinct groups of resources:

  • one top-level folder per business unit/team
  • one top-level folder for shared services
  • one second-level folder for each environment in all the business unit top-level folders
  • one project in the shared folder to hold Terraform-related resources
  • one project in the shared folder to set up and host centralized audit log exports
  • one project in the shared folder to hold services used across environments like GCS, GCR, KMS, Cloud Build, etc.

The number of resources in this sample is kept to a minimum so as to make it generally applicable, more resources can be easily added by leveraging other modules from our bundle, or from other sources like the CFT suite.

Shared services

This sample uses a top-level folder to encapsulate projects that host resources that are not specific to a single environment. If no shared services are needed,the Terraform and audit modules can be easily attached to the root node, and the shared services folder and project removed from main.tf.

Variables

name description type required default
billing_account_id Billing account id used as default for new projects. string
organization_id Organization id in organizations/nnnnnnn format. string
prefix Prefix used for resources that need unique names. string
root_node Root node for the new hierarchy, either 'organizations/org_id' or 'folders/folder_id'. string
audit_filter Audit log filter used for the log sink. string ...
environments Environment short names. map(string) ...
gcs_defaults Defaults use for the state GCS buckets. map(string) ...
iam_audit_viewers Audit project viewers, in IAM format. list(string) []
iam_shared_owners Shared services project owners, in IAM format. list(string) []
iam_terraform_owners Terraform project owners, in IAM format. list(string) []
project_services Service APIs enabled by default in new projects. list(string) ...

Outputs

name description sensitive
audit_logs_project Project that holds the audit logs export resources.
bootstrap_tf_gcs_bucket GCS bucket used for the bootstrap Terraform state.
bu_business_intelligence Business Intelligence attributes.
bu_business_intelligence_keys Business Intelligence service account keys.
bu_machine_learning Machine Learning attributes.
bu_machine_learning_keys Machine Learning service account keys.
shared_folder_id Shared folder id.
shared_resources_project Project that holdes resources shared across business units.
terraform_project Project that holds the base Terraform resources.