130 lines
8.3 KiB
Markdown
130 lines
8.3 KiB
Markdown
# 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](https://medium.com/google-cloud/resource-factories-a-descriptive-approach-to-terraform-581b3ebb59c).
|
|
|
|
## Design overview and choices
|
|
|
|
<p align="center">
|
|
<img src="diagram.svg" alt="Project factory diagram">
|
|
</p>
|
|
|
|
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](https://cloud.google.com/billing/docs/how-to/budgets) and [important notifications](https://cloud.google.com/resource-manager/docs/managing-notification-contacts?hl=en))
|
|
|
|
## How to run this stage
|
|
|
|
This stage is meant to be executed after "foundational stages" (i.e., stages [`00-bootstrap`](../../0-bootstrap), [`01-resman`](../../1-resman), 02-networking (either [VPN](../../2-networking-b-vpn), [NVA](../../2-networking-c-nva), [NVA with BGP support](../../2-networking-e-nva-bgp)) and [`02-security`](../../2-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.)
|
|
|
|
### Provider and Terraform variables
|
|
|
|
As all other FAST stages, the [mechanism used to pass variable values and pre-built provider files from one stage to the next](../../0-bootstrap/README.md#output-files-and-cross-stage-variables) is also leveraged here.
|
|
|
|
The commands to link or copy the provider and terraform variable files can be easily derived from the `stage-links.sh` script in the FAST root folder, passing it a single argument with the local output files folder (if configured) or the GCS output bucket in the automation project (derived from stage 0 outputs). The following examples demonstrate both cases, and the resulting commands that then need to be copy/pasted and run.
|
|
|
|
```bash
|
|
../../../stage-links.sh ~/fast-config
|
|
|
|
# copy and paste the following commands for '3-project-factory'
|
|
|
|
ln -s ~/fast-config/providers/3-project-factory-providers.tf ./
|
|
ln -s ~/fast-config/tfvars/globals.auto.tfvars.json ./
|
|
ln -s ~/fast-config/tfvars/0-bootstrap.auto.tfvars.json ./
|
|
ln -s ~/fast-config/tfvars/1-resman.auto.tfvars.json ./
|
|
ln -s ~/fast-config/tfvars/2-networking.auto.tfvars.json ./
|
|
ln -s ~/fast-config/tfvars/2-security.auto.tfvars.json ./
|
|
```
|
|
|
|
```bash
|
|
../../../stage-links.sh gs://xxx-prod-iac-core-outputs-0
|
|
|
|
# copy and paste the following commands for '3-project-factory'
|
|
|
|
gcloud alpha storage cp gs://xxx-prod-iac-core-outputs-0/providers/3-project-factory-providers.tf ./
|
|
gcloud alpha storage cp gs://xxx-prod-iac-core-outputs-0/tfvars/globals.auto.tfvars.json ./
|
|
gcloud alpha storage cp gs://xxx-prod-iac-core-outputs-0/tfvars/0-bootstrap.auto.tfvars.json ./
|
|
gcloud alpha storage cp gs://xxx-prod-iac-core-outputs-0/tfvars/1-resman.auto.tfvars.json ./
|
|
gcloud alpha storage cp gs://xxx-prod-iac-core-outputs-0/tfvars/2-networking.auto.tfvars.json ./
|
|
gcloud alpha storage cp gs://xxx-prod-iac-core-outputs-0/tfvars/2-security.auto.tfvars.json ./
|
|
```
|
|
|
|
If you're not using Fast, refer to the [Variables](#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`](./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`](./data/projects/project.yaml.sample) 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
|
|
|
|
```bash
|
|
terraform init
|
|
terraform apply
|
|
```
|
|
|
|
<!-- TFDOC OPTS files:1 show_extra:1 -->
|
|
<!-- BEGIN TFDOC -->
|
|
|
|
## Files
|
|
|
|
| name | description | modules |
|
|
|---|---|---|
|
|
| [main.tf](./main.tf) | Project factory. | <code>project-factory</code> |
|
|
| [outputs.tf](./outputs.tf) | Module outputs. | |
|
|
| [variables.tf](./variables.tf) | Module variables. | |
|
|
|
|
## Variables
|
|
|
|
| name | description | type | required | default | producer |
|
|
|---|---|:---:|:---:|:---:|:---:|
|
|
| [billing_account](variables.tf#L19) | Billing account id. If billing account is not part of the same org set `is_org_level` to false. | <code title="object({ id = string is_org_level = optional(bool, true) })">object({…})</code> | ✓ | | <code>0-bootstrap</code> |
|
|
| [prefix](variables.tf#L60) | Prefix used for resources that need unique names. Use 9 characters or less. | <code>string</code> | ✓ | | <code>0-bootstrap</code> |
|
|
| [data_dir](variables.tf#L32) | Relative path for the folder storing configuration data. | <code>string</code> | | <code>"data/projects"</code> | |
|
|
| [defaults_file](variables.tf#L38) | Relative path for the file storing the project factory configuration. | <code>string</code> | | <code>"data/defaults.yaml"</code> | |
|
|
| [environment_dns_zone](variables.tf#L44) | DNS zone suffix for environment. | <code>string</code> | | <code>null</code> | <code>2-networking</code> |
|
|
| [host_project_ids](variables.tf#L51) | Host project for the shared VPC. | <code title="object({ dev-spoke-0 = string })">object({…})</code> | | <code>null</code> | <code>2-networking</code> |
|
|
| [vpc_self_links](variables.tf#L71) | Self link for the shared VPC. | <code title="object({ dev-spoke-0 = string })">object({…})</code> | | <code>null</code> | <code>2-networking</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive | consumers |
|
|
|---|---|:---:|---|
|
|
| [projects](outputs.tf#L17) | Created projects and service accounts. | | |
|
|
|
|
<!-- END TFDOC -->
|