skaffold README

The project's README from github.com/GoogleContainerTools/skaffold. As one markdown file: README.md.


Code Coverage LICENSE Releases

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.


Install Skaffold

Or, check out our Github Releases page for release info or to install a specific version.

Demo

Features

Check out our examples page for more complex workflows!

IDE integrations

For a managed experience of Skaffold you can install the Google Cloud Code extensions:

It can manage and keep Skaffold up-to-date while providing a more guided startup experience, along with providing and managing other common dependencies, and works with any kubernetes cluster.

Contributing to Skaffold

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 for more information on how to get started on sending your first PR.

Community

Support

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

Security Disclosures

Please see our security disclosure process. All security advisories are managed on Github.

skaffold (GoogleContainerTools/skaffold)

Searching Database…

15.9K ·GitHub
What is this?A command line tool that facilitates continuous development for Kubernetes applications: you iterate on your source code locally and it handles the workflow for building, pushing and deploying to local or remote clusters.
Is this something I install on my machine, or does it run inside my cluster?It runs client-side only: a lightweight CLI with no cluster-side component, so there is no overhead or maintenance burden on the cluster itself.
How do I get started with it?Install the skaffold binary from the GitHub Releases page, then run skaffold init in your project — Skaffold discovers your files and generates its own config file for you.
What do I need besides the CLI itself?A Kubernetes cluster to deploy to — local or remote both work. Build and deploy tools are pluggable, so you bring your own rather than being locked into one stack.
Is it production-ready, or still experimental?No big caveats — it is generally available and considered production ready, with a documented deprecation policy for retiring features.
Does it watch my code and redeploy automatically while I develop?Yes — Skaffold detects changes in your source code and automatically runs the build, push and deploy pipeline with policy-based image tagging. It also aggregates logs from deployed resources and forwards container ports to your local machine.
Can I use it in CI/CD too, or is it only for local development?Both: skaffold run does the end-to-end pipeline, or you can use individual Skaffold phases as building blocks for your CI/CD pipeline. skaffold render outputs hydrated Kubernetes manifests that fit GitOps workflows.
How do I share the setup with my teammates?Commit the Skaffold config to the repo — the README calls it the easiest way to share your project: git clone and skaffold run. Profiles, user-level config, environment variables and flags describe differences between environments.
Do I have to use it from the terminal, or is there IDE support?Google ships Cloud Code extensions for Visual Studio Code and JetBrains IDEs that manage and keep Skaffold up-to-date and provide a more guided startup experience.
What are similar projects?kompose, buildkit, helm, tilt, kaniko, openframe-cli, Reloader, rook
Size
178.4 MB
Stars
15.9K
Age
8y
Commits · 90 Days