grafana/loki

Docs: Add ring configuration details for scheduler_ring and compactor_ring

Open

#5,035 opened on Jan 4, 2022

View on GitHub
 (11 comments) (0 reactions) (1 assignee)Go (28,187 stars) (3,997 forks)batch import
help wantedkeepalivetype/docs

Description

PR https://github.com/grafana/loki/pull/5015 was merged in and solved the issue that ring configuration for the scheduler and compactor can be within the common section. However, ring configuration details may be specified within the scheduler block or within the compactor block. Those configuration knob descriptions are missing from the block-specific locations.

This issue exists to identify this further work that needs to be done to complete the ring-specific configuration.

Contributor guide

Tech stack
go
Domain
documentationbackend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Loki's ring configurationFamiliarity with the merged PR #5015
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the merged PR #5015 to understand the ring configuration changes. Then look at the existing documentation for scheduler and compactor blocks in the Loki docs (likely under configuration/). Identify where ring configuration options are missing and add descriptions for all ring related options in those blocks, referencing the common ring configuration if needed.