cmd: Add --skip-tracking flag to allocator vacate (#119)

Adds a --skip-tracking flag which will make the whole operation async
and not wait for the deployments to complete moving nodes. Adds an
interactive warning which can be skipped with the `--force` flag.

Signed-off-by: Marc Lopez <marc5.12@outlook.com>

Author: marclop

cmd/platform/allocator/vacate.go

@@ -60,15 +60,18 @@ const vacateExamples = `  ecctl [globalFlags] allocator vacate i-05e245252362f7f
 
   # Override the skip_data_migration setting
   ecctl [globalFlags] allocator vacate --skip-data-migration=true i-05e245252362f7f1d -c f521dedb07194c478fbbc6624f3bbf8f
-  `
+  
+  # Skips tracking the vacate progress which will cause the command to return almost immediately.
+  # Not recommended since it can lead to failed vacates without the operator knowing about them.
+  ecctl [globalFlags] allocator vacate --skip-tracking i-05e245252362f7f1d
+`
 
 var vacateAllocatorCmd = &cobra.Command{
 	Use:     "vacate <source>",
 	Short:   "Moves all the clusters from the specified allocator",
 	Example: vacateExamples,
 	PreRunE: cobra.MinimumNArgs(1),
 	Aliases: []string{"move-nodes"},
-
 	RunE: func(cmd *cobra.Command, args []string) error {
 		concurrency, err := strconv.ParseUint(cmd.Flag("concurrency").Value.String(), 10, 64)
 		if err != nil {
@@ -127,6 +130,11 @@ var vacateAllocatorCmd = &cobra.Command{
 			return err
 		}
 
+		skipTracking, _ := cmd.Flags().GetBool("skip-tracking")
+		if !force && skipTracking && !cmdutil.ConfirmAction("--skip-tracking flag specified. Are you sure you want to proceed? [y/N]: ", os.Stdin, os.Stderr) {
+			return nil
+		}
+
 		setAllocatorMaintenance, _ := cmd.Flags().GetBool("maintenance")
 
 		var merr error
@@ -156,6 +164,7 @@ var vacateAllocatorCmd = &cobra.Command{
 			Concurrency:         uint16(concurrency),
 			Output:              ecctl.Get().Config.OutputDevice,
 			MoveOnly:            ec.Bool(moveOnly),
+			SkipTracking:        skipTracking,
 			PlanOverrides: allocator.PlanOverrides{
 				SkipSnapshot:      skipSnapshot,
 				SkipDataMigration: skipDataMigration,
@@ -180,7 +189,7 @@ func validateSkipDataMigration(clusters []string, moveOnly bool) error {
 
 func init() {
 	Command.AddCommand(vacateAllocatorCmd)
-
+	vacateAllocatorCmd.Flags().Bool("skip-tracking", false, "Skips tracking the vacate progress causing the command to return after the move operation has been executed. Not recommended.")
 	vacateAllocatorCmd.Flags().StringP("kind", "k", "", "Kind of workload to vacate (elasticsearch|kibana)")
 	vacateAllocatorCmd.Flags().StringArrayP("cluster", "c", nil, "Cluster IDs to include in the vacate")
 	vacateAllocatorCmd.Flags().StringArrayP("target", "t", nil, "Target allocator(s) on which to place the vacated workload")

docs/ecctl_platform_allocator_vacate.md

@@ -42,6 +42,10 @@ ecctl platform allocator vacate <source> [flags]
   # Override the skip_data_migration setting
   ecctl [globalFlags] allocator vacate --skip-data-migration=true i-05e245252362f7f1d -c f521dedb07194c478fbbc6624f3bbf8f
   
+  # Skips tracking the vacate progress which will cause the command to return almost immediately.
+  # Not recommended since it can lead to failed vacates without the operator knowing about them.
+  ecctl [globalFlags] allocator vacate --skip-tracking i-05e245252362f7f1d
+
 ```
 
 ### Options
@@ -57,6 +61,7 @@ ecctl platform allocator vacate <source> [flags]
       --override-failsafe            If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints. [true|false]
       --skip-data-migration string   Skips the data-migration operation on the specified cluster IDs. ONLY available when the cluster IDs are specified and --move-only is true. [true|false]
       --skip-snapshot string         Skips the snapshot operation on the specified cluster IDs. ONLY available when the cluster IDs are specified. [true|false]
+      --skip-tracking                Skips tracking the vacate progress causing the command to return after the move operation has been executed. Not recommended.
   -t, --target stringArray           Target allocator(s) on which to place the vacated workload
 ```
 

pkg/platform/allocator/vacate.go

@@ -237,6 +237,7 @@ func newVacateClusterParams(params addAllocatorMovesToPoolParams, id, kind strin
 		ID:                  params.ID,
 		Kind:                kind,
 		ClusterID:           id,
+		SkipTracking:        params.VacateParams.SkipTracking,
 		ClusterFilter:       params.VacateParams.ClusterFilter,
 		PreferredAllocators: params.VacateParams.PreferredAllocators,
 		MaxPollRetries:      params.VacateParams.MaxPollRetries,
@@ -272,6 +273,10 @@ func VacateCluster(params *VacateClusterParams) error {
 		return err
 	}
 
+	if params.SkipTracking {
+		return nil
+	}
+
 	return trackMovedCluster(params)
 }
 

pkg/platform/allocator/vacate_params.go

@@ -86,6 +86,13 @@ type VacateParams struct {
 	// bare minimum to move the requested instances across to another allocator.
 	MoveOnly *bool
 
+	// SkipTracking skips displaying and waiting for the individual vacates to complete.
+	// Setting it to true will render the concurrency flag pretty much ineffective since
+	// the vacate action is asynchronous and the only thing keeping the working items in
+	// the pool is the tracking function call which synchronously waits until the vacate
+	// has effectively finished.
+	SkipTracking bool
+
 	// Plan body overrides to place in all of the vacate clusters.
 	PlanOverrides
 }
@@ -132,20 +139,20 @@ func (params VacateParams) Validate() error {
 // VacateClusterParams is used by VacateCluster to move a cluster node
 // from an allocator.
 type VacateClusterParams struct {
-	*api.API
-	ID                  string
-	ClusterID           string
-	Kind                string
 	PreferredAllocators []string
 	ClusterFilter       []string
-	MaxPollRetries      uint8
-	TrackFrequency      time.Duration
-	AllocatorDown       *bool
-	MoveOnly            *bool
-	Output              *output.Device
-
 	// Plan body overrides to place in all of the vacate clusters.
 	PlanOverrides
+	ID        string
+	ClusterID string
+	Kind      string
+	*api.API
+	TrackFrequency time.Duration
+	AllocatorDown  *bool
+	MoveOnly       *bool
+	Output         *output.Device
+	MaxPollRetries uint8
+	SkipTracking   bool
 }
 
 // Validate validates the parameters

pkg/platform/allocator/vacate_test.go

@@ -749,6 +749,24 @@ func TestVacateCluster(t *testing.T) {
 				"\x1b[92;mCluster [3ee11eb40eda22cac0cce259625c6734][Elasticsearch]: finished running all the plan steps\x1b[0m (Total plan duration )",
 			),
 		},
+		{
+			name: "Succeeds with an elasticsearch cluster with no tracking",
+			args: args{
+				buf: new(bytes.Buffer),
+				params: &VacateClusterParams{
+					ID:             "someID",
+					ClusterID:      "3ee11eb40eda22cac0cce259625c6734",
+					Kind:           "elasticsearch",
+					Output:         new(output.Device),
+					TrackFrequency: time.Nanosecond,
+					SkipTracking:   true,
+					MaxPollRetries: 1,
+					API: discardResponses(
+						newElasticsearchVacateMove(t, "someID", vacateCaseClusterConfig{}),
+					),
+				},
+			},
+		},
 		{
 			name: "Succeeds with a kibana instance",
 			args: args{
@@ -787,6 +805,24 @@ func TestVacateCluster(t *testing.T) {
 				"\x1b[92;mCluster [2ee11eb40eda22cac0cce259625c6734][Kibana]: finished running all the plan steps\x1b[0m (Total plan duration )",
 			),
 		},
+		{
+			name: "Succeeds with a kibana instance with no tracking",
+			args: args{
+				buf: new(bytes.Buffer),
+				params: &VacateClusterParams{
+					ID:             "someID",
+					ClusterID:      "2ee11eb40eda22cac0cce259625c6734",
+					Kind:           "kibana",
+					Output:         new(output.Device),
+					TrackFrequency: time.Nanosecond,
+					SkipTracking:   true,
+					MaxPollRetries: 1,
+					API: discardResponses(
+						newKibanaVacateMove(t, "someID", vacateCaseClusterConfig{}),
+					),
+				},
+			},
+		},
 		{
 			name: "Moving kibana instance fails",
 			args: args{