Welcome to the Cirrus docs!

Cirrus documentation

• Getting started with Cirrus
  • What is Cirrus?
  • Why Cirrus?
  • Concepts
  • Relationship with stac-server
  • Example Earth Search use case
  • AWS services used
  • Where to go next?
• Cirrus architecture
  • Cirrus overview
  • Workflow structure
  • Glossary
  • Naming conventions
• Cirrus Process Payload
  • Item
  • Process Definition
  • Output Options
• Configuration and Deployment
  • Using the Cirrus CLI to create new project
  • Naming your deployment
  • Required AWS deploy permissions
  • AWS Service Quotas and Limits
  • Build and deploy
  • Test basic publish workflow
  • Required resources
  • Notes on using a VPC
  • Deleting a deployment
• Basic Operation
  • Process definition
  • Process definition
  • Managing Secrets for Bucket access
  • Submit a job for processing
  • Check statedb
  • Go to workflow (Step Function execution)
  • Inspect output STAC Items
  • Rerun tasks
• Cirrus Components
  • Tasks
  • Workflows
  • Functions
  • Feeders
• Cloudformation Support
• State Database
  • Schema
  • Using cirrus-lib to interact with state database
  • Using the Cirrus API
  • Deleting items from database
• Pipeline Monitoring
  • Cirrus API
  • AWS Console
• Cirrus Examples
  • Example End-to-End Notebook
• Tips and Tricks
  • Processing Queue Priority
• Deploying

Component READMEs

• Functions
  • api
  • process
  • update-state
  • post_batch
  • pre_batch
• Tasks
  • post-batch
  • pre-batch
  • publish
• Workflows
  • publish-only

Cirrus CLI READMEs

• CLIrrus Overview
• Installing
• Authentication
• CLIrrus and Cirrus Deployments
• Command Examples