Getting Started Guide | Cribl Docs

For the complete documentation index, see llms.txt.

Cribl Stream Cribl Edge Cribl Search Cribl Lake Cribl Insights

Known Issues Release Notes What's New Cribl Copilot

Sandbox GitHub Repos Docker Hub Cribl as Code

(Ctrl+K / Cmd+K)

No Results Try to type a different keyword or phrase

What are you looking for? Type a keyword or phrase above

All Results Press Enter

API Reference Cribl Status Cribl.Cloud

4.8

Release Notes 4.20 4.19 4.18 4.17 4.16 4.15 4.14 4.13 4.12 4.11 4.10 4.9 4.8 4.7 4.6 4.5 4.4 4.3 4.2 4.1 4.0

4.8

4.20 4.19 4.18 4.17 4.16 4.15 4.14 4.13 4.12 4.11 4.10 4.9 4.8 4.7 4.6 4.5 4.4 4.3 4.2 4.1 4.0

About Cribl Stream Basic Concepts Getting Started Guide Distributed Quick Start

Initial Cribl.Cloud Setup Cribl.Cloud Portal Managing Cribl.Cloud Managing Cribl.Cloud Worker Groups Connecting On-Prem Leaders to Cribl.Cloud Billing Cribl.Cloud vs. Self-Hosted Enterprise Cloud

Deploying Cribl Stream Software

Planning and Sizing

Deployment Planning Sizing and Scaling Architectural Considerations Ports

Manual Deployment

Deployment Types OS and System Requirements Single-Instance/Basic Deployment Running Cribl Stream as a Non-Root User

Distributed Deployment

Set Up Leader and Worker Nodes Manage Worker Groups Map Workers to Worker Groups Manage Config Bundles Deploy Stream Configurations Persistent Socket Connections

Splunk App Deployment Bootstrap Workers from Leader Leader High Availability/Failover Converting a Single Instance to Distributed Deployment

Orchestrated Deployment

Kubernetes/Helm Deployment Kubernetes Worker Deployment

Docker Deployment

Reference Architectures

All-in-One Reference Architecture Syslog Reference Architecture Multiple Agents Reference Architecture Comprehensive Reference Architecture Comprehensive Hybrid Cloud Reference Architecture

Configuring Workspaces Members and Teams

Configuring Projects Configuring Subscriptions Adding Users to Projects

Licensing Version Control GitOps Group/Fleet Settings

Source-State Notifications Destination-State Notifications License-Expiration Notifications Email Notifications

Notification Targets

Webhook Notification Targets PagerDuty Notification Targets Slack Notification Targets AWS SNS Notification Targets Email Notification Targets

Customizing the interface

Custom Banners Custom Login Page

Scripts Upgrading Uninstalling

Access Management

Authentication Members and Permissions