Merge remote-tracking branch 'origin/main' into HEAD

Author: briandealwis

CHANGELOG.md

@@ -1,3 +1,59 @@
+# v1.34.0 Release - 10/26/2021
+**Linux**
+`curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/v1.34.0/skaffold-linux-amd64 && chmod +x skaffold && sudo mv skaffold /usr/local/bin`
+
+**macOS**
+`curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/v1.34.0/skaffold-darwin-amd64 && chmod +x skaffold && sudo mv skaffold /usr/local/bin`
+
+**Windows**
+https://storage.googleapis.com/skaffold/releases/v1.34.0/skaffold-windows-amd64.exe
+
+**Docker image**
+`gcr.io/k8s-skaffold/skaffold:v1.34.0`
+
+Note: This release comes with a new config version, `v2beta25`. To upgrade your skaffold.yaml, use `skaffold fix`. If you choose not to upgrade, skaffold will auto-upgrade as best as it can.
+
+Highlights:
+* `skaffold deploy`, `skaffold render` and `skaffold test` now support the `--images` flag for providing a list of images to run against.
+* The `--images` flag now supports `NAME=TAG` pairs.
+
+New Features and Additions:
+* feat: trap SIGUSR1 to dump current stacktrace [#6751](https://github.com/GoogleContainerTools/skaffold/pull/6751)
+* feat: skaffold lint core logic, CLI command+flags, and MVP skaffold.yaml support [#6715](https://github.com/GoogleContainerTools/skaffold/pull/6715)
+
+Fixes:
+* fix: fix non-determinism in skaffoldyamls_test.go [#6757](https://github.com/GoogleContainerTools/skaffold/pull/6757)
+* fix: use new stringslice lib [#6752](https://github.com/GoogleContainerTools/skaffold/pull/6752)
+* fix: correctly rewrite debug container entrypoint and bind host port [#6682](https://github.com/GoogleContainerTools/skaffold/pull/6682)
+* Fix new version generation [#6616](https://github.com/GoogleContainerTools/skaffold/pull/6616)
+* fix: panic caused by multiple channel closes [#6714](https://github.com/GoogleContainerTools/skaffold/pull/6714)
+* fix: sanity check kpt deployer versions [#6711](https://github.com/GoogleContainerTools/skaffold/pull/6711)
+
+Updates and Refactors:
+* refactor: move some of `pkg/skaffold/util` into into packages [#6731](https://github.com/GoogleContainerTools/skaffold/pull/6731)
+
+Docs, Test, and Release Updates:
+* doc: update CI-CD article to decouple `render` and `deploy` use from GitOps [#6750](https://github.com/GoogleContainerTools/skaffold/pull/6750)
+* chore: update image dependencies [#6736](https://github.com/GoogleContainerTools/skaffold/pull/6736)
+* chore: use ad-hoc signing on darwin to avoid network popups [#6738](https://github.com/GoogleContainerTools/skaffold/pull/6738)
+* chore: add cluster type to the instrumentation meter [#6734](https://github.com/GoogleContainerTools/skaffold/pull/6734)
+* chore: Update globstar syntax in examples dependencies [#6614](https://github.com/GoogleContainerTools/skaffold/pull/6614)
+* docs: add Cloud Code install instructions [#6716](https://github.com/GoogleContainerTools/skaffold/pull/6716)
+
+Huge thanks goes out to all of our contributors for this release:
+
+- Aaron Prindle
+- Brian de Alwis
+- Conor A. Callahan
+- Dave Dorbin
+- Gaurav
+- Halvard Skogsrud
+- Marlon Gamez
+- Mike Verbanic
+- Nick Kubala
+- Tejal Desai
+- Yuwen Ma
+
 # v1.33.0 Release - 10/07/2021
 **Linux**
 `curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/v1.33.0/skaffold-linux-amd64 && chmod +x skaffold && sudo mv skaffold /usr/local/bin`

Makefile

@@ -77,6 +77,9 @@ $(BUILD_DIR)/$(PROJECT): $(STATIK_FILES) $(GO_FILES) $(BUILD_DIR)
 	$(eval tags = $(GO_BUILD_TAGS_$(GOOS)) $(GO_BUILD_TAGS_$(GOOS)_$(GOARCH)))
 	GOOS=$(GOOS) GOARCH=$(GOARCH) CGO_ENABLED=1 \
 	    go build -gcflags="all=-N -l" -tags "$(tags)" -ldflags "$(ldflags)" -o $@ $(BUILD_PACKAGE)
+ifeq ($(GOOS),darwin)
+	codesign --force --deep --sign - $@
+endif
 
 .PHONY: install
 install: $(BUILD_DIR)/$(PROJECT)

cmd/skaffold/app/cmd/cmd.go

@@ -195,6 +195,7 @@ func NewSkaffoldCommand(out, errOut io.Writer) *cobra.Command {
 	rootCmd.AddCommand(NewCmdGeneratePipeline())
 	rootCmd.AddCommand(NewCmdSurvey())
 	rootCmd.AddCommand(NewCmdInspect())
+	rootCmd.AddCommand(NewCmdLint())
 
 	templates.ActsAsRootCommand(rootCmd, nil, groups...)
 	rootCmd.PersistentFlags().StringVarP(&v, "verbosity", "v", log.DefaultLogLevel.String(), fmt.Sprintf("Log level: one of %v", log.AllLevels))

cmd/skaffold/app/cmd/deploy.go

@@ -22,18 +22,13 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/GoogleContainerTools/skaffold/cmd/skaffold/app/flags"
 	"github.com/GoogleContainerTools/skaffold/cmd/skaffold/app/tips"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/graph"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/runner"
 	latestV1 "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest/v1"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/util"
 )
 
-var (
-	preBuiltImages flags.Images
-)
-
 // NewCmdDeploy describes the CLI command to deploy artifacts.
 func NewCmdDeploy() *cobra.Command {
 	return NewCmd("deploy").
@@ -44,7 +39,6 @@ func NewCmdDeploy() *cobra.Command {
 		WithExample("Deploy without first rendering the manifests", "deploy --skip-render").
 		WithCommonFlags().
 		WithFlags([]*Flag{
-			{Value: &preBuiltImages, Name: "images", Shorthand: "i", DefValue: nil, Usage: "A list of pre-built images to deploy"},
 			{Value: &opts.SkipRender, Name: "skip-render", DefValue: false, Usage: "Don't render the manifests, just deploy them", IsEnum: true},
 		}).
 		WithHouseKeepingMessages().

cmd/skaffold/app/cmd/flags.go

@@ -32,6 +32,7 @@ import (
 
 var (
 	fromBuildOutputFile flags.BuildOutputFileFlag
+	preBuiltImages      flags.Images
 )
 
 // Nillable is used to reset objects that implement pflag's `Value` and `SliceValue`.
@@ -180,7 +181,7 @@ var flagRegistry = []Flag{
 	},
 	{
 		Name:          "wait-for-connection",
-		Usage:         "Blocks execution until the /v2/events gRPC/HTTP endpoint is hit",
+		Usage:         "Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit",
 		Value:         &opts.WaitForConnection,
 		DefValue:      false,
 		FlagAddMethod: "BoolVar",
@@ -529,8 +530,19 @@ var flagRegistry = []Flag{
 		Value:         &fromBuildOutputFile,
 		DefValue:      "",
 		FlagAddMethod: "Var",
-		DefinedOn:     []string{"test", "deploy"},
+		DefinedOn:     []string{"deploy", "render", "test"},
 	},
+
+	{
+		Name:          "images",
+		Shorthand:     "i",
+		Usage:         "A list of pre-built images to deploy, either tagged images or NAME=TAG pairs",
+		Value:         &preBuiltImages,
+		DefValue:      nil,
+		FlagAddMethod: "Var",
+		DefinedOn:     []string{"deploy", "render", "test"},
+	},
+
 	{
 		Name:          "auto-create-config",
 		Usage:         "If true, skaffold will try to create a config for the user's run if it doesn't find one",
@@ -569,7 +581,8 @@ var flagRegistry = []Flag{
 			"run": true,
 		},
 		IsEnum: true,
-	}, {
+	},
+	{
 		Name:          "load-images",
 		Usage:         "If true, skaffold will force load the container images into the local cluster.",
 		Value:         &opts.ForceLoadImages,

cmd/skaffold/app/cmd/lint.go

@@ -0,0 +1,49 @@
+/*
+Copyright 2021 The Skaffold 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 cmd
+
+import (
+	"context"
+	"io"
+
+	"github.com/spf13/cobra"
+
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/lint"
+)
+
+var outFormat string
+
+func NewCmdLint() *cobra.Command {
+	return NewCmd("lint").
+		WithDescription("Lints skaffold app skaffold.yaml(s) to improve skaffold's - user-experience, performance, etc..").
+		WithCommonFlags().
+		WithFlags([]*Flag{
+			{Value: &outFormat, Name: "format", DefValue: lint.PlainTextOutput,
+				Usage: "Output format. One of: plain-text(default) or json"}}).
+		Hidden().
+		NoArgs(lintCmd)
+}
+
+func lintCmd(ctx context.Context, out io.Writer) error {
+	return lint.Lint(ctx, out, lint.Options{
+		Filename:     opts.ConfigurationFile,
+		RepoCacheDir: opts.RepoCacheDir,
+		OutFormat:    outFormat,
+		Modules:      opts.ConfigurationFilter,
+		Profiles:     opts.Profiles,
+	})
+}

cmd/skaffold/app/cmd/render.go

@@ -24,17 +24,15 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/GoogleContainerTools/skaffold/cmd/skaffold/app/flags"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/graph"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/runner"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/util"
 )
 
 var (
-	showBuild                 bool
-	renderOutputPath          string
-	renderFromBuildOutputFile flags.BuildOutputFileFlag
-	offline                   bool
+	showBuild        bool
+	renderOutputPath string
+	offline          bool
 )
 
 // NewCmdRender describes the CLI command to build artifacts render Kubernetes manifests.
@@ -45,7 +43,6 @@ func NewCmdRender() *cobra.Command {
 		WithCommonFlags().
 		WithFlags([]*Flag{
 			{Value: &showBuild, Name: "loud", DefValue: false, Usage: "Show the build logs and output", IsEnum: true},
-			{Value: &renderFromBuildOutputFile, Name: "build-artifacts", Shorthand: "a", Usage: "File containing build result from a previous 'skaffold build --file-output'"},
 			{Value: &offline, Name: "offline", DefValue: false, Usage: `Do not connect to Kubernetes API server for manifest creation and validation. This is helpful when no Kubernetes cluster is available (e.g. GitOps model). No metadata.namespace attribute is injected in this case - the manifest content does not get changed.`, IsEnum: true},
 			{Value: &renderOutputPath, Name: "output", Shorthand: "o", DefValue: "", Usage: "File to write rendered manifests to"},
 		}).
@@ -62,11 +59,15 @@ func doRender(ctx context.Context, out io.Writer) error {
 
 	return withRunner(ctx, out, func(r runner.Runner, configs []util.VersionedConfig) error {
 		var bRes []graph.Artifact
+		var err error
 
-		if renderFromBuildOutputFile.String() != "" {
-			bRes = renderFromBuildOutputFile.BuildArtifacts()
+		if fromBuildOutputFile.String() != "" || len(preBuiltImages.GetSlice()) > 0 {
+			// pass `nil` as render shouldn't build if provided --build-artifacts or --images
+			bRes, err = getBuildArtifactsAndSetTags(nil, r.ApplyDefaultRepo)
+			if err != nil {
+				return fmt.Errorf("loading artifacts: %w", err)
+			}
 		} else {
-			var err error
 			bRes, err = r.Build(ctx, buildOut, targetArtifacts(opts, configs))
 			if err != nil {
 				return fmt.Errorf("executing build: %w", err)

cmd/skaffold/app/flags/image.go

@@ -122,6 +122,16 @@ func convertImageToArtifact(value string) (*graph.Artifact, error) {
 	if value == "" {
 		return nil, errors.New("cannot add an empty image value")
 	}
+	if c := strings.SplitN(value, "=", 2); len(c) == 2 {
+		_, err := docker.ParseReference(c[1])
+		if err != nil {
+			return nil, err
+		}
+		return &graph.Artifact{
+			ImageName: c[0],
+			Tag:       c[1],
+		}, nil
+	}
 	parsed, err := docker.ParseReference(value)
 	if err != nil {
 		return nil, err

cmd/skaffold/app/flags/image_test.go

@@ -72,7 +72,15 @@ func TestImagesFlagSet(t *testing.T) {
 			},
 		},
 		{
-			description: "set errors with in-correct docker name",
+			description: "set with name=tag",
+			setValue:    "name=tag",
+			expectedArtifact: graph.Artifact{
+				ImageName: "name",
+				Tag:       "tag",
+			},
+		},
+		{
+			description: "set errors with invalid docker name",
 			setValue:    "docker_:!",
 			shouldErr:   true,
 		},
@@ -81,6 +89,11 @@ func TestImagesFlagSet(t *testing.T) {
 			setValue:    "",
 			shouldErr:   true,
 		},
+		{
+			description: "set errors with invalid docker name-tag pair",
+			setValue:    "name=docker_:!",
+			shouldErr:   true,
+		},
 	}
 	for _, test := range tests {
 		testutil.Run(t, test.description, func(t *testutil.T) {
@@ -121,8 +134,8 @@ func TestImagesString(t *testing.T) {
 	flag.SetNil()
 	testutil.CheckDeepEqual(t, "", flag.String())
 
-	flag.Set("gcr.io/test/test-image:test,gcr.io/test/test-image-1:test")
-	testutil.CheckDeepEqual(t, "gcr.io/test/test-image:test,gcr.io/test/test-image-1:test", flag.String())
+	flag.Set("gcr.io/test/test-image:test,gcr.io/test/test-image-1:test,name=tag")
+	testutil.CheckDeepEqual(t, "gcr.io/test/test-image:test,gcr.io/test/test-image-1:test,name=tag", flag.String())
 }
 
 func TestImagesType(t *testing.T) {

cmd/skaffold/app/skaffold.go

@@ -32,6 +32,7 @@ func Run(out, stderr io.Writer) error {
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 
+	catchStackdumpRequests()
 	catchCtrlC(cancel)
 
 	c := cmd.NewSkaffoldCommand(out, stderr)

cmd/skaffold/app/stackdump.go

@@ -0,0 +1,46 @@
+//go:build !windows
+// +build !windows
+
+/*
+Copyright 2021 The Skaffold 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 app
+
+import (
+	"fmt"
+	"os"
+	"os/signal"
+	"runtime"
+	"syscall"
+)
+
+func catchStackdumpRequests() {
+	signals := make(chan os.Signal, 1)
+	signal.Notify(signals,
+		syscall.SIGUSR1,
+	)
+
+	go func() {
+		for {
+			<-signals
+			buf := make([]byte, 1<<20)
+			runtime.Stack(buf, true)
+			os.Stderr.Write([]byte(fmt.Sprintf("---stacktraces begin: %v---\n", os.Args)))
+			os.Stderr.Write(buf)
+			os.Stderr.Write([]byte(fmt.Sprintf("---stacktraces end: %v---\n", os.Args)))
+		}
+	}()
+}

cmd/skaffold/app/stackdump_windows.go

@@ -0,0 +1,24 @@
+//go:build windows
+// +build windows
+
+/*
+Copyright 2021 The Skaffold 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 app
+
+func catchStackdumpRequests() {
+	// ignored on Windows
+}

deploy/skaffold/Dockerfile

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 # This base image has to be updated manually after running `make build_deps`
-FROM gcr.io/k8s-skaffold/build_deps:e34c0c143e9fe6c39a4f119547289d7142afcb0d as build
+FROM gcr.io/k8s-skaffold/build_deps:cc22ba3ccc5e3f854b540493fc781f7c5a4f5ece as build
 WORKDIR /skaffold
 
 FROM build as builder