Issue Summary: Docs: Document Different Hashing Algorithms in Receivers (thanos-io/thanos)
Issue ID: #5408 Created by: matej-g (collaborator) Date Created: September 9, 2022
Context:
Thanos recently introduced a new hashing algorithm for its receiver component, which may still be considered “semi-experimental.” There is a need for comprehensive documentation on both the existing default hashing algorithm (Hashmod) and the new algorithm (Ketama). This documentation is essential for users to understand the implications of each algorithm, especially regarding performance and migration.
Problem Statement:
Users lack clear guidance on:
- The workings, advantages, and disadvantages of Hashmod vs. Ketama algorithms.
- Performance implications and comparisons in horizontally scaled scenarios.
- Migration processes between the two algorithms, including procedures and potential pitfalls.
Proposed Solution:
- Create detailed documentation for the Hashmod and Ketama algorithms that explains:
- How each algorithm functions.
- Pros and cons associated with each.
- Performance metrics and scaling behavior.
- Steps for migrating between the algorithms with associated hurdles.
Current Progress:
- Initial discussions initiated with collaboration between members discussing documentation locations and content.
- Notable contributions and attempts from participants seeking to work on the issue, including Rahul3002, who is considering the most appropriate document section for the introduction.
- Guidance has been provided to Rahul3002 by matej-g on potential documentation locations.
- Additional interest expressed by other contributors to take up the work.
Labels:
- component: website/docs
- feature request/improvement
- good first issue
- help wanted
Next Steps:
Contributors are encouraged to submit a pull request (PR) containing the new documentation once they identify the appropriate section of the Thanos documentation for the algorithms. Collaboration is ongoing to ensure comprehensive coverage that meets user needs.
