[SLING-5021] Low Level Documentation for Sling Discovery.

• Type: Wish
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Component/s: Documentation
• Assignee: Stefan Egli
• Reporter: Ian Boston
• Created: 14/Sep/15 12:05
• Updated: 26/Nov/15 12:47
• Resolved: 26/Nov/15 12:47

Description

Improve the documentation at:

https://sling.apache.org/documentation/bundles/discovery-api-and-impl.html to include details on:

Conceptual Structure of a topology (eg Topology contains Clusters contains Instances).
Definition of a Cluster.
Description of the Voting process.
Description of how topology uses the following areas of a repository

/var/discovery/impl/clusterInstances
/var/discovery/impl/establishedView
/var/discovery/impl/ongoingVotings
/var/discovery/impl/previousView

What writes to those locations.
How instances within a cluster communicate.
How instances within a topology communicate.

This information will help anyone faced with dealing with low level failures related to topology in live running instances and may enable them to configure to avoid those failures. Improved documentation in this area will be greatly appreciated.