cloud-gov-instructions: Instructions file for GitHub Copilot

Cloud.gov Deployment Instructions

This document provides guidance for deploying applications to cloud.gov using the Cloud Foundry CLI.

Overview

Cloud.gov uses cf push as the primary deployment command. The platform builds your application using buildpacks and runs it in isolated containers.

Prerequisites

• Cloud Foundry CLI installed (cf command available)
• Authenticated to cloud.gov: cf login -a api.fr.cloud.gov --sso
• Targeted the correct org and space: cf target -o <ORG> -s <SPACE>

Basic Deployment Workflow

1. Prepare Your Application

Ensure your application follows these principles:

• Stateless: Don't write to local filesystem for persistent data
• 12-Factor: Follow Twelve-Factor App methodology
• Quick startup: Applications should start within 60 seconds
• Health endpoint: Implement /health or similar for monitoring

2. Create Required Files

manifest.yml

---
applications:
  - name: my-application
    memory: 512M
    instances: 2
    buildpacks:
      - python_buildpack
    env:
      ENVIRONMENT: production
    services:
      - my-database
    routes:
      - route: my-app.app.cloud.gov

.cfignore

Exclude unnecessary files from deployment:

.git/
.gitignore
node_modules/
__pycache__/
*.pyc
.env
.env.*
tests/
docs/
*.md
!README.md
.vscode/
.idea/

.profile (optional)

Shell script run before app starts:

#!/bin/bash
# Set runtime environment variables
export APP_STARTED_AT=$(date)

Procfile (optional)

Define process types:

web: gunicorn app:app --bind 0.0.0.0:$PORT
worker: python worker.py

3. Deploy the Application

# Basic deployment
cf push

# Deploy with specific manifest
cf push -f manifest.yml

# Deploy without starting (useful for binding services first)
cf push --no-start

# Deploy with a specific app name (overrides manifest)
cf push my-app-name

4. Verify Deployment

# Check application status
cf app <APP_NAME>

# View recent logs
cf logs <APP_NAME> --recent

# Stream live logs
cf logs <APP_NAME>

# Check application health
curl https://<APP_NAME>.app.cloud.gov/health