Skip to content

Commit 7559952

Browse files
committed
Point old documents to their new Hugo location
1 parent 294f880 commit 7559952

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+137
-2404
lines changed

Diff for: CONTRIBUTING.md

+1-21
Original file line numberDiff line numberDiff line change
@@ -1,21 +1 @@
1-
# Contributing guidelines
2-
3-
## Filing issues
4-
5-
File issues using the standard Github issue tracker for the repo.
6-
7-
## How to become a contributor and submit your own code
8-
9-
### Contributor License Agreements
10-
11-
We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.
12-
13-
[Please fill out either the individual or corporate Contributor License Agreement (CLA)](http://git.k8s.io/community/CLA.md)
14-
15-
### Contributing A Patch
16-
17-
1. Submit an issue describing your proposed change to the repo in question.
18-
1. The repo owner will respond to your issue promptly.
19-
1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
20-
1. Fork the desired repo, develop and test your code changes.
21-
1. Submit a pull request.
1+
This document has moved to https://minikube.sigs.k8s.io/docs/contributing/guide/

Diff for: docs/accessing_etcd.md

+1-11
Original file line numberDiff line numberDiff line change
@@ -1,11 +1 @@
1-
# Accessing Host Resources From Inside A Pod
2-
3-
## When you have a VirtualBox driver
4-
5-
In order to access host resources from inside a pod, run the following command to determine the host IP you can use:
6-
7-
```shell
8-
ip addr
9-
```
10-
11-
The IP address under `vboxnet1` is the IP that you need to access the host from within a pod.
1+
This document has moved to https://minikube.sigs.k8s.io/docs/tasks/accessing-host-resources/

Diff for: docs/addons.md

+1-50
Original file line numberDiff line numberDiff line change
@@ -1,50 +1 @@
1-
# Add-ons
2-
3-
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:
4-
5-
```shell
6-
$ minikube addons list
7-
- registry: disabled
8-
- registry-creds: disabled
9-
- freshpod: disabled
10-
- addon-manager: enabled
11-
- dashboard: enabled
12-
- heapster: disabled
13-
- efk: disabled
14-
- ingress: disabled
15-
- default-storageclass: enabled
16-
- storage-provisioner: enabled
17-
- storage-provisioner-gluster: disabled
18-
- nvidia-driver-installer: disabled
19-
- nvidia-gpu-device-plugin: disabled
20-
21-
# minikube must be running for these commands to take effect
22-
$ minikube addons enable heapster
23-
heapster was successfully enabled
24-
25-
$ minikube addons open heapster # This will open grafana (interacting w/ heapster) in the browser
26-
Waiting, endpoint for service is not ready yet...
27-
Waiting, endpoint for service is not ready yet...
28-
Created new window in existing browser session.
29-
```
30-
31-
The currently supported addons include:
32-
33-
* [Kubernetes Dashboard](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/dashboard)
34-
* [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
35-
* [EFK](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/fluentd-elasticsearch)
36-
* [Registry](https://github.com/kubernetes/minikube/tree/master/deploy/addons/registry)
37-
* [Registry Credentials](https://github.com/upmc-enterprises/registry-creds)
38-
* [Ingress](https://github.com/kubernetes/ingress-nginx)
39-
* [Freshpod](https://github.com/GoogleCloudPlatform/freshpod)
40-
* [nvidia-driver-installer](https://github.com/GoogleCloudPlatform/container-engine-accelerators/tree/master/nvidia-driver-installer/minikube)
41-
* [nvidia-gpu-device-plugin](https://github.com/GoogleCloudPlatform/container-engine-accelerators/tree/master/cmd/nvidia_gpu)
42-
* [logviewer](https://github.com/ivans3/minikube-log-viewer)
43-
* [gvisor](../deploy/addons/gvisor/README.md)
44-
* [storage-provisioner-gluster](../deploy/addons/storage-provisioner-gluster/README.md)
45-
46-
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.
47-
48-
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)
49-
50-
**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).
1+
This document has moved to https://minikube.sigs.k8s.io/docs/tasks/addons/

Diff for: docs/alternative_runtimes.md

+1-41
Original file line numberDiff line numberDiff line change
@@ -1,41 +1 @@
1-
# Alternative runtimes
2-
3-
## Using CRI-O
4-
5-
To use [CRI-O](https://github.com/kubernetes-sigs/cri-o) as the container runtime, run:
6-
7-
```shell
8-
$ minikube start --container-runtime=cri-o
9-
```
10-
11-
Or you can use the extended version:
12-
13-
```shell
14-
$ minikube start --container-runtime=cri-o \
15-
--network-plugin=cni \
16-
--enable-default-cni \
17-
--cri-socket=/var/run/crio/crio.sock \
18-
--extra-config=kubelet.container-runtime=remote \
19-
--extra-config=kubelet.container-runtime-endpoint=unix:///var/run/crio/crio.sock \
20-
--extra-config=kubelet.image-service-endpoint=unix:///var/run/crio/crio.sock
21-
```
22-
23-
## Using containerd
24-
25-
To use [containerd](https://github.com/containerd/containerd) as the container runtime, run:
26-
27-
```shell
28-
$ minikube start --container-runtime=containerd
29-
```
30-
31-
Or you can use the extended version:
32-
33-
```shell
34-
$ minikube start --container-runtime=containerd \
35-
--network-plugin=cni \
36-
--enable-default-cni \
37-
--cri-socket=/run/containerd/containerd.sock \
38-
--extra-config=kubelet.container-runtime=remote \
39-
--extra-config=kubelet.container-runtime-endpoint=unix:///run/containerd/containerd.sock \
40-
--extra-config=kubelet.image-service-endpoint=unix:///run/containerd/containerd.sock
41-
```
1+
This document has moved to https://minikube.sigs.k8s.io/docs/reference/runtimes/

Diff for: docs/building_images_within_the_vm.md

+1-31
Original file line numberDiff line numberDiff line change
@@ -1,31 +1 @@
1-
# Building images within the VM
2-
3-
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.
4-
5-
## Docker (containerd)
6-
7-
For Docker, you can either set up your host docker client to communicate by [reusing the docker daemon](reusing_the_docker_daemon.md).
8-
9-
Or you can use `minikube ssh` to connect to the virtual machine, and run the `docker build` there:
10-
11-
```shell
12-
docker build
13-
```
14-
15-
For more information on the `docker build` command, read the [Docker documentation](https://docs.docker.com/engine/reference/commandline/build/) (docker.com).
16-
17-
## Podman (cri-o)
18-
19-
For Podman, there is no daemon running. The processes are started by the user, monitored by `conmon`.
20-
21-
So you need to use `minikube ssh`, and you will also make sure to run the command as the root user:
22-
23-
```shell
24-
sudo -E podman build
25-
```
26-
27-
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).
28-
29-
## Build context
30-
31-
For the build context you can use any directory on the virtual machine, or any address on the network.
1+
This document has moved to https://minikube.sigs.k8s.io/docs/tasks/building_within/

Diff for: docs/cache.md

+1-20
Original file line numberDiff line numberDiff line change
@@ -1,20 +1 @@
1-
# Caching Images
2-
3-
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>`.
4-
5-
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:
6-
7-
```shell
8-
# cache a image into $HOME/.minikube/cache/images
9-
$ minikube cache add ubuntu:16.04
10-
$ minikube cache add redis:3
11-
12-
# list cached images
13-
$ minikube cache list
14-
redis:3
15-
ubuntu:16.04
16-
17-
# delete cached images
18-
$ minikube cache delete ubuntu:16.04
19-
$ minikube cache delete $(minikube cache list)
20-
```
1+
This document has moved to https://minikube.sigs.k8s.io/docs/tasks/caching

0 commit comments

Comments
 (0)