Skip to content

Commit

Permalink
Updates kev dev tutorial docs (#354)
Browse files Browse the repository at this point in the history
Co-authored-by: marcinc <[email protected]>
  • Loading branch information
marcinc and marcinc authored Dec 8, 2020
1 parent 65a8c11 commit 42846cd
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/tutorials/kev-dev-with-skaffold.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ In order to take advantage of Skaffold, you must prepare your project accordingl

> Initialise Kev project with Skaffold support
```sh
kev init --skaffold -e stage
kev init --skaffold -e stage
```

This command prepares your application and bootstraps a new Skaffold config (_skaffold.yaml_) if it doesn't already exist. Alternatively, it'll add environment & helper profiles to already existing Skaffold config automatically. The profiles added by Kev can be used to control which application Kubernetes manifests should be deployed and to which K8s cluster, be it local or remote. They should also come handy when defining steps in CI/CD pipelines.
Expand Down Expand Up @@ -91,6 +91,11 @@ There are a few extra bits of information that Skaffold requires to perform its
* `--kubecontext | -k` - Specified kubectl context to be used by Skaffold. This determines the cluster to which your application will be deployed to. If not specified it will default to current [kebectl context](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#kubectl-context-and-configuration).
* `--kev-env` - Kev tracked environment name of which Kubernetes manifests will be deployed to a target cluster/namespace. Defaults to the sandbox `dev` environment, if no environments have been specified.
Additional OPTIONAL flags for Skaffold enabled workflow:
* `--manual-trigger | -m` - Triggers Skaffold's build/push/deploy only after manual user action (hit ENTER to release)
* `--tail | -t` - Will stream application logs once it's deployed to Kubernetes cluster.
When the dev loop is interrupted with Ctrl+C it will automatically cleanup all deployed K8s objects from a target namespace and attempt to prune locally built docker images.
_NOTE: Image pruning might take some time and in some cases won't remove stale docker images. it's therefore advised that local images are periodically (manually) pruned._

0 comments on commit 42846cd

Please sign in to comment.