Logo

dev-resources.site

for different kinds of informations.

Deploying a stateless container on cloud run

Published at
10/7/2024
Categories
devops
python
fastapi
containerapps
Author
mohamed_rasvi_9f19a0ec9c9
Author
25 person written this
mohamed_rasvi_9f19a0ec9c9
open
Deploying a stateless container on cloud run

Deploying a stateless container on cloud run

I will demonstrate how to deploy a simple container on cloud run.

Cloud Run is a fully managed platform that enables you to run your code directly on top of Google’s scalable infrastructure. Cloud Run is simple, automated, and designed to make you more productive.

  1. Create a simple hello world application using fastapi library (python)
  2. Containerize the application
  3. Configure the workflow with GCP
  4. Deploy the container onto cloud run service via github workflow

I followed official fastapi doc to spin up a hello world app
Create a requirements.txt file

fastapi[standard]
pydantic>=2.7.0,<3.0.0
Enter fullscreen mode Exit fullscreen mode
  • Create an app directory and enter it
  • Create an empty file init.py
  • Create a main.py file with:
from typing import Union

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id, "q": q}
Enter fullscreen mode Exit fullscreen mode

Create a Dockerfile

FROM python:3.9

WORKDIR /code

COPY ./requirements.txt /code/requirements.txt

RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt

COPY ./app /code/app

CMD ["fastapi", "run", "app/main.py", "--port", "80"]
Enter fullscreen mode Exit fullscreen mode

GitHub Action
In order for the GitHub actions process to pick up the YAML file, there’s specific location for it to live. Each repository using actions requires a directory structure called /.github/workflows

*Configure this workflow with GCP more info *

# This workflow build and push a Docker container to Google Artifact Registry
# and deploy it on Cloud Run when a commit is pushed to the $default-branch
# branch.
#
# To configure this workflow:
#
# 1. Enable the following Google Cloud APIs:
#
#    - Artifact Registry (artifactregistry.googleapis.com)
#    - Cloud Run (run.googleapis.com)
#    - IAM Credentials API (iamcredentials.googleapis.com)
#
#    You can learn more about enabling APIs at
#    https://support.google.com/googleapi/answer/6158841.
#
# 2. Create and configure a Workload Identity Provider for GitHub:
#    https://github.com/google-github-actions/auth#preferred-direct-workload-identity-federation.
#
#    Depending on how you authenticate, you will need to grant an IAM principal
#    permissions on Google Cloud:
#
#    - Artifact Registry Administrator (roles/artifactregistry.admin)
#    - Cloud Run Developer (roles/run.developer)
#
#    You can learn more about setting IAM permissions at
#    https://cloud.google.com/iam/docs/manage-access-other-resources
#
# 3. Change the values in the "env" block to match your values.
Enter fullscreen mode Exit fullscreen mode

Create a file google-cloudrun-docker.yml

name: 'Build and Deploy to Cloud Run'

on:
  push:
    branches:
      - '$default-branch'

env:
  PROJECT_ID: 'my-project' # TODO: update to your Google Cloud project ID
  REGION: 'us-central1' # TODO: update to your region
  SERVICE: 'my-service' # TODO: update to your service name
  WORKLOAD_IDENTITY_PROVIDER: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider' # TODO: update to your workload identity provider

