kubernetes
/
minikube
mirror of https://github.com/kubernetes/minikube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add unit test to check that docs are up to date 

This requires the following changes:

1. We need to pass in -ldflags to `go test`, since we need to know the curren iso version to correctly generate the description for --iso-url

2. We need to rewrite the description of the --driver flag on `minikube start` because it is operating system specific, which doesn't make sense for our documentation
pull/7385/head
Priya Wadhwa 2020-04-02 10:48:47 -07:00
parent 9405163530
commit 6fdecf2ebf
39 changed files with 1562 additions and 316 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Makefile
View File

@ -268,7 +268,7 @@ integration-versioned: out/minikube ## Trigger minikube integration testing
.PHONY: test
test: pkg/minikube/assets/assets.go pkg/minikube/translate/translations.go ## Trigger minikube test
./test.sh
MINIKUBE_LDFLAGS="${MINIKUBE_LDFLAGS}" ./test.sh
.PHONY: generate-docs
generate-docs: out/minikube
@ -278,10 +278,6 @@ generate-docs: out/minikube
extract: ## Compile extract tool
go run cmd/extract/extract.go
.PHONY: extract
extract: ## Compile extract tool
go run cmd/extract/extract.go
# Regenerates assets.go when template files have been updated
pkg/minikube/assets/assets.go: $(shell find "deploy/addons" -type f)
ifeq ($(MINIKUBE_BUILD_IN_DOCKER),y)

108
cmd/minikube/cmd/actual Normal file
View File

