Skip to content

README.md

Latest commit

 

History

History
157 lines (115 loc) · 4.18 KB

README.md

File metadata and controls

157 lines (115 loc) · 4.18 KB

Lambda Deployment with PipeCD Tutorial

This directory contains examples for deploying AWS Lambda functions using PipeCD with direct source code deployment instead of container images, making it much easier to get started.

🎯 What's New (Issue #16)

Previously, the Lambda tutorial required:

  • ❌ Building and pushing container images to ECR
  • ❌ Complex Docker setup
  • ❌ ECR repository management

Now it uses:

  • ✅ Simple Python source code
  • ✅ Automatic packaging by PipeCD
  • ✅ No manual zip building or S3 uploads
  • ✅ Minimal prerequisites (just an IAM role)

📁 Directory Structure

lambda/
├── simple/                 # Simple deployment example
│   ├── src/
│   │   ├── index.py       # Lambda function source code
│   │   └── requirements.txt # Python dependencies
│   ├── function.yaml      # Lambda function configuration
│   └── app.pipecd.yaml    # PipeCD application config
├── canary/                # Canary deployment example
│   ├── src/
│   │   ├── index.py       # Enhanced Lambda function
│   │   └── requirements.txt # Python dependencies
│   ├── function.yaml      # Lambda function configuration
│   └── app.pipecd.yaml    # PipeCD canary pipeline config
└── README.md             # This file

🚀 Quick Start

Prerequisites

  1. AWS CLI configured with appropriate permissions
  2. IAM role for Lambda execution

Step 1: Configure function.yaml

Edit simple/function.yaml:

spec:
  name: PipeCDTutorial_Simple
  role: arn:aws:iam::123456789012:role/lambda-execution-role
  source:
    git: ""  # Empty means same repository
    ref: ""  # Empty means current commit
    path: "src"  # Path to source code directory
  runtime: python3.9
  handler: index.lambda_handler

Step 2: Deploy with PipeCD

Follow the main tutorial instructions to register and deploy the application.

That's it! PipeCD will automatically:

  • Package your source code into a zip file
  • Deploy it to AWS Lambda
  • Handle all the complexity for you

📋 Function Details

Simple Function (simple/src/index.py)

  • Returns a JSON response with greeting and metadata
  • Includes request information and timestamps
  • Uses only Python standard library (no dependencies)
  • Perfect for testing basic Lambda deployment

Canary Function (canary/src/index.py)

  • Enhanced version with deployment tracking
  • Additional logging for canary deployment monitoring
  • Environment variables for version control
  • Demonstrates gradual rollout capabilities

🔧 Customization

Adding Dependencies

  1. Edit src/requirements.txt:

    requests==2.31.0
boto3==1.34.0

  2. Commit and push - PipeCD will automatically install dependencies during packaging

Modifying the Function

  1. Edit src/index.py with your custom logic
  2. Test locally: python src/index.py
  3. Commit and push - PipeCD handles the rest

Environment Variables

Add environment variables in function.yaml:

spec:
  environment:
    CUSTOM_VAR: "custom_value"
    API_ENDPOINT: "https://api.example.com"

🧪 Local Testing

Test your function locally before deployment:

cd simple/src/
python index.py

This runs the function with a test event and displays the output.

📊 Deployment Strategies

Simple Deployment

  • Uses simple/ directory
  • Quick sync strategy
  • Immediate deployment

Canary Deployment

  • Uses canary/ directory
  • Gradual traffic shifting (10% → 50% → 100%)
  • Built-in rollback capabilities
  • Wait stages for monitoring

🔍 Troubleshooting

Deployment Issues

  • Verify IAM role has Lambda execution permissions
  • Check function.yaml syntax
  • Ensure source code is in the correct directory structure

Runtime Issues

  • Review CloudWatch logs
  • Test function locally first
  • Verify environment variables

📚 Next Steps

  1. Try the simple deployment first
  2. Experiment with the canary deployment
  3. Customize the function for your use case
  4. Explore PipeCD's advanced Lambda features

For more information, see the PipeCD Lambda documentation.