feat: materialize host support bundle (#405)

* feat: materializes host support bundle

we want to have the host suppport bundle definition stored locally in
the node in case of the cluster being offline.

* chore: disable puppeteer chrome download

* chore: attempt to disable chrome download during puppeteer install

* chore: use already installed chromium

Author: ricardomaraschini

.github/workflows/pull-request.yaml

@@ -124,6 +124,7 @@ jobs:
           - TestCommandsRequireSudo
           - TestInstallWithoutEmbed
           - TestResetAndReinstall
+          - TestCollectSupportBundle
     steps:
     - name: Checkout
       uses: actions/checkout@v4

.github/workflows/release-dev.yaml

@@ -105,6 +105,7 @@ jobs:
           - TestInstallWithoutEmbed
           - TestInstallFromReplicatedApp
           - TestResetAndReinstall
+          - TestCollectSupportBundle
     steps:
       - name: Checkout
         uses: actions/checkout@v4

Makefile

@@ -9,7 +9,7 @@ ADMIN_CONSOLE_IMAGE_OVERRIDE =
 ADMIN_CONSOLE_MIGRATIONS_IMAGE_OVERRIDE =
 EMBEDDED_OPERATOR_CHART_URL = oci://registry.replicated.com/library
 EMBEDDED_OPERATOR_CHART_NAME = embedded-cluster-operator
-EMBEDDED_OPERATOR_CHART_VERSION = 0.23.1
+EMBEDDED_OPERATOR_CHART_VERSION = 0.24.1
 OPENEBS_CHART_URL = https://openebs.github.io/charts
 OPENEBS_CHART_NAME = openebs/openebs
 OPENEBS_CHART_VERSION = 3.10.0

e2e/scripts/collect-support-bundle.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+main() {
+    if ! kubectl support-bundle --output host.tar.gz --interactive=false /var/lib/embedded-cluster/support/host-support-bundle.yaml; then
+        echo "Failed to collect local host support bundle"
+        return 1
+    fi
+
+    if ! kubectl support-bundle --output cluster.tar.gz --interactive=false --load-cluster-specs; then
+        echo "Failed to collect cluster support bundle"
+        return 1
+    fi
+}
+
+export KUBECONFIG=/var/lib/k0s/pki/admin.conf
+export PATH=$PATH:/var/lib/embedded-cluster/bin
+main "$@"

e2e/scripts/install-puppeteer.sh

@@ -44,4 +44,4 @@ curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dea
 NODE_MAJOR=20
 echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list
 apt-get update && apt-get install nodejs -y
-npm install -g [email protected]
+PUPPETEER_SKIP_DOWNLOAD=1 npm install -g [email protected]

e2e/scripts/puppeteer.sh

@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 set -euo pipefail
-NODE_PATH="$(npm root -g)" "$@"
+PUPPETEER_EXECUTABLE_PATH=/snap/bin/chromium NODE_PATH="$(npm root -g)" "$@"

e2e/support-bundle_test.go

@@ -0,0 +1,40 @@
+package e2e
+
+import (
+	"testing"
+	"time"
+
+	"github.com/replicatedhq/embedded-cluster/e2e/cluster"
+)
+
+func TestCollectSupportBundle(t *testing.T) {
+	t.Parallel()
+	tc := cluster.NewTestCluster(&cluster.Input{
+		T:                   t,
+		Nodes:               1,
+		Image:               "ubuntu/jammy",
+		LicensePath:         "license.yaml",
+		EmbeddedClusterPath: "../output/bin/embedded-cluster",
+	})
+	defer tc.Destroy()
+	t.Logf("%s: installing embedded-cluster on node 0", time.Now().Format(time.RFC3339))
+	line := []string{"single-node-install.sh"}
+	stdout, stderr, err := RunCommandOnNode(t, tc, 0, line)
+	if err != nil {
+		t.Log("stdout:", stdout)
+		t.Log("stderr:", stderr)
+		t.Fatalf("fail to install embedded-cluster on node %s: %v", tc.Nodes[0], err)
+	}
+
+	line = []string{"collect-support-bundle.sh"}
+	stdout, stderr, err = RunCommandOnNode(t, tc, 0, line)
+	if err != nil {
+		t.Log("stdout:", stdout)
+		t.Log("stderr:", stderr)
+		t.Fatalf("fail to install collect support bundle on node %s: %v", tc.Nodes[0], err)
+	}
+
+	t.Log("stdout:", stdout)
+	t.Log("stderr:", stderr)
+	t.Logf("%s: test complete", time.Now().Format(time.RFC3339))
+}

pkg/defaults/defaults.go

@@ -85,3 +85,8 @@ func PathToK0sStatusSocket() string {
 func EmbeddedClusterHomeDirectory() string {
 	return def().EmbeddedClusterHomeDirectory()
 }
+
+// PathToEmbeddedClusterSupportFile calls PathToEmbeddedClusterSupportFile on the default provider.
+func PathToEmbeddedClusterSupportFile(name string) string {
+	return def().PathToEmbeddedClusterSupportFile(name)
+}

pkg/defaults/provider.go

@@ -160,3 +160,20 @@ func (d *Provider) PathToK0sStatusSocket() string {
 func (d *Provider) PathToK0sConfig() string {
 	return "/etc/k0s/k0s.yaml"
 }
+
+// EmbeddedClusterSupportSubDir returns the path to the directory where embedded-cluster
+// support files are stored. Things that are useful when providing end user support in
+// a running cluster should be stored into this directory.
+func (d *Provider) EmbeddedClusterSupportSubDir() string {
+	path := filepath.Join(d.EmbeddedClusterHomeDirectory(), "support")
+	if err := os.MkdirAll(path, 0700); err != nil {
+		logrus.Fatalf("unable to create embedded-cluster support dir: %s", err)
+	}
+	return path
+}
+
+// PathToEmbeddedClusterSupportFile is an utility function that returns the full path to
+// a materialized support file. This function does not check if the file exists.
+func (d *Provider) PathToEmbeddedClusterSupportFile(name string) string {
+	return filepath.Join(d.EmbeddedClusterSupportSubDir(), name)
+}

pkg/goods/goods.go

@@ -13,9 +13,6 @@ import (
 	"github.com/replicatedhq/embedded-cluster/pkg/defaults"
 )
 
-//go:embed bins/*
-var binfs embed.FS
-
 // K0sBinarySHA256 returns the SHA256 checksum of the embedded k0s binary.
 func K0sBinarySHA256() (string, error) {
 	fp, err := binfs.Open("bins/k0s")
@@ -30,8 +27,11 @@ func K0sBinarySHA256() (string, error) {
 	return hex.EncodeToString(hasher.Sum(nil)), nil
 }
 
-// Materialize writes to disk all embedded assets.
-func Materialize() error {
+//go:embed bins/*
+var binfs embed.FS
+
+// materializeBinaries materializes all binary files from inside bins directory.
+func materializeBinaries() error {
 	entries, err := binfs.ReadDir("bins")
 	if err != nil {
 		return fmt.Errorf("unable to read embedded-cluster bins dir: %w", err)
@@ -49,3 +49,37 @@ func Materialize() error {
 	}
 	return nil
 }
+
+//go:embed support/*
+var supportfs embed.FS
+
+// materializeSupportFiles materializes all support files from inside support directory.
+func materializeSupportFiles() error {
+	entries, err := supportfs.ReadDir("support")
+	if err != nil {
+		return fmt.Errorf("unable to read embedded-cluster support dir: %w", err)
+	}
+	for _, entry := range entries {
+		srcpath := fmt.Sprintf("support/%s", entry.Name())
+		srcfile, err := supportfs.ReadFile(srcpath)
+		if err != nil {
+			return fmt.Errorf("unable to read asset: %w", err)
+		}
+		dstpath := defaults.PathToEmbeddedClusterSupportFile(entry.Name())
+		if err := os.WriteFile(dstpath, srcfile, 0700); err != nil {
+			return fmt.Errorf("unable to write file: %w", err)
+		}
+	}
+	return nil
+}
+
+// Materialize writes to disk all embedded assets.
+func Materialize() error {
+	if err := materializeBinaries(); err != nil {
+		return fmt.Errorf("unable to materialize embedded binaries: %w", err)
+	}
+	if err := materializeSupportFiles(); err != nil {
+		return fmt.Errorf("unable to materialize embedded support files: %w", err)
+	}
+	return nil
+}