Clarify comment on Node.Role

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
moby · Jan 5, 2017 · 167b493 · 167b493
1 parent e5f0bde
commit 167b493
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/api/objects.pb.go b/api/objects.pb.go
diff --git a/api/objects.proto b/api/objects.proto
@@ -52,8 +52,12 @@ message Node {
 	// Role is the *observed* role for this node. It differs from the
 	// desired role set in Node.Spec.Role because the role here is only
 	// updated after the Raft member list has been reconciled with the
-	// desired role from the spec. Note that this doesn't show whether the
-	// node has obtained a certificate that reflects its current role.
+	// desired role from the spec.
+	//
+	// This field represents the current reconciled state. If an action is
+	// to be performed, first verify the role in the cert. This field only
+	// shows the privilege level that the CA would currently grant when
+	// issuing or renewing the node's certificate.
 	NodeRole role = 9;
 }