Code review based improvements.

1 files changed, 21 insertions, 1 deletions

diff --git a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/nodeadmin/NodeAdmin.java b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/nodeadmin/NodeAdmin.java
index bbed28d541a..fb65f03a57b 100644
--- a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/nodeadmin/NodeAdmin.java
+++ b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/nodeadmin/NodeAdmin.java
@@ -8,20 +8,40 @@ import java.util.List;
 import java.util.Set;
 
 /**
- * API for NodeAdmin seen from outside.
+ * NodeAdmin manages the life cycle of NodeAgents.
  * @author dybis
  */
 public interface NodeAdmin {
 
+    /**
+     * Calling this will cause NodeAdmin to move to the state containersToRun by adding or removing nodes.
+     * @param containersToRun this is the wanted state.
+     */
     void refreshContainersToRun(final List<ContainerNodeSpec> containersToRun);
 
+    /**
+     * Causes the NodeAgents to freeze, meaning they will not pick up any changes from NodeRepository.
+     * @return if NodeAgent is frozen.
+     */
     boolean freezeAndCheckIfAllFrozen();
 
+    /**
+     * Causes the NodeAgent to unfreeze and start picking up changes from NodeRepository.
+     */
     void unfreeze();
 
+    /**
+     * Returns list of hosts.
+     */
     Set<HostName> getListOfHosts();
 
+    /**
+     * Return the state as a human readable string. Do not try to parse output or use in tests.
+     */
     String debugInfo();
 
+    /**
+     * Stop the NodeAgent. Will not delete the storage or stop the container.
+     */
     void shutdown();
 }