jobs:
  deploy:
    runs-on: 'ubuntu-latest'

    permissions:
      contents: 'read'
      id-token: 'write'

    steps:
      - name: 'Checkout'
        uses: 'actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332' # actions/checkout@v4

      # Configure Workload Identity Federation and generate an access token.
      #
      # See https://github.com/google-github-actions/auth for more options,
      # including authenticating via a JSON credentials file.
      - id: 'auth'
        name: 'Authenticate to Google Cloud'
        uses: 'google-github-actions/auth@f112390a2df9932162083945e46d439060d66ec2' # google-github-actions/auth@v2
        with:
          workload_identity_provider: '${{ env.WORKLOAD_IDENTITY_PROVIDER }}'

      # BEGIN - Docker auth and build
      #
      # If you already have a container image, you can omit these steps.
      - name: 'Docker Auth'
        uses: 'docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567' # docker/login-action@v3
        with:
          username: 'oauth2accesstoken'
          password: '${{ steps.auth.outputs.auth_token }}'
          registry: '${{ env.REGION }}-docker.pkg.dev'

      - name: 'Build and Push Container'
        run: |-
          DOCKER_TAG="$${{ env.REGION }}-docker.pkg.dev/${{ env.PROJECT_ID }}/${{ env.SERVICE }}:${{ github.sha }}"
          docker build --tag "${DOCKER_TAG}" .
          docker push "${DOCKER_TAG}"
      - name: 'Deploy to Cloud Run'

        # END - Docker auth and build

        uses: 'google-github-actions/deploy-cloudrun@33553064113a37d688aa6937bacbdc481580be17' # google-github-actions/deploy-cloudrun@v2
        with:
          service: '${{ env.SERVICE }}'
          region: '${{ env.REGION }}'
          # NOTE: If using a pre-built image, update the image name below:

          image: '${{ env.REGION }}-docker.pkg.dev/${{ env.PROJECT_ID }}/${{ env.SERVICE }}:${{ github.sha }}'
      # If required, use the Cloud Run URL output in later steps
      - name: 'Show output'
        run: |2-

          echo ${{ steps.deploy.outputs.url }}
Enter fullscreen mode Exit fullscreen mode

Directory Structure

You should now have a directory structure like:

β”œβ”€β”€ app
β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚   └── main.py
β”œβ”€β”€ Dockerfile
└── requirements.txt
└── requirements.txt
β”œβ”€β”€ .github
β”‚Β Β  β”œβ”€β”€ workflows
         β”œβ”€β”€ google-cloudrun-docker.yml


Enter fullscreen mode Exit fullscreen mode

> 1. Create a new repo in gitHUb
> 2. Push your exisisting code to new repository on default branch
Enter fullscreen mode Exit fullscreen mode
containerapps Article's
30 articles in total
Favicon
Tackling CPU Throttling in Kubernetes for Better Application Performance
Favicon
What the Heck is Docker?
Favicon
A Step-by-Step Guide to CI/CD Pipeline for Angular App with Azure Container Apps
Favicon
Cool SHIT you can do with docker
Favicon
Deploying a stateless container on cloud run
Favicon
Dockerize Your Development: Build Reusable Features, Faster
Favicon
Docker For Beginners
Favicon
Preventing Out-of-Memory (OOM) Kills in Kubernetes: Tips for Optimizing Container Memory Management
Favicon
How and why did we improve our API hosting?
Favicon
Deploying a Java Azure Function on Azure Container Apps
Favicon
AWS App Runner: A quick start deploying Docker Container to AppRunner
Favicon
Deploying a Static Website with Docker: A Comprehensive Guide
Favicon
Day 12 of my 90-Devops Journey: CI/CD for Containerized Applications: A GitLab Guide
Favicon
How to containerize your web app- a beginner-friendly tutorial for Dockerfile
Favicon
Use LLMs in Java. An example with Merlinite, Quarkus, and Podman Desktop AI Lab
Favicon
How to Build a Container Image Running on Docker Hub.
Favicon
Android Encrypted Shared Preference access issue from new container
Favicon
What is Docker ?: Understanding the Concept of Containerization.
Favicon
How Azure Container Apps Simplify the Cloud Deployment Process
Favicon
docker compose : top level object must be mapping
Favicon
Deploying Containers with Security in mind (Beginner)
Favicon
Containerizing your Go application by using Docker
Favicon
Containerizing your Go application using Docker
Favicon
Revolutionize Your Dev Workflow: Containerization and Linux VPS Hosting for Streamlined Software Development
Favicon
Java application latency reduction and pitfalls
Favicon
A Beginner's Tour of NodePort, LoadBalancer, and Ingress Services
Favicon
Azure Container Apps: Zero to Hero
Favicon
Dev Container for React Native with Expo
Favicon
How to authenticate and register GitHub Runners hosted in Azure Container Apps with GitHub App via Azure Key Vault
Favicon
The Orchestration of The Ring

Featured ones: