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

Removed /docs and docs-test from test.sh

pull/1356/head
Aaron Prindle 2017-04-10 09:47:17 -07:00
parent 5e11c69b8e
commit 840c8c2f82
30 changed files with 0 additions and 2091 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
RELEASING.md
View File

@ -30,8 +30,6 @@ Investigate and fix any failures.
## Bump the version in the Makefile and Update Docs to reflect this
See [this PR](https://github.com/kubernetes/minikube/pull/165) for an example.
Also run `make gendocs` once this change has been made
##Send an initial commit with the Makefile change:

1101
docs/bash-completion
View File

File diff suppressed because it is too large Load Diff

41
docs/minikube.md
View File

@ -1,41 +0,0 @@
## minikube
Minikube is a tool for managing local Kubernetes clusters.
### Synopsis
Minikube is a CLI tool that provisions and manages single-node Kubernetes clusters optimized for development workflows.
### Options
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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
* [minikube completion](minikube_completion.md) - Outputs minikube shell completion for the given shell (bash)
* [minikube config](minikube_config.md) - Modify minikube config
* [minikube dashboard](minikube_dashboard.md) - Opens/displays the kubernetes dashboard URL for your local cluster
* [minikube delete](minikube_delete.md) - Deletes a local kubernetes cluster.
* [minikube docker-env](minikube_docker-env.md) - sets up docker env variables; similar to '$(docker-machine env)'
* [minikube get-k8s-versions](minikube_get-k8s-versions.md) - Gets the list of available kubernetes versions available for minikube.
* [minikube ip](minikube_ip.md) - Retrieve the IP address of the running cluster.
* [minikube logs](minikube_logs.md) - Gets the logs of the running localkube instance, used for debugging minikube, not user code.
* [minikube mount](minikube_mount.md) - Mounts the specified directory into minikube.
* [minikube service](minikube_service.md) - Gets the kubernetes URL(s) for the specified service in your local cluster
* [minikube ssh](minikube_ssh.md) - Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'
* [minikube start](minikube_start.md) - Starts a local kubernetes cluster.
* [minikube status](minikube_status.md) - Gets the status of a local kubernetes cluster.
* [minikube stop](minikube_stop.md) - Stops a running local kubernetes cluster.
* [minikube version](minikube_version.md) - Print the version of minikube.

43
docs/minikube_addons.md
View File

@ -1,43 +0,0 @@
## 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}}
")
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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 there current status (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

30
docs/minikube_addons_configure.md
View File

@ -1,30 +0,0 @@
## 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
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

30
docs/minikube_addons_disable.md
View File

@ -1,30 +0,0 @@
## 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
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

30
docs/minikube_addons_enable.md
View File

@ -1,30 +0,0 @@
## 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
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

30
docs/minikube_addons_list.md
View File

@ -1,30 +0,0 @@
## minikube addons list
Lists all available minikube addons as well as there current status (enabled/disabled)
### Synopsis
Lists all available minikube addons as well as there current status (enabled/disabled)
```
minikube addons list
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

38
docs/minikube_addons_open.md
View File

@ -1,38 +0,0 @@
## 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
```
### Options
```
--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}}")
--https Open the addons URL with https instead of http
--url Display the kubernetes addons URL in the CLI instead of opening it in the default browser
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

45
docs/minikube_completion.md
View File

@ -1,45 +0,0 @@
## minikube completion
Outputs minikube shell completion for the given shell (bash)
### Synopsis
Outputs minikube shell completion for the given shell (bash)
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
$ source ~/.minikube-completion
Ubuntu:
$ apt-get install bash-completion
$ source /etc/bash-completion
$ source <(minikube completion bash)
Additionally, you may want to output completion to a file and source in your .bashrc
```
minikube completion SHELL
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

59
docs/minikube_config.md
View File

@ -1,59 +0,0 @@
## minikube config
Modify minikube config
### Synopsis
config modifies minikube config files using subcommands like "minikube config set vm-driver kvm"
Configurable fields:
* vm-driver
* v
* cpus
* disk-size
* host-only-cidr
* memory
* log_dir
* kubernetes-version
* iso-url
* WantUpdateNotification
* ReminderWaitPeriodInHours
* WantReportError
* WantReportErrorPrompt
* WantKubectlDownloadMsg
* dashboard
* addon-manager
* kube-dns
* heapster
* ingress
* registry-creds
* default-storageclass
* hyperv-virtual-switch
* use-vendored-driver
```
minikube config SUBCOMMAND [flags]
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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 config get](minikube_config_get.md) - Gets the value of PROPERTY_NAME from the minikube config file
* [minikube config set](minikube_config_set.md) - Sets an individual value in a minikube config file
* [minikube config unset](minikube_config_unset.md) - unsets an individual value in a minikube config file
* [minikube config view](minikube_config_view.md) - Display values currently set in the minikube config file

30
docs/minikube_config_get.md
View File

@ -1,30 +0,0 @@
## minikube config get
Gets the value of PROPERTY_NAME from the minikube config file
### 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
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

31
docs/minikube_config_set.md
View File

@ -1,31 +0,0 @@
## 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.
```
minikube config set PROPERTY_NAME PROPERTY_VALUE
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

30
docs/minikube_config_unset.md
View File

@ -1,30 +0,0 @@
## 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
```
minikube config unset PROPERTY_NAME
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

38
docs/minikube_config_view.md
View File

@ -1,38 +0,0 @@
## minikube config view
Display values currently set in the minikube config file
### Synopsis
Display values currently set in the minikube config file.
```
minikube config view
```
### Options
```
--format string Go template format string for the config view 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#ConfigViewTemplate (default "- {{.ConfigKey}}: {{.ConfigValue}}
")
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

36
docs/minikube_dashboard.md
View File

@ -1,36 +0,0 @@
## minikube dashboard
Opens/displays the kubernetes dashboard URL for your local cluster
### Synopsis
Opens/displays the kubernetes dashboard URL for your local cluster
```
minikube dashboard
```
### Options
```
--url Display the kubernetes dashboard in the CLI instead of opening it in the default browser
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

31
docs/minikube_delete.md
View File

@ -1,31 +0,0 @@
## minikube delete
Deletes a local kubernetes cluster.
### Synopsis
Deletes a local kubernetes cluster. This command deletes the VM, and removes all
associated files.
```
minikube delete
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

38
docs/minikube_docker-env.md
View File

@ -1,38 +0,0 @@
## 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
```
### Options
```
--no-proxy Add machine IP to NO_PROXY environment variable
--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
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

30
docs/minikube_get-k8s-versions.md
View File

@ -1,30 +0,0 @@
## minikube get-k8s-versions
Gets the list of available kubernetes versions available for minikube.
### Synopsis
Gets the list of available kubernetes versions available for minikube.
```
minikube get-k8s-versions
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

30
docs/minikube_ip.md
View File

@ -1,30 +0,0 @@
## minikube ip
Retrieve the IP address of the running cluster.
### Synopsis
Retrieves the IP address of the running cluster, and writes it to STDOUT.
```
minikube ip
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

36
docs/minikube_logs.md
View File

@ -1,36 +0,0 @@
## minikube logs
Gets the logs of the running localkube instance, used for debugging minikube, not user code.
### Synopsis
Gets the logs of the running localkube instance, used for debugging minikube, not user code.
```
minikube logs
```
### Options
```
-f, --follow Show only the most recent journal entries, and continuously print new entries as they are appended to the journal.
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

30
docs/minikube_mount.md
View File

@ -1,30 +0,0 @@
## minikube mount
Mounts the specified directory into minikube.
### Synopsis
Mounts the specified directory into minikube.
```
minikube mount [flags] MOUNT_DIRECTORY(ex:"/home")
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

40
docs/minikube_service.md
View File

@ -1,40 +0,0 @@
## 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
```
### 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}}")
--https Open the service URL with https instead of http
-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
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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 service list](minikube_service_list.md) - Lists the URLs for the services in your local cluster

37
docs/minikube_service_list.md
View File

@ -1,37 +0,0 @@
## 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]
```
### Options
```
-n, --namespace string The services namespace
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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

30
docs/minikube_ssh.md
View File

@ -1,30 +0,0 @@
## 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
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

59
docs/minikube_start.md
View File

@ -1,59 +0,0 @@
## minikube start
Starts a local kubernetes cluster.
### Synopsis
Starts a local kubernetes cluster using Virtualbox. This command
assumes you already have Virtualbox installed.
```
minikube start
```
### Options
```
--apiserver-name string The apiserver name which is used in the generated certificate for localkube/kubernetes. This can be used if you want to make the apiserver available from outside the machine (default "minikubeCA")
--container-runtime string The container runtime to be used
--cpus int Number of CPUs allocated to the minikube VM (default 2)
--disk-size string Disk size allocated to the minikube VM (format: <number>[<unit>], where unit = b, k, m or g) (default "20g")
--dns-domain string The cluster dns domain name used in the kubernetes cluster
--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)
--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, apiserver, controller-manager, etcd, proxy, scheduler.
--feature-gates string A set of key=value pairs that describe feature gates for alpha/experimental features.
--host-only-cidr string The CIDR to be used for the minikube VM (only supported with Virtualbox driver) (default "192.168.99.1/24")
--hyperv-virtual-switch string The hyperv virtual switch name. Defaults to first found. (only supported with HyperV driver)
--insecure-registry stringSlice Insecure Docker registries to pass to the Docker daemon
--iso-url string Location of the minikube iso (default "https://storage.googleapis.com/minikube/iso/minikube-v0.18.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)
OR a URI which contains a localkube binary (ex: https://storage.googleapis.com/minikube/k8sReleases/v1.3.0/localkube-linux-amd64) (default "v1.6.0")
--kvm-network string The KVM network name. (only supported with KVM driver) (default "default")
--memory int Amount of RAM allocated to the minikube VM (default 2048)
--network-plugin string The name of the network plugin
--registry-mirror stringSlice Registry mirrors to pass to the Docker daemon
--vm-driver string VM driver is one of: [virtualbox vmwarefusion kvm xhyve hyperv] (default "virtualbox")
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

39
docs/minikube_status.md
View File

@ -1,39 +0,0 @@
## minikube status
Gets the status of a local kubernetes cluster.
### Synopsis
Gets the status of a local kubernetes cluster.
```
minikube status
```
### Options
```
--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 "minikubeVM: {{.MinikubeStatus}}
localkube: {{.LocalkubeStatus}}
")
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

31
docs/minikube_stop.md
View File

@ -1,31 +0,0 @@
## 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.
```
minikube stop
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

30
docs/minikube_version.md
View File

@ -1,30 +0,0 @@
## minikube version
Print the version of minikube.
### Synopsis
Print the version of minikube.
```
minikube version
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--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 (default "")
--logtostderr log to standard error instead of files
--show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
--use-vendored-driver Use the vendored in drivers instead of RPC
-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.

16
test.sh
View File

@ -67,21 +67,5 @@ if [[ ! -z ${files} ]]; then
exit 1
fi
# Check that cobra docs are up to date
# This is done by generating new docs and then seeing if they are different than the committed docs
echo "Checking help documentation..."
if [[ $(git diff) ]]; then
echo "Skipping help text check because the git state is dirty."
else
make gendocs
files=$(git diff)
if [[ $files ]]; then
echo "Help text is out of date: $files \n Please run \"make gendocs\"\n and make sure that those doc changes are committed"
exit 1
else
echo "Help text is up to date"
fi
fi
echo "Checking releases.json schema"
go run deploy/minikube/schema_check.go