pass embedded cluster artifacts in upstream upgrade

Author: Craig O'Donnell

go.mod

@@ -49,7 +49,7 @@ require (
 	github.com/pkg/errors v0.9.1
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2
 	github.com/replicatedhq/embedded-cluster-kinds v1.1.2
-	github.com/replicatedhq/kotskinds v0.0.0-20240326213823-6a0ed11e7397
+	github.com/replicatedhq/kotskinds v0.0.0-20240402213802-a6d75e97be70
 	github.com/replicatedhq/kurlkinds v1.5.0
 	github.com/replicatedhq/troubleshoot v0.87.0
 	github.com/replicatedhq/yaml/v3 v3.0.0-beta5-replicatedhq

go.sum

@@ -1310,6 +1310,8 @@ github.com/replicatedhq/embedded-cluster-kinds v1.1.2 h1:2ITzcUzh5uh0fsnfZsVHvkw
 github.com/replicatedhq/embedded-cluster-kinds v1.1.2/go.mod h1:LheSDOgMngMRAbwAj0sVZUVv2ciKIVR2bYTMeOBGwlg=
 github.com/replicatedhq/kotskinds v0.0.0-20240326213823-6a0ed11e7397 h1:JNuBcFH9D3Osyi+1QUwdvaAklEd6HXznqZDfpWlr73M=
 github.com/replicatedhq/kotskinds v0.0.0-20240326213823-6a0ed11e7397/go.mod h1:QjhIUu3+OmHZ09u09j3FCoTt8F3BYtQglS+OLmftu9I=
+github.com/replicatedhq/kotskinds v0.0.0-20240402213802-a6d75e97be70 h1:55fMr60YysSf+ac5zeW+xTIIJ8edUpAjorQyFn0iP2c=
+github.com/replicatedhq/kotskinds v0.0.0-20240402213802-a6d75e97be70/go.mod h1:QjhIUu3+OmHZ09u09j3FCoTt8F3BYtQglS+OLmftu9I=
 github.com/replicatedhq/kurlkinds v1.5.0 h1:zZ0PKNeh4kXvSzVGkn62DKTo314GxhXg1TSB3azURMc=
 github.com/replicatedhq/kurlkinds v1.5.0/go.mod h1:rUpBMdC81IhmJNCWMU/uRsMETv9P0xFoMvdSP/TAr5A=
 github.com/replicatedhq/termui/v3 v3.1.1-0.20200811145416-f40076d26851 h1:eRlNDHxGfVkPCRXbA4BfQJvt5DHjFiTtWy3R/t4djyY=

pkg/embeddedcluster/util.go

@@ -5,11 +5,13 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"path/filepath"
 	"regexp"
 	"sort"
 	"time"
 
 	embeddedclusterv1beta1 "github.com/replicatedhq/embedded-cluster-kinds/apis/v1beta1"
+	"github.com/replicatedhq/kots/pkg/imageutil"
 	"github.com/replicatedhq/kots/pkg/k8sutil"
 	"github.com/replicatedhq/kots/pkg/logger"
 	kotsv1beta1 "github.com/replicatedhq/kotskinds/apis/kots/v1beta1"
@@ -171,3 +173,21 @@ func startClusterUpgrade(ctx context.Context, newcfg embeddedclusterv1beta1.Conf
 	}
 	return nil
 }
+
+type EmbeddedClusterArtifactOCIPathOptions struct {
+	RegistryHost      string
+	RegistryNamespace string
+	ChannelID         string
+	UpdateCursor      string
+	VersionLabel      string
+}
+
+// EmbeddedClusterArtifactOCIPath returns the OCI path for an embedded cluster artifact given
+// the artifact filename and details about the configured registry and channel release.
+func EmbeddedClusterArtifactOCIPath(filename string, opts EmbeddedClusterArtifactOCIPathOptions) string {
+	name := filepath.Base(filename)
+	repository := filepath.Join("embedded-cluster", imageutil.SanitizeRepo(name))
+	tag := imageutil.SanitizeTag(fmt.Sprintf("%s-%s-%s", opts.ChannelID, opts.UpdateCursor, opts.VersionLabel))
+	artifact := fmt.Sprintf("%s:%s", filepath.Join(opts.RegistryHost, opts.RegistryNamespace, repository), tag)
+	return artifact
+}

