clay-prod-checklist

# Clay Production Checklist ## Overview Complete checklist for deploying Clay integrations to production. ## Prerequisites - Staging environment tested and verified - Production API keys available - Deployment pipeline configured - Monitoring and alerting ready ## Instructions ### Step 1: Pre-Deployment Configuration - [ ] Production API keys in secure vault - [ ] Environment variables set in deployment platform - [ ] API key scopes are minimal (least privilege) - [ ] Webhook endpoints configured with HTTPS - [ ] Webhook secrets stored securely ### Step 2: Code Quality Verification - [ ] All tests passing (`npm test`) - [ ] No hardcoded credentials - [ ] Error handling covers all Clay error types - [ ] Rate limiting/backoff implemented - [ ] Logging is production-appropriate ### Step 3: Infrastructure Setup - [ ] Health check endpoint includes Clay connectivity - [ ] Monitoring/alerting configured - [ ] Circuit breaker pattern implemented - [ ] Graceful degradation configured ### Step 4: Documentation Requirements - [ ] Incident runbook created - [ ] Key rotation procedure documented - [ ] Rollback procedure documented - [ ] On-call escalation path defined ### Step 5: Deploy with Gradual Rollout ```bash # Pre-flight checks curl -f https://staging.example.com/health curl -s https://status.clay.com # Gradual rollout - start with canary (10%) kubectl apply -f k8s/production.yaml kubectl set image deployment/clay-integration app=image:new --record kubectl rollout pause deployment/clay-integration # Monitor canary traffic for 10 minutes sleep 600 # Check error rates and latency before continuing # If healthy, continue rollout to 50% kubectl rollout resume deployment/clay-integration kubectl rollout pause deployment/clay-integration sleep 300 # Complete rollout to 100% kubectl rollout resume deployment/clay-integration kubectl rollout status deployment/clay-integration ``` ## Output - Deployed Clay integration - Health checks passing - Monitoring active - Rollback procedure documented ## Error Handling | Alert | Condition | Severity | |-------|-----------|----------| | API Down | 5xx errors > 10/min | P1 | | High Latency | p99 > 5000ms | P2 | | Rate Limited | 429 errors > 5/min | P2 | | Auth Failures | 401/403 errors > 0 | P1 | ## Examples ### Health Check Implementation ```typescript async function healthCheck(): Promise<{ status: string; clay: any }> { const start = Date.now(); try { await clayClient.ping(); return { status: 'healthy', clay: { connected: true, latencyMs: Date.now() - start } }; } catch (error) { return { status: 'degraded', clay: { connected: false, latencyMs: Date.now() - start } }; } } ``` ### Immediate Rollback ```bash kubectl rollout undo deployment/clay-integration kubectl rollout status deployment/clay-integration ``` ## Resources - [Clay Status](https://status.clay.com) - [Clay Support](https://docs.clay.com/support) ## Next Steps For version upgrades, see `clay-upgrade-migration`.