Author: stefanegli
Date: Wed Nov 25 16:59:06 2015
New Revision: 1716485
URL: http://svn.apache.org/viewvc?rev=1716485&view=rev
Log:
SLING-5021 : wording, formatting
Modified:
sling/site/trunk/content/documentation/bundles/discovery-api-and-impl.mdtext
Modified:
sling/site/trunk/content/documentation/bundles/discovery-api-and-impl.mdtext
URL:
http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/bundles/discovery-api-and-impl.mdtext?rev=1716485&r1=1716484&r2=1716485&view=diff
==============================================================================
---
sling/site/trunk/content/documentation/bundles/discovery-api-and-impl.mdtext
(original)
+++
sling/site/trunk/content/documentation/bundles/discovery-api-and-impl.mdtext
Wed Nov 25 16:59:06 2015
@@ -10,13 +10,14 @@ instances) and contains a simple propert
[TOC]
-## API
+## Discovery Entities
The Discovery API defines the following entities
### Instance, InstanceDescription
A Sling instance running in one VM is represented in the discovery API by an
`InstanceDescription`:
+
* it represents one Sling instance
* it has thus a unique Sling ID
* it has a flag that marks if it is leader in a cluster (more details below)
@@ -27,6 +28,7 @@ A Sling instance running in one VM is re
Multiple instances that are connected to the same underlying repository are
commonly referred to as a 'Cluster'. The reasoning behind this terminology
being that they access the same data and can thus deliver or modify the same
data.
In the discovery API this cluster concept is represented via a `ClusterView`
object. A 'view' because it is a momentary snapshot of the cluster and only
contains instances that are currently alive. It's features are:
+
* each cluster has a stable leader. Stable meaning it won't change unless that
leader crashes.
* it has a list of instances that are part of it, thus currently alive
* plus it has a unique id that is persistent across restarts
