Example repo showing how the CFT modules can be composed to build a secure cloud foundation.
This is an example repo showing how the CFT Terraform modules can be composed to build a secure GCP foundation, following the Google Cloud security foundations guide. The supplied structure and code is intended to form a starting point for building your own foundation with pragmatic defaults you can customize to meet your own requirements. Currently, the step 0 is manually executed. From step 1 onwards, the Terraform code is deployed by leveraging either Google Cloud Build (by default) or Jenkins. Cloud Build has been chosen by default to allow teams to quickly get started without needing to deploy a CI/CD tool, although it is worth noting the code can easily be executed by your preferred tool.
This repo contains several distinct Terraform projects each within their own directory that must be applied separately, but in sequence. Each of these Terraform projects are to be layered on top of each other, running in the following order.
This stage executes the CFT Bootstrap module which bootstraps an existing GCP organization, creating all the required GCP resources & permissions to start using the Cloud Foundation Toolkit (CFT). For CI/CD pipelines, you can use either Cloud Build (by default) or Jenkins. If you want to use Jenkins instead of Cloud Build, please see README-Jenkins on how to use the included Jenkins sub-module.
The bootstrap step includes: - The
cft-seedproject, which contains: - Terraform state bucket - Custom Service Account used by Terraform to create new resources in GCP - The
prj-cicdif using Jenkins), which contains: - A CI/CD pipeline implemented with either Cloud Build or Jenkins - If using Cloud Build: - Cloud Source Repository - If using Jenkins: - A GCE Instance configured as a Jenkins Agent - Custom Service Account to run Jenkins Agents GCE instances - VPN connection with on-prem (or where ever your Jenkins Master is located)
It is a best practice to separate concerns by having two projects here: one for the CFT resources and one for the CI/CD tool. The
cft-seedproject stores Terraform state and has the Service Account able to create / modify infrastructure. On the other hand, the deployment of that infrastructure is coordinated by a CI/CD tool of your choice allocated in a second project (named
cft-cloudbuildproject if using Google Cloud Build and
prj-cicdproject if using Jenkins).
To further separate the concerns at the IAM level as well, the service account of the CI/CD tool is given different permissions than the Terraform account. The CI/CD tool account (
@cloudbuild.gserviceaccount.comif using Cloud Build and
After executing this step, you will have the following structure:
example-organization/ └── fldr-bootstrap ├── cft-cloudbuild (prj-cicd if using Jenkins) └── cft-seed
When this step uses the Cloud Build submodule, it sets up Cloud Build and Cloud Source Repositories for each of the stages below. Triggers are configured to run a
terraform planfor any non environment branch and
terraform applywhen changes are merged to an environment branch (
production). Usage instructions are available in the 0-bootstrap README.
The purpose of this stage is to set up the common folder used to house projects which contain shared resources such as DNS Hub, Interconnect, SCC Notification, org level secrets and org level logging. This will create the following folder & project structure:
example-organization └── fldr-common ├── prj-c-logging ├── prj-c-billing-logs ├── prj-c-dns-hub ├── prj-c-interconnect ├── prj-c-scc └── prj-c-secrets
Among the six projects created under the common folder, two projects (
prj-c-billing-logs) are used for logging. The first one for organization wide audit logs and the latter for billing logs. In both cases the logs are collected into BigQuery datasets which can then be used general querying, dashboarding & reporting. Logs are also exported to Pub/Sub and GCS bucket. The various audit log types being captured in BigQuery are retained for 30 days.
For billing data, a BigQuery dataset is created with permissions attached, however you will need to configure a billing export manually, as there is no easy way to automate this at the moment.
Under the common folder, one project is created. This project will host the DNS Hub for the organization.
Under the common folder, one project is created. This project will host the Interconnect infrastructure for the organization.
Under the common folder, one project is created. This project will host the SCC Notification resources at the organization level. This project will contain a Pub/Sub topic and subscription, a SCC Notification configured to send all new Findings to the topic created. You can adjust the filter when deploying this step.
Under the common folder, one project is created. This project is allocated for GCP Secret Manager for secrets shared by the organization.
Usage instructions are available for the org step in the README.
The purpose of this stage is to set up the environments folders used to house projects which contain monitoring, secrets, networking projects. This will create the following folder & project structure:
example-organization └── fldr-development ├── prj-d-monitoring ├── prj-d-secrets ├── prj-d-shared-base └── prj-d-shared-restricted └── fldr-non-production ├── prj-n-monitoring ├── prj-n-secrets ├── prj-n-shared-base └── prj-n-shared-restricted └── fldr-production ├── prj-p-monitoring ├── prj-p-secrets ├── prj-p-shared-base └── prj-p-shared-restricted
Under the environment folder, a project is created per environment (
production), which is intended to be used as a Cloud Monitoring workspace for all projects in that environment. Please note that creating the workspace and linking projects can currently only be completed through the Cloud Console. If you have strong IAM requirements for these monitoring workspaces, it is worth considering creating these at a more granular level, such as per business unit or per application.
Under the environment folder, two projects, one for base and another for restricted network, are created per environment (
production) which is intended to be used as a Shared VPC Host project for all projects in that environment. This stage only creates the projects and enables the correct APIs, the following networks stage creates the actual Shared VPC networks.
Under the environment folder, one project is created. This is allocated for GCP Secret Manager for secrets shared by the environment.
Usage instructions are available for the environments step in the README.
This step focuses on creating a Shared VPC per environment (
production) in a standard configuration with a reasonable security baseline. Currently this includes:
productioninclusive of secondary ranges for those that want to use GKE.
allow-iap-rdpnetwork tags respectively
egress-internetrequired on VMs in order to reach the internet.
Usage instructions are available for the networks step in the README.
This step, is focused on creating service projects with a standard configuration and that are attached to the Shared VPC created in the previous step. Running this code as-is should generate a structure as shown below:
example-organization/ └── fldr-development ├── prj-bu1-d-sample-floating ├── prj-bu1-d-sample-base ├── prj-bu1-d-sample-restrict ├── prj-bu2-d-sample-floating ├── prj-bu2-d-sample-base └── prj-bu2-d-sample-restrict └── fldr-non-production ├── prj-bu1-n-sample-floating ├── prj-bu1-n-sample-base ├── prj-bu1-n-sample-restrict ├── prj-bu2-n-sample-floating ├── prj-bu2-n-sample-base └── prj-bu2-n-sample-restrict └── fldr-production ├── prj-bu1-p-sample-floating ├── prj-bu1-p-sample-base ├── prj-bu1-p-sample-restrict ├── prj-bu2-p-sample-floating ├── prj-bu2-p-sample-base └── prj-bu2-p-sample-restrict
The code in this step includes two options for creating projects. The first is the standard projects module which creates a project per environment and the second creates a standalone project for one environment. If relevant for your use case, there are also two optional submodules which can be used to create a subnet per project and a dedicated private DNS zone per project.
Usage instructions are available for the projects step in the README.
Once all steps above have been executed your GCP organization should represent the structure shown below, with projects being the lowest nodes in the tree.
example-organization └── fldr-common ├── prj-c-logging ├── prj-c-billing-logs ├── prj-c-dns-hub ├── prj-c-interconnect ├── prj-c-scc └── prj-c-secrets └── fldr-development ├── prj-bu1-d-sample-floating ├── prj-bu1-d-sample-base ├── prj-bu1-d-sample-restrict ├── prj-bu2-d-sample-floating ├── prj-bu2-d-sample-base ├── prj-bu2-d-sample-restrict ├── prj-d-monitoring ├── prj-d-secrets ├── prj-d-shared-base └── prj-d-shared-restricted └── fldr-non-production ├── prj-bu1-n-sample-floating ├── prj-bu1-n-sample-base ├── prj-bu1-n-sample-restrict ├── prj-bu2-n-sample-floating ├── prj-bu2-n-sample-base ├── prj-bu2-n-sample-restrict ├── prj-n-monitoring ├── prj-n-secrets ├── prj-n-shared-base └── prj-n-shared-restricted └── fldr-production ├── prj-bu1-p-sample-floating ├── prj-bu1-p-sample-base ├── prj-bu1-p-sample-restrict ├── prj-bu2-p-sample-floating ├── prj-bu2-p-sample-base ├── prj-bu2-p-sample-restrict ├── prj-p-monitoring ├── prj-p-secrets ├── prj-p-shared-base └── prj-p-shared-restricted └── fldr-bootstrap ├── cft-cloudbuild (prj-cicd if using Jenkins) └── cft-seed
There are three main named branches -
productionthat reflect the corresponding environments. These branches should be protected. When the CI/CD pipeline (Jenkins/CloudBuild) runs on a particular named branch (say for instance
development), only the corresponding environment (
development) is applied. An exception is the
sharedenvironment which is only applied when triggered on the
productionbranch. This is because any changes in the
sharedenvironment may affect resources in other environments and can have adverse effects if not validated correctly.
Development happens on feature/bugfix branches (which can be named
bugfix/fix-bar, etc.) and when complete, a pull request (PR) or merge request (MR) can be opened targeting the
developmentbranch. This will trigger the CI pipeline to perform a plan and validate against all environments (
production). Once code review is complete and changes are validated, this branch can be merged into
development. This will trigger a CI pipeline that applies the latest changes in the
developmentbranch on the
Once validated in
development, changes can be promoted to
non-productionby opening a PR/MR targeting the
non-productionbranch and merging them. Similarly changes can be promoted from
Some variables used to deploy the steps have default values, check those before deployment to ensure they match your requirements. For more information, there are tables of inputs and outputs for the Terraform modules, each with a detailed description of their variables. Look for variables marked as not required in the section Inputs of these READMEs:
Refer to the contribution guidelines for information on contributing to this module.