Tutorials on Skaffold

Use Skaffold to build and deploy an application on Kubernetes

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

This is a link to an introductory Cloud Shell tutorial. In this tutorial, you will:

Use skaffold init to bootstrap your Skaffold config.
Use skaffold dev to automatically build and deploy your application when your code changes.
Use skaffold build and skaffold test to tag, push, and test your container images.
Use skaffold render and skaffold apply to generate and deploy Kubernetes manifests as part of a GitOps workflow.

Manage CRDs w/ Skaffold - Configuring Which K8s Resources & Fields Skaffold Manages

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

Common Use Cases This Page Helps Resolve:

Users who want skaffold to properly manage the rendering and deployment of their custom CRDs (as skaffold does with K8s objects like Pod, Deployment.apps, etc.)
- Additionally users w/ a CRD that uses a different field name for image: (eg: foo:) and want skaffold to properly modify the value to instead have the image label for the image skaffold recently built
Users who are seeing issues with skaffold’s default resource field overwriting for a given resource - eg: skaffold errors as it tries to mutate immutable config on re-deployment

Currently skaffold modifies the manifests it renders and deploys for the following functionality:

Defining dependencies between artifacts

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

This page describes how to define dependencies between artifacts and reference them in the docker builder.

Before you begin

First, you will need to have Skaffold and a Kubernetes cluster set up. To learn more about how to set up Skaffold and a Kubernetes cluster, see the quickstart docs.

Tutorial - Simple artifact dependency

This tutorial will be based on the simple-artifact-dependency example in our repository.

Adding an artifact dependency

We have a base artifact which has a single Dockerfile that we build with the docker builder:

Importing configuration as dependencies

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

Skaffold’s config dependencies feature allows you to import configurations defined across multiple skaffold.yaml files (even across repositories) into a single configuration as its dependencies. This helps more readily integrate Skaffold with multi-microservice and multi-repository applications.

For a guided Cloud Shell tutorial on setting up local dependencies, follow:

For a guided Cloud Shell tutorial on setting up remote git dependencies, follow:

Building Artifacts with a Custom Build Script

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

This page describes building Skaffold artifacts using a custom build script, which builds images using ko. ko builds containers from Go source code, without the need for a Dockerfile or even installing Docker.

Before you begin

First, you will need to have Skaffold and a Kubernetes cluster set up. To learn more about how to set up Skaffold and a Kubernetes cluster, see the quickstart docs.

Tutorial - Hello World in Go

This tutorial will be based on the custom example in our repository.

Developer Journey with Buildpacks

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

Skaffold Developer Journey with Buildpacks Tutorial

Introduction

What is this project?

Skaffold allows developers to easily transition from local development on minikube to remote development on an enterprise Kubernetes cluster managed by IT. During the transition from local to remote deployment, a security team might ask a developer to patch a library with a specific vulnerability in it. This is where Skaffold’s support for buildpacks comes in handy. In this tutorial, you’ll start out deploying an application locally, swap out buildpacks in the skaffold.yaml file to use the latest libraries, and then deploy the application to a remote Kubernetes cluster.

Go integration test coverage profiles

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

This tutorial describes how to use Skaffold to collect coverage profile data from Go applications when running integration tests. These more comprehensive tests, often called end-to-end tests, are run against a deployed application, typically testing multiple user journeys.

Background

Go 1.20 introduced support for collecting coverage profile data from running Go applications. To enable coverage collection, build the binary with the -cover flag. The application records coverage profile data in a local directory set by the GOCOVERDIR environment variable.

Override the run image in buildpacks builder

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

This is a link to a guided Cloud Shell tutorial using skaffold’s artifact dependency feature to override the run image in the buildpacks builder:

Using Skaffold for CI/CD with GitLab

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

Contributed by: @tvvignesh

Skaffold is a tool which is non-opinionated about the CI/CD tool you should use and acts as a platform agnostic solution for both development and deploying to production.

To facilitate building and deploying images in CI/CD, skaffold offers docker images which you can build on top of. If that doesn’t work for your use-case, you can make your own Dockerfile and pull in skaffold and its dependencies using curl.