From 864f1fbf06b1d6e54f292283cdbcafbf00eec1b6 Mon Sep 17 00:00:00 2001 From: absolutelightning Date: Tue, 5 Sep 2023 16:33:28 +0000 Subject: [PATCH 1/3] backport of commit e8f4bfe7a034e9f187790b7aa5f08f7d197e90ec --- command/snapshot/save/snapshot_save.go | 29 +++------------------- website/content/commands/snapshot/save.mdx | 15 ++++++----- 2 files changed, 11 insertions(+), 33 deletions(-) diff --git a/command/snapshot/save/snapshot_save.go b/command/snapshot/save/snapshot_save.go index 8a4c94eb9211..b2dc2bc71fa2 100644 --- a/command/snapshot/save/snapshot_save.go +++ b/command/snapshot/save/snapshot_save.go @@ -33,7 +33,7 @@ type cmd struct { func (c *cmd) getAppendFileNameFlag() *flag.FlagSet { fs := flag.NewFlagSet("", flag.ContinueOnError) fs.Var(&c.appendFileNameFlag, "append-filename", "Append filename flag supports the following "+ - "comma-separated arguments. 1. version, 2. dc. 3. node 4. status. It appends these values to the filename provided in the command") + "comma-separated arguments. 1. version, 2. dc. It appends these values to the filename provided in the command") return fs } @@ -72,7 +72,9 @@ func (c *cmd) Run(args []string) int { if len(appendFileNameFlags) != 0 && len(c.appendFileNameFlag.String()) > 0 { agentSelfResponse, err := client.Agent().Self() - if err != nil { + operatorHealthResponse, error := client.Operator().AutopilotServerHealth(nil) + + if err != nil && error != nil { c.UI.Error(fmt.Sprintf("Error connecting to Consul agent and fetching datacenter/version: %s", err)) return 1 } @@ -96,29 +98,6 @@ func (c *cmd) Run(args []string) int { } } - if slices.Contains(appendFileNameFlags, "node") { - if config, ok := agentSelfResponse["Config"]; ok { - if nodeName, ok := config["NodeName"]; ok { - fileNameWithoutExt = fileNameWithoutExt + "-" + nodeName.(string) - } - } - } - - if slices.Contains(appendFileNameFlags, "status") { - if status, ok := agentSelfResponse["Stats"]; ok { - if config, ok := status["consul"]; ok { - configMap := config.(map[string]interface{}) - if leader, ok := configMap["leader"]; ok { - if leader == "true" { - fileNameWithoutExt = fileNameWithoutExt + "-" + "leader" - } else { - fileNameWithoutExt = fileNameWithoutExt + "-" + "follower" - } - } - } - } - } - //adding extension back file = fileNameWithoutExt + fileExt } diff --git a/website/content/commands/snapshot/save.mdx b/website/content/commands/snapshot/save.mdx index dfd4d4086d45..e8b780c0267e 100644 --- a/website/content/commands/snapshot/save.mdx +++ b/website/content/commands/snapshot/save.mdx @@ -77,20 +77,19 @@ $ consul snapshot save -stale backup.snap # ... ``` -To create snapshot file with consul version, datacenter, node name and leader/follower info, -run +This is useful for situations where a cluster is in a degraded state and no +leader is available. To target a specific server for a snapshot, you can run +the `consul snapshot save` command on that specific server. + +To create snapshot file with consul version and datacenter run ```shell-session -$ consul snapshot save -append-filename node,status,version,dc backup.snap +$ consul snapshot save -append-filename version,dc backup.snap #... ``` -File name created will be like backup-%CONSUL_VERSION%-%DC_NAME%-%NODE_NAME%-%STATUS.snap +File name created will be like backup-%CONSUL_VERSION%-%DC_NAME%.snap example - backup-1.17.0-dc1-local-machine-leader.tgz -This is useful for situations where a cluster is in a degraded state and no -leader is available. To target a specific server for a snapshot, you can run -the `consul snapshot save` command on that specific server. - Please see the [HTTP API](/consul/api-docs/snapshot) documentation for more details about snapshot internals. From 35dc2081a12ca63b21df2604032bce2fda95c7d1 Mon Sep 17 00:00:00 2001 From: absolutelightning Date: Wed, 6 Sep 2023 07:07:05 +0000 Subject: [PATCH 2/3] backport of commit 5072958f6394dbf4318df549dec061d8e2ca8a5f --- command/snapshot/save/snapshot_save.go | 18 +++++++++----- command/snapshot/save/snapshot_save_test.go | 27 ++++++++++----------- 2 files changed, 25 insertions(+), 20 deletions(-) diff --git a/command/snapshot/save/snapshot_save.go b/command/snapshot/save/snapshot_save.go index b2dc2bc71fa2..0a6810772f41 100644 --- a/command/snapshot/save/snapshot_save.go +++ b/command/snapshot/save/snapshot_save.go @@ -72,9 +72,7 @@ func (c *cmd) Run(args []string) int { if len(appendFileNameFlags) != 0 && len(c.appendFileNameFlag.String()) > 0 { agentSelfResponse, err := client.Agent().Self() - operatorHealthResponse, error := client.Operator().AutopilotServerHealth(nil) - - if err != nil && error != nil { + if err != nil { c.UI.Error(fmt.Sprintf("Error connecting to Consul agent and fetching datacenter/version: %s", err)) return 1 } @@ -83,11 +81,19 @@ func (c *cmd) Run(args []string) int { fileNameWithoutExt := strings.TrimSuffix(file, fileExt) if slices.Contains(appendFileNameFlags, "version") { - if config, ok := agentSelfResponse["Config"]; ok { - if version, ok := config["Version"]; ok { - fileNameWithoutExt = fileNameWithoutExt + "-" + version.(string) + operatorHealthResponse, err := client.Operator().AutopilotServerHealth(nil) + if err != nil { + c.UI.Error(fmt.Sprintf("Error fetching version of Consul agent Leader: %s", err)) + return 1 + } + version := "" + for _, server := range operatorHealthResponse.Servers { + if server.Leader { + version = server.Version + break } } + fileNameWithoutExt = fileNameWithoutExt + "-" + version } if slices.Contains(appendFileNameFlags, "dc") { diff --git a/command/snapshot/save/snapshot_save_test.go b/command/snapshot/save/snapshot_save_test.go index 40a75a7b9492..46e16c2bda25 100644 --- a/command/snapshot/save/snapshot_save_test.go +++ b/command/snapshot/save/snapshot_save_test.go @@ -85,19 +85,11 @@ func TestSnapshotSaveCommandWithAppendFileNameFlag(t *testing.T) { dir := testutil.TempDir(t, "snapshot") file := filepath.Join(dir, "backup.tgz") args := []string{ - "-append-filename=version,dc,node,status", + "-append-filename=version,dc", "-http-addr=" + a.HTTPAddr(), file, } - stats := a.Stats() - - status := "follower" - - if stats["consul"]["leader"] == "true" { - status = "leader" - } - // We need to use the self endpoint here for ENT, which returns the product suffix (+ent) self, err := client.Agent().Self() require.NoError(t, err) @@ -105,14 +97,21 @@ func TestSnapshotSaveCommandWithAppendFileNameFlag(t *testing.T) { cfg, ok := self["Config"] require.True(t, ok) - versionAny, ok := cfg["Version"] + dc, ok := cfg["Datacenter"] require.True(t, ok) - version, ok := versionAny.(string) - require.True(t, ok) + datacenter := dc.(string) + + operatorHealth, err := client.Operator().AutopilotServerHealth(nil) + + version := "" + for _, server := range operatorHealth.Servers { + if server.Leader { + version = server.Version + } + } - newFilePath := filepath.Join(dir, "backup"+"-"+version+"-"+a.Config.Datacenter+ - "-"+a.Config.NodeName+"-"+status+".tgz") + newFilePath := filepath.Join(dir, "backup"+"-"+version+"-"+datacenter+".tgz") code := c.Run(args) if code != 0 { From aa6c145b1378a03db4566dd4b74b5024dfd9f711 Mon Sep 17 00:00:00 2001 From: Ashesh Vidyut <134911583+absolutelightning@users.noreply.github.com> Date: Wed, 6 Sep 2023 15:49:25 +0530 Subject: [PATCH 3/3] Removed nodename and status from consul snapshot save -append-filename command and using leader version in version (#18680) * init * fix tests * fix tests lint * fix api call inside dc * updated doc * address comments --- command/snapshot/save/snapshot_save.go | 14 +++++++------- command/snapshot/save/snapshot_save_test.go | 5 +++-- website/content/commands/snapshot/save.mdx | 1 + 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/command/snapshot/save/snapshot_save.go b/command/snapshot/save/snapshot_save.go index 0a6810772f41..6820406067e6 100644 --- a/command/snapshot/save/snapshot_save.go +++ b/command/snapshot/save/snapshot_save.go @@ -71,12 +71,6 @@ func (c *cmd) Run(args []string) int { appendFileNameFlags := strings.Split(c.appendFileNameFlag.String(), ",") if len(appendFileNameFlags) != 0 && len(c.appendFileNameFlag.String()) > 0 { - agentSelfResponse, err := client.Agent().Self() - if err != nil { - c.UI.Error(fmt.Sprintf("Error connecting to Consul agent and fetching datacenter/version: %s", err)) - return 1 - } - fileExt := filepath.Ext(file) fileNameWithoutExt := strings.TrimSuffix(file, fileExt) @@ -86,7 +80,7 @@ func (c *cmd) Run(args []string) int { c.UI.Error(fmt.Sprintf("Error fetching version of Consul agent Leader: %s", err)) return 1 } - version := "" + var version string for _, server := range operatorHealthResponse.Servers { if server.Leader { version = server.Version @@ -97,6 +91,12 @@ func (c *cmd) Run(args []string) int { } if slices.Contains(appendFileNameFlags, "dc") { + agentSelfResponse, err := client.Agent().Self() + if err != nil { + c.UI.Error(fmt.Sprintf("Error connecting to Consul agent and fetching datacenter/version: %s", err)) + return 1 + } + if config, ok := agentSelfResponse["Config"]; ok { if datacenter, ok := config["Datacenter"]; ok { fileNameWithoutExt = fileNameWithoutExt + "-" + datacenter.(string) diff --git a/command/snapshot/save/snapshot_save_test.go b/command/snapshot/save/snapshot_save_test.go index 46e16c2bda25..5c916415d45d 100644 --- a/command/snapshot/save/snapshot_save_test.go +++ b/command/snapshot/save/snapshot_save_test.go @@ -102,9 +102,10 @@ func TestSnapshotSaveCommandWithAppendFileNameFlag(t *testing.T) { datacenter := dc.(string) - operatorHealth, err := client.Operator().AutopilotServerHealth(nil) + operatorHealth, error := client.Operator().AutopilotServerHealth(nil) + require.NoError(t, error) - version := "" + var version string for _, server := range operatorHealth.Servers { if server.Leader { version = server.Version diff --git a/website/content/commands/snapshot/save.mdx b/website/content/commands/snapshot/save.mdx index e8b780c0267e..cf77cd48a695 100644 --- a/website/content/commands/snapshot/save.mdx +++ b/website/content/commands/snapshot/save.mdx @@ -90,6 +90,7 @@ $ consul snapshot save -append-filename version,dc backup.snap File name created will be like backup-%CONSUL_VERSION%-%DC_NAME%.snap example - backup-1.17.0-dc1-local-machine-leader.tgz +Note Version is always the leader's consul version Please see the [HTTP API](/consul/api-docs/snapshot) documentation for more details about snapshot internals.