New kismatic volume delete command

Author: dkoshkin

ansible/_persistent-volume-delete.yaml

@@ -0,0 +1,11 @@
+---
+  - hosts: master[0]
+    any_errors_fatal: true
+    name: "Delete Kubernetes Persistent Volume"
+    become: yes
+    vars_files:
+      - group_vars/all.yaml
+
+    tasks:
+      - name: delete Kubernetes PV
+        command: kubectl delete pv {{ volume_name }} --kubeconfig {{ kubernetes_kubeconfig_path }}

ansible/_volume-delete.yaml

@@ -0,0 +1,29 @@
+---
+  - hosts: storage
+    any_errors_fatal: true
+    name: "Delete Gluster Volume"
+    become: yes
+    vars_files:
+      - group_vars/all.yaml
+
+    tasks:
+      - name: verify volume exists
+        command: gluster volume list
+        register: out
+        failed_when: "'{{ volume_name }}' not in out.stdout"
+        run_once: true
+
+      - name: stop Gluster volume
+        command: gluster volume stop {{ volume_name }} --mode=script
+        run_once: true
+
+      - name: delete Gluster volume
+        command: gluster volume delete {{ volume_name }} --mode=script
+        run_once: true
+
+      - name: delete brick directory
+        file:
+          path: "{{ volume_mount }}{{ volume_base_dir }}{{ volume_name }}"
+          state: directory
+          mode: "{{ volume_mode }}"
+          state: absent

ansible/volume-delete.yaml

@@ -0,0 +1,3 @@
+---
+  - include: _persistent-volume-delete.yaml
+  - include: _volume-delete.yaml

integration/storage.go

@@ -116,6 +116,13 @@ func createVolume(planFile *os.File, name string, replicationCount int, distribu
 	return cmd.Run()
 }
 
