From 00605c021449b2560d36718b47fb752037ede3dd Mon Sep 17 00:00:00 2001
From: James Phillips <slackpad@gmail.com>
Date: Thu, 7 Sep 2017 12:17:39 -0700
Subject: [PATCH] Shows the segment name in the keyring API and command output.

---
 agent/consul/internal_endpoint.go                      | 9 +++++----
 agent/structs/structs.go                               | 1 +
 api/operator_keyring.go                                | 3 +++
 command/keyring.go                                     | 3 +++
 website/source/api/operator/keyring.html.md            | 4 ++++
 website/source/docs/commands/keyring.html.markdown.erb | 9 ++++++---
 6 files changed, 22 insertions(+), 7 deletions(-)

diff --git a/agent/consul/internal_endpoint.go b/agent/consul/internal_endpoint.go
index dcac0ab763..817c2623d3 100644
--- a/agent/consul/internal_endpoint.go
+++ b/agent/consul/internal_endpoint.go
@@ -149,12 +149,12 @@ func (m *Internal) executeKeyringOp(
 
 	if wan {
 		mgr := m.srv.KeyManagerWAN()
-		m.executeKeyringOpMgr(mgr, args, reply, wan)
+		m.executeKeyringOpMgr(mgr, args, reply, wan, "")
 	} else {
 		segments := m.srv.LANSegments()
-		for _, segment := range segments {
+		for name, segment := range segments {
 			mgr := segment.KeyManager()
-			m.executeKeyringOpMgr(mgr, args, reply, wan)
+			m.executeKeyringOpMgr(mgr, args, reply, wan, name)
 		}
 	}
 }
@@ -166,7 +166,7 @@ func (m *Internal) executeKeyringOpMgr(
 	mgr *serf.KeyManager,
 	args *structs.KeyringRequest,
 	reply *structs.KeyringResponses,
-	wan bool) {
+	wan bool, segment string) {
 	var serfResp *serf.KeyResponse
 	var err error
 
@@ -190,6 +190,7 @@ func (m *Internal) executeKeyringOpMgr(
 	reply.Responses = append(reply.Responses, &structs.KeyringResponse{
 		WAN:        wan,
 		Datacenter: m.srv.config.Datacenter,
+		Segment:    segment,
 		Messages:   serfResp.Messages,
 		Keys:       serfResp.Keys,
 		NumNodes:   serfResp.NumNodes,
diff --git a/agent/structs/structs.go b/agent/structs/structs.go
index 146ecb7e13..ca6628d130 100644
--- a/agent/structs/structs.go
+++ b/agent/structs/structs.go
@@ -887,6 +887,7 @@ func (r *KeyringRequest) RequestDatacenter() string {
 type KeyringResponse struct {
 	WAN        bool
 	Datacenter string
+	Segment    string
 	Messages   map[string]string `json:",omitempty"`
 	Keys       map[string]int
 	NumNodes   int
diff --git a/api/operator_keyring.go b/api/operator_keyring.go
index 4f91c35432..6b614296ce 100644
--- a/api/operator_keyring.go
+++ b/api/operator_keyring.go
@@ -13,6 +13,9 @@ type KeyringResponse struct {
 	// The datacenter name this request corresponds to
 	Datacenter string
 
+	// Segment has the network segment this request corresponds to.
+	Segment string
+
 	// A map of the encryption keys to the number of nodes they're installed on
 	Keys map[string]int
 
diff --git a/command/keyring.go b/command/keyring.go
index 5ca1a4862f..b824ceea7f 100644
--- a/command/keyring.go
+++ b/command/keyring.go
@@ -129,6 +129,9 @@ func (c *KeyringCommand) Run(args []string) int {
 func (c *KeyringCommand) handleList(responses []*consulapi.KeyringResponse) {
 	for _, response := range responses {
 		pool := response.Datacenter + " (LAN)"
+		if response.Segment != "" {
+			pool += fmt.Sprintf(" [%s]", response.Segment)
+		}
 		if response.WAN {
 			pool = "WAN"
 		}
diff --git a/website/source/api/operator/keyring.html.md b/website/source/api/operator/keyring.html.md
index 6d49d29452..e1aaa7b8fe 100644
--- a/website/source/api/operator/keyring.html.md
+++ b/website/source/api/operator/keyring.html.md
@@ -55,6 +55,7 @@ $ curl \
   {
     "WAN": true,
     "Datacenter": "dc1",
+    "Segment": "",
     "Keys": {
       "0eK8RjnsGC/+I1fJErQsBA==": 1,
       "G/3/L4yOw3e5T7NTvuRi9g==": 1,
@@ -65,6 +66,7 @@ $ curl \
   {
     "WAN": false,
     "Datacenter": "dc1",
+    "Segment": "",
     "Keys": {
       "0eK8RjnsGC/+I1fJErQsBA==": 1,
       "G/3/L4yOw3e5T7NTvuRi9g==": 1,
@@ -80,6 +82,8 @@ $ curl \
 
 - `Datacenter` is the datacenter the block refers to.
 
+- `Segment` is the network segment the block refers to.
+
 - `Keys` is a map of each gossip key to the number of nodes it's currently
   installed on.
 
diff --git a/website/source/docs/commands/keyring.html.markdown.erb b/website/source/docs/commands/keyring.html.markdown.erb
index 871bb8a3ae..6aa3ec2dbc 100644
--- a/website/source/docs/commands/keyring.html.markdown.erb
+++ b/website/source/docs/commands/keyring.html.markdown.erb
@@ -73,11 +73,14 @@ dc2 (LAN):
 
 dc1 (LAN):
   a1i101sMY8rxB+0eAKD/gw== [2/2]
+
+dc1 (LAN) [alpha]:
+  a1i101sMY8rxB+0eAKD/gw== [2/2]
 ```
 
-As you can see, the output above is divided first by gossip pool, and then by
-encryption key. The indicator to the right of each key displays the number of
-nodes the key is installed on over the total number of nodes in the pool.
+As you can see, the output above is divided first by gossip pool, including any network
+segments, and then by encryption key. The indicator to the right of each key displays
+the number of nodes the key is installed on over the total number of nodes in the pool.
 
 ## Errors