Welcome to Turbinia’s documentation!

Turbinia is an open-source framework for deploying, managing, and running distributed forensic workloads.

The source code is available from https://github.com/google/turbinia

Contents:

• User documentation
  • Turbinia Quick Installation Instructions
    • Overview
    • Installation
  • Turbinia GKE Celery Installation Instructions
    • Introduction
    • Deployment
    • Making requests local to the cluster
    • Making requests within a pod in the cluster
    • Monitoring Installation
  • Turbinia GKE Quick Installation Instructions
    • Introduction
    • Installation
    • Monitoring Installation
  • Monitoring Installation
    • Application Metrics
    • Deploying Prometheus
    • Testing Prometheus Deployment
    • Deploying Grafana
    • Email Notifications
  • Turbinia External Access and Authentication Instructions
    • Introduction
    • Deployment
    • Making Turbinia processing requests
    • Additional networking topics
  • Turbinia GCP Installation Instructions
    • Overview
    • Installation
  • Turbinia local stack using Docker
    • Caveats
    • Running
  • GKE SRE Guide to Turbinia
    • Introduction
    • Debugging Task Failures
    • GKE Infrastructure
    • Updating the Turbinia infrastructure
    • Scaling Turbinia
    • Helpful K8s Commands
    • GKE Load Testing
    • GKE Metrics and Monitoring
    • Grafana and Prometheus config
  • How Turbinia Works
    • General
    • Architecture
    • Tasks
    • Jobs
    • Workers
    • Evidence
    • Task Manager
    • Task Manager Flow
  • Turbinia API Server
    • Summary
    • Getting started
  • Turbinia Web UI
  • Using Docker for Job execution
    • Overview
    • Enabling Docker usage
    • Example using Plaso
  • Operational Details
    • Google Cloud Platform (GCP) Processing Details
    • General Notes
  • Recipes
    • Introduction
    • Using Recipes
    • Writing new Recipes
  • Debugging
    • Logs
    • Request Debugging
    • Task Debugging
    • Common Errors
  • FAQ
    • Where do I specify configuration options?
    • Where are the configuration options documented?
    • How can I write new Tasks?
    • How can I debug problems with Turbinia?
    • Where are the files listed in the turbiniactl status output?
  • Turbinia API Python library
  • Turbinia Client
    • Turbinia API CLI tool (turbinia-client)

• 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
    • Boilerplate and Glue
    • Logging
    • Reporting
    • Tips
    • Testing
    • Notes
  • Developing on a local Turbinia setup (no cloud required)
    • Before you start
  • Developing with Visual Studio Code (no cloud required)
    • Introduction
    • Before you start
  • Turbinia SRE Guide
    • Introduction
    • GCP
    • Turbinia Metrics setup and management

Indices and tables

• Index

• Module Index

• Search Page