Skip to content
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.

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

docs: explain minikube detection #6512

Merged
merged 1 commit into from
Aug 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 14 additions & 3 deletions docs/content/en/docs/environment/local-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,32 @@ uses images straight from your local docker daemon. It leads to much faster deve

### Auto detection

Skaffold's heuristic to detect local clusters is based on the Kubernetes context name.
The following context names are checked:
Skaffold's heuristic to detect local clusters is based on the Kubernetes context name
set on kubectl. You can find your the current context name by running:

```bash
kubectl config current-context
```

Skaffold checks for the following context names:

| Kubernetes context | Local cluster type | Notes |
| ------------------ | ------------------ | ----- |
| docker-desktop | [`Docker Desktop`] | |
| docker-for-desktop | [`Docker Desktop`] | This context name is deprecated |
| minikube | [`minikube`] | |
| minikube <sup>1</sup> | [`minikube`] | See <sup>1</sup> | |
| kind-(.*) | [`kind`] | This pattern is used by kind >= v0.6.0 |
| (.*)@kind | [`kind`] | This pattern was used by kind < v0.6.0 |
| k3d-(.*) | [`k3d`] | This pattern is used by k3d >= v3.0.0 |

For any other name, Skaffold assumes that the cluster is remote and that images
have to be pushed.

<sup>1</sup> Additionally, a Kubernetes context may be considered as `minikube`
even if it's not named `minikube` but it's cluster certificate is stored at
`$HOME/.minikube` or the `minikube profile list` command returns the Kubernetes
context name.

[`minikube`]: https://github.com/kubernetes/minikube/
[`Docker Desktop`]: https://www.docker.com/products/docker-desktop
[`kind`]: https://github.com/kubernetes-sigs/kind
Expand Down
2 changes: 1 addition & 1 deletion docs/static/stylesheets/infopanel.css
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
}

sup {
font-size: 18px;
font-size: 0.8rem;
line-height: 2em;
}

Expand Down