skaffold

module
v1.37.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 2, 2023 License: Apache-2.0

README


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

  • 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 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 integrate with any build or deploy tool
  • Lightweight
    • 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

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

Come hang out with us!

Office Hours

We hold open office hours on the last Wednesday of the month 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!

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! 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. 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.

Directories

Path Synopsis
cmd
skaffold/app/cmd/credits/statik
Package statik contains static assets.
Package statik contains static assets.
examples
hack
man
pkg
skaffold/debug
Package debug transforms Kubernetes pod-bearing resources so as to configure containers for remote debugging as suited for a container's runtime technology.
Package debug transforms Kubernetes pod-bearing resources so as to configure containers for remote debugging as suited for a container's runtime technology.
skaffold/render/kptfile
Note: This is copied from kpt schema version v1alpha2.
Note: This is copied from kpt schema version v1alpha2.
proto
v1
Package proto is a reverse proxy.
Package proto is a reverse proxy.
v2
Package v2 is a reverse proxy.
Package v2 is a reverse proxy.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL