quickwit-oss/quickwit

Update the distributed search tutorial

Open

#4,004 opened on Oct 21, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Rust (580 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (11,532 stars)
PR merge metrics
 (Avg merge 5d 18h) (41 merged PRs in 30d)

Description

Improvements:

  • use enabled_services parameters in the node configs
  • (optional) add an alternative cURL command for search using docusaurus tabs

Tutorial is here: https://github.com/quickwit-oss/quickwit/blob/main/docs/get-started/tutorials/tutorial-hdfs-logs-distributed-search-aws-s3.md

Example of searcher 1 config.

version: 0.6
node_id: searcher-1
listen_address: 127.0.0.1
rest_listen_port: 7280
enabled_services:
  - metastore
  - control-plane
  - searcher
  - indexer
  - janitor

peer_seeds:
  - 127.0.0.1:7290 # searcher-2
  - 127.0.0.1:7300 # searcher-3

searcher 2

version: 0.6
node_id: searcher-2
listen_address: 127.0.0.1
rest_listen_port: 7290
enabled_services:
  - searcher
peer_seeds:
  - 127.0.0.1:7280 # searcher-1
  - 127.0.0.1:7300 # searcher-3

version: 0.6
node_id: searcher-3
listen_address: 127.0.0.1
rest_listen_port: 7300
enabled_services:
  - searcher
peer_seeds:
  - 127.0.0.1:7280 # searcher-1
  - 127.0.0.1:7290 # searcher-2

Contributor guide

Research direction
Read the current tutorial file, examine the provided YAML examples, update the file to include enabled services in node configs, and optionally add a cURL alternative using Docusaurus tabs.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90