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

GoogleContainerTools · May 9, 2020 · 05c454a · 05c454a
2 parents 4ad52a0 + 58e72a6
commit 05c454a
Show file tree

Hide file tree

Showing 169 changed files with 3,311 additions and 1,689 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,135 @@
+# v1.9.1 Hotfix Release - 05/07/2020
+
+This is a hotfix release to address an issue with tailing logs while deploying with Helm, and to avoid an issue with authentication while building with Kaniko in GCB.
+
+* Revert "Only listen to pods for the current RunID" [#4122](https://github.com/GoogleContainerTools/skaffold/pull/4122)
+* Pin to kaniko v0.20.0 [#4128](https://github.com/GoogleContainerTools/skaffold/pull/4128)
+
+**Linux**
+`curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/v1.9.1/skaffold-linux-amd64 && chmod +x skaffold && sudo mv skaffold /usr/local/bin`
+
+**macOS**
+`curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/v1.9.1/skaffold-darwin-amd64 && chmod +x skaffold && sudo mv skaffold /usr/local/bin`
+
+**Windows**
+ https://storage.googleapis.com/skaffold/releases/v1.9.1/skaffold-windows-amd64.exe
+
+**Docker image**
+`gcr.io/k8s-skaffold/skaffold:v1.9.1`
+
+
+# v1.9.0 Release - 05/05/2020
+
+Note: This release comes with a new config version `v2beta3`. To upgrade your skaffold.yaml, use `skaffold fix`. If you choose not to upgrade, skaffold will auto-upgrade as best as it can.
+
+**Linux**
+`curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/v1.9.0/skaffold-linux-amd64 && chmod +x skaffold && sudo mv skaffold /usr/local/bin`
+
+**macOS**
+`curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/v1.9.0/skaffold-darwin-amd64 && chmod +x skaffold && sudo mv skaffold /usr/local/bin`
+
+**Windows**
+ https://storage.googleapis.com/skaffold/releases/v1.9.0/skaffold-windows-amd64.exe
+
+**Docker image**
+`gcr.io/k8s-skaffold/skaffold:v1.9.0`
+
+
+Highlights:
+* Skaffold should now correctly debug NodeJS applications!
+* Buildpacks now support Auto Sync, and debugging is enabled
+* `skaffold diagnose` takes a `--yaml-only` flag to print the effective skaffold.yaml
+* Git tagger now supports prefixing
+* Auto-activated profiles can now be disabled with `--profile-auto-activation`
+* Port-forwarding rules are now processed in sequence
+* `skaffold fix` now takes an optional target schema version
+* `skaffold build` now supports `--dry-run`
+* `skaffold survey` added to open our user-feedback survey
+* Added several fail fast conditions so initial errors are surfaced much quicker
+* Error messages are becoming much simpler - this is a WIP!
+
+New Features:
+* Add events to indicate start and end of skaffold dev iterations [#4037](https://github.com/GoogleContainerTools/skaffold/pull/4037)
+* Print the effective skaffold.yaml configuration [#4048](https://github.com/GoogleContainerTools/skaffold/pull/4048)
+* git tagger now supports an optional prefix [#4049](https://github.com/GoogleContainerTools/skaffold/pull/4049)
+* Support `skaffold fix —version skaffold/v1` [#4016](https://github.com/GoogleContainerTools/skaffold/pull/4016)
+* Add a dry-run to `skaffold build` [#4039](https://github.com/GoogleContainerTools/skaffold/pull/4039)
+* Add a new survey command to show Skaffold User Survey form url. [#3733](https://github.com/GoogleContainerTools/skaffold/pull/3733)
+* Add CLI option `--profile-auto-activation` to allow disabling automatic profile activation. [#4034](https://github.com/GoogleContainerTools/skaffold/pull/4034)
+* skaffold render --output takes GCS file path  [#3979](https://github.com/GoogleContainerTools/skaffold/pull/3979)
+* Add pod checks [#3952](https://github.com/GoogleContainerTools/skaffold/pull/3952)
+* First draft for adding actionable error items Framework [#4045](https://github.com/GoogleContainerTools/skaffold/pull/4045)
+* Add codes for error types and detect terminated containers [#4012](https://github.com/GoogleContainerTools/skaffold/pull/4012)
+* Buildpacks support Auto sync [#4079](https://github.com/GoogleContainerTools/skaffold/pull/4079)
+* Disable profiles with the command line [#4054](https://github.com/GoogleContainerTools/skaffold/pull/4054)
+
+Fixes:
+* `--dry-run=client` must replace `--dry-run=true` with kubectl >= 1.18 [#4096](https://github.com/GoogleContainerTools/skaffold/pull/4096)
+* fix status check event error reporting [#4101](https://github.com/GoogleContainerTools/skaffold/pull/4101)
+* Fix default-repo handling for `skaffold deploy` [#4074](https://github.com/GoogleContainerTools/skaffold/pull/4074)
+* Prevent the cache from sending “Build in progress” events. [#4038](https://github.com/GoogleContainerTools/skaffold/pull/4038)
+* Skip podspecs that already have a debug.cloud.google.com/config annotation [#4027](https://github.com/GoogleContainerTools/skaffold/pull/4027)
+* Always use the RunId overridden with an env var [#3985](https://github.com/GoogleContainerTools/skaffold/pull/3985)
+* Use Go 1.14.2 to prevent SIGILL: illegal instruction on macOS [#4009](https://github.com/GoogleContainerTools/skaffold/pull/4009)
+* Gracefully shutdown RPC servers. [#4010](https://github.com/GoogleContainerTools/skaffold/pull/4010)
+* When a tagger fails, use a fallback tagger [#4019](https://github.com/GoogleContainerTools/skaffold/pull/4019)
+* Support --default-repo=‘’ to erase the value from global config [#3990](https://github.com/GoogleContainerTools/skaffold/pull/3990)
+* Run container-structure-test on remote images [#3983](https://github.com/GoogleContainerTools/skaffold/pull/3983)
+* Fix nodemon versions [#4015](https://github.com/GoogleContainerTools/skaffold/pull/4015)
+* Fail when cache check should have succeeded [#3996](https://github.com/GoogleContainerTools/skaffold/pull/3996)
+* Fail fast if the Dockerfile can’t be found [#3999](https://github.com/GoogleContainerTools/skaffold/pull/3999)
+* [json schema] When we don’t know a field’s type, let’s leave it empty [#3964](https://github.com/GoogleContainerTools/skaffold/pull/3964)
+* ResourceType is of type string [#3987](https://github.com/GoogleContainerTools/skaffold/pull/3987)
+* Don’t replace existing labels [#4105](https://github.com/GoogleContainerTools/skaffold/pull/4105)
+
+Updates & Refactors:
+* Use `node` wrapper to debug NodeJS apps [#4086](https://github.com/GoogleContainerTools/skaffold/pull/4086)
+* add serviceAccount and runAsUser to kaniko build (resolves #3267) [#3965](https://github.com/GoogleContainerTools/skaffold/pull/3965)
+* Only listen to pods for the current RunID [#4097](https://github.com/GoogleContainerTools/skaffold/pull/4097)
+* Pin the version of Ko in Custom Example [#4099](https://github.com/GoogleContainerTools/skaffold/pull/4099)
+* Use NODEJS_VERSION and NODE_ENV in detection [#4021](https://github.com/GoogleContainerTools/skaffold/pull/4021)
+* Change default buildpacks [#4070](https://github.com/GoogleContainerTools/skaffold/pull/4070)
+* Handle port forwarding rules in sequence [#4053](https://github.com/GoogleContainerTools/skaffold/pull/4053)
+* Support Google Cloud Build logging options [#4043](https://github.com/GoogleContainerTools/skaffold/pull/4043)
+* Fail fast when k8s is not reachable [#4031](https://github.com/GoogleContainerTools/skaffold/pull/4031)
+* Fail fast if minikube is used but not started [#4042](https://github.com/GoogleContainerTools/skaffold/pull/4042)
+* Introduce v2beta3 [#4029](https://github.com/GoogleContainerTools/skaffold/pull/4029)
+* Update to Helm 3 in builder image [#4020](https://github.com/GoogleContainerTools/skaffold/pull/4020)
+* For upgrades, direct users to the GitHub release page [#4024](https://github.com/GoogleContainerTools/skaffold/pull/4024)
+* [kaniko] Better error message when upload fails [#4023](https://github.com/GoogleContainerTools/skaffold/pull/4023)
+* Initial draft for sending skaffold metrics using metadata event [#3966](https://github.com/GoogleContainerTools/skaffold/pull/3966)
+* Validate generated json schema [#3976](https://github.com/GoogleContainerTools/skaffold/pull/3976)
+* Changing test config invalidates the build cache [#3984](https://github.com/GoogleContainerTools/skaffold/pull/3984)
+* Simplify error messages [#3997](https://github.com/GoogleContainerTools/skaffold/pull/3997)
+
+Docs updates:
+* [doc] Explain how buildArgs are used by custom builder. [#4077](https://github.com/GoogleContainerTools/skaffold/pull/4077)
+* Add link-able anchors to skaffold.yaml docs [#4052](https://github.com/GoogleContainerTools/skaffold/pull/4052)
+* Clarify which containers log tailing works with [#4078](https://github.com/GoogleContainerTools/skaffold/pull/4078)
+* Update 2020 Roadmap [#3939](https://github.com/GoogleContainerTools/skaffold/pull/3939)
+* Improve GCB docs to include a table of properties [#3989](https://github.com/GoogleContainerTools/skaffold/pull/3989)
+* install docs: use "install" and "choco -y" [#3992](https://github.com/GoogleContainerTools/skaffold/pull/3992)
+* Add docs for configuring helm project with skaffold [#3973](https://github.com/GoogleContainerTools/skaffold/pull/3973)
+
+
+Huge thanks goes out to all of our contributors for this release:
+- Balint Pato
+- Brian de Alwis
+- Chanseok Oh
+- Chris Ge
+- Daniel Sel
+- David Gageot
+- Marcin
+- Max Goltzsche
+- Michael Parker
+- Nick Kubala
+- Pedro de Brito
+- Tejal Desai
+- Thomas Strömberg
+- gsquared94
+- knv srinivas
+
+
 # v1.8.0 Release - 04/17/2020
 
 Note: This release comes with a new config version `v2beta2`. To upgrade your skaffold.yaml, use `skaffold fix`. If you choose not to upgrade, skaffold will auto-upgrade as best as it can.

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -105,6 +105,10 @@ Once you've done this, merge or rebase your development branch with config chang
 
 For more details behind the logic of config changes see [the Skaffold config management doc](https://docs.google.com/document/d/e/2PACX-1vRIjLuHL2uZ1OXcV9ZXbOQ7ijmqmeCeOZroCGBGTgstuNaZqoKXwg0KLGt_M-PHBwoVpnsKUhHxJ3Jc/pub).
 
+## Making changes to the Skaffold API
+
+We build the API directly through gRPC, which gets translated into REST API through a reverse proxy gateway library. If you make changes to the [proto/skaffold.proto](https://github.com/GoogleContainerTools/skaffold/blob/master/proto/skaffold.proto) file you can run `./hack/generate-proto.sh` to generate the equivalent Go code. 
+
 ## Building skaffold
 
 To build with your local changes you have two options:

diff --git a/README.md b/README.md
@@ -17,138 +17,58 @@ provides building blocks and describe customizations for a CI/CD pipeline.
 
 ---------------------
 
-## Community
-
-**We'd love to hear from you!**
-
-* [skaffold-users mailing list](https://groups.google.com/forum/#!forum/skaffold-users)
-* [#skaffold on Kubernetes Slack](https://kubernetes.slack.com/messages/CABQMSZA6/)
-* [Give us Feedback](https://skaffold.dev/docs/resources/feedback/)
-
-**Office Hours** 
+## [Install Skaffold](https://skaffold.dev/docs/install/)
 
-Skaffold office hours are for The Skaffold Community. We want to provide an open forum for the Community to share
-   * How can we make Skaffold better as a community: design proposals, issues or concerns, questions, ideas 
-   * How can we make contributing to Skaffold better
-   * How you are using Skaffold - demo of features, integrations are welcome to be shared with the community so everyone can learn from it!
-
-Please feel free to add suggestions to the [agenda](https://docs.google.com/document/d/1mnCC_fAI3pmg3Vb2nMJyPk8Qtjjuapw_BTyqI_dX7sk/edit) and attend.
-
-Join the [skaffold-users mailing list](https://groups.google.com/forum/#!forum/skaffold-users) to get the calendar invite directly on your calendar.
-You can access the hangouts invite directly from this calendar invite.
-
-**Survey** 
-
-Your feedback is very valuable to us! We have an anonymous user feedback survey - please help us by spending a quick 5 minutes to tell us how satisfied you are with Skaffold, and what improvements we should make!
-
-Survey Link - https://forms.gle/BMTbGQXLWSdn7vEs6
+Or, check out our [Github Releases](https://github.com/GoogleContainerTools/skaffold/releases) page for release info or to install a specific version.
 
+![Demo](docs/static/images/intro.gif)
 
 ## Features
 
-* Fast local Kubernetes Development
-  * **optimized source-to-k8s** - Skaffold detects changes in your source code and handles the pipeline to
-  **build**, **push**, and **deploy** your application automatically with **policy based image tagging** and **highly optimized, fast local workflows**
-  * **continuous feedback** - Skaffold automatically manages logging and port-forwarding
-* Skaffold projects work everywhere
+* Blazing fast local development
+  * **optimized source-to-deploy** - Skaffold detects changes in your source code and handles the pipeline to
+  **build**, **push**, and **deploy** your application automatically with **policy based image tagging**
+  * **continuous feedback** - Skaffold automatically aggregates logs from deployed resources and forwards container ports to your local machine
+* Project portability
   * **share with other developers** - Skaffold is the easiest way to **share your project** with the world: `git clone` and `skaffold run`
   * **context aware** - use Skaffold profiles, user level config, environment variables and flags to describe differences in environments
-  * **CI/CD building blocks** - use `skaffold run` end-to-end or just part of skaffold stages from build to deployment in your CI/CD system
-* skaffold.yaml - a single pluggable, declarative configuration for your project
+  * **CI/CD building blocks** - use `skaffold run` end-to-end, or use individual Skaffold phases to build up your CI/CD pipeline. `skaffold render` outputs hydrated Kubernetes manifests that can be used in GitOps workflows.
+* Pluggable, declarative configuration for your project
   * **skaffold init** - Skaffold discovers your files and generates its own config file
   * **multi-component apps** - Skaffold supports applications consisting of multiple components
-  * **bring your own tools** - Skaffold has a pluggable architecture to allow for different implementations of the stages
+  * **bring your own tools** - Skaffold has a pluggable architecture to integrate with any build or deploy tool
 * Lightweight
-  * **client-side only** - Skaffold does not require maintaining a cluster-side component, so there is no overhead or maintenance burden to
-  your cluster.
+  * **client-side only** - Skaffold has no cluster-side component, so there is no overhead or maintenance burden
   * **minimal pipeline** - Skaffold provides an opinionated, minimal pipeline to keep things simple
 
-## Install
-
-Installation methods can be found in the [Getting Started Guide](https://skaffold.dev/docs/install/).
-
-See [Github Releases](https://github.com/GoogleContainerTools/skaffold/releases) for more information.
-
-:mega: **Please fill out our [quick 5-question survey](https://forms.gle/BMTbGQXLWSdn7vEs6)** so that we can learn how satisfied you are with Skaffold, and what improvements we should make. Thank you! :dancers:
+### Check out our [examples page](./examples) for more complex workflows!
 
-## Demo
+## Contributing to Skaffold
 
-![Demo](docs/static/images/intro.gif)
-
-## A Glance at Skaffold Workflow and Architecture
-
-Skaffold simplifies your development workflow by organizing common development
-stages into one simple command. Every time you run `skaffold dev`, the system
-
-1. Collects and watches your source code for changes
-1. Syncs files directly to pods if user marks them as syncable
-1. Builds artifacts from the source code
-1. Tests the built artifacts using container-structure-tests
-1. Tags the artifacts
-1. Pushes the artifacts
-1. Deploys the artifacts
-1. Monitors the deployed artifacts
-1. Cleans up deployed artifacts on exit (Ctrl+C)
-
-What's more, the pluggable architecture is central to Skaffold's design, allowing you to use
-the tool you prefer in each stage. Also, Skaffold's `profiles` feature grants
-you the freedom to switch tools as you see fit depending on the context.
+We welcome any contributions from the community with open arms - Skaffold wouldn't be where it is today without contributions from the community! Have a look at our [contribution guide](./CONTRIBUTING.md) for more information on how to get started on sending your first PR.
 
-For example, if you are coding on a local machine, you can configure Skaffold to build artifacts
-with local Docker daemon and deploy them to minikube
-using `kubectl`, the Kubernetes command-line interface and when you finalize your
-design, you can switch to the production profile and start building with
-Google Cloud Build and deploy with Helm.
-
-Skaffold supports the following tools:
-
-* Build
-  * Dockerfile locally
-  * Dockerfile in-cluster (kaniko)
-  * Dockerfile on cloud (Google Cloud Build)
-  * Bazel locally
-  * Jib Maven/Gradle locally
-* Test
-  * with container-structure-test
-* Tag
-  * tag by git commit
-  * tag by current date&time
-  * tag by environment variables based template
-* Push
-  * don't push - keep the image on the local daemon
-  * push to registry
-* Deploy
-  * Kubernetes Command-Line Interface (`kubectl`)
-  * Helm
-  * kustomize
-
-![architecture](docs/static/images/architecture.png)
+## Community
 
-Besides the above steps, skaffold also automatically manages the following utilities for you:
+**Come hang out with us!**
 
-* forwards container ports to your local machine using `kubectl port-forward`
-* aggregates all the logs from the deployed pods
+* We're always around on [#skaffold on Kubernetes Slack](https://kubernetes.slack.com/messages/CABQMSZA6/)
+* [skaffold-users mailing list](https://groups.google.com/forum/#!forum/skaffold-users)
+* Have something you want us to hear? [Give us feedback!](https://skaffold.dev/docs/resources/feedback/)
 
-## Documentation
+**Office Hours**
 
-Documentation for latest release: <https://skaffold.dev>
+We hold open office hours every other Wednesday at 9:30 AM Pacific Time. This is an open forum for anyone to show up and bring ideas, concerns, or just in general come hang out with the team! This is also a great time to get direct feedback on contributions, or give us feedback on ways you think we can improve the project. Come show us how you're using Skaffold!
 
-Documentation for latest build: <https://skaffold-latest.firebaseapp.com>
+Join the [skaffold-users mailing list](https://groups.google.com/forum/#!forum/skaffold-users) to get the calendar invite directly on your calendar.
+You can access the hangouts invite directly from this calendar invite.
 
-## More examples
+**Survey**
 
-Check out our [examples page](./examples)
+Your feedback is very valuable to us! We have an anonymous user feedback survey - please help us by spending a quick 5 minutes to tell us how satisfied you are with Skaffold, and what improvements we should make! You can also run `skaffold survey` from your terminal to open the survey directly in your default browser.
 
+Survey Link - https://forms.gle/BMTbGQXLWSdn7vEs6
 
 ## Support 
 
-Skaffold is generally available and considered production ready. 
+Skaffold is generally available and considered production ready.
 Detailed feature maturity information and how we deprecate features are described in our [Deprecation Policy](https://skaffold.dev/docs/references/deprecation).
-
-Support channels: 
-
-* Github Issues and PRs on this repo is our primary channel: the Skaffold team triages Github Issues and PRs daily, PRs are welcome (please read [CONTRIBUTING.md](CONTRIBUTING.md) for more details).
-* [skaffold-users mailing list](https://groups.google.com/forum/#!forum/skaffold-users)
-* [#skaffold on Kubernetes Slack](https://kubernetes.slack.com/messages/CABQMSZA6/): you can find us there on a best effort basis
-* Skaffold Office hours at 9AM PST, every other Wednesday: join the [skaffold-users mailing list](https://groups.google.com/forum/#!forum/skaffold-users) to get the calendar invite directly on your calendar.  
-