Create a support folder with diagnostics and reattach-pv (elastic#4246)

Author: idanmo

Makefile

@@ -126,7 +126,7 @@ clean:
 
 reattach-pv:
 	# just check that reattach-pv still compiles
-	go build -o /dev/null hack/reattach-pv/main.go
+	go build -o /dev/null support/reattach-pv/main.go
 
 compile-all: 
 	@ go build ./...

hack/diagnostics/README.md

@@ -0,0 +1 @@
+This resource has been moved to a [new location](../../support/diagnostics/) within the top level [support](../../support) folder.

hack/reattach-pv/README.md

@@ -1,56 +1 @@
-# Reattach-PV
-
-This tool can be used to recreate an Elasticsearch cluster by reusing orphaned PersistentVolumes that used to belong to that cluster before it was deleted.
-
-**Warning**: to be used at your own risk. This tool has not been tested extensively with multiple Kubernetes distributions and PersistentVolume providers. You should backup the data in the underlying storage system before attempting to use this tool. Also make sure you perform a dry-run first.
-
-## Expectations
-
-This tool can only be used when the following conditions are met:
-
-* The Elasticsearch resource to re-create does not exist in Kubernetes.
-* All PersistentVolumeClaims of the previous cluster do not exist anymore.
-* All PersistentVolumes of the previous cluster still exist with the status `Released`.
-* The Elasticsearch resource to re-create has the exact same specs as the deleted one. Same cluster name, same node sets, same count, etc.
-* The current default kubectl context targets the desired Kubernetes cluster.
-
-## Usage
-
-```
-Recreate an Elasticsearch cluster by reattaching existing released PersistentVolumes
-
-Usage:
-  reattach-pv [flags]
-
-Flags:
-      --dry-run                         do not apply any Kubernetes resource change
-      --elasticsearch-manifest string   path pointing to the Elasticsearch yaml manifest
-  -h, --help                            help for reattach-pv
-```
-
-Example:
-
-```
-# build the binary with a recent Go version
-go build
-# perform a dry run first
-./reattach-pv --elasticsearch-manifest elasticsearch.yml --dry-run
-# then, execute again without the dry-run flag
-./reattach-pv --elasticsearch-manifest elasticsearch.yml
-```
-
-## How it works
-
-This tool basically does the following:
-
-* Ensure the Elasticsearch resource and the corresponding PersistentVolumeClaims do not exist in the APIServer.
-* Generate the list of PersistentVolumeClaims that would normally be created for this Elasticsearch cluster.
-* Retrieve the list of existing Released PersistentVolumes. Match their `claimRef` to the generated PersistentVolumeClaims, based on their name.
-* Create the expected PersistentVolumeClaims, with a status set to `Bound`.
-* Update the existing PersistentVolumes to reference the newly created PersistentVolumeClaims.
-* Create the Elasticsearch resource. The created PersistentVolumeClaims will automatically be used for the Elasticsearch Pods, since they have the correct name convention.
-
-## Limitations
-
-* PersistentVolumsClaims are not created the exact same way they would normally be created by the StatefulSet controller. Especially, they don't have the usual annotations and labels.
-* PersistentVolumeClaims are not created with an OwnerReference pointing to the Elasticsearch resource, because they are created before that resource. Therefore, they will not be automatically removed upon Elasticsearch resource deletion.
+This resource has been moved to a [new location](../../support/reattach-pv/) within the top level [support](../../support) folder.

hack/diagnostics/eck-dump.sh renamed to support/diagnostics/eck-dump.sh

@@ -0,0 +1,56 @@
+# Reattach-PV
+
+This tool can be used to recreate an Elasticsearch cluster by reusing orphaned PersistentVolumes that used to belong to that cluster before it was deleted.
+
+**Warning**: to be used at your own risk. This tool has not been tested extensively with multiple Kubernetes distributions and PersistentVolume providers. You should backup the data in the underlying storage system before attempting to use this tool. Also make sure you perform a dry-run first.
+
+## Expectations
+
+This tool can only be used when the following conditions are met:
+
+* The Elasticsearch resource to re-create does not exist in Kubernetes.
+* All PersistentVolumeClaims of the previous cluster do not exist anymore.
+* All PersistentVolumes of the previous cluster still exist with the status `Released`.
+* The Elasticsearch resource to re-create has the exact same specs as the deleted one. Same cluster name, same node sets, same count, etc.
+* The current default kubectl context targets the desired Kubernetes cluster.
+
+## Usage
+
+```
+Recreate an Elasticsearch cluster by reattaching existing released PersistentVolumes
+
+Usage:
+  reattach-pv [flags]
+
+Flags:
+      --dry-run                         do not apply any Kubernetes resource change
+      --elasticsearch-manifest string   path pointing to the Elasticsearch yaml manifest
+  -h, --help                            help for reattach-pv
+```
+
+Example:
+
+```
+# build the binary with a recent Go version
+go build
+# perform a dry run first
+./reattach-pv --elasticsearch-manifest elasticsearch.yml --dry-run
+# then, execute again without the dry-run flag
+./reattach-pv --elasticsearch-manifest elasticsearch.yml
+```
+
+## How it works
+
+This tool basically does the following:
+
+* Ensure the Elasticsearch resource and the corresponding PersistentVolumeClaims do not exist in the APIServer.
+* Generate the list of PersistentVolumeClaims that would normally be created for this Elasticsearch cluster.
+* Retrieve the list of existing Released PersistentVolumes. Match their `claimRef` to the generated PersistentVolumeClaims, based on their name.
+* Create the expected PersistentVolumeClaims, with a status set to `Bound`.
+* Update the existing PersistentVolumes to reference the newly created PersistentVolumeClaims.
+* Create the Elasticsearch resource. The created PersistentVolumeClaims will automatically be used for the Elasticsearch Pods, since they have the correct name convention.
+
+## Limitations
+
+* PersistentVolumsClaims are not created the exact same way they would normally be created by the StatefulSet controller. Especially, they don't have the usual annotations and labels.
+* PersistentVolumeClaims are not created with an OwnerReference pointing to the Elasticsearch resource, because they are created before that resource. Therefore, they will not be automatically removed upon Elasticsearch resource deletion.

support/reattach-pv/README.md

@@ -721,9 +721,9 @@ func (h *helper) dumpEventLog() {
 func (h *helper) dumpK8sData() {
 	operatorNs := h.testContext.Operator.Namespace
 	managedNs := strings.Join(h.testContext.Operator.ManagedNamespaces, ",")
-	cmd := exec.Command("hack/diagnostics/eck-dump.sh", "-N", operatorNs, "-n", managedNs, "-o", h.testContext.TestRun, "-z")
+	cmd := exec.Command("support/diagnostics/eck-dump.sh", "-N", operatorNs, "-n", managedNs, "-o", h.testContext.TestRun, "-z")
 	err := cmd.Run()
 	if err != nil {
-		log.Error(err, "Failed to run hack/diagnostics/eck-dump.sh")
+		log.Error(err, "Failed to run support/diagnostics/eck-dump.sh")
 	}
 }