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

Massage autogenerated output to Hugo form

pull/4964/head
Thomas Stromberg 2019-08-02 18:04:09 -07:00
parent c516cd70d4
commit 5e4696fd00
22 changed files with 281 additions and 746 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,14 +1,12 @@
---
title: "Addons"
linkTitle: "Addons"
title: "addons"
linkTitle: "addons"
weight: 1
date: 2019-08-01
description: >
Modify minikube's kubernetes addons
Modifies minikube addons files using subcommands like "minikube addons enable heapster"
---
Addons modifies minikube addons files using subcommands like "minikube addons enable heapster"
## Usage
```
@ -16,177 +14,59 @@ minikube addons SUBCOMMAND [flags]
minikube addons [command]
```
## Available Commands
## Subcommands
```
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
```
* **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
## Flags
```
--format string Go template format string for the addon list output. The format for Go templates can be found here: https://golang.org/pkg/text/template/
For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#AddonListTemplate (default "- {{.AddonName}}: {{.AddonStatus}}\n")
```
## 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
### Usage
```
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
```
### SEE ALSO
* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons
###### Auto generated by spf13/cobra on 1-Aug-2019
## 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
### Usage
```
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
```
### SEE ALSO
* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons
###### Auto generated by spf13/cobra on 1-Aug-2019
## 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
### Usage
```
minikube addons enable ADDON_NAME [flags]
```
### Options
```
-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
```
### SEE ALSO
* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons
###### Auto generated by spf13/cobra on 1-Aug-2019
## 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)
### Usage
```
minikube addons list [flags]
```
### Options
```
-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
```
### SEE ALSO
* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons
###### Auto generated by spf13/cobra on 1-Aug-2019
## 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
### Usage
```
minikube addons open ADDON_NAME [flags]
@ -203,44 +83,6 @@ minikube addons open ADDON_NAME [flags]
--wait int Amount of time to wait for service in seconds (default 20)
```
### 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
```
### SEE ALSO
* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons
###### Auto generated by spf13/cobra on 1-Aug-2019
## minikube addons
Modify minikube's kubernetes addons
### Synopsis
addons modifies minikube addons files using subcommands like "minikube addons enable heapster"
```
minikube addons SUBCOMMAND [flags]
```
### Options
```
--format string Go template format string for the addon list output. The format for Go templates can be found here: https://golang.org/pkg/text/template/
For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#AddonListTemplate (default "- {{.AddonName}}: {{.AddonStatus}}\n")
-h, --help help for addons
```
### Options inherited from parent commands
@ -255,14 +97,3 @@ minikube addons SUBCOMMAND [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
* [minikube addons configure](minikube_addons_configure.md) - 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 disable](minikube_addons_disable.md) - 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 enable](minikube_addons_enable.md) - 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 list](minikube_addons_list.md) - Lists all available minikube addons as well as their current statuses (enabled/disabled)
* [minikube addons open](minikube_addons_open.md) - Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,15 +1,15 @@
---
title: "Cache"
linkTitle: "Cache"
title: "cache"
linkTitle: "cache"
weight: 1
date: 2019-08-01
description: >
Modify minikube's kubernetes addons
---## minikube cache add
Add or delete an image from the local cache.
---
Add an image to local cache.
### Subcommands
### Synopsis
## minikube cache add
Add an image to local cache.
@ -17,76 +17,18 @@ 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
```
### SEE ALSO
* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache.
###### Auto generated by spf13/cobra on 1-Aug-2019
## 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
```
### SEE ALSO
* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache.
###### Auto generated by spf13/cobra on 1-Aug-2019
## minikube cache list
List all available images from the local cache.
### Synopsis
List all available images from the local cache.
```
minikube cache list [flags]
```
@ -98,59 +40,3 @@ minikube cache list [flags]
For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#CacheListTemplate (default "{{.CacheImage}}\n")
-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
```
### SEE ALSO
* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache.
###### Auto generated by spf13/cobra on 1-Aug-2019
## 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
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
* [minikube cache add](minikube_cache_add.md) - Add an image to local cache.
* [minikube cache delete](minikube_cache_delete.md) - Delete an image from the local cache.
* [minikube cache list](minikube_cache_list.md) - List all available images from the local cache.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,40 +1,46 @@
## minikube completion
---
title: "completion"
linkTitle: "completion"
weight: 1
date: 2019-08-01
description: >
Outputs minikube shell completion for the given shell (bash or zsh)
---
Outputs minikube shell completion for the given shell (bash or zsh)
### Synopsis
Outputs minikube shell completion for the given shell (bash or zsh)
This depends on the bash-completion binary. Example installation instructions:
OS X:
```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
```
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
```
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]
```
### Options
```
-h, --help help for completion
```
### Options inherited from parent commands
```
@ -48,9 +54,3 @@ minikube completion SHELL [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,123 +1,104 @@
## minikube config get
Gets the value of PROPERTY_NAME from the minikube config file
---
title: "config"
linkTitle: "config"
weight: 1
date: 2019-08-01
description: >
Modify minikube config
---
### Synopsis
config modifies minikube config files using subcommands like "minikube config set vm-driver kvm"
Configurable fields:
* vm-driver
* feature-gates
* v
* cpus
* disk-size
* host-only-cidr
* memory
* log_dir
* kubernetes-version
* iso-url
* WantUpdateNotification
* ReminderWaitPeriodInHours
* WantReportError
* WantReportErrorPrompt
* WantKubectlDownloadMsg
* WantNoneDriverWarning
* profile
* bootstrapper
* ShowDriverDeprecationNotification
* ShowBootstrapperDeprecationNotification
* dashboard
* addon-manager
* default-storageclass
* heapster
* efk
* ingress
* registry
* registry-creds
* freshpod
* default-storageclass
* storage-provisioner
* storage-provisioner-gluster
* metrics-server
* nvidia-driver-installer
* nvidia-gpu-device-plugin
* logviewer
* gvisor
* hyperv-virtual-switch
* disable-driver-mounts
* cache
* embed-certs
### subcommands
- **get**: Gets the value of PROPERTY_NAME from the minikube config file
## minikube config get
Returns the value of PROPERTY_NAME from the minikube config file. Can be overwritten at runtime by flags or environmental variables.
### Usage
```
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
```
### SEE ALSO
* [minikube config](minikube_config.md) - Modify minikube config
###### Auto generated by spf13/cobra on 1-Aug-2019
## 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
```
### SEE ALSO
* [minikube config](minikube_config.md) - Modify minikube config
###### Auto generated by spf13/cobra on 1-Aug-2019
## minikube config unset
unsets an individual value in a minikube config file
### Synopsis
unsets PROPERTY_NAME from the minikube config file. Can be overwritten by flags or environmental variables
### Usage
```
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
```
### SEE ALSO
* [minikube config](minikube_config.md) - Modify minikube config
###### Auto generated by spf13/cobra on 1-Aug-2019
## minikube config view
Display values currently set in the minikube config file
### Synopsis
Display values currently set in the minikube config file.
### Usage
```
minikube config view [flags]
```
@ -143,9 +124,3 @@ 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
```
### SEE ALSO
* [minikube config](minikube_config.md) - Modify minikube config
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,10 +1,13 @@
## minikube dashboard
---
title: "dashboard"
linkTitle: "dashboard"
weight: 1
date: 2019-08-01
description: >
Access the kubernetes dashboard running within the minikube cluster
---
Access the kubernetes dashboard running within the minikube cluster
### Synopsis
Access the kubernetes dashboard running within the minikube cluster
### Usage
```
minikube dashboard [flags]
@ -29,10 +32,4 @@ minikube dashboard [flags]
--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
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019
```

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

@ -1,22 +1,23 @@
## minikube delete
Deletes a local kubernetes cluster
---
title: "delete"
linkTitle: "delete"
weight: 1
date: 2019-08-01
description: >
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]
```
### Options
```
-h, --help help for delete
```
### Options inherited from parent commands
```
@ -30,9 +31,3 @@ minikube delete [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,10 +1,13 @@
## minikube docker-env
---
title: "docker-env"
linkTitle: "docker-env"
weight: 1
date: 2019-08-01
description: >
Sets up docker env variables; similar to '$(docker-machine env)'
---
Sets up docker env variables; similar to '$(docker-machine env)'
### Synopsis
Sets up docker env variables; similar to '$(docker-machine env)'.
### Usage
```
minikube docker-env [flags]
@ -32,9 +35,3 @@ 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
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

