include k0s images within metadata output (#439)

* include k0s images within metadata output

* what happens if we use the cluster config from the compiled library

* break up 'build' and 'export metadata' github steps

* f

* 'go get' k0s when updating binary import

* do not zero out images

* validate test

* the test worked

* ensure k0s go mod version matches at build time

Author: laverya

.github/workflows/dependencies.yaml

@@ -11,6 +11,10 @@ jobs:
     steps:
     - name: Check out repo
       uses: actions/checkout@v4
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: "1.21"
     - name: AdminConsole
       run: |
         export VERSION=`curl https://api.github.com/repos/replicatedhq/kots-helm/tags | jq -r .[].name | grep -v alpha | head -1 | tr -d v`
@@ -35,6 +39,7 @@ jobs:
         if [ "$CURVERSION" != "$VERSION" ]; then
           sed -i "/^K0S_VERSION/c\K0S_VERSION = $VERSION" Makefile
           sed -i "/^K0S_BINARY_SOURCE_OVERRIDE/c\K0S_BINARY_SOURCE_OVERRIDE =" Makefile
+          go get github.com/k0sproject/k0s@${VERSION}
         fi
     - name: Troubleshoot
       run: |

.github/workflows/pull-request.yaml

@@ -53,6 +53,8 @@ jobs:
     - name: Build Linux AMD64
       run: |
         make embedded-cluster-linux-amd64 VERSION=dev-$SHORT_SHA
+    - name: Output Metadata
+      run: |
         ./output/bin/embedded-cluster version metadata > metadata.json
     - name: Install Replicated CLI
       run: |

.github/workflows/release-dev.yaml

@@ -21,6 +21,8 @@ jobs:
         run: |
           make embedded-cluster-linux-amd64
           tar -C output/bin -czvf embedded-cluster-linux-amd64.tgz embedded-cluster
+      - name: Output Metadata
+        run: |
           ./output/bin/embedded-cluster version metadata > metadata.json
       - name: Publish development release
         uses: marvinpinto/action-automatic-releases@latest

.github/workflows/release-prod.yaml

@@ -23,6 +23,8 @@ jobs:
         run: |
           make embedded-cluster-linux-amd64 VERSION=$TAG_NAME
           tar -C output/bin -czvf embedded-cluster-linux-amd64.tgz embedded-cluster
+      - name: Output Metadata
+        run: |
           ./output/bin/embedded-cluster version metadata > metadata.json
       - name: Cache Staging Files
         env:

Makefile

@@ -81,20 +81,24 @@ output/bin/embedded-cluster-release-builder:
 embedded-release: embedded-cluster-linux-amd64 output/tmp/release.tar.gz output/bin/embedded-cluster-release-builder
 	./output/bin/embedded-cluster-release-builder output/bin/embedded-cluster output/tmp/release.tar.gz output/bin/embedded-cluster
 
+go.mod: Makefile
+	go get github.com/k0sproject/k0s@$(K0S_VERSION)
+	go mod tidy
+
 .PHONY: static
 static: pkg/goods/bins/k0s \
 	pkg/goods/bins/kubectl-preflight \
 	pkg/goods/bins/kubectl \
 	pkg/goods/bins/kubectl-support_bundle
 
 .PHONY: embedded-cluster-linux-amd64
-embedded-cluster-linux-amd64: static
+embedded-cluster-linux-amd64: static go.mod
 	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "$(LD_FLAGS)" -o ./output/bin/$(APP_NAME) ./cmd/embedded-cluster
 
 # for testing
-.PHONY: embedded-cluster-darwin-amd64
-embedded-cluster-darwin-amd64:
-	CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags "$(LD_FLAGS)" -o ./output/bin/$(APP_NAME) ./cmd/embedded-cluster
+.PHONY: embedded-cluster-darwin-arm64
+embedded-cluster-darwin-arm64: go.mod
+	CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags "$(LD_FLAGS)" -o ./output/bin/$(APP_NAME) ./cmd/embedded-cluster
 
 .PHONY: unit-tests
 unit-tests:

cmd/embedded-cluster/install.go

@@ -162,18 +162,15 @@ func checkLicenseMatches(c *cli.Context) error {
 // createK0sConfig creates a new k0s.yaml configuration file. The file is saved in the
 // global location (as returned by defaults.PathToK0sConfig()). If a file already sits
 // there, this function returns an error.
-func ensureK0sConfig(c *cli.Context, useprompt bool) error {
+func ensureK0sConfig(c *cli.Context) error {
 	cfgpath := defaults.PathToK0sConfig()
 	if _, err := os.Stat(cfgpath); err == nil {
 		return fmt.Errorf("configuration file already exists")
 	}
 	if err := os.MkdirAll(filepath.Dir(cfgpath), 0755); err != nil {
 		return fmt.Errorf("unable to create directory: %w", err)
 	}
-	cfg, err := config.RenderK0sConfig(c.Context)
-	if err != nil {
-		return fmt.Errorf("unable to render config: %w", err)
-	}
+	cfg := config.RenderK0sConfig()
 	opts := []addons.Option{}
 	if c.Bool("no-prompt") {
 		opts = append(opts, addons.WithoutPrompt())
@@ -188,6 +185,7 @@ func ensureK0sConfig(c *cli.Context, useprompt bool) error {
 	if err := config.UpdateHelmConfigs(cfg, opts...); err != nil {
 		return fmt.Errorf("unable to update helm configs: %w", err)
 	}
+	var err error
 	if cfg, err = applyUnsupportedOverrides(c, cfg); err != nil {
 		return fmt.Errorf("unable to apply unsupported overrides: %w", err)
 	}
@@ -357,7 +355,7 @@ var installCommand = &cli.Command{
 			return err
 		}
 		logrus.Debugf("creating k0s configuration file")
-		if err := ensureK0sConfig(c, !c.Bool("no-prompt")); err != nil {
+		if err := ensureK0sConfig(c); err != nil {
 			err := fmt.Errorf("unable to create config file: %w", err)
 			metrics.ReportApplyFinished(c, err)
 			return err

cmd/embedded-cluster/types/types.go

@@ -8,6 +8,7 @@ type ReleaseMetadata struct {
 	Versions     map[string]string
 	K0sSHA       string
 	K0sBinaryURL string
+	K0sImages    []string
 	Configs      v1beta1.HelmExtensions
 	Protected    map[string][]string
 }

cmd/embedded-cluster/version.go

@@ -3,14 +3,15 @@ package main
 import (
 	"encoding/json"
 	"fmt"
-	"github.com/replicatedhq/embedded-cluster/cmd/embedded-cluster/types"
 	"sort"
 	"strings"
 
 	"github.com/jedib0t/go-pretty/table"
+	"github.com/k0sproject/k0s/pkg/airgap"
+	k0sconfig "github.com/k0sproject/k0s/pkg/apis/k0s/v1beta1"
 	"github.com/urfave/cli/v2"
 
-	k0sconfig "github.com/k0sproject/k0s/pkg/apis/k0s/v1beta1"
+	"github.com/replicatedhq/embedded-cluster/cmd/embedded-cluster/types"
 	"github.com/replicatedhq/embedded-cluster/pkg/addons"
 	"github.com/replicatedhq/embedded-cluster/pkg/config"
 	"github.com/replicatedhq/embedded-cluster/pkg/defaults"
@@ -96,6 +97,14 @@ var metadataCommand = &cli.Command{
 			return fmt.Errorf("unable to get protected fields: %w", err)
 		}
 		meta.Protected = protectedFields
+
+		// Render k0s config to get the images contained within
+		k0sConfig := config.RenderK0sConfig()
+		if err != nil {
+			return fmt.Errorf("unable to render k0s config: %w", err)
+		}
+		meta.K0sImages = airgap.GetImageURIs(k0sConfig.Spec, true)
+
 		data, err := json.MarshalIndent(meta, "", "\t")
 		if err != nil {
 			return fmt.Errorf("unable to marshal versions: %w", err)

e2e/version_test.go

@@ -64,6 +64,22 @@ func TestVersion(t *testing.T) {
 		}
 	}
 
+	expectedImageSubstrings := []string{"coredns", "calico-cni", "metrics-server", "pause", "envoy"}
+	for _, v := range expectedImageSubstrings {
+		found := false
+
+		for _, image := range parsed.K0sImages {
+			if strings.Contains(image, v) {
+				found = true
+				break
+			}
+		}
+		if !found {
+			t.Errorf("missing image substring %q in image metadata output", v)
+			failed = true
+		}
+	}
+
 	for _, foundChart := range parsed.Configs.Charts {
 		if strings.Contains(foundChart.Values, "embeddedClusterID") {
 			t.Errorf("metadata output for chart %s contains embeddedClusterID", foundChart.Name)

go.mod

@@ -11,15 +11,17 @@ require (
 	github.com/gosimple/slug v1.14.0
 	github.com/jedib0t/go-pretty v4.3.0+incompatible
 	github.com/k0sproject/dig v0.2.0
+	github.com/k0sproject/k0s v1.29.3-0.20240220215935-6a63dc9024ce
 	github.com/replicatedhq/embedded-cluster-operator v0.24.1
-	github.com/replicatedhq/embedded-cluster-utils v0.0.0-20240214185439-68a1dfae58be
+	github.com/replicatedhq/embedded-cluster-utils v0.0.0-20240308200300-87d150770db8
 	github.com/replicatedhq/kotskinds v0.0.0-20230724164735-f83482cc9cfe
 	github.com/replicatedhq/troubleshoot v0.83.0
 	github.com/sirupsen/logrus v1.9.3
 	github.com/stretchr/testify v1.9.0
 	github.com/urfave/cli/v2 v2.27.1
 	golang.org/x/term v0.18.0
 	gopkg.in/yaml.v2 v2.4.0
+	gopkg.in/yaml.v3 v3.0.1
 	k8s.io/api v0.29.2
 	k8s.io/apimachinery v0.29.2
 	sigs.k8s.io/controller-runtime v0.17.2
@@ -33,7 +35,7 @@ require (
 	github.com/coreos/go-semver v0.3.1 // indirect
 	github.com/coreos/go-systemd/v22 v22.5.0 // indirect
 	github.com/cyphar/filepath-securejoin v0.2.4 // indirect
-	github.com/frankban/quicktest v1.14.5 // indirect
+	github.com/frankban/quicktest v1.14.6 // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/google/go-cmp v0.6.0 // indirect
@@ -50,18 +52,18 @@ require (
 	github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
 	github.com/xeipuuv/gojsonschema v1.2.0 // indirect
-	go.etcd.io/etcd/api/v3 v3.5.10 // indirect
-	go.etcd.io/etcd/client/pkg/v3 v3.5.10 // indirect
-	go.etcd.io/etcd/client/v3 v3.5.10 // indirect
-	golang.org/x/crypto v0.19.0 // indirect
+	go.etcd.io/etcd/api/v3 v3.5.12 // indirect
+	go.etcd.io/etcd/client/pkg/v3 v3.5.12 // indirect
+	go.etcd.io/etcd/client/v3 v3.5.12 // indirect
+	golang.org/x/crypto v0.21.0 // indirect
 	golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa // indirect
 	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
 	google.golang.org/genproto v0.0.0-20231106174013-bbf56f31fb17 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20231106174013-bbf56f31fb17 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20231120223509-83a465c0220f // indirect
-	google.golang.org/grpc v1.59.0 // indirect
-	helm.sh/helm/v3 v3.14.0 // indirect
-	k8s.io/component-base v0.29.0 // indirect
+	google.golang.org/grpc v1.60.1 // indirect
+	helm.sh/helm/v3 v3.14.1 // indirect
+	k8s.io/component-base v0.29.2 // indirect
 )
 
 require (
@@ -78,10 +80,10 @@ require (
 	github.com/go-macaroon-bakery/macaroon-bakery/v3 v3.0.1 // indirect
 	github.com/go-macaroon-bakery/macaroonpb v1.0.0 // indirect
 	github.com/go-openapi/errors v0.20.3 // indirect
-	github.com/go-openapi/jsonpointer v0.20.0 // indirect
+	github.com/go-openapi/jsonpointer v0.20.2 // indirect
 	github.com/go-openapi/jsonreference v0.20.2 // indirect
 	github.com/go-openapi/strfmt v0.21.7 // indirect
-	github.com/go-openapi/swag v0.22.4 // indirect
+	github.com/go-openapi/swag v0.22.5 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/gnostic-models v0.6.8 // indirect
@@ -96,7 +98,6 @@ require (
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/juju/webbrowser v1.0.0 // indirect
 	github.com/julienschmidt/httprouter v1.3.0 // indirect
-	github.com/k0sproject/k0s v1.28.5-0.20231116142149-82f76181191c
 	github.com/k0sproject/version v0.6.0 // indirect
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
 	github.com/kr/fs v0.1.0 // indirect
@@ -128,7 +129,7 @@ require (
 	go.mongodb.org/mongo-driver v1.11.3 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	go.uber.org/zap v1.26.0 // indirect
-	golang.org/x/net v0.20.0 // indirect
+	golang.org/x/net v0.21.0 // indirect
 	golang.org/x/oauth2 v0.15.0 // indirect
 	golang.org/x/sys v0.18.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
@@ -140,8 +141,7 @@ require (
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/macaroon.v2 v2.1.0 // indirect
 	gopkg.in/square/go-jose.v2 v2.6.0 // indirect
-	gopkg.in/yaml.v3 v3.0.1
-	k8s.io/apiextensions-apiserver v0.29.0 // indirect
+	k8s.io/apiextensions-apiserver v0.29.2 // indirect
 	k8s.io/client-go v0.29.2 // indirect
 	k8s.io/klog/v2 v2.120.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20231113174909-778a5567bc1e // indirect