feat(ec): update node join instructions for improved join experience

Author: emosbaugh

pkg/embeddedcluster/node_join.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/base64"
 	"fmt"
+	"net"
 	"strings"
 	"sync"
 	"time"
@@ -208,29 +209,37 @@ func findInternalIPAddress(addresses []corev1.NodeAddress) *corev1.NodeAddress {
 	return nil
 }
 
-// GenerateAddNodeCommand returns the command a user should run to add a node with the provided token
-// the command will be of the form 'embeddedcluster node join ip:port UUID'
-func GenerateAddNodeCommand(ctx context.Context, kbClient kbclient.Client, token string, isAirgap bool) (string, error) {
+// GenerateAddNodeCommand returns a list of commands a user should run to add a node with the
+// provided token.
+func GenerateAddNodeCommand(ctx context.Context, kbClient kbclient.Client, token string) ([]string, error) {
 	installation, err := GetCurrentInstallation(ctx, kbClient)
 	if err != nil {
-		return "", fmt.Errorf("failed to get current installation: %w", err)
+		return nil, fmt.Errorf("failed to get current installation: %w", err)
 	}
 
 	binaryName := installation.Spec.BinaryName
 
 	// get the IP of a controller node
 	nodeIP, err := getControllerNodeIP(ctx, kbClient)
 	if err != nil {
-		return "", fmt.Errorf("failed to get controller node IP: %w", err)
+		return nil, fmt.Errorf("failed to get controller node IP: %w", err)
 	}
 
 	// get the port of the 'admin-console' service
 	port, err := getAdminConsolePort(ctx, kbClient)
 	if err != nil {
-		return "", fmt.Errorf("failed to get admin console port: %w", err)
+		return nil, fmt.Errorf("failed to get admin console port: %w", err)
 	}
 
-	return fmt.Sprintf("sudo ./%s join %s:%d %s", binaryName, nodeIP, port, token), nil
+	address := net.JoinHostPort(nodeIP, fmt.Sprintf("%d", port))
+
+	commands := []string{
+		fmt.Sprintf("curl -k https://%s/api/v1/embedded-cluster/binary -o %s.tar.gz", address, binaryName),
+		fmt.Sprintf("tar -xvf %s.tar.gz", binaryName),
+		fmt.Sprintf("sudo ./%s join %s %s", binaryName, address, token),
+	}
+
+	return commands, nil
 }
 
 // GenerateK0sJoinCommand returns the k0s node join command, without the token but with all other required flags

pkg/embeddedcluster/node_join_test.go

@@ -80,25 +80,18 @@ func TestGenerateAddNodeCommand(t *testing.T) {
 
 	req := require.New(t)
 
-	// Generate the add node command for online
-	gotCommand, err := GenerateAddNodeCommand(context.Background(), kbClient, "token", false)
+	gotCommand, err := GenerateAddNodeCommand(context.Background(), kbClient, "token")
 	if err != nil {
 		t.Fatalf("Failed to generate add node command: %v", err)
 	}
 
 	// Verify the generated command
-	wantCommand := "sudo ./my-app join 192.168.0.100:30000 token"
-	req.Equal(wantCommand, gotCommand)
-
-	// Generate the add node command for airgap
-	gotCommand, err = GenerateAddNodeCommand(context.Background(), kbClient, "token", true)
-	if err != nil {
-		t.Fatalf("Failed to generate add node command: %v", err)
+	wantCommands := []string{
+		"curl -k https://192.168.0.100:30000/api/v1/embedded-cluster/binary -o my-app.tar.gz",
+		"tar -xvf my-app.tar.gz",
+		"sudo ./my-app join 192.168.0.100:30000 token",
 	}
-
-	// Verify the generated command
-	wantCommand = "sudo ./my-app join 192.168.0.100:30000 token"
-	req.Equal(wantCommand, gotCommand)
+	req.Equal(wantCommands, gotCommand)
 }
 
 func TestGetAllNodeIPAddresses(t *testing.T) {

pkg/handlers/embedded_cluster_node_join_command.go

@@ -8,7 +8,7 @@ import (
 	"github.com/google/uuid"
 	"github.com/replicatedhq/embedded-cluster/kinds/types/join"
 
-  "github.com/replicatedhq/kots/pkg/api/handlers/types"
+	"github.com/replicatedhq/kots/pkg/api/handlers/types"
 	"github.com/replicatedhq/kots/pkg/embeddedcluster"
 	"github.com/replicatedhq/kots/pkg/k8sutil"
 	"github.com/replicatedhq/kots/pkg/kotsutil"
@@ -38,35 +38,22 @@ func (h *Handler) GenerateEmbeddedClusterNodeJoinCommand(w http.ResponseWriter,
 		return
 	}
 
-	apps, err := store.GetStore().ListInstalledApps()
-	if err != nil {
-		logger.Error(fmt.Errorf("failed to list installed apps: %w", err))
-		w.WriteHeader(http.StatusInternalServerError)
-		return
-	}
-	if len(apps) == 0 {
-		logger.Error(fmt.Errorf("no installed apps found"))
-		w.WriteHeader(http.StatusInternalServerError)
-		return
-	}
-	app := apps[0]
-
 	kbClient, err := h.GetKubeClient(r.Context())
 	if err != nil {
 		logger.Error(fmt.Errorf("failed to get kubeclient: %w", err))
 		w.WriteHeader(http.StatusInternalServerError)
 		return
 	}
 
-	nodeJoinCommand, err := embeddedcluster.GenerateAddNodeCommand(r.Context(), kbClient, token, app.IsAirgap)
+	nodeJoinCommands, err := embeddedcluster.GenerateAddNodeCommand(r.Context(), kbClient, token)
 	if err != nil {
 		logger.Error(fmt.Errorf("failed to generate add node command: %w", err))
 		w.WriteHeader(http.StatusInternalServerError)
 		return
 	}
 
 	JSON(w, http.StatusOK, types.GenerateEmbeddedClusterNodeJoinCommandResponse{
-		Command: []string{nodeJoinCommand},
+		Command: nodeJoinCommands,
 	})
 }
 

web/src/components/apps/EmbeddedClusterManagement.tsx

@@ -178,7 +178,7 @@ const EmbeddedClusterManagement = ({
   });
 
   type AddNodeCommandResponse = {
-    command: string;
+    command: string[];
     expiry: string;
   };
 
@@ -438,6 +438,12 @@ const EmbeddedClusterManagement = ({
     );
   };
 
+  const addNodesCommandInstructions = [
+    "Download the installation assets",
+    "Extract the installation assets",
+    "Join the node to the cluster",
+  ];
+
   const AddNodeCommands = () => {
     return (
       <>
@@ -506,18 +512,26 @@ const EmbeddedClusterManagement = ({
             </p>
           )}
           {!generateAddNodeCommandLoading && generateAddNodeCommand?.command && (
-            <>
-              <CodeSnippet
-                key={selectedNodeTypes.toString()}
-                language="bash"
-                canCopy={true}
-                onCopyText={
-                  <span className="u-textColor--success">Copied!</span>
-                }
-              >
-                {generateAddNodeCommand?.command}
-              </CodeSnippet>
-            </>
+            <div className="tw-flex tw-flex-col tw-gap-4 tw-mt-4">
+              {generateAddNodeCommand.command.map((command, index) => (
+                <div key={command}>
+                  {addNodesCommandInstructions[index] && (
+                    <p className="tw-text-gray-600 tw-font-semibold">
+                      {addNodesCommandInstructions[index]}
+                    </p>
+                  )}
+                  <CodeSnippet
+                    language="bash"
+                    canCopy={true}
+                    onCopyText={
+                      <span className="u-textColor--success">Copied!</span>
+                    }
+                  >
+                    {command}
+                  </CodeSnippet>
+                </div>
+              ))}
+            </div>
           )}
         </div>
       </>