Documentation Index
Fetch the complete documentation index at: https://docs.cirron.com/llms.txt
Use this file to discover all available pages before exploring further.
cirron deploy
Deploy your ML project to Cirron environments (development, staging, production) with support for build, artifact upload, deployment monitoring, and rollback capabilities.Usage
Options
| Option | Description | Default |
|---|---|---|
--env, -e | Target environment (development, staging, production) | development |
--message, -m | Deployment message | Auto-generated |
--no-build | Skip build step | false |
--force, -f | Force deploy (skip confirmation) | false |
--rollback | Rollback to previous successful deployment | false |
Deployment Workflow
1. Pre-deployment Checks
- Project Configuration: Validates
cirron.yamlexists - Authentication: Ensures user is authenticated
- Environment Validation: Verifies target environment exists
- Production Confirmation: Prompts for production deployments
2. Build Process
- Automatic Build: Runs
cirron buildunless--no-buildis specified - Build Validation: Verifies build output exists
- Clean Build: Uses
--cleanflag for fresh builds
3. Pre-deploy Commands
- Command Execution: Runs configured
beforeDeploycommands - Error Handling: Fails deployment if pre-deploy commands fail
- Verbose Output: Shows command output in verbose mode
4. Deployment Creation
- Deployment Data: Creates deployment with project and environment info
- Artifact Upload: Uploads build artifacts to Cirron
- Deployment Start: Initiates deployment process
5. Deployment Monitoring
- Status Tracking: Monitors deployment progress
- Status Updates: Shows current deployment status
- Timeout Handling: 5-minute timeout for deployment monitoring
6. Post-deploy Commands
- Success Commands: Runs
afterDeploycommands on successful deployment - Error Handling: Continues deployment even if post-deploy commands fail
- Logging: Logs post-deploy command execution
Rollback Functionality
Rollback to the previous successful deployment in the target environment.Rollback Process
- Previous Deployment Search: Finds the most recent successful deployment
- Confirmation: Prompts for confirmation (unless
--forceis used) - Rollback Execution: Performs rollback to previous deployment
- Monitoring: Monitors rollback progress
- Verification: Confirms rollback success
Examples
Basic Deployment
Skip Build
Custom Deployment Message
Rollback Operations
Configuration
Project Configuration
Deployment options are configured in yourcirron.yaml:
Environment Configuration
Each environment can have specific configuration:Deployment Monitoring
Status Tracking
The deployment process tracks multiple statuses:- pending: Deployment is queued
- building: Building deployment container
- deploying: Deploying to infrastructure
- success: Deployment completed successfully
- failed: Deployment failed
Monitoring Output
Deployment Results
Artifact Upload
Build Artifacts
The deploy command automatically uploads build artifacts:- Output Directory: Uses
build.outputDirfrom configuration - File Filtering: Skips certain files (
.DS_Store,Thumbs.db, etc.) - Batch Upload: Uploads files in batches of 5
- Progress Tracking: Shows upload progress
Skipped Files
The following files are automatically skipped:.DS_Store(macOS)Thumbs.db(Windows).gitdirectoriesnode_modulesdirectories.envfiles.logfiles
Error Handling
Common Errors
Missing Project Configuration
Authentication Required
Environment Not Found
Build Failure
No Previous Deployment for Rollback
Recovery Actions
-
Build Issues
-
Deployment Failures
-
Rollback Issues
Best Practices
Deployment Strategy
- Test in Staging: Always test in staging before production
- Use Messages: Add descriptive deployment messages
- Monitor Deployments: Watch deployment progress and logs
- Rollback Plan: Have a rollback strategy for production
Configuration Management
- Environment Separation: Keep development, staging, and production separate
- Pre-deploy Hooks: Use pre-deploy commands for validation
- Post-deploy Hooks: Use post-deploy commands for notifications
- Build Optimization: Optimize build process for faster deployments
Security Considerations
- Production Confirmation: Always confirm production deployments
- Environment Variables: Use secure environment variable management
- Access Control: Ensure proper access controls for production
- Audit Trail: Keep deployment logs for audit purposes
Integration
CI/CD Pipeline
Development Workflow
Troubleshooting
Debugging Deployment Issues
Common Problems
- Network Issues: Check internet connection and firewall settings
- Authentication Expired: Re-authenticate with
cirron auth login - Build Failures: Check build configuration and dependencies
- Deployment Timeouts: Check infrastructure status and resource availability
Related Commands
- cirron build - Build project before deployment
- cirron logs - View deployment logs
- cirron auth - Manage authentication
- cirron status - Check deployment status