I recently launched indieweb-endpoints.cc, a single-purpose Sinatra application for discovering a website’s IndieWeb-specific URLs. The website demonstrates the capabilities of the indieweb-endpoints Ruby gem and provides a JSON API accessible to other websites or command line utilities.
curl --header 'Accept: application/json' 'https://indieweb-endpoints.cc/search?url=https://sixtwothree.org'
I deployed IndieWeb Endpoints to the recently-launched (in beta, anyway…) Google Cloud Run “serverless” container platform. As part of Google’s broader and infinitely complex Google Cloud suite of products, Cloud Run deploys Docker containers, allows for assigning custom domain names, and provisions auto-renewing TLS certificates using Let’s Encrypt. Cloud Run isn’t appropriate for everything, but it’s an interesting choice for a certain category of Web thang.
While this post is not an endorsement of Google Cloud or competing cloud-based service providers, it does detail solutions to a few specific problems I encountered when automating deployments from a GitHub repository to Cloud Run.
I want to lay out a few assumptions before proceeding:
- This post is first and foremost a brain dump for myself so that I don’t forget how to fix these problems next time I encounter them.
- The instructions below are accurate as of the date of publication. Google’s notorious for rapidly changing their products so there’s no guarantee that these instructions will work in the future. Hell, Google’s own documentation website isn’t entirely accurate.
- Most importantly, this post assumes you have some familiarity with Google Cloud, Docker, GitHub, etc. (see Assumption #1). The Cloud Run Quickstarts may be helpful if you haven’t yet configured an application on the platform.
- Let’s also assume you have a Google Cloud account with Cloud Run enabled, have built a Docker-ized application whose source code is on GitHub, and have done the initial setup on Cloud Run. I’ll be using the indieweb-endpoints.cc GitHub repository in the examples throughout this post.
That’s a lot, but… yeah. Trying to keep this post focused.
Create a Cloud Build configuration file
In the root of your project, create a
cloudbuild.yaml file with contents similar to the following:
steps: - name: "gcr.io/cloud-builders/docker" args: ["build", "-t", "gcr.io/$PROJECT_ID/indieweb-endpoints-cc-web", "."] - name: "gcr.io/cloud-builders/docker" args: ["push", "gcr.io/$PROJECT_ID/indieweb-endpoints-cc-web"] - name: "gcr.io/cloud-builders/gcloud" args: ["beta", "run", "deploy", "indieweb-endpoints-cc-web", "--image", "gcr.io/$PROJECT_ID/indieweb-endpoints-cc-web", "--platform", "managed", "--region", "us-central1"] images: - "gcr.io/$PROJECT_ID/indieweb-endpoints-cc-web"
A few things you’ll tweak:
- The service name (
indieweb-endpoints-cc-webin the snippet above) is the name of the Cloud Run service.
- The platform should be either
- The region should be one of the available Cloud Run regions (currently limited to
Add, commit, and push this new file to your application’s GitHub repository.
Create a deployable branch
I prefer deploying to production environments from a branch other than
git checkout -b production git push -u origin production
Create a build trigger
Google’s Automating builds using build triggers tutorial actually does a good job of covering this step. Basically, create a build trigger using your application’s GitHub repository (specifically, the
production branch) and the new
You should then be able to trigger builds by pushing new commits to the
production branch or manually using Google’s website. Here’s where things went sideways for me.
Update Cloud Build service account permissions
The following steps will address the first error I encountered during a failed deploy:
ERROR: (gcloud.beta.run.deploy) PERMISSION_DENIED: The caller does not have permission
- Log in to the Console and navigate to the IAM page.
- Click the “edit” icon next to your project’s Cloud Build Service Account (e.g. $PROJECT_NUMBER@cloudbuild.gserviceaccount.com).
- In the “Edit permissions” panel, click “Add another role” and choose “Cloud Run Admin.”
- Click “Save.”
If you retry the earlier failed deploy and have the same problem I had, you’ll need to…
Update service account user access
The next error you encounter might look like:
Permission ‘iam.serviceaccounts.actAs’ denied on service account $PROJECT_NUMBERemail@example.com (or it may not exist).
(Here and elsewhere,
$PROJECT_NUMBER stands in for the unique string of characters specific to your project.)
This one took forever to sort out despite staring intently at not one but two Stack Overflow answers. I’ll reserve my Very Strong Feelings™ on cloud platform service provider UX design for another time…
- Log in to the Console and navigate to the Service Accounts page.
- Click the checkbox next to “$PROJECT_NUMBERfirstname.lastname@example.org” and, if it’s not already visible, click “Show Info Panel.”
- Click “Add Member.”
- Enter “$PROJECT_NUMBER@cloudbuild.gserviceaccount.com” into New Members and from “Select a Role,” choose “Service Account User.”
- Click “Save.”
Retry the failed deploy and…
You should now be set up to continuously deploy an application from a production branch on GitHub to Google Cloud Run. Next step? Figure out how to post notifications to Slack.