pkg/pull/pull.go

@@ -216,6 +216,7 @@ func Pull(upstreamURI string, pullOptions PullOptions) (string, error) {
 		fetchOptions.CurrentVersionIsRequired = installation.Spec.IsRequired
 		fetchOptions.CurrentReplicatedRegistryDomain = installation.Spec.ReplicatedRegistryDomain
 		fetchOptions.CurrentReplicatedProxyDomain = installation.Spec.ReplicatedProxyDomain
+		fetchOptions.CurrentEmbeddedClusterArtifacts = installation.Spec.EmbeddedClusterArtifacts
 	}
 
 	if pullOptions.AirgapRoot != "" {

pkg/rewrite/rewrite.go

@@ -77,6 +77,7 @@ func Rewrite(rewriteOptions RewriteOptions) error {
 		CurrentReplicatedRegistryDomain: rewriteOptions.Installation.Spec.ReplicatedRegistryDomain,
 		CurrentReplicatedProxyDomain:    rewriteOptions.Installation.Spec.ReplicatedProxyDomain,
 		CurrentReplicatedChartNames:     rewriteOptions.Installation.Spec.ReplicatedChartNames,
+		CurrentEmbeddedClusterArtifacts: rewriteOptions.Installation.Spec.EmbeddedClusterArtifacts,
 		EncryptionKey:                   rewriteOptions.Installation.Spec.EncryptionKey,
 		License:                         rewriteOptions.License,
 		AppSequence:                     rewriteOptions.AppSequence,

pkg/upstream/fetch.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/kots/pkg/crypto"
+	"github.com/replicatedhq/kots/pkg/embeddedcluster"
 	"github.com/replicatedhq/kots/pkg/replicatedapp"
 	"github.com/replicatedhq/kots/pkg/upstream/types"
 	"github.com/replicatedhq/kots/pkg/util"
@@ -50,6 +51,7 @@ func downloadUpstream(upstreamURI string, fetchOptions *types.FetchOptions) (*ty
 			pickReplicatedRegistryDomain(fetchOptions),
 			pickReplicatedProxyDomain(fetchOptions),
 			pickReplicatedChartNames(fetchOptions),
+			pickEmbeddedClusterArtifacts(fetchOptions),
 			fetchOptions.AppSlug,
 			fetchOptions.AppSequence,
 			fetchOptions.Airgap != nil,
@@ -118,3 +120,22 @@ func pickReplicatedChartNames(fetchOptions *types.FetchOptions) []string {
 	}
 	return fetchOptions.CurrentReplicatedChartNames
 }
+
+func pickEmbeddedClusterArtifacts(fetchOptions *types.FetchOptions) []string {
+	if fetchOptions.Airgap != nil {
+		opts := embeddedcluster.EmbeddedClusterArtifactOCIPathOptions{
+			RegistryHost:      fetchOptions.LocalRegistry.Hostname,
+			RegistryNamespace: fetchOptions.LocalRegistry.Namespace,
+			ChannelID:         fetchOptions.Airgap.Spec.ChannelID,
+			UpdateCursor:      fetchOptions.Airgap.Spec.UpdateCursor,
+			VersionLabel:      fetchOptions.Airgap.Spec.VersionLabel,
+		}
+		return []string{
+			embeddedcluster.EmbeddedClusterArtifactOCIPath(fetchOptions.Airgap.Spec.EmbeddedClusterArtifacts.Binary, opts),
+			embeddedcluster.EmbeddedClusterArtifactOCIPath(fetchOptions.Airgap.Spec.EmbeddedClusterArtifacts.Charts, opts),
+			embeddedcluster.EmbeddedClusterArtifactOCIPath(fetchOptions.Airgap.Spec.EmbeddedClusterArtifacts.Images, opts),
+			embeddedcluster.EmbeddedClusterArtifactOCIPath(fetchOptions.Airgap.Spec.EmbeddedClusterArtifacts.Metadata, opts),
+		}
+	}
+	return fetchOptions.CurrentEmbeddedClusterArtifacts
+}

pkg/upstream/replicated.go

@@ -56,6 +56,7 @@ type Release struct {
 	ReplicatedRegistryDomain string
 	ReplicatedProxyDomain    string
 	ReplicatedChartNames     []string
+	EmbeddedClusterArtifacts []string
 	Manifests                map[string][]byte
 }
 
@@ -127,6 +128,7 @@ func downloadReplicated(
 	replicatedRegistryDomain string,
 	replicatedProxyDomain string,
 	replicatedChartNames []string,
+	embeddedClusterArtifacts []string,
 	appSlug string,
 	appSequence int64,
 	isAirgap bool,
@@ -138,7 +140,7 @@ func downloadReplicated(
 	var release *Release
 
 	if localPath != "" {
-		parsedLocalRelease, err := readReplicatedAppFromLocalPath(localPath, updateCursor, versionLabel, isRequired, replicatedRegistryDomain, replicatedProxyDomain, replicatedChartNames)
+		parsedLocalRelease, err := readReplicatedAppFromLocalPath(localPath, updateCursor, versionLabel, isRequired, replicatedRegistryDomain, replicatedProxyDomain, replicatedChartNames, embeddedClusterArtifacts)
 		if err != nil {
 			return nil, errors.Wrap(err, "failed to read replicated app from local path")
 		}
@@ -299,12 +301,13 @@ func downloadReplicated(
 		ReplicatedRegistryDomain: release.ReplicatedRegistryDomain,
 		ReplicatedProxyDomain:    release.ReplicatedProxyDomain,
 		ReplicatedChartNames:     release.ReplicatedChartNames,
+		EmbeddedClusterArtifacts: embeddedClusterArtifacts,
 	}
 
 	return upstream, nil
 }
 
-func readReplicatedAppFromLocalPath(localPath string, localCursor replicatedapp.ReplicatedCursor, versionLabel string, isRequired bool, replicatedRegistryDomain string, replicatedProxyDomain string, replicatedChartNames []string) (*Release, error) {
+func readReplicatedAppFromLocalPath(localPath string, localCursor replicatedapp.ReplicatedCursor, versionLabel string, isRequired bool, replicatedRegistryDomain string, replicatedProxyDomain string, replicatedChartNames []string, embeddedClusterArtifacts []string) (*Release, error) {
 	release := Release{
 		Manifests:                make(map[string][]byte),
 		UpdateCursor:             localCursor,
@@ -313,6 +316,7 @@ func readReplicatedAppFromLocalPath(localPath string, localCursor replicatedapp.
 		ReplicatedRegistryDomain: replicatedRegistryDomain,
 		ReplicatedProxyDomain:    replicatedProxyDomain,
 		ReplicatedChartNames:     replicatedChartNames,
+		EmbeddedClusterArtifacts: embeddedClusterArtifacts,
 	}
 
 	err := filepath.Walk(localPath,

pkg/upstream/types/types.go

@@ -37,6 +37,7 @@ type Upstream struct {
 	ReplicatedRegistryDomain string
 	ReplicatedProxyDomain    string
 	ReplicatedChartNames     []string
+	EmbeddedClusterArtifacts []string
 	EncryptionKey            string
 }
 
@@ -104,6 +105,7 @@ type FetchOptions struct {
 	CurrentReplicatedRegistryDomain string
 	CurrentReplicatedProxyDomain    string
 	CurrentReplicatedChartNames     []string
+	CurrentEmbeddedClusterArtifacts []string
 	ChannelChanged                  bool
 	AppSlug                         string
 	AppSequence                     int64

pkg/upstream/write.go

@@ -141,6 +141,7 @@ func WriteUpstream(u *types.Upstream, options types.WriteOptions) error {
 			ReplicatedRegistryDomain: u.ReplicatedRegistryDomain,
 			ReplicatedProxyDomain:    u.ReplicatedProxyDomain,
 			ReplicatedChartNames:     u.ReplicatedChartNames,
+			EmbeddedClusterArtifacts: u.EmbeddedClusterArtifacts,
 			EncryptionKey:            encryptionKey,
 		},
 	}