cloud-foundation-fabric/fast/stages/03-project-factory/dev/README.md

Project factory

The Project Factory (or PF) builds on top of your foundations to create and set up projects (and related resources) to be used for your workloads. It is organized in folders representing environments (e.g., "dev", "prod"), each implemented by a stand-alone terraform resource factory.

Design overview and choices

A single factory creates projects in a well-defined context, according to your resource management structure. For example, in the diagram above, each Team is structured to have specific folders projects for a given environment, such as Production and Development, per the resource management structure configured in stage 01-resman.

Projects for each environment across different teams are created by dedicated service accounts, as exemplified in the diagram above. While there's no intrinsic limitation regarding where the project factory can create a projects, the IAM bindings for the service account effectively enforce boundaries (e.g., the production service account shouldn't be able to create or have any access to the development projects, and vice versa).

The project factory takes care of the following activities:

• Project creation
• API/Services enablement
• Service accounts creation
• IAM roles assignment for groups and service accounts
• KMS keys roles assignment
• Shared VPC attachment and subnets IAM binding
• DNS zones creation and visibility configuration
• Project-level org policies definition
• Billing setup (billing account attachment and budget configuration)
• Essential contacts definition (for budget alerts and important notifications)

How to run this stage

This stage is meant to be executed after "foundational stages" (i.e., stages 00-bootstrap, 01-resman, 02-networking (either VPN or NVA) and 02-security) have been run.

It's of course possible to run this stage in isolation, by making sure the architectural prerequisites are satisfied (e.g., networking), and that the Service Account running the stage is granted the roles/permissions below:

• One service account per environment, each with appropriate permissions
  • at the organization level a custom role for networking operations including the following permissions
    • "compute.organizations.enableXpnResource",
    • "compute.organizations.disableXpnResource",
    • "compute.subnetworks.setIamPolicy",
    • "dns.networks.bindPrivateDNSZone"
    • and role "roles/orgpolicy.policyAdmin"
  • on each folder where projects are created
    • "roles/logging.admin"
    • "roles/owner"
    • "roles/resourcemanager.folderAdmin"
    • "roles/resourcemanager.projectCreator"
  • on the host project for the Shared VPC
    • "roles/browser"
    • "roles/compute.viewer"
    • "roles/dns.admin"
• If networking is used (e.g., for VMs, GKE Clusters or AppEngine flex), VPC Host projects and their subnets should exist when creating projects
• If per-environment DNS sub-zones are required, one "root" zone per environment should exist when creating projects (e.g., dev.gcp.example.com.)

Providers configuration

If you're running this on top of FAST, you should run the following commands to create the providers file, and populate the required variables from the previous stage.

# Variable `outputs_location` is set to `~/fast-config` in stage 01-resman
$ cd fabric-fast/stages/03-project-factory/dev
ln -s ~/fast-config/providers/03-project-factory-dev-providers.tf .

Variable configuration

There are two broad sets of variables you will need to fill in:

• variables shared by other stages (org id, billing account id, etc.), or derived from a resource managed by a different stage (folder id, automation project id, etc.)
• variables specific to resources managed by this stage

To avoid the tedious job of filling in the first group of variables with values derived from other stages' outputs, the same mechanism used above for the provider configuration can be used to leverage pre-configured .tfvars files.

If you configured a valid path for outputs_location in the bootstrap and networking stage, simply link the relevant terraform-*.auto.tfvars.json files from this stage's outputs folder (under the path you specified), where the * above is set to the name of the stage that produced it. For this stage, a single .tfvars file is available:

# Variable `outputs_location` is set to `~/fast-config`
ln -s ~/fast-config/tfvars/00-bootstrap.auto.tfvars.json .
ln -s ~/fast-config/tfvars/01-resman.auto.tfvars.json . 
ln -s ~/fast-config/tfvars/02-networking.auto.tfvars.json .

If you're not using Fast, refer to the Variables table at the bottom of this document for a full list of variables, their origin (e.g., a stage or specific to this one), and descriptions explaining their meaning.

Besides the values above, a project factory takes 2 additional inputs:

• data/defaults.yaml, manually configured by adapting the data/defaults.yaml, which defines per-environment default values e.g., for billing alerts and labels.
• data/projects/*.yaml, one file per project (optionally grouped in folders), which configures each project. A data/projects/project.yaml is provided as reference and documentation for the schema. Projects will be named after the filename, e.g., fast-dev-lab0.yaml will create project fast-dev-lab0.

Once the configuration is complete, run the project factory by running

terraform init
terraform apply

Files

name	description	modules
main.tf	Project factory.	project-factory
outputs.tf	Module outputs.
variables.tf	Module variables.

Variables

name	description	type	required	default	producer
billing_account	Billing account id and organization id ('nnnnnnnn' or null).	object({…})	✓		00-bootstrap
prefix	Prefix used for resources that need unique names. Use 9 characters or less.	string	✓		00-bootstrap
data_dir	Relative path for the folder storing configuration data.	string		"data/projects"
defaults_file	Relative path for the file storing the project factory configuration.	string		"data/defaults.yaml"
environment_dns_zone	DNS zone suffix for environment.	string		null	02-networking
host_project_ids	Host project for the shared VPC.	object({…})		null	02-networking
vpc_self_links	Self link for the shared VPC.	object({…})		null	02-networking

Outputs

name	description	sensitive	consumers
projects	Created projects and service accounts.