Skaffold 2.0 Documentation on Skaffold

Init

Mon, 01 Jan 0001 00:00:00 +0000

skaffold init helps you get started using Skaffold by running you through a wizard and generating the required skaffold.yaml file in the root of your project directory.

The generated skaffold.yaml defines your build and deploy config.

Build Config Initialization

skaffold init currently supports build detection for those builders:

skaffold init walks your project directory and looks for any build configuration files such as Dockerfile, build.gradle/pom.xml, package.json, requirements.txt or go.mod. init skips files that are larger than 500MB.

File Sync

Mon, 01 Jan 0001 00:00:00 +0000

Skaffold supports copying changed files to a deployed container so as to avoid the need to rebuild, redeploy, and restart the corresponding pod. The file copying is enabled by adding a sync section with sync rules to the artifact in the skaffold.yaml. Under the hood, Skaffold creates a tar file with changed files that match the sync rules. This tar file is sent to and extracted on the corresponding containers.

Log Tailing

Mon, 01 Jan 0001 00:00:00 +0000

Skaffold has built-in support for tailing logs for containers built and deployed by Skaffold on your cluster to your local machine when running in either dev, debug or run mode.

Note

Log Tailing is enabled by default for dev and debug.
Log Tailing is disabled by default for run mode; it can be enabled with the --tail flag.

Log Structure

To view log structure, run skaffold run --tail in examples/microservices

skaffold run --tail

will produce an output like this

Verify [NEW]

Mon, 01 Jan 0001 00:00:00 +0000

Skaffold v2.0.0+ supports running post-deployment verification tests. You define these tests as a list of test containers that are either standalone or built by Skaffold. Skaffold runs these containers after the deploy stage and monitors them for success or failure.

You can configure and execute post-deployment verification tests using the verify command and associated skaffold.yaml schema configuration.

Execution modes

You can run post-deployment verification tests in the following execution environments:

A local Docker environment
A Kubernetes cluster environment

Local

When Skaffold runs a post-deployment verifications test in the local execution mode, it uses the docker CLI to run the test container on the host machine. This is the default execution mode.

Deploy Status Checking

Mon, 01 Jan 0001 00:00:00 +0000

This page describes how Skaffold’s deployment status checking waits for deployed resources to become ready, and reports errors if they fail to stabilize within a certain time period.

Overview

Commands that trigger a deployment, like skaffold dev, skaffold deploy, skaffold run, and skaffold apply, monitor select resources and wait for them to become ready.

Skaffold monitors the status of the following resource types:

Pod: check that the pod and its containers are in a Ready state.
Deployment: check the output of kubectl rollout status deployment command
Stateful Sets: check the output of kubectl rollout status statefulset command
Cloud Run instances (running containers) are ready to receive traffic

Note

Status checking is enabled by default; it can be disabled with the --status-check=false flag, or by setting the statusCheck field of the deployment config stanza in the skaffold.yaml to false.

Lifecycle Hooks

Mon, 01 Jan 0001 00:00:00 +0000

This page describes how to use the lifecycle hook framework to run code triggered by different events during the skaffold process lifecycle.

Overview

We identify three distinct phases in skaffold - build, sync and deploy. Skaffold can trigger a hook before or after executing each phase. There are two types of hooks that can be defined - host hooks and container hooks.

Host hooks

Host hooks are executed on the runner and can be defined for the following phases:

Port Forwarding

Mon, 01 Jan 0001 00:00:00 +0000

Skaffold has built-in support for forwarding ports from exposed Kubernetes resources on your cluster to your local machine when running in dev, debug, deploy, or run modes.

Automatic Port Forwarding

Skaffold supports automatic port forwarding the following classes of resources:

user: explicit port-forwards defined in the skaffold.yaml (called user-defined port forwards)
services: ports exposed on services deployed by Skaffold.
debug: debugging ports as enabled by skaffold debug for Skaffold-built images.
pods: all containerPorts on deployed pods for Skaffold-built images.

Skaffold enables certain classes of forwards by default depending on the Skaffold command used. These defaults can be overridden with the --port-forward flag, and port-forwarding can be disabled with --port-forward=off.

Cleanup

Mon, 01 Jan 0001 00:00:00 +0000

Skaffold works with image builders and deployers that both have side effects on both your local and deployment environments:

resources are created in one or more namespaces in a Kubernetes cluster
images might be created on the local Docker daemon
images might be pushed to registries
application might have arbitrary side effects

Skaffold offers cleanup functionality to negate some of these side effects:

Kubernetes resource cleanup - skaffold delete, and automatic cleanup on Ctrl+C for skaffold dev and skaffold debug
Image pruning - for local Docker daemon images only, automatically on Ctrl+C for skaffold dev and skaffold debug

For pushed images in registries and application side effects the user has to take care of cleanup.

Custom Actions

Mon, 01 Jan 0001 00:00:00 +0000

With Skaffold you can define generic actions in a declarative way using a Skaffold config file (skaffold.yaml), and execute them with the skaffold exec <action-name> command.

A generic action (a.k.a. Custom Action), defines a list of containers that will be executed in parallel when the action is invoked. A Custom Action execution is considered successful if all its containers end without errors, and considered as failed if one or more of its containers report an error.

Skaffold 2.0 Documentation on Skaffold

Init

Build Config Initialization

Tag

File Sync

Log Tailing

Note

Log Structure

Verify [NEW]

Execution modes

Local

Deploy Status Checking

Overview

Note

Lifecycle Hooks

Overview

Host hooks

Port Forwarding

Automatic Port Forwarding

Cleanup

Custom Actions