An open API service indexing awesome lists of open source software.

https://github.com/cometkim/quickwit-tutorial

Quickwit tutorial on local containers
https://github.com/cometkim/quickwit-tutorial

docker-compose quickwit

Last synced: 3 months ago
JSON representation

Quickwit tutorial on local containers

Awesome Lists containing this project

README

          

# Quickwit Tutorial w/ Docker Compose

[Quickwit](https://quickwit.io/) local setup for demonstration purpose, fully powered by containers & Docker Compose.

## Prerequisites

- OrbStack or Docker (uncomment port mapping in [docker-compose.yml](docker-compose.yml))
- 2~5GB of free space

## How to

> [!NOTE]
> `docker-compose.yml` assumes that you are using [OrbStack proxy](https://docs.orbstack.dev/docker/domains#ports).
> If you are using Docker, uncomment the `"ports"` mappings in the file.

### Starting services

To start services

```bash
docker compose up -d
```

compose includes these pre-configured services

- `quickwit`
- Quickwit single node config
- Endpoints:
- [Quickwit UI](https://quickwit.quickwit-tutorial.orb.local)
- HTTP services: 7280
- OTLP gRPC: 7281

- `jaeger`
- Jaeger client, using Quickwit as its backend
- Endpoints:
- [Jaeger UI](https://jaeger.quickwit-tutorial.orb.local)

- `grafana`
- Endpoints:
- [Dashboards -> Indexer metrics](https://grafana.quickwit-tutorial.orb.local/d/quickwit-indexers/quickwit-indexers)
- [Dashboards -> Metastore metrics](https://grafana.quickwit-tutorial.orb.local/d/quickwit-metastore/quickwit-metastore)
- [Dashboards -> Search metrics](https://grafana.quickwit-tutorial.orb.local/d/quickwit-searchers/quickwit-searchers)
- Explore -> Quickwit OTEL Logs
- Explore -> Quickwit OTEL Traces
- Explore -> Jaeger

- `prometheus`
- Scrape Quickwit metrics

- `otel-collector`
- OpenTelemetry collector
- Endpoints:
- OTLP gRPC: 4317
- OTLP HTTP: 4318

- `demo-service`
- Simple GraphQL service with OpenTelemetry OTLP trace/log setup
- Endpoints:
- [GraphiQL](https://demo-service.quickwit-tutorial.orb.local/graphql)

### Ingesting sample data

While running services, you can create index with pre-configured config and data.

- HDFS logs (10K): `docker compose up ingest-hdfs-logs-10k`
- HDFS logs (20M): `docker compose up ingest-hdfs-logs-20m`
- Stackoverflow posts (10K): `docker compose up ingest-stackoverflow-10k`