skaffold

README

---

Skaffold is a command line tool that facilitates continuous development for Kubernetes applications. You can iterate on your application source code locally then deploy to local or remote Kubernetes clusters. Skaffold handles the workflow for building, pushing and deploying your application. It also provides building blocks and describe customizations for a CI/CD pipeline.

---

Community

We'd love to hear from you!

• skaffold-users mailing list
• #skaffold on Kubernetes Slack
• Give us Feedback

Office Hours

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 and attend.

Join the skaffold-users mailing list 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

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
  • 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
  • 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
• Lightweight
  • client-side only - Skaffold does not require maintaining a cluster-side component, so there is no overhead or maintenance burden to your cluster.
  • minimal pipeline - Skaffold provides an opinionated, minimal pipeline to keep things simple

Install

Installation methods can be found in the Getting Started Guide.

See Github Releases for more information.

📣 Please fill out our quick 5-question survey so that we can learn how satisfied you are with Skaffold, and what improvements we should make. Thank you! 👯

Demo

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
2. Syncs files directly to pods if user marks them as syncable
3. Builds artifacts from the source code
4. Tests the built artifacts using container-structure-tests
5. Tags the artifacts
6. Pushes the artifacts
7. Deploys the artifacts
8. Monitors the deployed artifacts
9. 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.

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

Besides the above steps, skaffold also automatically manages the following utilities for you:

• forwards container ports to your local machine using kubectl port-forward
• aggregates all the logs from the deployed pods

Documentation

Documentation for latest release: https://skaffold.dev

Documentation for latest build: https://skaffold-latest.firebaseapp.com

More examples

Check out our examples page

Support

Skaffold is generally available and considered production ready. Detailed feature maturity information and how we deprecate features are described in our Deprecation Policy.

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 for more details).
• skaffold-users mailing list
• #skaffold on Kubernetes Slack: 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 to get the calendar invite directly on your calendar.