Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/serverless-helm/cloudrun

Fast Google CloudRun deployments with Helm using GitOps bypassing the overhead of Kubernetes and Terraform.
https://github.com/serverless-helm/cloudrun

cloudrun continous-integration deployment docker github-actions google helm serverless terraform

Last synced: 25 days ago
JSON representation

Fast Google CloudRun deployments with Helm using GitOps bypassing the overhead of Kubernetes and Terraform.

Host: GitHub
URL: https://github.com/serverless-helm/cloudrun
Owner: serverless-helm
License: mit
Created: 2024-11-13T17:48:55.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-11-16T05:58:33.000Z (3 months ago)
Last Synced: 2024-11-16T06:23:46.105Z (3 months ago)
Topics: cloudrun, continous-integration, deployment, docker, github-actions, google, helm, serverless, terraform
Language: Smarty
Homepage:
Size: 45.9 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Serverless Google CloudRun Helm Deployments

![Version](https://img.shields.io/github/v/release/serverless-helm/cloudrun)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/serverless-helm/cloudrun/release.yaml)
![License](https://img.shields.io/github/license/serverless-helm/cloudrun)

## Overview

### The Challenge

Modern container deployment presents teams with a challenging dilemma:

**Kubernetes** offers a powerful developer experience through GitOps-style deployments, where simple YAML files in your repository define and manage container workloads. However, it demands significant operational overhead, expertise, and resources - making it impractical for many early-stage companies and small teams.

**Serverless platforms** like Google Cloud Run provide a streamlined, cost-effective alternative for hosting containers without infrastructure management. But when implementing GitOps practices, teams are often forced to use Terraform, leading to:

- Long feedback cycles and deployment times
- Infrastructure changes siloed in separate repositories
- Complex approval processes for simple updates like environment variables
- Tight coupling between application and infrastructure changes

### The Solution

This project offers a new approach using a custom Helm chart and Github Actions to combine the best of both worlds:

- **Kubernetes-like Developer Experience**: Use familiar Helm syntax and values files to manage your container workloads directly in your application repositories
- **Serverless Simplicity**: Generate Cloud Run YAML specifications that deploy directly via the Google Cloud CLI - no Kubernetes required
- **Rapid Iterations**: Update environment variables and configurations by simply modifying `values.yaml` - no Terraform changes needed
- **Minimal Infrastructure Code**: Reduce Terraform to a thin wrapper that only manages resources like IAM, while delegating container configuration to Helm
- **GitOps Ready**: Version control your Cloud Run configurations and automate deployments through CI/CD pipelines

This innovative approach has been proven in production, enabling teams to achieve up to 10x faster deployments while maintaining the simplicity and cost benefits of serverless infrastructure.

This Helm chart generates manifests compatible with Google Cloud Run's YAML specification, which can be deployed using the `gcloud run services replace` command or the Github Action from this repository.

## Prerequisites

- [Helm](https://helm.sh/) v3.x
- [Google Cloud SDK](https://cloud.google.com/sdk/docs/install)
- Access to a Google Cloud project with Cloud Run enabled

## Getting Started

## Usage

To render the manifest for a Cloud Run service or job, run the following command:

```bash
helm template oci://ghcr.io/serverless-helm/cloudrun/charts/serverless-helm-cloudrun -f values.yaml > cloudrun_manifest.yaml
```

To deploy the manifest, run the following command:

```bash
gcloud run services replace out/cloudrun/templates/serverless-helm.cloudrun.yaml --region=
```

To clean up and delete the service, run the following command:

```bash
gcloud run services delete serverless-helm --region=
```

## Configuration Reference

Find the full configuration reference for the Helm chart in the [chart/docs/values.md](./chart/docs/values.md) file.

## TODO:

### Documentation

- [ ] Add documentation page using [MkDocs](https://www.mkdocs.org/)
- [ ] Add documentation for the Github Action
- [ ] [How to setup Google Cloud credentials for Github Actions](https://github.com/google-github-actions/auth#workload-identity-federation-through-a-service-account)
- Important: give the service account the following roles needed to deploy to Cloud Run:
- `roles/run.admin`
- `roles/iam.serviceAccountUser` on the service account used to run the CloudRun Service - by default this is the project's default service account - highly recommended to create a new service account to run the CloudRun Service and grant only the necessary roles to this account
- `roles/iam.serviceAccountTokenCreator` on the repository service account itself