Merge pull request #3664 from twz123/no-envoy-image-in-config

Only include envoy image in default config if images should be included

cmd/config/create.go

@@ -36,6 +36,7 @@ func NewCreateCmd() *cobra.Command {
 			config := v1beta1.DefaultClusterConfig()
 			if !includeImages {
 				config.Spec.Images = nil
+				config.Spec.Network.NodeLocalLoadBalancing.EnvoyProxy.Image = nil
 			}
 
 			cfg, err := yaml.Marshal(config)

cmd/config/create_test.go

@@ -0,0 +1,65 @@
+/*
+Copyright 2023 k0s authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package config_test
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/k0sproject/k0s/cmd/config"
+)
+
+func TestCreateCmd_Images(t *testing.T) {
+	for _, test := range []struct {
+		name  string
+		args  []string
+		check func(t *testing.T, cfg, needle string)
+	}{
+		{
+			"default", []string{},
+			func(t *testing.T, cfg, needle string) { t.Helper(); assert.NotContains(t, cfg, needle) },
+		},
+
+		{
+			"include_images", []string{"--include-images"},
+			func(t *testing.T, cfg, needle string) { t.Helper(); assert.Contains(t, cfg, needle) },
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			underTest := config.NewCreateCmd()
+
+			var out strings.Builder
+			var err strings.Builder
+			underTest.SetArgs(test.args)
+			underTest.SetOut(&out)
+			underTest.SetErr(&err)
+
+			assert.NoError(t, underTest.Execute())
+
+			assert.Empty(t, err.String(), "Something has been written to stderr")
+			// This is a very broad check if there's some ImageSpec in the output. May
+			// produce false positives if something similar gets added to the config in
+			// the future. Can be refined then.
+			cfg := out.String()
+			test.check(t, cfg, "quay.io/k0sproject")
+			test.check(t, cfg, "image: ")
+			test.check(t, cfg, "version: ")
+		})
+	}
+}

docs/configuration.md

@@ -95,9 +95,6 @@ spec:
       enabled: false
       envoyProxy:
         apiServerBindPort: 7443
-        image:
-          image: docker.io/envoyproxy/envoy-distroless
-          version: v1.24.1
         konnectivityServerBindPort: 7132
       type: EnvoyProxy
     podCIDR: 10.244.0.0/16

pkg/apis/k0s/v1beta1/nllb.go

@@ -116,7 +116,7 @@ func (n *NodeLocalLoadBalancing) IsEnabled() bool {
 type EnvoyProxy struct {
 	// image specifies the OCI image that's being used for the Envoy Pod.
 	// +optional
-	Image *ImageSpec `json:"image"`
+	Image *ImageSpec `json:"image,omitempty"`
 
 	// imagePullPolicy specifies the pull policy being used for the Envoy Pod.
 	// Defaults to the default image pull policy.