Man pages for starburst
Seamless AWS Cloud Bursting for Parallel R Workloads
| atomic_claim_task | Atomically claim a pending task |
| aws-retry | AWS Retry Logic |
| build_base_image | Build base Docker image with common dependencies |
| build_environment_image | Build environment image |
| build_initial_environment | Build initial environment |
| calculate_predictions | Calculate Cloud Performance Predictions |
| calculate_task_cost | Calculate task cost |
| calculate_total_cost | Calculate total cost |
| check_and_submit_wave | Check and Submit Wave if Ready |
| check_aws_credentials | Check AWS credentials |
| check_ecr_image_age | Check ECR image age and suggest/force rebuild |
| check_ecr_image_exists | Check if ECR image exists |
| check_fargate_quota | Check Fargate vCPU quota |
| check_quota_sufficient | Check if quota is sufficient for plan |
| cleanup_cluster | Clean up cluster resources |
| cleanup_s3_files | Cleanup S3 files |
| cleanup_session | Cleanup session |
| collect_session_results | Collect results from session |
| compute_env_hash | Compute environment image hash |
| config_dir | Get configuration directory |
| config_path | Get configuration file path |
| create_ecr_lifecycle_policy | Create ECR lifecycle policy to auto-delete old images |
| create_ecr_repository | Create ECR repository |
| create_ecs_cluster | Create ECS cluster |
| create_session_manifest | Create session manifest in S3 |
| create_session_object | Create session object with methods |
| create_starburst_bucket | Create S3 bucket for staRburst |
| create_task | Create task object |
| create_task_status | Create task status in S3 |
| ec2-pool | EC2 Pool Management for staRburst |
| ensure_base_image | Ensure base image exists |
| ensure_ecs_instance_profile | Ensure ECS instance IAM profile exists |
| ensure_ecs_security_group | Ensure ECS security group exists |
| ensure_environment | Ensure environment is ready |
| ensure_log_group | Ensure CloudWatch log group exists |
| errors | Error Handling for staRburst |
| estimate_cost | Estimate Cost |
| extend_session_timeout | Extend session timeout |
| extract_region_from_key | Extract region from S3 key |
| future.starburst | Create a Future using Starburst Backend |
| get_architecture_from_instance_type | Get CPU architecture from instance type |
| get_autoscaling_client | Get Auto Scaling client |
| get_aws_account_id | Get AWS account ID |
| get_base_image_source | Get base image source URI |
| get_base_image_uri | Get base image URI |
| get_cloud_performance_ratio | Get Cloud Performance Ratio |
| get_current_vcpu_usage | Get current vCPU usage |
| get_ec2_client | Get EC2 client |
| get_ec2_instance_price | Get EC2 instance pricing |
| get_ecr_client | Get ECR client |
| get_ecs_client | Get ECS client |
| get_ecs_optimized_ami | Get ECS-optimized AMI ID for region and architecture |
| get_execution_role_arn | Get IAM execution role ARN |
| get_instance_specs | Get instance specifications (vCPUs, memory) |
| get_instance_vcpus | Get vCPU count for instance type |
| get_local_hardware_specs | Get Local Hardware Specifications |
| get_or_create_security_group | Get or create security group |
| get_or_create_subnets | Get or create subnets |
| get_or_create_task_definition | Get or create task definition |
| get_pool_status | Get pool status |
| get_s3_client | Get S3 client |
| get_service_quotas_client | Get Service Quotas client |
| get_session_manifest | Get session manifest from S3 |
| get_session_status | Get session status |
| get_starburst_bucket | Get starburst bucket name |
| get_starburst_config | Get staRburst configuration |
| get_starburst_security_groups | Get starburst security groups |
| get_starburst_subnets | Get starburst subnets |
| get_task_arn | Get task ARN |
| get_task_registry | Get task registry environment |
| get_task_role_arn | Get IAM task role ARN |
| get_task_status | Get task status from S3 |
| get_vpc_config | Get VPC configuration for ECS tasks |
| get_wave_status | Get wave queue status |
| initialize_detached_backend | Initialize backend for detached mode |
| is_setup_complete | Check if setup is complete |
| launch_detached_workers | Launch workers for detached session |
| launchFuture.StarburstBackend | Launch a future on the Starburst backend |
| list_active_clusters | List active clusters |
| listFutures.StarburstBackend | List futures for StarburstBackend |
| list_pending_tasks | List pending tasks in session |
| list_task_arns | List all stored task ARNs |
| list_task_statuses | List all task statuses in session |
| load_quota_history | Load quota request history |
| nbrOfWorkers.StarburstBackend | Number of workers for StarburstBackend |
| package_installation_error | Package installation error |
| parse_memory | Parse memory specification |
| permission_error | Permission denied error |
| plan.starburst | staRburst Future Backend |
| poll_for_result | Poll for result |
| print_estimate_summary | Print Estimate Summary |
| print.StarburstSessionStatus | Print method for session status |
| quota_error | Quota exceeded error |
| reconstruct_backend_from_manifest | Reconstruct backend from session manifest |
| register_cleanup | Register cleanup handler |
| request_quota_increase | Request quota increase |
| resolved.StarburstFuture | Check if StarburstFuture is Resolved |
| result_exists | Check if result exists |
| result.StarburstFuture | Get Result from StarburstFuture |
| run.StarburstFuture | Run a StarburstFuture |
| safe_system | Execute system command safely (no shell injection) |
| save_config | Save staRburst configuration |
| save_quota_request | Save quota request to local history |
| serialize_and_upload | Serialize and upload to S3 |
| session-api | Detached Session API |
| session-backend | Session Backend Initialization |
| session-state | S3 Session State Management |
| setup_ec2_capacity_provider | Setup EC2 capacity provider for ECS cluster |
| setup_vpc_resources | Setup VPC resources |
| starburst | Starburst strategy marker |
| StarburstBackend | Starburst Future Backend |
| starburst_check_quota_request | Monitor quota increase request |
| starburst_cleanup_ecr | Clean up staRburst ECR images |
| starburst_cluster | Create a Starburst Cluster |
| starburst_cluster_map | Execute Map on Starburst Cluster |
| starburst_config | Configure staRburst options |
| starburst_error | Create informative staRburst error |
| starburst_estimate | Estimate Cloud Performance and Cost |
| StarburstFuture | StarburstFuture Constructor |
| starburst_is_configured | Check if staRburst is configured |
| starburst_list_sessions | List All Sessions |
| starburst_logs | View worker logs |
| starburst_map | Map Function Over Data Using AWS Fargate |
| starburst-package | starburst: Seamless AWS Cloud Bursting for Parallel R... |
| starburst_quota_status | Show quota status |
| starburst_rebuild_environment | Rebuild environment image |
| starburst_request_quota_increase | Request quota increase (user-facing) |
| starburst_session | Create a Detached Starburst Session |
| starburst_session_attach | Reattach to Existing Session |
| starburst_setup | Setup staRburst |
| starburst_setup_ec2 | Setup EC2 capacity providers for staRburst |
| starburst_status | Show staRburst status |
| start_warm_pool | Start warm EC2 pool |
| stop_running_tasks | Stop running tasks |
| stop_warm_pool | Stop warm pool |
| store_task_arn | Store task ARN |
| submit_detached_worker | Submit detached worker to ECS |
| submit_task | Submit Task to ECS |
| submit_to_session | Submit task to session |
| suggest_quota | Suggest appropriate quota based on needs |
| task_failure_error | Task failure error |
| update_session_manifest | Update session manifest atomically |
| update_task_status | Update task status with atomic write |
| upload_detached_task | Upload task for detached session |
| utils | Utility functions for staRburst |
| with_aws_retry | Retry AWS operations with exponential backoff |
| with_ecr_retry | Retry ECR operations |
| with_ecs_retry | Retry ECS operations |
| with_s3_retry | Retry S3 operations |
| worker_validation_error | Worker validation error |
