User documentation

• Turbinia Quick Installation Instructions
  • Overview
  • Installation
    • GCP Project Setup
    • Deploy Turbinia
    • Client configuration (optional)
    • Grafana SMTP Setup
• Turbinia GKE Celery Installation Instructions
  • Introduction
    • Prerequisites
  • Deployment
    • Deploying the Turbinia cluster
    • Destroying the Turbinia cluster
    • Networks listed
  • Making requests local to the cluster
  • Making requests within a pod in the cluster
  • Monitoring Installation
• Turbinia GKE Quick Installation Instructions
  • Introduction
    • Prerequisites
  • Installation
    • Turbinia GKE Deployment
    • Making processing requests in GKE
  • Monitoring Installation
• Monitoring Installation
  • Application Metrics
  • Deploying Prometheus
  • Testing Prometheus Deployment
  • Deploying Grafana
  • Email Notifications
• Turbinia External Access and Authentication Instructions
  • Introduction
    • Prerequisites
  • Deployment
    • 1. Create a static external IP address
    • 2. Set up domain and DNS
    • 3. Create Oauth2 Application IDs
    • 4. Deploy the Load Balancer and Managed SSL
  • Making Turbinia processing requests
  • Additional networking topics
    • Configuring an ipv6 address
    • Egress Connectivity for Nodes
• Turbinia GCP Installation Instructions
  • Overview
  • Installation
    • GCP Project Setup
    • Deploy Turbinia
    • Client configuration (optional)
    • Grafana SMTP Setup
• Turbinia local stack using Docker
  • Caveats
  • Running
    • Step 1
    • Step 2
    • Step 3
    • Step 4
• GKE SRE Guide to Turbinia
  • Introduction
  • Debugging Task Failures
    • Turbinia Controller
  • GKE Infrastructure
    • Preparation
  • Updating the Turbinia infrastructure
    • Update the Turbinia configuration
    • Update an environment variable
    • Updating the Turbinia Docker image
  • Scaling Turbinia
    • Scaling Turbinia Worker Pods
    • Scaling Turbinia Nodes
  • Helpful K8s Commands
  • GKE Load Testing
  • GKE Metrics and Monitoring
    • Connecting to Prometheus instance
    • Connecting to Grafana instance
  • Grafana and Prometheus config
    • Importing a new dashboard into Grafana
    • Exporting a dashboard from Grafana
    • Updating the Prometheus Config
    • Updating Prometheus Rules
• How Turbinia Works
  • General
  • Architecture
    • Cloud Architecture
    • Local Architecture
    • Hybrid Architecture
  • Tasks
  • Jobs
  • Workers
  • Evidence
    • New Evidence
    • Evidence Processors
    • Copyable Evidence
  • Task Manager
  • Task Manager Flow
• Turbinia API Server
  • Summary
  • Getting started
    • Installation
    • Configuration and UI
    • Usage
    • Authentication
• Turbinia Web UI
• Using Docker for Job execution
  • Overview
  • Enabling Docker usage
  • Example using Plaso
• Operational Details
  • Google Cloud Platform (GCP) Processing Details
    • Persistent Disks
    • Processing non-cloud disks in GCP
    • Stackdriver Logging
    • Stackdriver Error Reporting
    • Prometheus instrumentation
  • General Notes
• Recipes
  • Introduction
  • Using Recipes
  • Writing new Recipes
• Debugging
  • Logs
  • Request Debugging
    • Finding previous request data
    • No Jobs being created
  • Task Debugging
    • Task Failures
    • Full Task report data
    • Determining Task status
    • Writing debug logs for binary dependencies
    • Disappearing Tasks
  • 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)
    • Summary
    • Getting started
    • Reporting bugs and contributing