Skip to content

19 — Quick Reference

← Previous: 18 — Quick Reference

All the important commands from this guide in one place.

Terraform

cd infrastructure

terraform init               # Initialize (download providers, setup backend)
terraform plan               # Preview changes (no actual changes)
terraform apply              # Apply changes (creates/updates resources)
terraform apply -auto-approve # Apply without confirmation prompt
terraform destroy            # Delete all Terraform-managed resources
terraform show               # Show current state
terraform output             # Show output values
terraform state list         # List all resources in state
terraform refresh            # Sync state with real infrastructure

Terraform variables

# Set a variable via CLI
terraform plan -var="project_id=my-project"

# Or in terraform.tfvars (not committed to git)
echo 'project_id = "my-project"' > terraform.tfvars

GCP Project & APIs

# Get current project
gcloud config get-value project

# Set project
gcloud config set project mycoolproject-prod

# Get project number
gcloud projects describe mycoolproject-prod --format='value(projectNumber)'

# List enabled APIs
gcloud services list --enabled --project=mycoolproject-prod

Artifact Registry

# Authenticate Docker
gcloud auth configure-docker southamerica-east1-docker.pkg.dev

# List repositories
gcloud artifacts repositories list --project=mycoolproject-prod

# List images in a repository
gcloud artifacts docker images list southamerica-east1-docker.pkg.dev/mycoolproject-prod/app-repo

Cloud Run

# Deploy a new image
gcloud run deploy mycoolproject \
  --image=southamerica-east1-docker.pkg.dev/mycoolproject-prod/app-repo/app:latest \
  --region=southamerica-east1

# Get service URL
gcloud run services describe mycoolproject --region=southamerica-east1 --format="value(status.url)"

# View logs
gcloud run services logs tail mycoolproject --region=southamerica-east1

# List revisions
gcloud run revisions list --service=mycoolproject --region=southamerica-east1

# Rollback to previous revision
gcloud run services update-traffic mycoolproject \
  --region=southamerica-east1 \
  --to-revisions=mycoolproject-<revision>=100

# Update env vars
gcloud run services update mycoolproject \
  --region=southamerica-east1 \
  --update-env-vars=ALLOWED_HOSTS="mycoolproject.com,www.mycoolproject.com"

Cloud Run Jobs

# Create a job
gcloud run jobs create job-name \
  --image=southamerica-east1-docker.pkg.dev/mycoolproject-prod/app-repo/app:latest \
  --region=southamerica-east1

# Run a job (and wait)
gcloud run jobs execute job-name --region=southamerica-east1 --wait

# List jobs
gcloud run jobs list --region=southamerica-east1

Cloud Tasks

# List queues
gcloud tasks queues list --location=southamerica-east1

# Purge a queue (delete all tasks)
gcloud tasks queues purge mycoolproject-default --location=southamerica-east1

Cloud Scheduler

# Create a scheduler job (trigger Cloud Run Job)
gcloud scheduler jobs create http worker-trigger \
  --schedule="* * * * *" \
  --uri="https://region-run.googleapis.com/v2/projects/mycoolproject-prod/locations/southamerica-east1/jobs/mycoolproject-worker:run" \
  --http-method=POST \
  --oidc-service-account-email=mycoolproject-scheduler@mycoolproject-prod.iam.gserviceaccount.com

# List jobs
gcloud scheduler jobs list --location=southamerica-east1

# Pause a job
gcloud scheduler jobs pause worker-trigger --location=southamerica-east1

# Resume a job
gcloud scheduler jobs resume worker-trigger --location=southamerica-east1

Cloud Storage

# List buckets
gsutil ls

# List bucket contents
gsutil ls gs://mycoolproject-prod-static/

# Make bucket public
gsutil iam ch allUsers:objectViewer gs://mycoolproject-prod-static

# Upload file
gsutil cp file.txt gs://mycoolproject-prod-media/

# Download file
gsutil cp gs://mycoolproject-prod-media/file.txt ./

# Set cache control on files
gsutil setmeta -h "Cache-Control:public, max-age=31536000" gs://mycoolproject-prod-static/**/*.css

Secret Manager

# List secrets
gcloud secrets list

# Create a secret
echo -n "value" | gcloud secrets create SECRET_NAME --data-file=-

