mchmarny/gcf-images

Generate images for each one of the 2nd gen runtime/language combo supported in GCF

gcf-images

When you deploy GCF function, that code (stored in GCS bucket), will be automatically built by GCB into a container image and pushed into Artifact Registry. GCF runs that image when your function is invoked. More about that process here.

This repo creates images for each one of the 2nd generation runtimes supported in GCF using sample function code in multiple development languages, basically automating the how-to process outlined in the Create and deploy a Cloud Function doc using code samples found in following repos:

• Node.js - github.com/GoogleCloudPlatform/nodejs-docs-samples.git
• Python - github.com/GoogleCloudPlatform/python-docs-samples.git
• Go - github.com/GoogleCloudPlatform/golang-samples.git
• Java - github.com/GoogleCloudPlatform/java-docs-samples.git
• C# - github.com/GoogleCloudPlatform/dotnet-docs-samples.git
• Ruby - github.com/GoogleCloudPlatform/ruby-docs-samples.git
• PHP - github.com/GoogleCloudPlatform/php-docs-samples.git

Each one of the samples is deployed on multiple runtimes (e.g. nodejs18, nodejs16, or nodejs14). Some of the above mentioned samples no longer deploy to the older runtimes, so this repo also keeps a "legacy" source for that runtime.

Images created by GCF resulting from this deployment can be found in Artifact Registry under gcf-artifacts registry (us-west1-docker.pkg.dev/cloudy-labz/gcf-artifacts). The name of the image follows the daily--<runtime> convention (e.g. daily--nodejs18, daily--python311, or daily--go120).

Note the double --. GCF automatically injects additional - for each one found in the function name. So function daily-go120 becomes daily--go120 container image in AR.

docker pull us-west1-docker.pkg.dev/cloudy-labz/gcf-artifacts/daily--go120:latest

To list all images in that repo:

gcloud artifacts docker images list us-west1-docker.pkg.dev/cloudy-labz/gcf-artifacts

custom setup

To setup your own instance, first, fork this repo and clone it locally. Then deploy the GCP dependencies into your GCP project:

This repo uses OpenID Connect to grant the GitHub Actions the necessary rights to deploy function without the need for service accounts keys. More about OIDC on GCP here.

make setup

When prompted, provide the two required parameters:

• project_id - the ID of your GCP project (e.g. your-project-id)
• git_repo - the name of your forked github repo (e.g. your-github-username/your-repo-name)

The defaults for optional parameters are defined in setup/variables.tf.

The output will include the two parameters you will need to update in fn-deploy workflow. Find the provider, and user input parameters and update them to the values provided from setup:

provider:
    description: 'Workload Identity Provider'
    required: false
    type: string
    default: '<PROVIDER_ID>'
user:
    description: 'Workload Identity User'
    required: false
    type: string
    default: '<SA_EMAIL>'

The workflow is currently set to execute every 11 hours. If you want change that, alter the schedule at the top of daily.yaml.

on:
  schedule:
    - cron: '0 */11 * * *'

To test, simply commit your changes and push upstream. In addition to the above described schedule, the workflow will also execute on the main branch push or PR.

cleanup

To delete all the resources created by Terraform in your GCP project:

make destroy

disclaimer

This is my personal project and it does not represent my employer. While I do my best to ensure that everything works, I take no responsibility for issues caused by this code.