drone-gcloud-run

README

Drone Google Cloud Run

A Drone plugin deploy and manage Google Cloud Run services.

IMPORTANT: This plugin currently supports only Managed Google Cloud Run services.

Usage

The following settings changes this plugin's behavior.

• service_account_json: The Google Cloud Service Account JSON that has required permissions to create, update and delete Google Cloud Run services. This string should be a base64 encoded string. If you don't set this value then you need to set the environment variable GOOGLE_APPLICATION_CREDENTIALS pointing to the service account key json file.
• project: The Google project where the Google Cloud Run service will be deployed.
• region: The Google Cloud region e.g asia-south1 where the Google Cloud Run service will be deployed.
• service_name: The name of the Google Cloud Run service.
• image: The container image that will be used for the service.
• image_digest_file: (optional) The file holding the SHA256 digest of the image. Note if don't provide this, the image digest will be computed from image.
• delete: If the service needs to be deleted.
• allow_unauthenticated: Allow public access to the service.

Below is an example .drone.yml that uses this plugin.

kind: pipeline
type: docker
name: deploy-service

environment: &buildEnv
  SERVICE_ACCOUNT_JSON:
    from_secret: SERVICE_ACCOUNT_JSON
  GOOGLE_CLOUD_PROJECT:
     from_secret: GOOGLE_CLOUD_PROJECT
  GOOGLE_CLOUD_REGION:
     from_secret: GOOGLE_CLOUD_REGION
  
steps:
- name: publish
  image: quay.io/kameshsampath/drone-gcloud-run
  settings:
    service_account_json: ${SERVICE_ACCOUNT_JSON}
    project: ${GOOGLE_CLOUD_PROJECT}
    region: ${GOOGLE_CLOUD_REGION}
    service_name: my-service
    image: asia.gcr.io/${GOOGLE_CLOUD_PROJECT}/greeter
  environment: *buildEnv

IMPORTANT: It is highly recommended that the environment variables are passed using secrets e.g. drone exec --secret-file=.env

Please check the examples directory for more examples.

Building

Build the plugin binary:

make build-plugin

Build the plugin image:

docker build -t docker.io/kameshsampath/drone-gcloud-run -f docker/Dockerfile .

Testing

Execute the plugin from your current working directory:

docker run --rm -e PLUGIN_SERVICE_ACCOUNT_JSON=foo \
  -e PLUGIN_GOOGLE_CLOUD_PROJECT=bar \
  -e PLUGIN_GOOGLE_CLOUD_REGION=asia-south1 \
  -e PLUGIN_IMAGE=asia.gcr.io/${GOOGLE_CLOUD_PROJECT}/greeter \
  -e PLUGIN_SERVICE_NAME=my-service \
  -w /drone/src \
  -v $(pwd):/drone/src \
  quay.io/kameshsampath/drone-gcloud-run