44
site/content/en/docs/Reference/Commands/generate-docs.md
View File

@ -1,44 +0,0 @@
## 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
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,21 +1,22 @@
## minikube ip
Retrieves the IP address of the running cluster
---
title: "ip"
linkTitle: "ip"
weight: 1
date: 2019-08-01
description: >
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
```
@ -29,9 +30,3 @@ minikube ip [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,24 +1,31 @@
## minikube kubectl
---
title: "kubectl"
linkTitle: "kubectl"
weight: 1
date: 2019-08-01
description: >
Run kubectl
---
Run kubectl
### Synopsis
Run the kubernetes client, download it if necessary.
Examples:
minikube kubectl -- --help
kubectl get pods --namespace kube-system
### Usage
```
minikube kubectl [flags]
```
### Options
### Examples:
```
-h, --help help for kubectl
minikube kubectl -- --help
kubectl get pods --namespace kube-system
```
### Options inherited from parent commands
```
@ -32,9 +39,3 @@ minikube kubectl [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,10 +1,13 @@
## minikube logs
---
title: "logs"
linkTitle: "logs"
weight: 1
date: 2019-08-01
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
### Synopsis
Gets the logs of the running instance, used for debugging minikube, not user code.
## Usage
```
minikube logs [flags]
@ -32,9 +35,3 @@ minikube logs [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,10 +1,13 @@
## minikube mount
---
title: "mount"
linkTitle: "mount"
weight: 1
date: 2019-08-01
description: >
Mounts the specified directory into minikube
---
Mounts the specified directory into minikube
### Synopsis
Mounts the specified directory into minikube.
### Usage
```
minikube mount [flags] <source directory>:<target directory>
@ -38,9 +41,3 @@ 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
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,21 +1,28 @@
## minikube profile
Profile gets or sets the current minikube profile
---
title: "profile"
linkTitle: "profile"
weight: 1
date: 2019-08-01
description: >
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`
```
minikube profile [MINIKUBE_PROFILE_NAME]. You can return to the default minikube profile by running `minikube profile default` [flags]
```
### Options
### Usage
```
-h, --help help for profile
minikube profile [MINIKUBE_PROFILE_NAME]
You can return to the default minikube profile by running `minikube profile default` [flags]
```
## Subcommands
- **list**: Lists all minikube profiles.
### Options inherited from parent commands
```
@ -30,12 +37,7 @@ minikube profile [MINIKUBE_PROFILE_NAME]. You can return to the default minikub
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
* [minikube profile list](minikube_profile_list.md) - Lists all minikube profiles.
###### Auto generated by spf13/cobra on 1-Aug-2019
## minikube profile list
Lists all minikube profiles.
@ -47,29 +49,3 @@ Lists all valid minikube profiles and detects all possible invalid profiles.
```
minikube profile list [flags]
```
### Options
```
-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
```
### SEE ALSO
* [minikube profile](minikube_profile.md) - Profile gets or sets the current minikube profile
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,15 +1,26 @@
## minikube service
Gets the kubernetes URL(s) for the specified service in your local cluster
---
title: "service"
linkTitle: "service"
weight: 1
date: 2019-08-01
description: >
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.
### Usage
```
minikube service [flags] SERVICE
```
### Subcommands
- **list**: Lists the URLs for the services in your local cluster
### Options
```
@ -36,20 +47,10 @@ minikube service [flags] SERVICE
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
* [minikube service list](minikube_service_list.md) - Lists the URLs for the services in your local cluster
###### Auto generated by spf13/cobra on 1-Aug-2019
## 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]
```
@ -61,23 +62,3 @@ 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
```
### SEE ALSO
* [minikube service](minikube_service.md) - Gets the kubernetes URL(s) for the specified service in your local cluster
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,21 +1,18 @@
## minikube ssh-key
---
title: "ssh-key"
linkTitle: "sshs-key"
weight: 1
date: 2019-08-01
description: >
Retrieve the ssh identity key path of the specified cluster
---
Retrieve the ssh identity key path of the specified cluster
### Synopsis
Retrieve the ssh identity key path of the specified cluster.
### Usage
```
minikube ssh-key [flags]
```
### Options
```
-h, --help help for ssh-key
```
### Options inherited from parent commands
```
@ -29,9 +26,3 @@ 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
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,19 +1,18 @@
## minikube ssh
---
title: "ssh"
linkTitle: "ssh"
weight: 1
date: 2019-08-01
description: >
Log into or run a command on a machine with SSH; similar to 'docker-machine 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'.
### Usage
```
minikube ssh [flags]
```
### Options
```
-h, --help help for ssh
```
### Options inherited from parent commands
@ -29,9 +28,3 @@ minikube ssh [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,10 +1,13 @@
## minikube start
---
title: "start"
linkTitle: "start"
weight: 1
date: 2019-08-01
description: >
Starts a local kubernetes cluster
---
Starts a local kubernetes cluster
### Synopsis
Starts a local kubernetes cluster
### Usage
```
minikube start [flags]
@ -76,9 +79,3 @@ minikube start [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,6 +1,12 @@
## minikube status
---
title: "status"
linkTitle: "status"
weight: 1
date: 2019-08-01
description: >
Gets the status of a local kubernetes cluster
---
Gets the status of a local kubernetes cluster
### Synopsis
@ -8,6 +14,8 @@ 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)
### Usage
```
minikube status [flags]
```
@ -33,9 +41,3 @@ minikube status [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,22 +1,23 @@
## minikube stop
Stops a running local kubernetes cluster
---
title: "stop"
linkTitle: "stop"
weight: 1
date: 2019-08-01
description: >
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
```
@ -30,9 +31,3 @@ minikube stop [flags]
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,11 +1,18 @@
## minikube tunnel
tunnel makes services of type LoadBalancer accessible on localhost
---
title: "tunnel"
linkTitle: "tunnel"
weight: 1
date: 2019-08-01
description: >
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
### Usage
```
minikube tunnel [flags]
```
@ -31,8 +38,3 @@ minikube tunnel [flags]
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,37 +1,14 @@
## minikube update-check
---
title: "update-check"
linkTitle: "update-check"
weight: 1
date: 2019-08-01
description: >
Print current and latest version number
---
Print current and latest version number
### Synopsis
Print current and latest version number
### Usage
```
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
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019

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

@ -1,22 +1,22 @@
## minikube update-context
Verify the IP address of the running cluster in kubeconfig.
---
title: "update-context"
linkTitle: "update-context"
weight: 1
date: 2019-08-01
description: >
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.
Retrieves the IP address of the running cluster, checks it with IP in kubeconfig, and corrects kubeconfig if incorrect.
### Usage
```
minikube update-context [flags]
```
### Options
```
-h, --help help for update-context
```
### Options inherited from parent commands
```
@ -30,9 +30,3 @@ 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
```
### SEE ALSO
* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters.
###### Auto generated by spf13/cobra on 1-Aug-2019