repository·main·Indexed 12 days ago
https://github.com/GoogleContainerTools/skaffoldA CLI tool that automates the build, push, and deploy cycle for Kubernetes applications. It provides building blocks for CI/CD pipelines and supports various builders including Cloud Native Buildpacks, Bazel, docker buildx, and custom shell commands. Skaffold also integrates with kpt for configuration validation and can generate Tekton pipelines via the generate-pipeline command.
Skaffold allows you to execute builds in different environments depending on your infrastructure and requirements. The supported build environments are:
Skaffold supports several different builder types to create container images from your source code. Depending on your language, build tool, or environment, you can choose from the following builders:
Skaffold is designed for high-velocity development with the following capabilities:
git clone and skaffold run. Supports profiles, local user config, and environment variables to handle environment differences.The Skaffold CLI is organized into functional groups: end-to-end pipelines, CI/CD building blocks, project initialization, and utility commands.
Use these for complete workflows from code to running application:
skaffold run: Build and deploy once.skaffold dev: Trigger the watch loop (build and deploy continuously) and clean up resources on exit.skaffold debug: Run a pipeline in debug mode.Use these to execute individual stages of a deployment pipeline:
skaffold build: Build and tag images only.skaffold deploy: Deploy specific images.skaffold delete: Clean up deployed artifacts.skaffold render: Build and tag images, then output the templated Kubernetes manifests.skaffold apply: Apply hydrated manifests to a cluster.skaffold init: Bootstrap a new skaffold.yaml configuration.skaffold fix: Upgrade an existing skaffold.yaml from an older schema version to a newer one.skaffold help: Print help information.skaffold version: Get the current Skaffold version.skaffold completion: Set up shell tab completion.skaffold config: Manage context-specific parameters.skaffold credits: Export third-party notices (defaults to ./skaffold-credits).skaffold diagnose: Run diagnostics to check how Skaffold works in your project.skaffold schema: List and print JSON schemas used for skaffold.yaml validation.Skaffold supports various tools for building container images across three primary execution contexts: Local Build (using your machine's tools), In Cluster Build (building inside your Kubernetes cluster), and Remote on Google Cloud Build (using Google's infrastructure).
| Tool | Local Build | In Cluster Build | Remote (GCB) |
|---|---|---|---|
| Dockerfile | Yes | Yes | Yes |
| Jib (Maven/Gradle) | Yes | - | Yes |
| Cloud Native Buildpacks | Yes | - | Yes |
| Bazel | Yes | - | - |
| ko | Yes | - | Yes |
| Custom Script | Yes | Yes | - |
Skaffold is a command-line tool designed to facilitate continuous development for container-based and Kubernetes applications. It automates the workflow of building, pushing, and deploying applications, allowing developers to focus on code iteration while Skaffold manages the underlying infrastructure updates.
When running skaffold dev, the tool executes a pipeline of stages:
container-structure-test or custom scripts.Ctrl+C).Note that any of these stages can be skipped based on your configuration.
HCL is a structured configuration language designed to be both human-friendly and machine-friendly, specifically targeted towards DevOps tools and servers.
Key characteristics include:
kpt is an open-source tool for Kubernetes packaging. It uses a standard format to manage the lifecycle of configuration manifests, specifically allowing you to:
A key advantage of kpt is its ability to prune resources accurately using a three-way merge strategy, which helps maintain the desired state of your cluster more reliably than standard tools.
Skaffold supports lifecycle hooks that allow you to execute commands at different stages of the development workflow. Based on the design schema, hooks can be categorized into pre and post stages.
There are two primary types of hook executions:
command.build or sync), you can optionally specify container-name and pod-prefix to target specific environments.Note: The schema uses dash-casing (e.g., pre-hooks, post-hooks, container-name) for configuration keys.
pre-hooks:
- command: [ "sleep", "5" ]
os: [ "linux", "darwin" ]
- command: [ "timeout", "5" ]
os: [ "windows" ]
- container-command: [ "echo", "foo" ]
container-name: foo
pod-prefix: bar
post-hooks:
- command: [ "echo", "foo" ]By default, Skaffold attempts to build all artifacts in parallel during an in-cluster build. If your cluster resources are limited, you can control the number of simultaneous builds using the concurrency setting.
concurrency: 1 to build artifacts one after another.concurrency to a value greater than 1 to limit the number of simultaneous builds.Note: Even when builds run in parallel, Skaffold prints build logs in sequence to ensure readability.
build:
cluster:
concurrency: 1Skaffold provides an API that allows developers to retrieve information about the current state of the Skaffold process and exert fine-grained control over its execution. This API is exposed through two primary protocols:
Detailed design information regarding the API's purpose and architecture can be found in the Skaffold design documentation.