Javadoc

2 files changed, 20 insertions, 0 deletions

diff --git a/configserver/src/main/java/com/yahoo/vespa/config/server/tenant/RotationAssignment.java b/configserver/src/main/java/com/yahoo/vespa/config/server/tenant/RotationAssignment.java
index e72570b63a7..4c9e5b289b7 100644
--- a/configserver/src/main/java/com/yahoo/vespa/config/server/tenant/RotationAssignment.java
+++ b/configserver/src/main/java/com/yahoo/vespa/config/server/tenant/RotationAssignment.java
@@ -8,6 +8,17 @@ import com.yahoo.vespa.applicationmodel.ClusterId;
 
 import java.util.Objects;
 
+/**
+ * RotationAssignment is an immutable dataclass that contains the
+ * tuple for [endpoint, cluster, rotation].  This information is used
+ * to keep track of
+ *
+ *  - Name of an endpoint used externally.
+ *  - The container cluster that endpoint should point to.
+ *  - The rotation used to give availability to that cluster endpoint.
+ *
+ * @author ogronnesby
+ */
 public class RotationAssignment {
     private final String endpointId;
     private final Rotation rotation;
diff --git a/configserver/src/main/java/com/yahoo/vespa/config/server/tenant/RotationsCache.java b/configserver/src/main/java/com/yahoo/vespa/config/server/tenant/RotationsCache.java
index d1c9dc329ed..a4f2eacd02b 100644
--- a/configserver/src/main/java/com/yahoo/vespa/config/server/tenant/RotationsCache.java
+++ b/configserver/src/main/java/com/yahoo/vespa/config/server/tenant/RotationsCache.java
@@ -16,6 +16,15 @@ import java.util.Map;
 
 
 /**
+ * Persists assignment of rotations to an application to ZooKeeper.
+ * The entries are RotationAssignments, which keep track of the container
+ * cluster that is the target, the endpoint name, and the rotation used to
+ * give availability to that cluster.
+ *
+ * This is v2 of that storage in a new directory.  Previously we only stored
+ * the name of the rotation, since all the other information could be
+ * calculated runtime.
+ *
  * @author ogronnesby
  */
 public class RotationsCache {