Developer documentation

• Contributing
  • Before you contribute
  • Code review
  • Style guide
  • The small print
• Developing new Turbinia Tasks and Evidence types
  • It’s easy!
  • Before you start
  • Task code
    • Task Setup
    • Task execution
    • Task Finalization and Saving Results
    • Pre/Post-Processing
    • Evidence Paths
    • Recipe configuration
  • Boilerplate and Glue
  • Logging
  • Reporting
  • Tips
  • Testing
  • Notes
• Developing on a local Turbinia setup (no cloud required)
  • Before you start
    • Step 1
    • Step 2
    • Step 3
    • Step 4
    • Step 5
    • Step 6
    • Step 7
• Developing with Visual Studio Code (no cloud required)
  • Introduction
  • Before you start
    • Step 1 - Install required software
    • Step 2 - Fork Turbinia
    • Step 3 - Open in Visual Studio Code
    • Step 4 - Local Turbinia setup
    • Step 5 - GCP hybrid Turbinia setup
    • Step 6 - Turbinia installation verification
    • Step 8 - Debugging example
• Turbinia SRE Guide
  • Introduction
  • GCP
    • Preparation
    • Stop and start the Turbinia stack
    • Configuration update
    • Environment variable update
    • Docker image update
    • Spin-up more Turbinia workers
  • Turbinia Metrics setup and management
    • Monitoring configuration
    • GCP setup
    • Importing a new dashboard to Grafana
    • Exporting a dashboard from Grafana
    • How to update prometheus config

For more details please visit Turbinia design documents.