feat(control): enable kubectl completion

add bash completion as external component

control node completes kubectl commands and parameters
via bash completion

kubectl fabric will be autocompleted also when it is
supported

Signed-off-by: Pau Capdevila <pau@githedgehog.com>

Author: pau-hedgehog

api/fabricator/v1beta1/fabricator_types.go

@@ -218,14 +218,15 @@ type Versions struct {
 }
 
 type PlatformVersions struct {
-	K3s         meta.Version `json:"k3s,omitempty"`
-	Zot         meta.Version `json:"zot,omitempty"`
-	CertManager meta.Version `json:"certManager,omitempty"`
-	K9s         meta.Version `json:"k9s,omitempty"`
-	Toolbox     meta.Version `json:"toolbox,omitempty"`
-	Reloader    meta.Version `json:"reloader,omitempty"`
-	NTP         meta.Version `json:"ntp,omitempty"`
-	NTPChart    meta.Version `json:"ntpChart,omitempty"`
+	K3s            meta.Version `json:"k3s,omitempty"`
+	Zot            meta.Version `json:"zot,omitempty"`
+	CertManager    meta.Version `json:"certManager,omitempty"`
+	K9s            meta.Version `json:"k9s,omitempty"`
+	Toolbox        meta.Version `json:"toolbox,omitempty"`
+	Reloader       meta.Version `json:"reloader,omitempty"`
+	NTP            meta.Version `json:"ntp,omitempty"`
+	NTPChart       meta.Version `json:"ntpChart,omitempty"`
+	BashCompletion meta.Version `json:"bashCompletion,omitempty"`
 }
 
 type FabricatorVersions struct {

config/crd/bases/fabricator.githedgehog.com_fabricators.yaml

@@ -324,6 +324,8 @@ spec:
                         type: object
                       platform:
                         properties:
+                          bashCompletion:
+                            type: string
                           certManager:
                             type: string
                           k3s:
@@ -521,6 +523,8 @@ spec:
                     type: object
                   platform:
                     properties:
+                      bashCompletion:
+                        type: string
                       certManager:
                         type: string
                       k3s:

docs/api.md

@@ -542,6 +542,7 @@ _Appears in:_
 | `reloader` _[Version](#version)_ |  |  |  |
 | `ntp` _[Version](#version)_ |  |  |  |
 | `ntpChart` _[Version](#version)_ |  |  |  |
+| `bashCompletion` _[Version](#version)_ |  |  |  |
 
 
 #### RegistryConfig

pkg/fab/comp/bashcompletion/bashcompletion.go

@@ -0,0 +1,82 @@
+// Copyright 2024 Hedgehog
+// SPDX-License-Identifier: Apache-2.0
+
+package bashcompletion
+
+import (
+	"context"
+	"embed"
+	"fmt"
+	"io"
+	"log/slog"
+	"os"
+	"path/filepath"
+	"strings"
+
+	fabapi "go.githedgehog.com/fabricator/api/fabricator/v1beta1"
+	"go.githedgehog.com/fabricator/api/meta"
+)
+
+//go:embed scripts/profile.sh
+var scriptFS embed.FS
+
+const (
+	BashCompletionRef  = "bash-completion"
+	BashCompletionFile = "bash_completion"
+	InstallDir         = "/opt/bash-completion"
+	ProfileDir         = "/etc/profile.d"
+	ProfileFilename    = "bash-completion.sh"
+)
+
+func Version(f fabapi.Fabricator) meta.Version {
+	return f.Status.Versions.Platform.BashCompletion
+}
+
+func Install(_ context.Context, workDir string, fab fabapi.Fabricator) error {
+	slog.Info("Installing bash-completion")
+
+	versionStr := strings.TrimPrefix(string(Version(fab)), "v")
+	slog.Info("Using bash-completion version", "version", versionStr)
+
+	dirs := []string{
+		InstallDir,
+		ProfileDir,
+	}
+
+	for _, dir := range dirs {
+		if err := os.MkdirAll(dir, 0755); err != nil {
+			return fmt.Errorf("creating directory %s: %w", dir, err)
+		}
+	}
+
+	srcPath := filepath.Join(workDir, BashCompletionFile)
+	dstPath := filepath.Join(InstallDir, BashCompletionFile)
+
+	srcFile, err := os.Open(srcPath)
+	if err != nil {
+		return fmt.Errorf("opening source file: %w", err)
+	}
+	defer srcFile.Close()
+
+	dstFile, err := os.OpenFile(dstPath, os.O_CREATE|os.O_WRONLY, 0644)
+	if err != nil {
+		return fmt.Errorf("creating destination file: %w", err)
+	}
+	defer dstFile.Close()
+
+	if _, err := io.Copy(dstFile, srcFile); err != nil {
+		return fmt.Errorf("copying file content: %w", err)
+	}
+
+	profileScript, err := scriptFS.ReadFile("scripts/profile.sh")
+	if err != nil {
+		return fmt.Errorf("reading profile script: %w", err)
+	}
+
+	profilePath := filepath.Join(ProfileDir, ProfileFilename)
+	if err := os.WriteFile(profilePath, profileScript, 0644); err != nil { //nolint:gosec
+		return fmt.Errorf("writing bash-completion profile script: %w", err)
+	}
+
+	return nil
+}

pkg/fab/comp/bashcompletion/scripts/profile.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# Copyright 2024 Hedgehog
+# SPDX-License-Identifier: Apache-2.0
+
+export LC_ALL=C
+export LANG=C
+
+if [ -f /opt/bash-completion/bash_completion ]; then
+    . /opt/bash-completion/bash_completion
+else
+    echo "Warning: bash_completion file not found" >&2
+fi
+
+alias k=kubectl
+
+if command -v kubectl &>/dev/null; then
+    source <(kubectl completion bash) 2>/dev/null || true
+    complete -o default -F __start_kubectl k 2>/dev/null || true
+fi
+
+if command -v kubectl &>/dev/null; then
+    if kubectl fabric --help >/dev/null 2>&1; then
+        kubectl fabric completion bash >/dev/null 2>&1 || true
+    fi
+fi

pkg/fab/recipe/control_build.go

@@ -16,6 +16,7 @@ import (
 	fabapi "go.githedgehog.com/fabricator/api/fabricator/v1beta1"
 	"go.githedgehog.com/fabricator/pkg/artificer"
 	"go.githedgehog.com/fabricator/pkg/fab/comp"
+	"go.githedgehog.com/fabricator/pkg/fab/comp/bashcompletion"
 	"go.githedgehog.com/fabricator/pkg/fab/comp/certmanager"
 	"go.githedgehog.com/fabricator/pkg/fab/comp/f8r"
 	"go.githedgehog.com/fabricator/pkg/fab/comp/fabric"
@@ -134,6 +135,15 @@ func (b *ControlInstallBuilder) addPayload(ctx context.Context, slog *slog.Logge
 		return fmt.Errorf("downloading cert-manager: %w", err)
 	}
 
+	slog.Info("Adding bash-completion to installer", "control", b.Control.Name)
+	if err := b.Downloader.FromORAS(ctx, installDir, bashcompletion.BashCompletionRef, bashcompletion.Version(b.Fab), []artificer.ORASFile{
+		{
+			Name: bashcompletion.BashCompletionFile,
+		},
+	}); err != nil {
+		return fmt.Errorf("downloading bash-completion: %w", err)
+	}
+
 	slog.Info("Adding config and wiring files to installer")
 	fabF, err := os.Create(filepath.Join(installDir, FabName))
 	if err != nil {

pkg/fab/recipe/control_install.go

@@ -20,6 +20,7 @@ import (
 	"go.githedgehog.com/fabric/pkg/util/logutil"
 	fabapi "go.githedgehog.com/fabricator/api/fabricator/v1beta1"
 	"go.githedgehog.com/fabricator/pkg/fab/comp"
+	"go.githedgehog.com/fabricator/pkg/fab/comp/bashcompletion"
 	"go.githedgehog.com/fabricator/pkg/fab/comp/certmanager"
 	"go.githedgehog.com/fabricator/pkg/fab/comp/k3s"
 	"go.githedgehog.com/fabricator/pkg/fab/comp/k9s"
@@ -75,6 +76,10 @@ func (c *ControlInstall) Run(ctx context.Context) error {
 		return fmt.Errorf("installing zot: %w", err)
 	}
 
+	if err := bashcompletion.Install(ctx, c.WorkDir, c.Fab); err != nil {
+		return fmt.Errorf("installing bash completion: %w", err)
+	}
+
 	// we should use in-cluster registry from now on
 	c.Fab.Status.IsBootstrap = false
 

pkg/fab/versions.go

@@ -18,14 +18,15 @@ var (
 
 var Versions = fabapi.Versions{
 	Platform: fabapi.PlatformVersions{
-		K3s:         "v1.32.1-k3s1",
-		Zot:         "v2.1.1",
-		CertManager: "v1.17.1",
-		K9s:         "v0.40.6",
-		Toolbox:     "latest",  // TODO use specific version, move to fabricator repo
-		Reloader:    "v1.0.40", // TODO upgrade or get rid of?
-		NTP:         "v0.0.2",
-		NTPChart:    FabricatorVersion,
+		K3s:            "v1.32.1-k3s1",
+		Zot:            "v2.1.1",
+		CertManager:    "v1.17.1",
+		K9s:            "v0.40.6",
+		Toolbox:        "latest",  // TODO use specific version, move to fabricator repo
+		Reloader:       "v1.0.40", // TODO upgrade or get rid of?
+		NTP:            "v0.0.2",
+		BashCompletion: "v2.16.0",
+		NTPChart:       FabricatorVersion,
 	},
 	Fabricator: fabapi.FabricatorVersions{
 		API:            FabricatorVersion,