Skip to content

Latest commit

 

History

History
200 lines (167 loc) · 10.2 KB

README.md

File metadata and controls

200 lines (167 loc) · 10.2 KB
Raw

Secure CI/CD pipeline

This repository contains Terraform modules and example configurations to enable Google Cloud customers to quickly deploy a secure CI/CD pipeline, implementing many of the functions outlined in the Shifting Left on Security report.

The Terraform modules in this repository provide an opinionated architecture that incorporates and documents best practices for secure application delivery architecture.

Tagline

Create a CI/CD pipeline that follows security best practices.

Detailed

Set up a secure CI/CD pipeline that follows best practices for building, scanning, storing, and deploying containers to GKE. You can choose whether to deploy your solution through the console directly or download as Terraform from GitHub to deploy later.

Architecture

  1. A developer pushes new code or a code change for a container-based application to Cloud Source Repositories.
  2. The code push invokes a Cloud Build trigger. The Cloud Build trigger starts a build in a Cloud Build private worker pool that's hosted in a customer-managed VPC. The outputs of the build are metadata files, Cloud Build logs, and containers.
  3. The metadata files and the Cloud Build logs are stored in a Cloud Storage bucket.
  4. The pipeline runs security scans (which you configure) and validates the container structure. When the scans and structure pass, the containers are stored in Artifact Registry.
  5. The Cloud Build trigger requests an attestation from Binary Authorization that certifies that the required scans passed. The attestation is stored as a cryptographic signature in Binary Authorization.
  6. The Cloud Build trigger starts a Cloud Deploy release to roll out the containers to the three environments: developer (Dev), QA, and production (Prod). Each environment is one Kubernetes cluster in its own subnet. All three clusters and subnets are in the same GKE VPC. The last cluster is the production environment.
  7. As the rollout starts, Cloud Deploy sends the containers to the developer environment. Google Kubernetes Engine (GKE) uses the policy that's defined for the cluster to check the containers’ build attestation in Binary Authorization. When this check passes, GKE deploys the containers into the Kubernetes cluster.
  8. When Cloud Deploy releases the containers to the developer environment, Cloud Deploy sends a Pub/Sub message that starts the second Cloud Build trigger. This Cloud Build trigger runs post-deployment tests (which you configure) in the developer environment. To run these tests, Cloud Build worker pools communicate with the clusters using Connect Gateway.
  9. When the post-deployment checks succeed, the Cloud Build trigger requests an attestation from Binary Authorization. The attestation certifies that the required tests from the developer environment passed.
  10. Cloud Deploy promotes the release to the second Kubernetes cluster for the QA environment. Steps 7 to 9 run again with some differences: GKE checks for the two attestations before deploying, and after the tests pass, the quality attestation is created.
  11. Cloud Deploy promotes the release to the production environment, which is the third Kubernetes cluster. GKE uses a policy to check for all three attestations in Binary Authorization. When this check passes, GKE deploys the containers in the Kubernetes cluster for the production environment.

Documentation

Usage

Basic usage of this module is as follows:

# Secure-CI
module "ci_pipeline" {
  source                  = "GoogleCloudPlatform/secure-cicd/google//modules/secure-ci"

  project_id              = var.project_id
  primary_location        = "us-central1"
  attestor_names_prefix   = ["build", "security", "quality"]
  app_build_trigger_yaml  = "cloudbuild-ci.yaml"
  runner_build_folder     = "../../../examples/app_cicd/cloud-build-builder"
  build_image_config_yaml = "cloudbuild-skaffold-build-image.yaml"
  trigger_branch_name     = ".*"
}

# Secure-CD
module "cd_pipeline" {
  source           = "GoogleCloudPlatform/secure-cicd/google//modules/secure-cd"