# Add a new version
echo -n "new-value" | gcloud secrets versions add SECRET_NAME --data-file=-

# Read a secret
gcloud secrets versions access latest --secret=SECRET_NAME

# Delete a secret (and all versions)
gcloud secrets delete SECRET_NAME

Service Accounts

# List service accounts
gcloud iam service-accounts list --project=mycoolproject-prod

# Grant IAM role
gcloud projects add-iam-policy-binding mycoolproject-prod \
  --member="serviceAccount:name@project.iam.gserviceaccount.com" \
  --role="roles/role-name"

# Remove IAM role
gcloud projects remove-iam-policy-binding mycoolproject-prod \
  --member="serviceAccount:name@project.iam.gserviceaccount.com" \
  --role="roles/role-name"

Workload Identity

# Get provider resource name
gcloud iam workload-identity-pools providers describe github-provider \
  --location=global \
  --workload-identity-pool=github-pool \
  --format="value(name)"

Docker

# Build image
docker build -t mycoolproject-app .

# Run locally
docker run --rm -p 8080:8080 \
  -e DATABASE_URL="postgres://..." \
  -e SECRET_KEY="test" \
  mycoolproject-app

# Tag for Artifact Registry
docker tag mycoolproject-app southamerica-east1-docker.pkg.dev/mycoolproject-prod/app-repo/app:latest

# Push
docker push southamerica-east1-docker.pkg.dev/mycoolproject-prod/app-repo/app:latest

PlanetScale CLI

# Authenticate
pscale auth login

# Create database
pscale database create mycoolproject

# List databases
pscale database list

# Create branch
pscale branch create mycoolproject feature-branch

# List branches
pscale branch list mycoolproject

# Connect to branch (local development)
pscale connect mycoolproject development

# Delete branch
pscale branch delete mycoolproject feature-branch

# Get connection string
pscale connection-string mycoolproject main --fetch

Django management commands

cd web

# Run migrations (in production via Cloud Run Job)
DJANGO_SETTINGS_MODULE=core.settings.prod uv run manage.py migrate

# Collectstatic (upload static files to GCS)
DJANGO_SETTINGS_MODULE=core.settings.prod uv run manage.py collectstatic --noinput

# Create superuser
DJANGO_SETTINGS_MODULE=core.settings.prod uv run manage.py createsuperuser --noinput

# Run tests
DJANGO_SETTINGS_MODULE=core.settings.test uv run manage.py test

GitHub Actions workflow

The complete workflow is in .github/workflows/deploy.yml:

name: Test & Deploy

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

env:
  REGION: southamerica-east1
  IMAGE: southamerica-east1-docker.pkg.dev/mycoolproject-prod/app-repo/app

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: astral-sh/setup-uv@v4
        with:
          working-directory: web
      - name: Install dependencies
        run: cd web && uv sync --frozen
      - name: Run tests
        run: cd web && uv run manage.py test web/tests --settings=core.settings.test
        env:
          SECRET_KEY: ci-secret-not-real

  deploy:
    runs-on: ubuntu-latest
    needs: test
    if: github.ref == 'refs/heads/main'
    permissions:
      contents: read
      id-token: write
    steps:
      - uses: actions/checkout@v4
      - uses: google-github-actions/auth@v2
        with:
          workload_identity_provider: ${{ secrets.GCP_WORKLOAD_IDENTITY_PROVIDER }}
          service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}
      - uses: google-github-actions/setup-gcloud@v2
      - name: Configure Docker
        run: gcloud auth configure-docker ${{ env.REGION }}-docker.pkg.dev --quiet
      - name: Build image
        run: |
          docker build \
            -t ${{ env.IMAGE }}:${{ github.sha }} \
            -t ${{ env.IMAGE }}:latest \
            .
      - name: Push image
        run: docker push --all-tags ${{ env.IMAGE }}
      - name: Deploy to Cloud Run
        run: |
          gcloud run services update mycoolproject \
            --image=${{ env.IMAGE }}:${{ github.sha }} \
            --region=${{ env.REGION }}
      - name: Run migrations
        run: |
          gcloud run jobs execute migrate \
            --region=${{ env.REGION }} \
            --wait

Health check

curl https://mycoolproject.com/health/
# Expected: {"status": "ok"}