-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Point old documents to their new Hugo location
- Loading branch information
1 parent
294f880
commit 7559952
Showing
44 changed files
with
137 additions
and
2,404 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1 @@ | ||
| # Contributing guidelines | ||
|
|
||
| ## Filing issues | ||
|
|
||
| File issues using the standard Github issue tracker for the repo. | ||
|
|
||
| ## How to become a contributor and submit your own code | ||
|
|
||
| ### Contributor License Agreements | ||
|
|
||
| We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles. | ||
|
|
||
| [Please fill out either the individual or corporate Contributor License Agreement (CLA)](http://git.k8s.io/community/CLA.md) | ||
|
|
||
| ### Contributing A Patch | ||
|
|
||
| 1. Submit an issue describing your proposed change to the repo in question. | ||
| 1. The repo owner will respond to your issue promptly. | ||
| 1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above). | ||
| 1. Fork the desired repo, develop and test your code changes. | ||
| 1. Submit a pull request. | ||
| This document has moved to https://minikube.sigs.k8s.io/docs/contributing/guide/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1 @@ | ||
| # Accessing Host Resources From Inside A Pod | ||
|
|
||
| ## When you have a VirtualBox driver | ||
|
|
||
| In order to access host resources from inside a pod, run the following command to determine the host IP you can use: | ||
|
|
||
| ```shell | ||
| ip addr | ||
| ``` | ||
|
|
||
| The IP address under `vboxnet1` is the IP that you need to access the host from within a pod. | ||
| This document has moved to https://minikube.sigs.k8s.io/docs/tasks/accessing-host-resources/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1 @@ | ||
| # Add-ons | ||
|
|
||
| Minikube has a set of built in addons that can be used enabled, disabled, and opened inside of the local k8s environment. Below is an example of this functionality for the `heapster` addon: | ||
|
|
||
| ```shell | ||
| $ minikube addons list | ||
| - registry: disabled | ||
| - registry-creds: disabled | ||
| - freshpod: disabled | ||
| - addon-manager: enabled | ||
| - dashboard: enabled | ||
| - heapster: disabled | ||
| - efk: disabled | ||
| - ingress: disabled | ||
| - default-storageclass: enabled | ||
| - storage-provisioner: enabled | ||
| - storage-provisioner-gluster: disabled | ||
| - nvidia-driver-installer: disabled | ||
| - nvidia-gpu-device-plugin: disabled | ||
|
|
||
| # minikube must be running for these commands to take effect | ||
| $ minikube addons enable heapster | ||
| heapster was successfully enabled | ||
|
|
||
| $ minikube addons open heapster # This will open grafana (interacting w/ heapster) in the browser | ||
| Waiting, endpoint for service is not ready yet... | ||
| Waiting, endpoint for service is not ready yet... | ||
| Created new window in existing browser session. | ||
| ``` | ||
|
|
||
| The currently supported addons include: | ||
|
|
||
| * [Kubernetes Dashboard](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/dashboard) | ||
| * [Heapster](https://github.com/kubernetes/heapster): [Troubleshooting Guide](https://github.com/kubernetes/heapster/blob/master/docs/influxdb.md) Note:You will need to login to Grafana as admin/admin in order to access the console | ||
| * [EFK](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/fluentd-elasticsearch) | ||
| * [Registry](https://github.com/kubernetes/minikube/tree/master/deploy/addons/registry) | ||
| * [Registry Credentials](https://github.com/upmc-enterprises/registry-creds) | ||
| * [Ingress](https://github.com/kubernetes/ingress-nginx) | ||
| * [Freshpod](https://github.com/GoogleCloudPlatform/freshpod) | ||
| * [nvidia-driver-installer](https://github.com/GoogleCloudPlatform/container-engine-accelerators/tree/master/nvidia-driver-installer/minikube) | ||
| * [nvidia-gpu-device-plugin](https://github.com/GoogleCloudPlatform/container-engine-accelerators/tree/master/cmd/nvidia_gpu) | ||
| * [logviewer](https://github.com/ivans3/minikube-log-viewer) | ||
| * [gvisor](../deploy/addons/gvisor/README.md) | ||
| * [storage-provisioner-gluster](../deploy/addons/storage-provisioner-gluster/README.md) | ||
|
|
||
| If you would like to have minikube properly start/restart custom addons, place the addon(s) you wish to be launched with minikube in the `.minikube/addons` directory. Addons in this folder will be moved to the minikube VM and launched each time minikube is started/restarted. | ||
|
|
||
| If you have a request for an addon in minikube, please open an issue with the name and preferably a link to the addon with a description of its purpose and why it should be added. You can also attempt to add the addon to minikube by following the guide at [Adding an Addon](contributors/adding_an_addon.md) | ||
|
|
||
| **Note:** If you want to have a look at the default configuration for the addons, see [deploy/addons](https://github.com/kubernetes/minikube/tree/master/deploy/addons). | ||
| This document has moved to https://minikube.sigs.k8s.io/docs/tasks/addons/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1 @@ | ||
| # Alternative runtimes | ||
|
|
||
| ## Using CRI-O | ||
|
|
||
| To use [CRI-O](https://github.com/kubernetes-sigs/cri-o) as the container runtime, run: | ||
|
|
||
| ```shell | ||
| $ minikube start --container-runtime=cri-o | ||
| ``` | ||
|
|
||
| Or you can use the extended version: | ||
|
|
||
| ```shell | ||
| $ minikube start --container-runtime=cri-o \ | ||
| --network-plugin=cni \ | ||
| --enable-default-cni \ | ||
| --cri-socket=/var/run/crio/crio.sock \ | ||
| --extra-config=kubelet.container-runtime=remote \ | ||
| --extra-config=kubelet.container-runtime-endpoint=unix:///var/run/crio/crio.sock \ | ||
| --extra-config=kubelet.image-service-endpoint=unix:///var/run/crio/crio.sock | ||
| ``` | ||
|
|
||
| ## Using containerd | ||
|
|
||
| To use [containerd](https://github.com/containerd/containerd) as the container runtime, run: | ||
|
|
||
| ```shell | ||
| $ minikube start --container-runtime=containerd | ||
| ``` | ||
|
|
||
| Or you can use the extended version: | ||
|
|
||
| ```shell | ||
| $ minikube start --container-runtime=containerd \ | ||
| --network-plugin=cni \ | ||
| --enable-default-cni \ | ||
| --cri-socket=/run/containerd/containerd.sock \ | ||
| --extra-config=kubelet.container-runtime=remote \ | ||
| --extra-config=kubelet.container-runtime-endpoint=unix:///run/containerd/containerd.sock \ | ||
| --extra-config=kubelet.image-service-endpoint=unix:///run/containerd/containerd.sock | ||
| ``` | ||
| This document has moved to https://minikube.sigs.k8s.io/docs/reference/runtimes/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1 @@ | ||
| # Building images within the VM | ||
|
|
||
| When using a single VM of Kubernetes it's really handy to build inside the VM; as this means you don't have to build on your host machine and push the image into a docker registry - you can just build inside the same machine as minikube which speeds up local experiments. | ||
|
|
||
| ## Docker (containerd) | ||
|
|
||
| For Docker, you can either set up your host docker client to communicate by [reusing the docker daemon](reusing_the_docker_daemon.md). | ||
|
|
||
| Or you can use `minikube ssh` to connect to the virtual machine, and run the `docker build` there: | ||
|
|
||
| ```shell | ||
| docker build | ||
| ``` | ||
|
|
||
| For more information on the `docker build` command, read the [Docker documentation](https://docs.docker.com/engine/reference/commandline/build/) (docker.com). | ||
|
|
||
| ## Podman (cri-o) | ||
|
|
||
| For Podman, there is no daemon running. The processes are started by the user, monitored by `conmon`. | ||
|
|
||
| So you need to use `minikube ssh`, and you will also make sure to run the command as the root user: | ||
|
|
||
| ```shell | ||
| sudo -E podman build | ||
| ``` | ||
|
|
||
| For more information on the `podman build` command, read the [Podman documentation](https://github.com/containers/libpod/blob/master/docs/podman-build.1.md) (podman.io). | ||
|
|
||
| ## Build context | ||
|
|
||
| For the build context you can use any directory on the virtual machine, or any address on the network. | ||
| This document has moved to https://minikube.sigs.k8s.io/docs/tasks/building_within/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1 @@ | ||
| # Caching Images | ||
|
|
||
| Minikube supports caching non-minikube images using the `minikube cache` command. Images can be added to the cache by running `minikube cache add <img>`, and deleted by running `minikube cache delete <img>`. | ||
|
|
||
| Images in the cache will be loaded on `minikube start`. If you want to list all available cached images, you can use `minikube cache list` command to list. Below is an example of this functionality: | ||
|
|
||
| ```shell | ||
| # cache a image into $HOME/.minikube/cache/images | ||
| $ minikube cache add ubuntu:16.04 | ||
| $ minikube cache add redis:3 | ||
|
|
||
| # list cached images | ||
| $ minikube cache list | ||
| redis:3 | ||
| ubuntu:16.04 | ||
|
|
||
| # delete cached images | ||
| $ minikube cache delete ubuntu:16.04 | ||
| $ minikube cache delete $(minikube cache list) | ||
| ``` | ||
| This document has moved to https://minikube.sigs.k8s.io/docs/tasks/caching |
Oops, something went wrong.