  project_id              = var.project_id
  primary_location        = "us-central1"
  gar_repo_name           = module.ci_pipeline.app_artifact_repo
  cloudbuild_cd_repo      = "cloudbuild-cd-config-pc"
  deploy_branch_clusters  = {
    dev = {
      cluster               = "dev-cluster",
      project_id            = "gke-proj-dev",
      location              = "us-central1",
      required_attestations = ["projects/${var.project_id}/attestors/build-attestor"]
      env_attestation       = "projects/${var.project_id}/attestors/security-attestor"
      next_env              = "qa"
    },
    qa = {
      cluster               = "qa-cluster",
      project_id            = "gke-proj-prod",
      location              = "us-central1",
      required_attestations = ["projects/${var.project_id}/attestors/security-attestor", "projects/${var.project_id}/attestors/build-attestor"]
      env_attestation       = "projects/${var.project_id}/attestors/quality-attestor"
      next_env              = "prod"
    },
    prod = {
      cluster               = "prod-cluster",
      project_id            = "gke-proj-prod",
      location              = "us-central1",
      required_attestations = ["projects/${var.project_id}/attestors/quality-attestor", "projects/${var.project_id}/attestors/security-attestor", "projects/${var.project_id}/attestors/build-attestor"]
      env_attestation       = ""
      next_env              = ""
    },
  }
  app_deploy_trigger_yaml = "cloudbuild-cd.yaml"
  cache_bucket_name       = module.ci_pipeline.cache_bucket_name
  depends_on = [
    module.ci_pipeline
  ]
}

Functional examples are included in the examples directory.

Build Configuration

Example Cloud Build configuration files are located in the Build folder. Push the cloudbuild-ci.yaml configuration to the application source code repository. Push the cloudbuild-cd.yaml configuration to the wet manifest repository. These build configurations offer a baseline for adhering to S3C application delivery practices within this blueprint, and are customizable as needed.

Requirements

These sections describe requirements for using this module.

Software

The following dependencies must be available:

Service Account

A service account with the following roles must be used to provision the resources of this blueprint:

  • Project level:
    • CI/CD project
      • roles/artifactregistry.admin
      • roles/binaryauthorization.attestorsAdmin
      • roles/cloudbuild.builds.builder
      • roles/cloudbuild.workerPoolOwner
      • roles/clouddeploy.admin
      • roles/cloudkms.admin
      • roles/cloudkms.publicKeyViewer
      • roles/containeranalysis.notes.editor
      • roles/compute.networkAdmin
      • roles/gkehub.editor
      • roles/iam.serviceAccountAdmin
      • roles/iam.serviceAccountUser
      • roles/pubsub.editor
      • roles/serviceusage.serviceUsageAdmin
      • roles/source.admin
      • roles/storage.admin
      • roles/resourcemanager.projectIamAdmin
      • roles/viewer
    • GKE projects
      • roles/compute.networkAdmin
      • roles/container.admin
      • roles/binaryauthorization.policyEditor
      • roles/resourcemanager.projectIamAdmin
      • roles/iam.serviceAccountAdmin
      • roles/serviceusage.serviceUsageViewer
      • roles/iam.serviceAccountUser

The Project Factory module and the IAM module may be used in combination to provision a service account with the necessary roles applied.

APIs

Projects with the following APIs enabled must be used to host the resources of this module:

CI/CD Project

  • Cloud Resource Manager API cloudresourcemanager.googleapis.com
  • Cloud Billing API cloudbilling.googleapis.com
  • Storage API storage-api.googleapis.com
  • Service Usage API serviceusage.googleapis.com
  • Cloud Build API cloudbuild.googleapis.com
  • Cloud Deploy API clouddeploy.googleapis.com
  • Pub/Sub API pubsub.googleapis.com
  • Container Registry API containerregistry.googleapis.com
  • IAM Credentials API iamcredentials.googleapis.com
  • Cloud Source Repositories API sourcerepo.googleapis.com
  • Artifact Registry API artifactregistry.googleapis.com
  • Container Analysis API containeranalysis.googleapis.com
  • Cloud KMS API cloudkms.googleapis.com
  • Binary Authorization API binaryauthorization.googleapis.com
  • Container Scanning API containerscanning.googleapis.com

GKE Projects:

  • Cloud Resource Manager API cloudresourcemanager.googleapis.com
  • Cloud Billing API cloudbilling.googleapis.com
  • Storage API storage-api.googleapis.com
  • Service Usage API serviceusage.googleapis.com
  • Container Registry API containerregistry.googleapis.com
  • IAM Credentials API iamcredentials.googleapis.com
  • Artifact Registry API artifactregistry.googleapis.com
  • Container Analysis API containeranalysis.googleapis.com
  • Cloud KMS API cloudkms.googleapis.com
  • Binary Authorization API binaryauthorization.googleapis.com
  • Container Scanning API containerscanning.googleapis.com
  • Kubernetes Engine API container.googleapis.com
  • Cloud Trace API cloudtrace.googleapis.com
  • Cloud Monitoring API monitoring.googleapis.com
  • Coud Logging API logging.googleapis.com

The Project Factory module can be used to provision a project with the necessary APIs enabled.

Contributing

Refer to the contribution guidelines for information on contributing to this module.