Create airgapinfo package to parse airgap bundle metadata

Signed-off-by: Evans Mungai <evans@replicated.com>

Author: banjoh

cmd/installer/cli/install.go

@@ -95,7 +95,16 @@ func InstallCmd(ctx context.Context, name string) *cobra.Command {
 			cancel() // Cancel context when command completes
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
-			if err := verifyAndPrompt(ctx, name, flags, prompts.New()); err != nil {
+			var airgapInfo *kotsv1beta1.Airgap
+			if flags.airgapBundle != "" {
+				var err error
+				airgapInfo, err = airgap.AirgapInfoFromPath(flags.airgapBundle)
+				if err != nil {
+					return fmt.Errorf("failed to get airgap info: %w", err)
+				}
+			}
+
+			if err := verifyAndPrompt(ctx, name, flags, prompts.New(), airgapInfo); err != nil {
 				return err
 			}
 			if err := preRunInstall(cmd, &flags, rc); err != nil {
@@ -571,7 +580,7 @@ func getAddonInstallOpts(flags InstallCmdFlags, rc runtimeconfig.RuntimeConfig,
 	return opts, nil
 }
 
-func verifyAndPrompt(ctx context.Context, name string, flags InstallCmdFlags, prompt prompts.Prompt) error {
+func verifyAndPrompt(ctx context.Context, name string, flags InstallCmdFlags, prompt prompts.Prompt, airgapInfo *kotsv1beta1.Airgap) error {
 	logrus.Debugf("checking if k0s is already installed")
 	err := verifyNoInstallation(name, "reinstall")
 	if err != nil {
@@ -588,9 +597,9 @@ func verifyAndPrompt(ctx context.Context, name string, flags InstallCmdFlags, pr
 	if err != nil {
 		return err
 	}
-	if flags.isAirgap {
+	if airgapInfo != nil {
 		logrus.Debugf("checking airgap bundle matches binary")
-		if err := checkAirgapMatches(flags.airgapBundle); err != nil {
+		if err := checkAirgapMatches(airgapInfo); err != nil {
 			return err // we want the user to see the error message without a prefix
 		}
 	}
@@ -885,23 +894,15 @@ func installExtensions(ctx context.Context, hcli helm.Client) error {
 	return nil
 }
 
-func checkAirgapMatches(airgapBundle string) error {
+func checkAirgapMatches(airgapInfo *kotsv1beta1.Airgap) error {
 	rel := release.GetChannelRelease()
 	if rel == nil {
 		return fmt.Errorf("airgap bundle provided but no release was found in binary, please rerun without the airgap-bundle flag")
 	}
 
-	// read file from path
-	rawfile, err := os.Open(airgapBundle)
-	if err != nil {
-		return fmt.Errorf("failed to open airgap file: %w", err)
-	}
-	defer rawfile.Close()
-
-	appSlug, channelID, airgapVersion, err := airgap.ChannelReleaseMetadata(rawfile)
-	if err != nil {
-		return fmt.Errorf("failed to get airgap bundle versions: %w", err)
-	}
+	appSlug := airgapInfo.Spec.AppSlug
+	channelID := airgapInfo.Spec.ChannelID
+	airgapVersion := airgapInfo.Spec.VersionLabel
 
 	// Check if the airgap bundle matches the application version data
 	if rel.AppSlug != appSlug {

cmd/installer/cli/install_runpreflights.go

@@ -7,11 +7,13 @@ import (
 
 	"github.com/replicatedhq/embedded-cluster/pkg-new/hostutils"
 	"github.com/replicatedhq/embedded-cluster/pkg-new/preflights"
+	"github.com/replicatedhq/embedded-cluster/pkg/airgap"
 	"github.com/replicatedhq/embedded-cluster/pkg/metrics"
 	"github.com/replicatedhq/embedded-cluster/pkg/netutils"
 	"github.com/replicatedhq/embedded-cluster/pkg/prompts"
 	"github.com/replicatedhq/embedded-cluster/pkg/release"
 	"github.com/replicatedhq/embedded-cluster/pkg/runtimeconfig"
+	kotsv1beta1 "github.com/replicatedhq/kotskinds/apis/kots/v1beta1"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -41,7 +43,16 @@ func InstallRunPreflightsCmd(ctx context.Context, name string) *cobra.Command {
 			rc.Cleanup()
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
-			if err := runInstallRunPreflights(cmd.Context(), name, flags, rc); err != nil {
+			var airgapInfo *kotsv1beta1.Airgap
+			if flags.airgapBundle != "" {
+				var err error
+				airgapInfo, err = airgap.AirgapInfoFromPath(flags.airgapBundle)
+				if err != nil {
+					return fmt.Errorf("failed to get airgap info: %w", err)
+				}
+			}
+
+			if err := runInstallRunPreflights(cmd.Context(), name, flags, rc, airgapInfo); err != nil {
 				return err
 			}
 
@@ -59,8 +70,8 @@ func InstallRunPreflightsCmd(ctx context.Context, name string) *cobra.Command {
 	return cmd
 }
 
-func runInstallRunPreflights(ctx context.Context, name string, flags InstallCmdFlags, rc runtimeconfig.RuntimeConfig) error {
-	if err := verifyAndPrompt(ctx, name, flags, prompts.New()); err != nil {
+func runInstallRunPreflights(ctx context.Context, name string, flags InstallCmdFlags, rc runtimeconfig.RuntimeConfig, airgapInfo *kotsv1beta1.Airgap) error {
+	if err := verifyAndPrompt(ctx, name, flags, prompts.New(), airgapInfo); err != nil {
 		return err
 	}
 

cmd/installer/cli/restore.go

@@ -135,7 +135,14 @@ func runRestore(ctx context.Context, name string, flags InstallCmdFlags, rc runt
 
 	if flags.isAirgap {
 		logrus.Debugf("checking airgap bundle matches binary")
-		if err := checkAirgapMatches(flags.airgapBundle); err != nil {
+
+		// read file from path
+		airgapInfo, err := airgap.AirgapInfoFromPath(flags.airgapBundle)
+		if err != nil {
+			return fmt.Errorf("failed to get airgap bundle versions: %w", err)
+		}
+
+		if err := checkAirgapMatches(airgapInfo); err != nil {
 			return err // we want the user to see the error message without a prefix
 		}
 	}

cmd/installer/cli/update.go

@@ -6,6 +6,7 @@ import (
 	"os"
 
 	"github.com/replicatedhq/embedded-cluster/cmd/installer/kotscli"
+	"github.com/replicatedhq/embedded-cluster/pkg/airgap"
 	"github.com/replicatedhq/embedded-cluster/pkg/release"
 	"github.com/replicatedhq/embedded-cluster/pkg/runtimeconfig"
 	rcutil "github.com/replicatedhq/embedded-cluster/pkg/runtimeconfig/util"
@@ -42,7 +43,14 @@ func UpdateCmd(ctx context.Context, name string) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if airgapBundle != "" {
 				logrus.Debugf("checking airgap bundle matches binary")
-				if err := checkAirgapMatches(airgapBundle); err != nil {
+
+				// read file from path
+				airgapInfo, err := airgap.AirgapInfoFromPath(airgapBundle)
+				if err != nil {
+					return fmt.Errorf("failed to get airgap bundle versions: %w", err)
+				}
+
+				if err := checkAirgapMatches(airgapInfo); err != nil {
 					return err // we want the user to see the error message without a prefix
 				}
 			}

go.mod

@@ -32,7 +32,7 @@ require (
 	github.com/onsi/gomega v1.37.0
 	github.com/replicatedhq/embedded-cluster/kinds v0.0.0
 	github.com/replicatedhq/embedded-cluster/utils v0.0.0
-	github.com/replicatedhq/kotskinds v0.0.0-20250411153224-089dbeb7ba2a
+	github.com/replicatedhq/kotskinds v0.0.0-20250609144916-baa60600998c
 	github.com/replicatedhq/troubleshoot v0.119.1
 	github.com/sirupsen/logrus v1.9.3
 	github.com/spf13/cobra v1.9.1

go.sum

@@ -1464,8 +1464,8 @@ github.com/redis/go-redis/extra/redisotel/v9 v9.0.5/go.mod h1:WZjPDy7VNzn77AAfnA
 github.com/redis/go-redis/v9 v9.7.3 h1:YpPyAayJV+XErNsatSElgRZZVCwXX9QzkKYNvO7x0wM=
 github.com/redis/go-redis/v9 v9.7.3/go.mod h1:bGUrSggJ9X9GUmZpZNEOQKaANxSGgOEBRltRTZHSvrA=
 github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
-github.com/replicatedhq/kotskinds v0.0.0-20250411153224-089dbeb7ba2a h1:aNZ7qcuEmPGIUIIfxF7c0sdKR2+zL2vc5r2V8j8a49I=
-github.com/replicatedhq/kotskinds v0.0.0-20250411153224-089dbeb7ba2a/go.mod h1:QjhIUu3+OmHZ09u09j3FCoTt8F3BYtQglS+OLmftu9I=
+github.com/replicatedhq/kotskinds v0.0.0-20250609144916-baa60600998c h1:lnCL/wYi2BFTnxOP/lmo9WJwVPG3fk/plgJ/9NrMFw4=
+github.com/replicatedhq/kotskinds v0.0.0-20250609144916-baa60600998c/go.mod h1:QjhIUu3+OmHZ09u09j3FCoTt8F3BYtQglS+OLmftu9I=
 github.com/replicatedhq/troubleshoot v0.119.1 h1:AroLbVdtkPMv32va4z2lNdOcShFbT357oPZeECP2aOA=
 github.com/replicatedhq/troubleshoot v0.119.1/go.mod h1:50okSHbWEqlbNQY1kCilXKphjGPBQ6JewezFOu47l8c=
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=

pkg/airgap/airgapinfo.go

@@ -0,0 +1,61 @@
+package airgap
+
+import (
+	"archive/tar"
+	"compress/gzip"
+	"fmt"
+	"io"
+	"os"
+
+	"github.com/pkg/errors"
+	kotsv1beta1 "github.com/replicatedhq/kotskinds/apis/kots/v1beta1"
+	"sigs.k8s.io/yaml"
+)
+
+// AirgapInfoFromReader extracts the airgap metadata from the airgap file and returns it
+func AirgapInfoFromReader(reader io.Reader) (metadata *kotsv1beta1.Airgap, err error) {
+	// decompress tarball
+	ungzip, err := gzip.NewReader(reader)
+	if err != nil {
+		return nil, fmt.Errorf("failed to decompress airgap file: %w", err)
+	}
+	defer ungzip.Close()
+
+	// iterate through tarball
+	tarreader := tar.NewReader(ungzip)
+	var nextFile *tar.Header
+	for {
+		nextFile, err = tarreader.Next()
+		if err != nil {
+			if err == io.EOF {
+				return nil, errors.Wrapf(err, "airgap.yaml not found in airgap file")
+			}
+			return nil, errors.Wrapf(err, "failed to read airgap file")
+		}
+
+		if nextFile.Name == "airgap.yaml" {
+			var contents []byte
+			contents, err = io.ReadAll(tarreader)
+			if err != nil {
+				return nil, errors.Wrapf(err, "failed to read airgap.yaml file within airgap file")
+			}
+			parsed := kotsv1beta1.Airgap{}
+
+			err := yaml.Unmarshal(contents, &parsed)
+			if err != nil {
+				return nil, errors.Wrapf(err, "failed to unmarshal airgap.yaml file within airgap file")
+			}
+			return &parsed, nil
+		}
+	}
+}
+
+func AirgapInfoFromPath(path string) (metadata *kotsv1beta1.Airgap, err error) {
+	reader, err := os.Open(path)
+	if err != nil {
+		return nil, fmt.Errorf("failed to open airgap file: %w", err)
+	}
+	defer reader.Close()
+
+	return AirgapInfoFromReader(reader)
+}

pkg/airgap/version_test.go renamed to pkg/airgap/airgapinfo_test.go

@@ -36,15 +36,28 @@ func TestAirgapBundleVersions(t *testing.T) {
 			t.Logf("Current working directory: %s", dir)
 			airgapReader := createTarballFromDir(filepath.Join(dir, "testfiles", tt.airgapDir), nil)
 
-			appSlug, channelID, versionLabel, err := ChannelReleaseMetadata(airgapReader)
+			airgapInfo, err := AirgapInfoFromReader(airgapReader)
 			req.NoError(err)
-			req.Equal(tt.wantAppslug, appSlug)
-			req.Equal(tt.wantChannelid, channelID)
-			req.Equal(tt.wantVersionlabel, versionLabel)
+			req.Equal(tt.wantAppslug, airgapInfo.Spec.AppSlug)
+			req.Equal(tt.wantChannelid, airgapInfo.Spec.ChannelID)
+			req.Equal(tt.wantVersionlabel, airgapInfo.Spec.VersionLabel)
 		})
 	}
 }
 
+func TestAirgapBundleSize(t *testing.T) {
+	req := require.New(t)
+
+	dir, err := os.Getwd()
+	req.NoError(err)
+	t.Logf("Current working directory: %s", dir)
+	airgapReader := createTarballFromDir(filepath.Join(dir, "testfiles", "tiny-airgap-noimages"), nil)
+
+	airgapInfo, err := AirgapInfoFromReader(airgapReader)
+	req.NoError(err)
+	req.Equal(int64(1234567890), airgapInfo.Spec.UncompressedSize)
+}
+
 func createTarballFromDir(rootPath string, additionalFiles map[string][]byte) io.Reader {
 	appTarReader, appWriter := io.Pipe()
 	gWriter := gzip.NewWriter(appWriter)

pkg/airgap/testfiles/tiny-airgap-noimages/airgap.yaml

@@ -15,4 +15,5 @@ spec:
   signature: PQ4Zs4e4g1sgrd1lYog2i23+ixbDXX3NancOcDdK+JqD1S4elmkHhsGIUazIl15rL4YuJQdzeem0geK14PKADN+0YLzvEVm9Gw1Coq+y3ZDpUn2+On7caK4k1vckAEbomUDw7Cm5AGxYDFPiz4iC+OnKmFYdfU8FqSNT0iMUxjTvBLdlIf9VOh5wsbi5J511UCEv2Ht9UexcNGobgolrC5AUWKAvbH4mGxnSXVRSHjXtsAJaIw/Aw0RdQ830AIaTEz+L+qbgwasQG7lExkaQz2dEbywPP2nL9ZiyCOIAsjaKiclGx8HzKDCk7Womt4+WOfusqyk6mUFe/EflX/l2TA==
   updateCursor: "1"
   versionLabel: 0.1.0
+  uncompressedSize: 1234567890
 status: {}