Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeffbryner/gcp-cloudrun-python-pipeline

Yet another cloudrun pipeline, but better because: python
https://github.com/jeffbryner/gcp-cloudrun-python-pipeline

Last synced: about 2 months ago
JSON representation

Yet another cloudrun pipeline, but better because: python

Awesome Lists containing this project

README 

        

# GCP-CloudRun-Python-Pipeline



A goldilocks effort (now with python) for bootstraping a GCP CloudRun project with it's own ci/cd pipeline focused on the quickest way to hoist a cloudrun container into GCP via terraform.



Based on this starter kickstarter project : https://github.com/jeffbryner/gcp-project-pipeline



## Why?



This is meant to simply satisfy the urge to dream up a *python* CloudRun project, give it a name and location in the org tree, terraform apply and then immediately begin using the ci/cd pipeline to build the remaining infrastructure.



## Setup

You will need to be able to create a project with billing in the appropriate place in your particular org structure. First you'll run terraform locallly to initialize the project and the pipeline. After the project is created, we will transfer terraform state to the cloud bucket and from then on you can use git commits to trigger terraform changes without any local resources or permissions.



1. Clone this repo



2. Change directory (cd) to the cicd directory and edit the terraform.tfvars to match your GCP organization.



3. Run the following commands in the cicd directory to enable the necessary APIs,

   grant the Cloud Build service account the necessary permissions, and create

   Cloud Build triggers and the terraform state bucket:



    ```shell

    terraform init

    terraform apply

    ```

4. Get the name of the terraform state bucket from the terraform output



    ```shell

    terraform output

    ```

  and copy backend.tf.example as backend.tf with the proper bucket name.



    ```terraform

        terraform {

      backend "gcs" {

        bucket = "UPDATE_ME_WITH_OUTPUT_OF_INITIAL_INIT"

        prefix = "cicd"

      }

    }

    ```



  Note that if you create other directories for other terraform concerns, you should duplicate this backend.tf file in those directories with a different prefix so your state bucket matches your directory layout.



5. Now terraform can transfer state from your local environment into GCP. From the cicd directory:

    ```shell

    terraform init -force-copy

    ```



6. Follow the instructions at https://source.cloud.google.com// to then push your code (from the parent directory of cicd, i.e. not the cicd directory) into your new CICD pipeline. Basically:



    ```shell

    git init

    gcloud init && git config --global credential.https://source.developers.google.com.helper gcloud.sh

    git remote add google  https://source.developers.google.com/p//r/

    git checkout -b main

    git add cicd/configs/* cicd/backend.tf cicd/main.tf cicd/outputs.tf cicd/terraform.tfvars cicd/triggers.tf cicd/variables.tf

    git commit -m 'first push after bootstrap'

    git push --all google



7. After the repo and pipeline is established you should be able to view the build triggers and history by visiting:

https://console.cloud.google.com/cloud-build/dashboard?project=



## Cloud run container ##

The /cloudrun directory is where you will work with terraform to publish the container you intend to serve using Cloudrun.



tl;dr is the main.tf is the terraform to tweak, and /cloudrun/container is the Dockerfile, cloudbuild.yaml and place to put your container source.



Be sure to set terraform.tvfars to reference your target project ID.



See /cloudrun/README.md for details.



## CICD Container/Container Creation



The Docker container used for CICD executions are inspired by those built and maintained by the

Cloud Foundation Toolkit (CFT) team.



Documentations and source can be found [here](https://github.com/GoogleCloudPlatform/cloud-foundation-toolkit/tree/master/infra/build/developer-tools-light). Images can be found [here](https://console.cloud.google.com/gcr/images/cloud-foundation-cicd/GLOBAL/cft/developer-tools-light).



This version of the container includes necessary dependencies (e.g. bash, terraform, gcloud, python, pip, pipenv) to validate and deploy Terraform configs and is based on hashicorp's native terraform and alpine linux.



To build the container, cd to the container directory and issue the command



```bash

gcloud builds submit

```

Which will kick off a build using the cloudbuild.yaml and Dockerfile in the container directory, creating a 'cloudbuilder' container ( gcr.io/${PROJECT_ID}/cloudbuilder )in your project that is used by the triggers.



## Features



### Event-triggered builds



Two presubmit and one postsubmit triggers are created by default.



* \[Presubmit\] `tf-validate`: Perform Terraform format and syntax check.

  * It does not access Terraform remote state.

* \[Presubmit\] `tf-plan`: Generate speculative plans to show a set of

    potential changes if the pending config changes are deployed.

  * It accesses Terraform remote state but does not lock it.

  * This also performs a non-blocking check for resource deletions. These

        are worth reviewing, as deletions are potentially destructive.

* \[Postsubmit\] `tf-apply`: Apply the terraform configs that are checked into

    the config source repo.

  * It accesses Terraform remote state and locks it.

  * This trigger is only applicable post-submit.

  * When this trigger is set in the Terraform engine config, the Cloud Build

        service account is given broader permissions to be able to make changes

        to the infrastructure.



Every new push to the Pull Request at the configured branches automatically

triggers presubmit runs.



The postsubmit Cloud Build job automatically starts after a Pull Ruquest is

submitted to a configured branch. To view the result of the Cloud Build run, go

to [Build history](https://console.cloud.google.com/cloud-build/builds) and look

for your commit to view the Cloud Build job triggered by your merged commit.



The `build_viewers` members can view detailed log output.



The triggers all use a [helper runner script](./cicd/configs/run.sh) to perform

actions. The `DIRS` var within the script lists the directories that are managed by the triggers and the order they are

run.