@ -0,0 +1,108 @@
---
title: "start"
linkTitle: "start"
weight: 1
date: 2020-04-01
description: >
Starts a local kubernetes cluster
---
## minikube start
Starts a local kubernetes cluster
### Synopsis
Starts a local kubernetes cluster
```
minikube start [flags]
```
### Options
```
--addons minikube addons list Enable addons. see minikube addons list for a list of valid addon names.
--apiserver-ips ipSlice A set of apiserver IP Addresses which are used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine (default [])
--apiserver-name string The apiserver name which is used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine (default "minikubeCA")
--apiserver-names stringArray A set of apiserver names which are used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine
--apiserver-port int The apiserver listening port (default 8443)
--auto-update-drivers If set, automatically updates drivers to the latest version. Defaults to true. (default true)
--cache-images If true, cache docker images for the current bootstrapper and load them into the machine. Always false with --driver=none. (default true)
--container-runtime string The container runtime to be used (docker, crio, containerd). (default "docker")
--cpus int Number of CPUs allocated to Kubernetes. (default 2)
--cri-socket string The cri socket path to be used.
--disable-driver-mounts Disables the filesystem mounts provided by the hypervisors
--disk-size string Disk size allocated to the minikube VM (format: <number>[<unit>], where unit = b, k, m or g). (default "20000mb")
--dns-domain string The cluster dns domain name used in the kubernetes cluster (default "cluster.local")
--dns-proxy Enable proxy for NAT DNS requests (virtualbox driver only)
--docker-env stringArray Environment variables to pass to the Docker daemon. (format: key=value)
--docker-opt stringArray Specify arbitrary flags to pass to the Docker daemon. (format: key=value)
--download-only If true, only download and cache files for later use - don't install or start anything.
--driver string Driver is one of: virtualbox, parallels, vmwarefusion, hyperkit, vmware, docker, podman (defaults to auto-detect)
--dry-run dry-run mode. Validates configuration, but does not mutate system state
--embed-certs if true, will embed the certs in kubeconfig.
--enable-default-cni Enable the default CNI plugin (/etc/cni/net.d/k8s.conf). Used in conjunction with "--network-plugin=cni".
--extra-config ExtraOption A set of key=value pairs that describe configuration that may be passed to different components.
The key should be '.' separated, and the first part before the dot is the component to apply the configuration to.
Valid components are: kubelet, kubeadm, apiserver, controller-manager, etcd, proxy, scheduler
Valid kubeadm parameters: ignore-preflight-errors, dry-run, kubeconfig, kubeconfig-dir, node-name, cri-socket, experimental-upload-certs, certificate-key, rootfs, skip-phases, pod-network-cidr
--feature-gates string A set of key=value pairs that describe feature gates for alpha/experimental features.
--force Force minikube to perform possibly dangerous operations
-h, --help help for start
--host-dns-resolver Enable host resolver for NAT DNS requests (virtualbox driver only) (default true)
--host-only-cidr string The CIDR to be used for the minikube VM (virtualbox driver only) (default "192.168.99.1/24")
--host-only-nic-type string NIC Type used for host only network. One of Am79C970A, Am79C973, 82540EM, 82543GC, 82545EM, or virtio (virtualbox driver only) (default "virtio")
--hyperkit-vpnkit-sock string Location of the VPNKit socket used for networking. If empty, disables Hyperkit VPNKitSock, if 'auto' uses Docker for Mac VPNKit connection, otherwise uses the specified VSock (hyperkit driver only)
--hyperkit-vsock-ports strings List of guest VSock ports that should be exposed as sockets on the host (hyperkit driver only)
--hyperv-external-adapter string External Adapter on which external switch will be created if no external switch is found. (hyperv driver only)
--hyperv-use-external-switch Whether to use external switch over Default Switch if virtual switch not explicitly specified. (hyperv driver only)
--hyperv-virtual-switch string The hyperv virtual switch name. Defaults to first found. (hyperv driver only)
--image-mirror-country string Country code of the image mirror to be used. Leave empty to use the global one. For Chinese mainland users, set it to cn.
--image-repository string Alternative image repository to pull docker images from. This can be used when you have limited access to gcr.io. Set it to "auto" to let minikube decide one for you. For Chinese mainland users, you may use local gcr.io mirrors such as registry.cn-hangzhou.aliyuncs.com/google_containers
--insecure-registry strings Insecure Docker registries to pass to the Docker daemon. The default service CIDR range will automatically be added.
--install-addons If set, install addons. Defaults to true. (default true)
--interactive Allow user prompts for more information (default true)
--iso-url strings Locations to fetch the minikube ISO from. (default [https://storage.googleapis.com/minikube/iso/minikube-v1.9.0.iso,https://github.com/kubernetes/minikube/releases/download/v1.9.0/minikube-v1.9.0.iso,https://kubernetes.oss-cn-hangzhou.aliyuncs.com/minikube/iso/minikube-v1.9.0.iso])
--keep-context This will keep the existing kubectl context and will create a minikube context.
--kubernetes-version string The kubernetes version that the minikube VM will use (ex: v1.2.3, 'stable' for v1.18.0, 'latest' for v1.18.0). Defaults to 'stable'.
--kvm-gpu Enable experimental NVIDIA GPU support in minikube
--kvm-hidden Hide the hypervisor signature from the guest in minikube (kvm2 driver only)
--kvm-network string The KVM network name. (kvm2 driver only) (default "default")
--kvm-qemu-uri string The KVM QEMU connection URI. (kvm2 driver only) (default "qemu:///system")
--memory string Amount of RAM to allocate to Kubernetes (format: <number>[<unit>], where unit = b, k, m or g).
--mount This will start the mount daemon and automatically mount files into minikube.
--mount-string string The argument to pass the minikube mount command on start. (default "/Users:/minikube-host")
--nat-nic-type string NIC Type used for host only network. One of Am79C970A, Am79C973, 82540EM, 82543GC, 82545EM, or virtio (virtualbox driver only) (default "virtio")
--native-ssh Use native Golang SSH client (default true). Set to 'false' to use the command line 'ssh' command when accessing the docker machine. Useful for the machine drivers when they will not start with 'Waiting for SSH'. (default true)
--network-plugin string The name of the network plugin.
--nfs-share strings Local folders to share with Guest via NFS mounts (hyperkit driver only)
--nfs-shares-root string Where to root the NFS Shares, defaults to /nfsshares (hyperkit driver only) (default "/nfsshares")
--no-vtx-check Disable checking for the availability of hardware virtualization before the vm is started (virtualbox driver only)
-n, --nodes int The number of nodes to spin up. Defaults to 1. (default 1)
--preload If set, download tarball of preloaded images if available to improve start time. Defaults to true. (default true)
--registry-mirror strings Registry mirrors to pass to the Docker daemon
--service-cluster-ip-range string The CIDR to be used for service cluster IPs. (default "10.96.0.0/12")
--uuid string Provide VM UUID to restore MAC address (hyperkit driver only)
--vm Filter to use only VM Drivers
--vm-driver driver DEPRECATED, use driver instead.
--wait Block until the apiserver is servicing API requests (default true)
--wait-timeout duration max time to wait per Kubernetes core services to be healthy. (default 6m0s)
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

108
cmd/minikube/cmd/expected Normal file
View File

@ -0,0 +1,108 @@
---
title: "start"
linkTitle: "start"
weight: 1
date: 2020-04-01
description: >
Starts a local kubernetes cluster
---
## minikube start
Starts a local kubernetes cluster
### Synopsis
Starts a local kubernetes cluster
```
minikube start [flags]
```
### Options
```
--addons minikube addons list Enable addons. see minikube addons list for a list of valid addon names.
--apiserver-ips ipSlice A set of apiserver IP Addresses which are used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine (default [])
--apiserver-name string The apiserver name which is used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine (default "minikubeCA")
--apiserver-names stringArray A set of apiserver names which are used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine
--apiserver-port int The apiserver listening port (default 8443)
--auto-update-drivers If set, automatically updates drivers to the latest version. Defaults to true. (default true)
--cache-images If true, cache docker images for the current bootstrapper and load them into the machine. Always false with --driver=none. (default true)
--container-runtime string The container runtime to be used (docker, crio, containerd). (default "docker")
--cpus int Number of CPUs allocated to Kubernetes. (default 2)
--cri-socket string The cri socket path to be used.
--disable-driver-mounts Disables the filesystem mounts provided by the hypervisors
--disk-size string Disk size allocated to the minikube VM (format: <number>[<unit>], where unit = b, k, m or g). (default "20000mb")
--dns-domain string The cluster dns domain name used in the kubernetes cluster (default "cluster.local")
--dns-proxy Enable proxy for NAT DNS requests (virtualbox driver only)
--docker-env stringArray Environment variables to pass to the Docker daemon. (format: key=value)
--docker-opt stringArray Specify arbitrary flags to pass to the Docker daemon. (format: key=value)
--download-only If true, only download and cache files for later use - don't install or start anything.
--driver string Driver is one of: virtualbox, parallels, vmwarefusion, hyperkit, vmware, docker, podman (experimental) (defaults to auto-detect)
--dry-run dry-run mode. Validates configuration, but does not mutate system state
--embed-certs if true, will embed the certs in kubeconfig.
--enable-default-cni Enable the default CNI plugin (/etc/cni/net.d/k8s.conf). Used in conjunction with "--network-plugin=cni".
--extra-config ExtraOption A set of key=value pairs that describe configuration that may be passed to different components.
The key should be '.' separated, and the first part before the dot is the component to apply the configuration to.
Valid components are: kubelet, kubeadm, apiserver, controller-manager, etcd, proxy, scheduler
Valid kubeadm parameters: ignore-preflight-errors, dry-run, kubeconfig, kubeconfig-dir, node-name, cri-socket, experimental-upload-certs, certificate-key, rootfs, skip-phases, pod-network-cidr
--feature-gates string A set of key=value pairs that describe feature gates for alpha/experimental features.
--force Force minikube to perform possibly dangerous operations
-h, --help help for start
--host-dns-resolver Enable host resolver for NAT DNS requests (virtualbox driver only) (default true)
--host-only-cidr string The CIDR to be used for the minikube VM (virtualbox driver only) (default "192.168.99.1/24")
--host-only-nic-type string NIC Type used for host only network. One of Am79C970A, Am79C973, 82540EM, 82543GC, 82545EM, or virtio (virtualbox driver only) (default "virtio")
--hyperkit-vpnkit-sock string Location of the VPNKit socket used for networking. If empty, disables Hyperkit VPNKitSock, if 'auto' uses Docker for Mac VPNKit connection, otherwise uses the specified VSock (hyperkit driver only)
--hyperkit-vsock-ports strings List of guest VSock ports that should be exposed as sockets on the host (hyperkit driver only)
--hyperv-external-adapter string External Adapter on which external switch will be created if no external switch is found. (hyperv driver only)
--hyperv-use-external-switch Whether to use external switch over Default Switch if virtual switch not explicitly specified. (hyperv driver only)
--hyperv-virtual-switch string The hyperv virtual switch name. Defaults to first found. (hyperv driver only)
--image-mirror-country string Country code of the image mirror to be used. Leave empty to use the global one. For Chinese mainland users, set it to cn.
--image-repository string Alternative image repository to pull docker images from. This can be used when you have limited access to gcr.io. Set it to "auto" to let minikube decide one for you. For Chinese mainland users, you may use local gcr.io mirrors such as registry.cn-hangzhou.aliyuncs.com/google_containers
--insecure-registry strings Insecure Docker registries to pass to the Docker daemon. The default service CIDR range will automatically be added.
--install-addons If set, install addons. Defaults to true. (default true)
--interactive Allow user prompts for more information (default true)
--iso-url strings Locations to fetch the minikube ISO from. (default [https://storage.googleapis.com/minikube/iso/minikube-v1.9.0.iso,https://github.com/kubernetes/minikube/releases/download/v1.9.0/minikube-v1.9.0.iso,https://kubernetes.oss-cn-hangzhou.aliyuncs.com/minikube/iso/minikube-v1.9.0.iso])
--keep-context This will keep the existing kubectl context and will create a minikube context.
--kubernetes-version string The kubernetes version that the minikube VM will use (ex: v1.2.3, 'stable' for v1.18.0, 'latest' for v1.18.0). Defaults to 'stable'.
--kvm-gpu Enable experimental NVIDIA GPU support in minikube
--kvm-hidden Hide the hypervisor signature from the guest in minikube (kvm2 driver only)
--kvm-network string The KVM network name. (kvm2 driver only) (default "default")
--kvm-qemu-uri string The KVM QEMU connection URI. (kvm2 driver only) (default "qemu:///system")
--memory string Amount of RAM to allocate to Kubernetes (format: <number>[<unit>], where unit = b, k, m or g).
--mount This will start the mount daemon and automatically mount files into minikube.
--mount-string string The argument to pass the minikube mount command on start. (default "/Users:/minikube-host")
--nat-nic-type string NIC Type used for host only network. One of Am79C970A, Am79C973, 82540EM, 82543GC, 82545EM, or virtio (virtualbox driver only) (default "virtio")
--native-ssh Use native Golang SSH client (default true). Set to 'false' to use the command line 'ssh' command when accessing the docker machine. Useful for the machine drivers when they will not start with 'Waiting for SSH'. (default true)
--network-plugin string The name of the network plugin.
--nfs-share strings Local folders to share with Guest via NFS mounts (hyperkit driver only)
--nfs-shares-root string Where to root the NFS Shares, defaults to /nfsshares (hyperkit driver only) (default "/nfsshares")
--no-vtx-check Disable checking for the availability of hardware virtualization before the vm is started (virtualbox driver only)
-n, --nodes int The number of nodes to spin up. Defaults to 1. (default 1)
--preload If set, download tarball of preloaded images if available to improve start time. Defaults to true. (default true)
--registry-mirror strings Registry mirrors to pass to the Docker daemon
--service-cluster-ip-range string The CIDR to be used for service cluster IPs. (default "10.96.0.0/12")
--uuid string Provide VM UUID to restore MAC address (hyperkit driver only)
--vm Filter to use only VM Drivers
--vm-driver driver DEPRECATED, use driver instead.
--wait Block until the apiserver is servicing API requests (default true)
--wait-timeout duration max time to wait per Kubernetes core services to be healthy. (default 6m0s)
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

5
cmd/minikube/cmd/generate-docs_test.go
View File

@ -22,6 +22,7 @@ import (
"path/filepath"
"testing"
"github.com/google/go-cmp/cmp"
"k8s.io/minikube/pkg/generate"
)
@ -39,8 +40,8 @@ func TestCommandsDocs(t *testing.T) {
if err != nil {
t.Fatalf("error getting contents: %v", err)
}
if string(actualContents) != string(expectedContents) {
t.Fatalf("Docs are not updated. Please run `make generate-docs` to update commands documentation.")
if diff := cmp.Diff(actualContents, string(expectedContents)); diff != "" {
t.Fatalf("Docs are not updated. Please run `make generate-docs` to update commands documentation: %s", diff)
}
})
}

20
pkg/generate/docs.go
View File

@ -40,24 +40,26 @@ func Docs(root *cobra.Command, path string) error {
for _, c := range cmds {
contents, err := DocForCommand(c)
if err != nil {
return errors.Wrapf(err, "generating doc for %s", c.Name)
return errors.Wrapf(err, "generating doc for %s", c.Name())
}
if err := saveDocForCommand(c, contents, path); err != nil {
if err := saveDocForCommand(c, []byte(contents), path); err != nil {
return errors.Wrapf(err, "saving doc for %s", c.Name())
}
}
return nil
}
func DocForCommand(command *cobra.Command) ([]byte, error) {
// DocForCommand returns the specific doc for that command
func DocForCommand(command *cobra.Command) (string, error) {
buf := bytes.NewBuffer([]byte{})
if err := generateTitle(command, buf); err != nil {
return nil, errors.Wrap(err, "generating title")
return "", errors.Wrap(err, "generating title")
}
if err := writeSubcommands(command, buf); err != nil {
return nil, errors.Wrap(err, "writing subcommands")
return "", errors.Wrap(err, "writing subcommands")
}
return removeHelpCommand(buf), nil
edited := removeHelpCommand(buf)
return rewriteFlags(command, edited), nil
}
// after every command, cobra automatically appends
@ -66,9 +68,9 @@ func DocForCommand(command *cobra.Command) ([]byte, error) {
// * [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons
// ###### Auto generated by spf13/cobra on 1-Apr-2020
// help text which is unecessary info after every subcommand
// help text which is unnecessary info after every subcommand
// This function removes that text.
func removeHelpCommand(buffer *bytes.Buffer) []byte {
func removeHelpCommand(buffer *bytes.Buffer) string {
beginningHelpText := "### SEE ALSO"
endHelpText := "###### Auto generated by spf13/cobra"
scanner := bufio.NewScanner(buffer)
@ -94,7 +96,7 @@ func removeHelpCommand(buffer *bytes.Buffer) []byte {
break
}
}
return final.Bytes()
return final.String()
}
func writeSubcommands(command *cobra.Command, w io.Writer) error {

4
pkg/generate/docs_templates.go
View File

@ -17,8 +17,8 @@ limitations under the License.
package generate
var title = `---
title: {{.Command}}
linkTitle: {{.Command}}
title: "{{.Command}}"
linkTitle: "{{.Command}}"
weight: 1
date: {{.Date}}
description: >

66
pkg/generate/rewrite.go Normal file
View File

@ -0,0 +1,66 @@
/*
Copyright 2020 The Kubernetes Authors All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package generate
import (
"strings"
"github.com/spf13/cobra"
)
type rewrite struct {
flag string
description string
}
// rewriteFlags rewrites flags that are dependent on operating system
// for example, for `minikube start`, the description of --driver
// outputs possible drivers for the operating system
func rewriteFlags(command *cobra.Command, contents string) string {
rewrites := map[string][]rewrite{
"start": []rewrite{{
flag: "--driver",
description: "Used to specify the driver to run kubernetes in. The list of available drivers depends on operating system.",
}},
}
rws, ok := rewrites[command.Name()]
if !ok {
return contents
}
for _, r := range rws {
contents = rewriteFlag(contents, r.flag, r.description)
}
return contents
}
func rewriteFlag(contents, flag, description string) string {
lines := strings.Split(contents, "\n")
for i, l := range lines {
if strings.Contains(l, flag) {
spacesBetween := 42 - len(flag)
// docs start with a prefix of 6 spaces
replacement := " "
replacement += flag
for i := 0; i < spacesBetween; i++ {
replacement += " "
}
replacement += description
lines[i] = replacement
}
}
return strings.Join(lines, "")
}

2
pkg/minikube/out/style_test.go
View File

@ -177,7 +177,7 @@ func TestApplyTemplateFormating(t *testing.T) {
}
for _, test := range tests {
t.Run(test.description, func(t *testing.T) {
rawGot := applyTemplateFormatting(test.styleEnum, test.useColor, test.format, test.a...)
rawGot := ApplyTemplateFormatting(test.styleEnum, test.useColor, test.format, test.a...)
got := strings.TrimSpace(rawGot)
if got != test.expected {
t.Errorf("Expected '%v' but got '%v'", test.expected, got)

8
site/content/en/docs/Reference/Commands/_index.md
View File

@ -1,8 +0,0 @@
---
title: "Commands"
linkTitle: "Commands"
weight: 1
date: 2019-08-01
description: >
minikube command reference
---

175
site/content/en/docs/Reference/Commands/addons.md
View File

@ -2,53 +2,182 @@
title: "addons"
linkTitle: "addons"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Modifies minikube addons files using subcommands like "minikube addons enable dashboard"
Modify minikube's kubernetes addons
---
## Overview
* **configure**: Configures the addon w/ADDON_NAME within minikube
* **disable**: Disables the addon w/ADDON_NAME within minikube
* **enable**: Enables the addon w/ADDON_NAME within minikube
* **list**: Lists all available minikube addons as well as their current statuses (enabled/disabled)
* **open**: Opens the addon w/ADDON_NAME within minikube
## minikube addons
Modify minikube's kubernetes addons
### Synopsis
addons modifies minikube addons files using subcommands like "minikube addons enable dashboard"
```
minikube addons SUBCOMMAND [flags]
```
### Options
```
-h, --help help for addons
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube addons configure
Configures the addon w/ADDON_NAME within minikube (example: minikube addons configure registry-creds). For a list of available addons use: minikube addons list
### Synopsis
Configures the addon w/ADDON_NAME within minikube (example: minikube addons configure registry-creds). For a list of available addons use: minikube addons list
```
minikube addons configure ADDON_NAME [flags]
```
### Options
```
-h, --help help for configure
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube addons disable
Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list
### Synopsis
Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list
```
minikube addons disable ADDON_NAME [flags]
```
### Options
```
-h, --help help for disable
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube addons enable
Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list
### Synopsis
Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list
```
minikube addons enable ADDON_NAME [flags]
```
or
### Options
```
minikube start --addons ADDON_NAME [flags]
-h, --help help for enable
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube addons help
Help about any command
### Synopsis
Help provides help for any command in the application.
Simply type addons help [path to command] for full details.
```
minikube addons help [command] [flags]
```
### Options
```
-h, --help help for help
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube addons list
Lists all available minikube addons as well as their current statuses (enabled/disabled)
### Synopsis
Lists all available minikube addons as well as their current statuses (enabled/disabled)
```
minikube addons list [flags]
```
@ -60,10 +189,28 @@ minikube addons list [flags]
-o, --output string minikube addons list --output OUTPUT. json, list (default "list")
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube addons open
Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list
### Synopsis
Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list
```
minikube addons open ADDON_NAME [flags]
```
@ -74,13 +221,12 @@ minikube addons open ADDON_NAME [flags]
--format string Format to output addons URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}")
-h, --help help for open
--https Open the addons URL with https instead of http
--interval int The time interval for each check that wait performs in seconds (default 6)
--interval int The time interval for each check that wait performs in seconds (default 1)
--url Display the kubernetes addons URL in the CLI instead of opening it in the default browser
--wait int Amount of time to wait for service in seconds (default 20)
--wait int Amount of time to wait for service in seconds (default 2)
```
## Options inherited from parent commands
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
@ -93,3 +239,4 @@ minikube addons open ADDON_NAME [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

157
site/content/en/docs/Reference/Commands/cache.md
View File

@ -2,32 +2,146 @@
title: "cache"
linkTitle: "cache"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Add or delete an image from the local cache.
---
## minikube cache
Add or delete an image from the local cache.
### Synopsis
Add or delete an image from the local cache.
### Options
```
-h, --help help for cache
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube cache add
Add an image to local cache.
### Synopsis
Add an image to local cache.
```
minikube cache add [flags]
```
### Options
```
-h, --help help for add
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube cache delete
Delete an image from the local cache.
### Synopsis
Delete an image from the local cache.
```
minikube cache delete [flags]
```
### Options
```
-h, --help help for delete
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube cache help
Help about any command
### Synopsis
Help provides help for any command in the application.
Simply type cache help [path to command] for full details.
```
minikube cache help [command] [flags]
```
### Options
```
-h, --help help for help
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube cache list
List all available images from the local cache.
### Synopsis
List all available images from the local cache.
```
minikube cache list [flags]
```
@ -40,10 +154,49 @@ minikube cache list [flags]
-h, --help help for list
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube cache reload
reload cached images.
### Synopsis
reloads images previously added using the 'cache add' subcommand
```
minikube cache reload [flags]
```
```
### Options
```
-h, --help help for reload
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

48
site/content/en/docs/Reference/Commands/completion.md
View File

@ -2,45 +2,50 @@
title: "completion"
linkTitle: "completion"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Outputs minikube shell completion for the given shell (bash or zsh)
---
### Overview
## minikube completion
Outputs minikube shell completion for the given shell (bash or zsh)
This depends on the bash-completion binary. Example installation instructions:
### Synopsis
Outputs minikube shell completion for the given shell (bash or zsh)
This depends on the bash-completion binary. Example installation instructions:
OS X:
$ brew install bash-completion
$ source $(brew --prefix)/etc/bash_completion
$ minikube completion bash > ~/.minikube-completion # for bash users
$ minikube completion zsh > ~/.minikube-completion # for zsh users
$ source ~/.minikube-completion
Ubuntu:
$ apt-get install bash-completion
$ source /etc/bash-completion
$ source <(minikube completion bash) # for bash users
$ source <(minikube completion zsh) # for zsh users
Additionally, you may want to output the completion to a file and source in your .bashrc
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
### Usage
```
minikube completion SHELL [flags]
```
## Example: macOS
### Options
```shell
brew install bash-completion
source $(brew --prefix)/etc/bash_completion
minikube completion bash > ~/.minikube-completion # for bash users
$ minikube completion zsh > ~/.minikube-completion # for zsh users
$ source ~/.minikube-completion
```
## Example: Ubuntu
```shell
apt-get install bash-completion
source /etc/bash-completion
source <(minikube completion bash) # for bash users
source <(minikube completion zsh) # for zsh users
-h, --help help for completion
```
Additionally, you may want to output the completion to a file and source in your .bashrc
### Options inherited from parent commands
```
@ -54,3 +59,4 @@ Additionally, you may want to output the completion to a file and source in your
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

152
site/content/en/docs/Reference/Commands/config.md
View File

@ -2,18 +2,24 @@
title: "config"
linkTitle: "config"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Modify minikube config
---
### Overview
## minikube config
Modify minikube config
### Synopsis
config modifies minikube config files using subcommands like "minikube config set driver kvm"
Configurable fields:
* driver
* vm-driver
* container-runtime
* feature-gates
* v
@ -41,51 +47,168 @@ Configurable fields:
* embed-certs
* native-ssh
```
minikube config SUBCOMMAND [flags]
```
### subcommands
### Options
- **get**: Gets the value of PROPERTY_NAME from the minikube config file
```
-h, --help help for config
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube config get
Returns the value of PROPERTY_NAME from the minikube config file. Can be overwritten at runtime by flags or environmental variables.
Gets the value of PROPERTY_NAME from the minikube config file
### Usage
### Synopsis
Returns the value of PROPERTY_NAME from the minikube config file. Can be overwritten at runtime by flags or environmental variables.
```
minikube config get PROPERTY_NAME [flags]
```
### Options
```
-h, --help help for get
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube config help
Help about any command
### Synopsis
Help provides help for any command in the application.
Simply type config help [path to command] for full details.
```
minikube config help [command] [flags]
```
### Options
```
-h, --help help for help
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube config set
Sets an individual value in a minikube config file
### Synopsis
Sets the PROPERTY_NAME config value to PROPERTY_VALUE
These values can be overwritten by flags or environment variables at runtime.
### Usage
```
minikube config set PROPERTY_NAME PROPERTY_VALUE [flags]
```
### Options
```
-h, --help help for set
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube config unset
unsets PROPERTY_NAME from the minikube config file. Can be overwritten by flags or environmental variables
unsets an individual value in a minikube config file
### Usage
### Synopsis
unsets PROPERTY_NAME from the minikube config file. Can be overwritten by flags or environmental variables
```
minikube config unset PROPERTY_NAME [flags]
```
### Options
```
-h, --help help for unset
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube config view
### Overview
Display values currently set in the minikube config file
### Synopsis
Display values currently set in the minikube config file.
### Usage
```
minikube config view [flags]
```
@ -111,3 +234,4 @@ minikube config view [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

19
site/content/en/docs/Reference/Commands/dashboard.md
View File

@ -2,25 +2,33 @@
title: "dashboard"
linkTitle: "dashboard"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Access the Kubernetes dashboard running within the minikube cluster
Access the kubernetes dashboard running within the minikube cluster
---
## Usage
## minikube dashboard
Access the kubernetes dashboard running within the minikube cluster
### Synopsis
Access the kubernetes dashboard running within the minikube cluster
```
minikube dashboard [flags]
```
## Options
### Options
```
-h, --help help for dashboard
--url Display dashboard URL instead of opening a browser
```
## Options inherited from parent commands
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
@ -33,3 +41,4 @@ minikube dashboard [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

41
site/content/en/docs/Reference/Commands/delete.md
View File

@ -2,44 +2,32 @@
title: "delete"
linkTitle: "delete"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Deletes a local Kubernetes cluster
Deletes a local kubernetes cluster
---
### Overview
Deletes a local Kubernetes cluster. This command deletes the VM, and removes all
## minikube delete
Deletes a local kubernetes cluster
### Synopsis
Deletes a local kubernetes cluster. This command deletes the VM, and removes all
associated files.
## Usage
```
minikube delete [flags]
```
##### Delete all profiles
```
minikube delete --all
```
##### Delete profile & `.minikube` directory
Do note that the following command only works if you have only 1 profile. If there are multiple profiles, the command will error out.
```
minikube delete --purge
```
##### Delete all profiles & `.minikube` directory
This will delete all the profiles and `.minikube` directory.
```
minikube delete --purge --all
```
### Flags
### Options
```
--all: Set flag to delete all profiles
--purge: Set this flag to delete the '.minikube' folder from your user directory.
--all Set flag to delete all profiles
-h, --help help for delete
--purge Set this flag to delete the '.minikube' folder from your user directory.
```
### Options inherited from parent commands
@ -55,3 +43,4 @@ minikube delete --purge --all
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

13
site/content/en/docs/Reference/Commands/docker-env.md
View File

@ -2,12 +2,20 @@
title: "docker-env"
linkTitle: "docker-env"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Sets up docker env variables; similar to '$(docker-machine env)'
---
### Usage
## minikube docker-env
Sets up docker env variables; similar to '$(docker-machine env)'
### Synopsis
Sets up docker env variables; similar to '$(docker-machine env)'.
```
minikube docker-env [flags]
@ -35,3 +43,4 @@ minikube docker-env [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

50
site/content/en/docs/Reference/Commands/generate-docs.md Normal file
View File

@ -0,0 +1,50 @@
---
title: "generate-docs"
linkTitle: "generate-docs"
weight: 1
date: 2020-04-02
description: >
Populates the specified folder with documentation in markdown about minikube
---
## minikube generate-docs
Populates the specified folder with documentation in markdown about minikube
### Synopsis
Populates the specified folder with documentation in markdown about minikube
```
minikube generate-docs [flags]
```
### Examples
```
minikube generate-docs --path <FOLDER_PATH>
```
### Options
```
-h, --help help for generate-docs
--path string The path on the file system where the docs in markdown need to be saved
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

44
site/content/en/docs/Reference/Commands/help.md Normal file
View File

@ -0,0 +1,44 @@
---
title: "help"
linkTitle: "help"
weight: 1
date: 2020-04-02
description: >
Help about any command
---
## minikube help
Help about any command
### Synopsis
Help provides help for any command in the application.
Simply type minikube help [path to command] for full details.
```
minikube help [command] [flags]
```
### Options
```
-h, --help help for help
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

19
site/content/en/docs/Reference/Commands/ip.md
View File

@ -2,21 +2,31 @@
title: "ip"
linkTitle: "ip"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Retrieves the IP address of the running cluster
---
### Overview
## minikube ip
Retrieves the IP address of the running cluster
### Synopsis
Retrieves the IP address of the running cluster, and writes it to STDOUT.
### Usage
```
minikube ip [flags]
```
### Options
```
-h, --help help for ip
```
### Options inherited from parent commands
```
@ -30,3 +40,4 @@ minikube ip [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

23
site/content/en/docs/Reference/Commands/kubectl.md
View File

@ -2,31 +2,35 @@
title: "kubectl"
linkTitle: "kubectl"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Run kubectl
---
### Overview
Run the Kubernetes client, download it if necessary.
Remember `--` after kubectl!
## minikube kubectl
### Usage
Run kubectl
### Synopsis
Run the kubernetes client, download it if necessary. Remember -- after kubectl!
Examples:
minikube kubectl -- --help
minikube kubectl -- get pods --namespace kube-system
```
minikube kubectl [flags]
```
### Examples:
### Options
```
minikube kubectl -- --help
minikube kubectl -- get pods --namespace kube-system
-h, --help help for kubectl
```
### Options inherited from parent commands
```
@ -40,3 +44,4 @@ minikube kubectl -- get pods --namespace kube-system
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

24
site/content/en/docs/Reference/Commands/logs.md
View File

@ -2,12 +2,20 @@
title: "logs"
linkTitle: "logs"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Gets the logs of the running instance, used for debugging minikube, not user code
Gets the logs of the running instance, used for debugging minikube, not user code.
---
## Usage
## minikube logs
Gets the logs of the running instance, used for debugging minikube, not user code.
### Synopsis
Gets the logs of the running instance, used for debugging minikube, not user code.
```
minikube logs [flags]
@ -16,10 +24,11 @@ minikube logs [flags]
### Options
```
-f, --follow Show only the most recent journal entries, and continuously print new entries as they are appended to the journal.
-h, --help help for logs
-n, --length int Number of lines back to go within the log (default 60)
--problems Show only log entries which point to known problems
-f, --follow Show only the most recent journal entries, and continuously print new entries as they are appended to the journal.
-h, --help help for logs
-n, --length int Number of lines back to go within the log (default 60)
--node string The node to get logs from. Defaults to the primary control plane.
--problems Show only log entries which point to known problems
```
### Options inherited from parent commands
@ -35,3 +44,4 @@ minikube logs [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

13
site/content/en/docs/Reference/Commands/mount.md
View File

@ -2,12 +2,20 @@
title: "mount"
linkTitle: "mount"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Mounts the specified directory into minikube
---
### Usage
## minikube mount
Mounts the specified directory into minikube
### Synopsis
Mounts the specified directory into minikube.
```
minikube mount [flags] <source directory>:<target directory>
@ -41,3 +49,4 @@ minikube mount [flags] <source directory>:<target directory>
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

208
site/content/en/docs/Reference/Commands/node.md Normal file
View File

@ -0,0 +1,208 @@
---
title: "node"
linkTitle: "node"
weight: 1
date: 2020-04-02
description: >
Node operations
---
## minikube node
Node operations
### Synopsis
Operations on nodes
```
minikube node [flags]
```
### Options
```
-h, --help help for node
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube node add
Adds a node to the given cluster.
### Synopsis
Adds a node to the given cluster config, and starts it.
```
minikube node add [flags]
```
### Options
```
--control-plane If true, the node added will also be a control plane in addition to a worker.
-h, --help help for add
--worker If true, the added node will be marked for work. Defaults to true. (default true)
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube node delete
Deletes a node from a cluster.
### Synopsis
Deletes a node from a cluster.
```
minikube node delete [flags]
```
### Options
```
-h, --help help for delete
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube node help
Help about any command
### Synopsis
Help provides help for any command in the application.
Simply type node help [path to command] for full details.
```
minikube node help [command] [flags]
```
### Options
```
-h, --help help for help
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube node start
Starts a node.
### Synopsis
Starts an existing stopped node in a cluster.
```
minikube node start [flags]
```
### Options
```
-h, --help help for start
--name string The name of the node to start
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube node stop
Stops a node in a cluster.
### Synopsis
Stops a node in a cluster.
```
minikube node stop [flags]
```
### Options
```
-h, --help help for stop
--name string The name of the node to delete
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

43
site/content/en/docs/Reference/Commands/options.md Normal file
View File

@ -0,0 +1,43 @@
---
title: "options"
linkTitle: "options"
weight: 1
date: 2020-04-02
description: >
Show a list of global command-line options (applies to all commands).
---
## minikube options
Show a list of global command-line options (applies to all commands).
### Synopsis
Show a list of global command-line options (applies to all commands).
```
minikube options [flags]
```
### Options
```
-h, --help help for options
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

19
site/content/en/docs/Reference/Commands/pause.md
View File

@ -2,18 +2,20 @@
title: "pause"
linkTitle: "pause"
weight: 1
date: 2020-02-05
date: 2020-04-02
description: >
pause the Kubernetes control plane or other namespaces
pause containers
---
### Overview
The pause command allows you to freeze containers using the Linux [cgroup freezer](https://www.kernel.org/doc/Documentation/cgroup-v1/freezer-subsystem.txt). Once frozen, processes will no longer consume CPU cycles, but will remain in memory.
By default, the pause command will pause the Kubernetes control plane (kube-system namespace), leaving your applications running. This reduces the background CPU usage of a minikube cluster to a negligible 2-3% of a CPU.
## minikube pause
### Usage
pause containers
### Synopsis
pause containers
```
minikube pause [flags]
@ -31,6 +33,7 @@ minikube pause [flags]
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
@ -40,7 +43,3 @@ minikube pause [flags]
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [unpause](unpause.md)

45
site/content/en/docs/Reference/Commands/podman-env.md Normal file
View File

@ -0,0 +1,45 @@
---
title: "podman-env"
linkTitle: "podman-env"
weight: 1
date: 2020-04-02
description: >
Sets up podman env variables; similar to '$(podman-machine env)'
---
## minikube podman-env
Sets up podman env variables; similar to '$(podman-machine env)'
### Synopsis
Sets up podman env variables; similar to '$(podman-machine env)'.
```
minikube podman-env [flags]
```
### Options
```
-h, --help help for podman-env
--shell string Force environment to be configured for a specified shell: [fish, cmd, powershell, tcsh, bash, zsh], default is auto-detect
-u, --unset Unset variables instead of setting them
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

71
site/content/en/docs/Reference/Commands/profile.md
View File

@ -2,26 +2,30 @@
title: "profile"
linkTitle: "profile"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Profile gets or sets the current minikube profile
---
### Overview
## minikube profile
Profile gets or sets the current minikube profile
### Synopsis
profile sets the current minikube profile, or gets the current profile if no arguments are provided. This is used to run and manage multiple minikube instance. You can return to the default minikube profile by running `minikube profile default`
### Usage
```
minikube profile [MINIKUBE_PROFILE_NAME]
You can return to the default minikube profile by running `minikube profile default` [flags]
minikube profile [MINIKUBE_PROFILE_NAME]. You can return to the default minikube profile by running `minikube profile default` [flags]
```
## Subcommands
### Options
- **list**: Lists all minikube profiles.
```
-h, --help help for profile
```
### Options inherited from parent commands
@ -37,12 +41,44 @@ You can return to the default minikube profile by running `minikube profile defa
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube profile help
Help about any command
### Synopsis
Help provides help for any command in the application.
Simply type profile help [path to command] for full details.
```
minikube profile help [command] [flags]
```
### Options
```
-h, --help help for help
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube profile list
Lists all minikube profiles.
### Overview
### Synopsis
Lists all valid minikube profiles and detects all possible invalid profiles.
@ -56,3 +92,18 @@ minikube profile list [flags]
-h, --help help for list
-o, --output string The output format. One of 'json', 'table' (default "table")
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

75
site/content/en/docs/Reference/Commands/service.md
View File

@ -2,35 +2,35 @@
title: "service"
linkTitle: "service"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Gets the Kubernetes URL(s) for the specified service in your local cluster
Gets the kubernetes URL(s) for the specified service in your local cluster
---
### Overview
Gets the Kubernetes URL(s) for the specified service in your local cluster. In the case of multiple URLs they will be printed one at a time.
### Usage
## minikube service
Gets the kubernetes URL(s) for the specified service in your local cluster
### Synopsis
Gets the kubernetes URL(s) for the specified service in your local cluster. In the case of multiple URLs they will be printed one at a time.
```
minikube service [flags] SERVICE
```
### Subcommands
- **list**: Lists the URLs for the services in your local cluster
### Options
```
--format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}")
-h, --help help for service
--https Open the service URL with https instead of http
--interval int The initial time interval for each check that wait performs in seconds (default 6)
--interval int The initial time interval for each check that wait performs in seconds (default 1)
-n, --namespace string The service namespace (default "default")
--url Display the kubernetes service URL in the CLI instead of opening it in the default browser
--wait int Amount of time to wait for a service in seconds (default 20)
--wait int Amount of time to wait for a service in seconds (default 2)
```
### Options inherited from parent commands
@ -47,10 +47,48 @@ minikube service [flags] SERVICE
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube service help
Help about any command
### Synopsis
Help provides help for any command in the application.
Simply type service help [path to command] for full details.
```
minikube service help [command] [flags]
```
### Options
```
-h, --help help for help
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
## minikube service list
Lists the URLs for the services in your local cluster
### Synopsis
Lists the URLs for the services in your local cluster
```
minikube service list [flags]
```
@ -62,3 +100,18 @@ minikube service list [flags]
-n, --namespace string The services namespace
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

21
site/content/en/docs/Reference/Commands/ssh-key.md
View File

@ -1,18 +1,32 @@
---
title: "ssh-key"
linkTitle: "sshs-key"
linkTitle: "ssh-key"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Retrieve the ssh identity key path of the specified cluster
---
### Usage
## minikube ssh-key
Retrieve the ssh identity key path of the specified cluster
### Synopsis
Retrieve the ssh identity key path of the specified cluster.
```
minikube ssh-key [flags]
```
### Options
```
-h, --help help for ssh-key
```
### Options inherited from parent commands
```
@ -26,3 +40,4 @@ minikube ssh-key [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

31
site/content/en/docs/Reference/Commands/ssh.md
View File

@ -2,13 +2,20 @@
title: "ssh"
linkTitle: "ssh"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'
---
### Usage
## minikube ssh
Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'
### Synopsis
Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'.
```
minikube ssh [flags]
@ -17,6 +24,22 @@ minikube ssh [flags]
### Options
```
-h, --help help for ssh
--native-ssh Use native Golang SSH client (default true). Set to 'false' to use the command line 'ssh' command when accessing the docker machine. Useful for the machine drivers when they will not start with 'Waiting for SSH'. (default true)
-h, --help help for ssh
--native-ssh Use native Golang SSH client (default true). Set to 'false' to use the command line 'ssh' command when accessing the docker machine. Useful for the machine drivers when they will not start with 'Waiting for SSH'. (default true)
-n, --node string The node to ssh into. Defaults to the primary control plane.
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

96
site/content/en/docs/Reference/Commands/start.md
View File

File diff suppressed because one or more lines are too long

38
site/content/en/docs/Reference/Commands/status.md
View File

@ -2,19 +2,22 @@
title: "status"
linkTitle: "status"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Gets the status of a local Kubernetes cluster
Gets the status of a local kubernetes cluster
---
### Overview
Gets the status of a local Kubernetes cluster.
Exit status contains the status of minikube's VM, cluster and Kubernetes encoded on it's bits in this order from right to left.
Eg: 7 meaning: 1 (for minikube NOK) + 2 (for cluster NOK) + 4 (for Kubernetes NOK)
## minikube status
### Usage
Gets the status of a local kubernetes cluster
### Synopsis
Gets the status of a local kubernetes cluster.
Exit status contains the status of minikube's VM, cluster and kubernetes encoded on it's bits in this order from right to left.
Eg: 7 meaning: 1 (for minikube NOK) + 2 (for cluster NOK) + 4 (for kubernetes NOK)
```
minikube status [flags]
@ -23,30 +26,14 @@ minikube status [flags]
### Options
```
-f, --format string Go template format string for the status output. The format for Go templates can be found here: https://golang.org/pkg/text/template/
For the list accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#Status (default "host: {{.Host}}\nkubelet: {{.Kubelet}}\napiserver: {{.APIServer}}\nkubeconfig: {{.Kubeconfig}}\n")
-f, --format string Go template format string for the status output. The format for Go templates can be found here: https://golang.org/pkg/text/template/
For the list accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#Status (default "{{.Name}}\nhost: {{.Host}}\nkubelet: {{.Kubelet}}\napiserver: {{.APIServer}}\nkubeconfig: {{.Kubeconfig}}\n\n")
-h, --help help for status
-o, --output string minikube status --output OUTPUT. json, text (default "text")
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
@ -58,3 +45,4 @@ minikube status [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

23
site/content/en/docs/Reference/Commands/stop.md
View File

@ -2,22 +2,32 @@
title: "stop"
linkTitle: "stop"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Stops a running local Kubernetes cluster
Stops a running local kubernetes cluster
---
### Overview
Stops a local Kubernetes cluster running in Virtualbox. This command stops the VM
## minikube stop
Stops a running local kubernetes cluster
### Synopsis
Stops a local kubernetes cluster running in Virtualbox. This command stops the VM
itself, leaving all files intact. The cluster can be started again with the "start" command.
### Usage
```
minikube stop [flags]
```
### Options
```
-h, --help help for stop
```
### Options inherited from parent commands
```
@ -31,3 +41,4 @@ minikube stop [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

12
site/content/en/docs/Reference/Commands/tunnel.md
View File

@ -2,16 +2,20 @@
title: "tunnel"
linkTitle: "tunnel"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
tunnel makes services of type LoadBalancer accessible on localhost
---
### Overview
tunnel creates a route to services deployed with type LoadBalancer and sets their Ingress to their ClusterIP
### Usage
## minikube tunnel
tunnel makes services of type LoadBalancer accessible on localhost
### Synopsis
tunnel creates a route to services deployed with type LoadBalancer and sets their Ingress to their ClusterIP. for a detailed example see https://minikube.sigs.k8s.io/docs/tasks/loadbalancer
```
minikube tunnel [flags]

19
site/content/en/docs/Reference/Commands/unpause.md
View File

@ -2,13 +2,20 @@
title: "unpause"
linkTitle: "unpause"
weight: 1
date: 2020-02-05
date: 2020-04-02
description: >
unpause the Kubernetes control plane or other namespaces
unpause Kubernetes
---
### Usage
## minikube unpause
unpause Kubernetes
### Synopsis
unpause Kubernetes
```
minikube unpause [flags]
@ -36,7 +43,3 @@ minikube unpause [flags]
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [pause](pause.md)

33
site/content/en/docs/Reference/Commands/update-check.md
View File

@ -2,13 +2,42 @@
title: "update-check"
linkTitle: "update-check"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Print current and latest version number
---
### Usage
## minikube update-check
Print current and latest version number
### Synopsis
Print current and latest version number
```
minikube update-check [flags]
```
### Options
```
-h, --help help for update-check
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm")
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files
-p, --profile string The name of the minikube VM being used. This can be set to allow having multiple instances of minikube independently. (default "minikube")
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

22
site/content/en/docs/Reference/Commands/update-context.md
View File

@ -2,18 +2,33 @@
title: "update-context"
linkTitle: "update-context"
weight: 1
date: 2019-08-01
date: 2020-04-02
description: >
Verify the IP address of the running cluster in kubeconfig.
---
The `update-context` command retrieves the IP address of the running cluster, checks it with IP in kubeconfig, and corrects kubeconfig if incorrect:
## minikube update-context
Verify the IP address of the running cluster in kubeconfig.
### Synopsis
Retrieves the IP address of the running cluster, checks it
with IP in kubeconfig, and corrects kubeconfig if incorrect.
```
minikube update-context [flags]
```
## Options inherited from parent commands
### Options
```
-h, --help help for update-context
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
@ -26,3 +41,4 @@ minikube update-context [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

13
site/content/en/docs/Reference/Commands/version.md
View File

@ -1,8 +1,19 @@
---
title: "version"
linkTitle: "version"
weight: 1
date: 2020-04-02
description: >
Print the version of minikube
---
## minikube version
Print the version of minikube
### Overview
### Synopsis
Print the version of minikube.

4
test.sh
View File

@ -60,10 +60,12 @@ then
echo "mode: count" >"${COVERAGE_PATH}"
pkgs=$(go list -f '{{ if .TestGoFiles }}{{.ImportPath}}{{end}}' ./cmd/... ./pkg/... | xargs)
go test \
-v -ldflags="$MINIKUBE_LDFLAGS" \
-tags "container_image_ostree_stub containers_image_openpgp" \
-covermode=count \
-coverprofile="${cov_tmp}" \
${pkgs} && echo ok || ((exitcode += 32))
${pkgs} \
&& echo ok || ((exitcode += 32))
tail -n +2 "${cov_tmp}" >>"${COVERAGE_PATH}"
fi