CheatSkaffold Kubernetes dev loop
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
skaffold initGenerate skaffold.yaml
skaffold devBuild, deploy, watch
skaffold runOne-shot build and deploy
skaffold debugDev loop with debugger
skaffold renderPrint final manifests
skaffold deleteRemove what was deployed
skaffold dev -p <profile>
Use a profile
skaffold diagnose
Show effective config
Concepts
- build images from artifacts
- test optional
- render manifests with new tags
- deploy kubectl / helm / kustomize
- verify optional checks
Dev loop
skaffold devBuild, deploy, watch, tail logs
Ctrl+C stops it and cleans up the deployment unless
--cleanup=false.
skaffold dev --port-forward=services
Forward service ports locally
The dev default is user: only ports listed under portForward
in skaffold.yaml.
skaffold dev --no-prune --cleanup=false
Keep resources after exit
skaffold dev --auto-build=false
Rebuild only on request
skaffold dev --trigger=polling
Poll for changes
Values: notify (default), polling, manual. Use polling on
network or container file systems.
skaffold dev -w <image>
Watch only matching images
skaffold dev --skip-tests
Skip tests after build
skaffold dev --keep-running-on-failure
Suspend instead of exit on error
skaffold dev --status-check=false
Do not wait for rollout
skaffold dev --tail=false
Do not stream logs
Run, build & deploy
skaffold runBuild and deploy once
skaffold run --tail
Deploy and stream logs
skaffold buildBuild images only
skaffold build -q
Print only built image names
skaffold build --push
Push built images
skaffold build --file-output <file>
Save built tags as JSON
skaffold build --dry-run
Compute tags without building
skaffold deploy -a <file>
Deploy pre-built images
Pair with build --file-output for a build once, deploy many
pipeline.
skaffold deploy -i <name>=<tag>
Deploy given image tag
skaffold run -b <substr>
Build only matching artifacts
skaffold run --force
Recreate resources if needed
May cause downtime.
skaffold testRun tests on built images
skaffold apply <dir>
Apply hydrated manifests
Debug & verify
skaffold debugDev loop with debug ports
Auto-build, auto-sync and auto-deploy are off by default here.
skaffold debug --port-forward=user,debug
Forward debug ports
skaffold verifyRun verify tests
skaffold verify -a <file>
Verify pre-built images
Config & profiles
skaffold initGenerate skaffold.yaml
Detects Dockerfiles and manifests and asks which to use.
skaffold init --generate-manifests
Also create basic manifests
skaffold init -k <glob>
Pick Kubernetes manifests
skaffold init -a <Dockerfile>=<image>
Map Dockerfile to image
skaffold init --compose-file <file>
Start from docker-compose
skaffold fixPrint config in newest schema
skaffold fix --overwrite
Upgrade skaffold.yaml in place
skaffold diagnose
Inspect effective config
skaffold diagnose --yaml-only
Print merged skaffold.yaml
skaffold dev -f <file>
Use another config file
skaffold dev -p <profile>
Activate a profile
skaffold dev -p <a>,-<b>
Enable a, disable b
skaffold dev -m <module>
Select config module
skaffold config set <key> <value>
Set a global option
Render & delete
skaffold renderPrint rendered manifests
skaffold render -o <file>
Write manifests to a file
skaffold render --offline
Render without a cluster
skaffold render --digest-source=none
Keep tags, skip digests
skaffold render --set <key>=<val>
Override templated field
skaffold render -i <name>=<tag>
Render with given tag
skaffold deleteRemove deployed resources
skaffold delete --dry-run
List what would be deleted
Targeting & images
skaffold dev -n <ns>
Deploy to a namespace
skaffold dev --kube-context <ctx>
Use a kube context
skaffold dev --kubeconfig <file>
Use another kubeconfig
skaffold dev -d <repo>
Default image repository
Prefixes image names, e.g. gcr.io/<project>; use for
remote clusters.
skaffold dev -t <tag>
Custom image tag
skaffold dev --platform <os/arch>
Target platform
skaffold dev -l <key>=<val>
Label deployed objects
skaffold dev --cache-artifacts=false
Disable build cache
Housekeeping
skaffold version
Print version
skaffold completion <shell>
Shell completion script
bash, fish or zsh.
skaffold dev -v <level>
Set log level
Levels: panic, fatal, error, warning, info, debug, trace.
skaffold dev --interactive=false
Never prompt
skaffold.yaml
apiVersion: skaffold/v4beta14kind: Configbuild: artifacts: - image: web docker: {dockerfile: Dockerfile}manifests: rawYaml: [k8s/*.yaml]deploy: kubectl: {}portForward:- {resourceType: service, resourceName: web, port: 80, localPort: 8080}Recipes
kubectl config use-context kind-devskaffold dev --port-forward=services -n devskaffold build -d registry.example/app --push --file-output build.jsonskaffold deploy -a build.json -p staging -n stagingskaffold deploy -a build.json -p prod -n prodskaffold render -a build.json -p prod --offline -o rendered.yamlkubectl diff -f rendered.yamlskaffold fix > skaffold.new.yamldiff skaffold.yaml skaffold.new.yamlskaffold fix --overwrite
