Skip to content

[docs] skaffold run docs in Continuous Delivery pipeline #3173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 6, 2019
Merged

[docs] skaffold run docs in Continuous Delivery pipeline #3173

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17a9135
skaffold run docs in Continuous Delivery pipeline
balopat Nov 5, 2019
4bd20eb
merge and review changes
tejal29 Nov 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions docs/content/en/docs/workflows/ci-cd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
---
title: "CI/CD with Skaffold"
linkTitle: "CI/CD with Skaffold"
title: "Continuous Delivery"
linkTitle: "Continuous Delivery"
weight: 40
---

Skaffold offers several sub-commands for its workflows that make it quite flexible when integrating with CI/CD pipelines.


## `skaffold run`

`skaffold run` is a single command for a one-off deployment. It includes all the following phases as it builds, tags, deploys and waits for the deployment to succeed if specified.
We recommend `skaffold run` for a simple Continuous Delivery setup, where it is sufficient to have a single step that deploys from version control to a cluster.
For more sophisticated Continuous Delivery pipelines, Skaffold offers building blocks that are described next:

- [healthcheck]({{<relref "/docs/workflows/ci-cd#waiting-for-skaffold-deployments-using-healthcheck">}}) -
wait for `deployments` to stabilize and succeed only if all deployments are successful
- [`skaffold build`]({{<relref "/docs/workflows/ci-cd#skaffold-build-skaffold-deploy">}}) - build, tag and push artifacts to a registry
- [`skaffold deploy`]({{<relref "/docs/workflows/ci-cd#skaffold-build-skaffold-deploy">}}) - deploy built artifacts to a cluster
- [`skaffold render`]({{<relref "/docs/workflows/ci-cd#skaffold-render">}}) - export the transformed Kubernetes manifests for GitOps workflows

## Waiting for Skaffold deployments using `healthcheck`
{{< maturity "deploy.status_check" >}}

{{< todo 1937 >}}

## `skaffold build | skaffold deploy`

`skaffold build` will build your project's artifacts, and push the build images to the specified registry. If your project is already configured to run with Skaffold, `skaffold build` can be a very lightweight way of setting up builds for your CI pipeline. Passing the `--file-output` flag to Skaffold build will also write out your built artifacts in JSON format to a file on disk, which can then by passed to `skaffold deploy` later on. This is a great way of "committing" your artifacts when they have reached a state that you're comfortable with, especially for projects with multiple artifacts for multiple services.
Expand Down Expand Up @@ -87,5 +105,3 @@ gives us the one line output telling us the only thing we need to know:
pod/getting-started configured
```

## Waiting for Skaffold deployments using `healthcheck`
{{< maturity "deploy.status_check" >}}