+func deleteVolume(planFile *os.File, name string) error {
+	cmd := exec.Command("./kismatic", "volume", "delete", "-f", planFile.Name(), name, "--force")
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	return cmd.Run()
+}
+
 func standupGlusterCluster(planFile *os.File, nodes []NodeDeets, sshKey string, distro linuxDistro) {
 	By("Setting up a plan file with storage nodes")
 	plan := PlanAWS{
@@ -238,5 +245,24 @@ func testStatefulWorkload(nodes provisionedNodes, sshKey string) error {
 	if err != nil {
 		return fmt.Errorf("Reader workload failed: %v", err)
 	}
+
+	By("Deleting the storage volume")
+	err = deleteVolume(plan, "kis-int-test")
+	if err != nil {
+		return fmt.Errorf("Failed to delete volume: %v", err)
+	}
+
+	By("Verifying the storage volume was deleted")
+	err = runViaSSH([]string{"sudo kubectl get pv 2>&1 | grep 'No resources found.'"}, []NodeDeets{nodes.master[0]}, sshKey, 30*time.Second)
+	if err != nil {
+		return fmt.Errorf("Error validating the volume was removed: %v", err)
+	}
+
+	By("Creating a storage volume with the same name as a deleted volume")
+	err = createVolume(plan, "kis-int-test", 2, 1, reclaimPolicy, accessModes)
+	if err != nil {
+		return fmt.Errorf("Failed to create volume: %v", err)
+	}
+
 	return nil
 }

pkg/cli/fakes_test.go

@@ -92,6 +92,10 @@ func (fe *fakeExecutor) AddVolume(*install.Plan, install.StorageVolume) error {
 	return nil
 }
 
+func (fe *fakeExecutor) DeleteVolume(*install.Plan, string) error {
+	return nil
+}
+
 type fakePKI struct {
 	called              bool
 	generateCACalled    bool

pkg/cli/kismatic.go

@@ -22,7 +22,7 @@ more documentation is availble at https://github.com/apprenda/kismatic`,
 
 	cmd.AddCommand(NewCmdVersion(buildDate, out))
 	cmd.AddCommand(NewCmdInstall(in, out))
-	cmd.AddCommand(NewCmdVolume(out))
+	cmd.AddCommand(NewCmdVolume(in, out))
 	cmd.AddCommand(NewCmdIP(out))
 	cmd.AddCommand(NewCmdDashboard(out))
 	cmd.AddCommand(NewCmdSSH(out))

pkg/cli/volume.go

@@ -7,7 +7,7 @@ import (
 )
 
 // NewCmdVolume returns the storage command
-func NewCmdVolume(out io.Writer) *cobra.Command {
+func NewCmdVolume(in io.Reader, out io.Writer) *cobra.Command {
 	var planFile string
 	cmd := &cobra.Command{
 		Use:   "volume",
@@ -19,5 +19,6 @@ func NewCmdVolume(out io.Writer) *cobra.Command {
 	addPlanFileFlag(cmd.PersistentFlags(), &planFile)
 	cmd.AddCommand(NewCmdVolumeAdd(out, &planFile))
 	cmd.AddCommand(NewCmdVolumeList(out, &planFile))
+	cmd.AddCommand(NewCmdVolumeDelete(in, out, &planFile))
 	return cmd
 }

pkg/cli/volume_add.go

@@ -28,7 +28,7 @@ type volumeAddOptions struct {
 func NewCmdVolumeAdd(out io.Writer, planFile *string) *cobra.Command {
 	opts := volumeAddOptions{}
 	cmd := &cobra.Command{
-		Use:   "add size_in_gigabytes [volume name]",
+		Use:   "add size_in_gigabytes [volume-name]",
 		Short: "add storage volumes to the Kubernetes cluster",
 		Long: `Add storage volumes to the Kubernetes cluster.
 

pkg/cli/volume_delete.go

@@ -0,0 +1,99 @@
+package cli
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"strings"
+
+	"github.com/apprenda/kismatic/pkg/install"
+	"github.com/apprenda/kismatic/pkg/util"
+	"github.com/spf13/cobra"
+)
+
+type volumeDeleteOptions struct {
+	verbose            bool
+	outputFormat       string
+	generatedAssetsDir string
+	force              bool
+}
+
+// NewCmdVolumeDelete returns the command for deleting storage volumes
+func NewCmdVolumeDelete(in io.Reader, out io.Writer, planFile *string) *cobra.Command {
+	opts := volumeDeleteOptions{}
+	cmd := &cobra.Command{
+		Use:   "delete volume-name",
+		Short: "delete storage volumes",
+		Long: `Delete storage volumes created by the 'volume add' command.
+		
+WARNING all data in the volume will be lost.`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if opts.force == false {
+				ans, err := util.PromptForString(in, out, "Are you sure you want to delete this volume? All data will be lost", "N", []string{"N", "y"})
+				if err != nil {
+					return fmt.Errorf("error getting user response: %v", err)
+				}
+				if strings.ToLower(ans) != "y" {
+					os.Exit(0)
+				}
+			}
+			return doVolumeDelete(out, opts, *planFile, args)
+		},
+	}
+	cmd.Flags().BoolVar(&opts.verbose, "verbose", false, "enable verbose logging")
+	cmd.Flags().StringVarP(&opts.outputFormat, "output", "o", "simple", `output format (options simple|raw)`)
+	cmd.Flags().StringVar(&opts.generatedAssetsDir, "generated-assets-dir", "generated", "path to the directory where assets generated during the installation process will be stored")
+	cmd.Flags().BoolVar(&opts.force, "force", false, `do not prompt`)
+	return cmd
+}
+
+func doVolumeDelete(out io.Writer, opts volumeDeleteOptions, planFile string, args []string) error {
+	// get volume name and size from arguments
+	var volumeName string
+	switch len(args) {
+	case 1:
+		volumeName = args[0]
+	default:
+		return fmt.Errorf("%d arguments were provided, but add does not support more than 1 arguments", len(args))
+	}
+
+	// setup ansible for execution
+	planner := &install.FilePlanner{File: planFile}
+	if !planner.PlanExists() {
+		return planFileNotFoundErr{filename: planFile}
+	}
+	execOpts := install.ExecutorOptions{
+		OutputFormat: opts.outputFormat,
+		Verbose:      opts.verbose,
+		// Need to refactor executor code... this will do for now as we don't need the generated assets dir in this command
+		GeneratedAssetsDirectory: opts.generatedAssetsDir,
+	}
+	exec, err := install.NewExecutor(out, out, execOpts)
+	if err != nil {
+		return err
+	}
+	plan, err := planner.Read()
+	if err != nil {
+		return err
+	}
+
+	// Run validation
+	vopts := &validateOpts{
+		outputFormat:       opts.outputFormat,
+		verbose:            opts.verbose,
+		planFile:           planFile,
+		skipPreFlight:      true,
+		generatedAssetsDir: opts.generatedAssetsDir,
+	}
+	if err := doValidate(out, planner, vopts); err != nil {
+		return err
+	}
+
+	if err := exec.DeleteVolume(plan, volumeName); err != nil {
+		return fmt.Errorf("error deleting volume: %v", err)
+	}
+
+	fmt.Fprintln(out)
+	fmt.Fprintln(out, "Successfully deleted the persistent volume in the kubernetes cluster.")
+	return nil
+}

pkg/install/execute.go

@@ -34,6 +34,7 @@ type Executor interface {
 	AddWorker(*Plan, Node) (*Plan, error)
 	RunPlay(string, *Plan) error
 	AddVolume(*Plan, StorageVolume) error
+	DeleteVolume(*Plan, string) error
 	UpgradeEtcd2Nodes(plan Plan, nodesToUpgrade []ListableNode) error
 	UpgradeNodes(plan Plan, nodesToUpgrade []ListableNode, onlineUpgrade bool, maxParallelWorkers int) error
 	ValidateControlPlane(plan Plan) error
@@ -454,6 +455,27 @@ func (ae *ansibleExecutor) AddVolume(plan *Plan, volume StorageVolume) error {
 	return ae.execute(t)
 }
 
+func (ae *ansibleExecutor) DeleteVolume(plan *Plan, name string) error {
+	cc, err := ae.buildClusterCatalog(plan)
+	if err != nil {
+		return err
+	}
+	// Add storage related vars
+	cc.VolumeName = name
+	cc.VolumeMount = "/"
+
+	t := task{
+		name:           "delete-volume",
+		playbook:       "volume-delete.yaml",
+		plan:           *plan,
+		inventory:      buildInventoryFromPlan(plan),
+		clusterCatalog: *cc,
+		explainer:      ae.defaultExplainer(),
+	}
+	util.PrintHeader(ae.stdout, "Delete Persistent Storage Volume", '=')
+	return ae.execute(t)
+}
+
 func (ae *ansibleExecutor) UpgradeEtcd2Nodes(plan Plan, nodesToUpgrade []ListableNode) error {
 	for _, nodeToUpgrade := range nodesToUpgrade {
 		if err := ae.upgradeEtcd2Node(plan, nodeToUpgrade); err != nil {