Reference

This section provides comprehensive documentation for all core Tapitalee features and CLI commands. Each page includes detailed explanations of purpose, usage patterns, AWS service integration, and best practices.

CLI

CLI Setup

General setup and usage information that applies across most CLI commands. Covers installation, authentication, specifying an app, common flags like --ignore-existing, and built-in utility commands.

Core Application Management

Apps

Complete application lifecycle management including creation, configuration, scaling, and deletion. Apps are the fundamental unit of organization in Tapitalee, providing isolated environments for your containerized applications.

Key Operations: Create, show, list, delete applications with resource allocation and regional deployment options.

Deployments

Zero-downtime deployment management with version control, rollback capabilities, and CI/CD integration. Includes container image building, registry management, and deployment orchestration.

Key Operations: Deploy applications, build images, manage deployment history, and integrate with automated pipelines.

Processes

Individual containerized services within your application. Each process can be independently scaled, configured, and managed with specific resource allocations and deployment strategies.

Key Operations: Create, modify, restart, and scale individual application processes with granular resource control.

Task and Job Management

Tasks

One-time container executions for background jobs, migrations, administrative scripts, and ad-hoc operations. Tasks provide isolated execution environments with configurable resources and time limits. Also includes interactive console sessions via tapit run.

Key Operations: Execute background jobs, run interactive console sessions, manage task history, and monitor execution.

Commands

Scheduled and recurring tasks with cron-based automation. Commands provide persistent job definitions for maintenance operations, data processing, and business automation.

Key Operations: Create scheduled jobs, manage cron expressions, monitor command execution history.

Versioning and Releases

Releases

Release management for tracking application versions with metadata, release notes, and approval workflows. Releases associate Docker image tags with git commits, tags, and changeset URLs.

Key Operations: Create release records, attach release notes, manage approval workflows, list release history.

Configuration and Security

Variables

Environment variable management with support for both regular configuration and encrypted secrets. Variables are automatically injected into all application containers and processes.

Key Operations: Set, delete, import, clone, and manage application environment variables and secrets.

Deploy Tokens

Secure authentication tokens for CI/CD pipelines and automated deployment systems. Deploy tokens provide scoped access control without exposing personal credentials.

Key Operations: Create, manage, revoke deployment tokens with audit trails and usage monitoring.

Domains

Custom domain management with automatic SSL certificate provisioning, DNS integration, and load balancer configuration. Support for multiple domains, subdomains, and automatic HTTPS.

Key Operations: Add domains, configure DNS, manage SSL certificates, and monitor domain health.

System Administration

System Utilities

Administrative commands for resource management, team coordination, monitoring, and system maintenance. Includes cross-application operations and infrastructure management.

Key Operations: Manage teams, monitor resources, handle previews, create backups, and perform system administration.

Command Categories

Create Operations

• Applications: create app - New application environments
• Infrastructure: Add-on creation (databases, storage, networking)
• Deployment: create deploy - Application deployments
• Services: create process - Individual service containers
• Jobs: create task / create command - Background and scheduled jobs
• Console: run - Interactive console sessions
• Configuration: create domain / create deploy_token - Domains and authentication
• Backups: create snapshot - Data snapshots and backups
• Releases: create release / create approval - Version tracking and approvals
• Sharing: create addon:share - Share add-ons between apps

Read Operations

• Status: show app / show process / show addon - Detailed resource information
• Lists: list apps / list processes / list addons - Resource inventories
• Monitoring: show logs / show events / show service - Operational monitoring
• History: list deploys / list tasks / list releases - Activity and deployment history
• Infrastructure: show ecr / list images / list builds - Image and registry information

Update Operations

• Configuration: set process / set rds / set command - Resource modification
• Variables: set variable / import variables / clone variables - Configuration management
• Images: image build / image deploy / image upload - Container image operations
• Release Notes: import release_notes - Attach notes to releases

Delete Operations

• Cleanup: delete app / delete process / delete addon - Resource removal
• Management: delete task / delete command / delete domain - Configuration cleanup
• Security: delete deploy_token - Token revocation
• Sharing: delete addon:share - Remove add-on shares

AWS Service Integration

Compute Services

• Amazon ECS: Container orchestration and service management
• AWS Fargate: Serverless container execution
• Amazon EC2: Virtual server instances with custom configurations
• Application Load Balancer: Traffic distribution and health checking

Database Services

• Amazon RDS: Managed relational databases (PostgreSQL, MySQL)
• Amazon ElastiCache (Redis): Redis clustering and caching

Storage Services

• Amazon S3: Object storage for files and static assets
• Amazon EFS: Shared network file systems

Networking Services

• Amazon VPC: Isolated network environments
• Route 53: DNS management and routing
• SSL Certificate Management: Automatic certificate provisioning via Let’s Encrypt

Security Services

• AWS IAM: Identity and access management
• AWS Secrets Manager: Encrypted secret storage
• AWS Security Groups: Network firewall rules

Best Practices

Application Architecture

1. Microservices: Use separate processes for different application components
2. Stateless Design: Design processes to be stateless for easy scaling
3. Environment Separation: Use separate apps for development, staging, and production
4. Resource Planning: Right-size resources based on actual usage patterns

Security

1. Least Privilege: Use minimal necessary permissions for all operations
2. Secret Management: Store sensitive data as encrypted variables
3. Network Security: Leverage VPC isolation and security groups
4. Access Control: Use deploy tokens for automated systems

Operations

1. Monitoring: Implement comprehensive logging and monitoring
2. Automation: Use CI/CD pipelines for consistent deployments
3. Backup Strategy: Regular snapshots and disaster recovery planning
4. Cost Optimization: Monitor usage and optimize resource allocation

Development Workflow

1. Preview Apps: Use temporary environments for feature testing
2. Database Migrations: Use tasks for schema changes and data migrations
3. Background Jobs: Implement proper queue processing with workers
4. Configuration Management: Use environment-specific variable sets

Getting Help

Each reference page includes:

• Comprehensive Examples: Real-world usage patterns and commands
• AWS Integration Details: How Tapitalee uses underlying AWS services
• Troubleshooting Guides: Common issues and resolution steps
• Best Practices: Recommended approaches for production usage
• Security Considerations: Important security guidelines and recommendations

For additional support:

• Review the specific reference page for detailed command information
• Check the troubleshooting sections for common issues
• Refer to the AWS service documentation for underlying infrastructure details