kubernetes
/
minikube
mirror of https://github.com/kubernetes/minikube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
minikube/site/content/en/docs/commands/addons.md

240 lines
10 KiB
Markdown
Raw Normal View History

Move more docs
2019-08-02 23:35:54 +00:00
---
Massage autogenerated output to Hugo form
2019-08-03 01:04:09 +00:00
title: "addons"
Move more docs
2019-08-02 23:35:54 +00:00
description: >
Run generate-docs
2020-05-07 21:18:00 +00:00
Enable or disable a minikube addon
Move more docs
2019-08-02 23:35:54 +00:00
---
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
2020-04-02 17:48:47 +00:00
## minikube addons
Run generate-docs
2020-05-07 21:18:00 +00:00
Enable or disable a minikube addon
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
2020-04-02 17:48:47 +00:00
### 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
Run generate-docs
2020-05-07 21:18:00 +00:00
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
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
2020-04-02 17:48:47 +00:00
--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
```
Move more docs
2019-08-02 23:35:54 +00:00
## 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
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
2020-04-02 17:48:47 +00:00
### 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
Move more docs
2019-08-02 23:35:54 +00:00
```
minikube addons configure ADDON_NAME [flags]
```
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
2020-04-02 17:48:47 +00:00
### Options
```
-h, --help help for configure
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
Run generate-docs
2020-05-07 21:18:00 +00:00
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
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
2020-04-02 17:48:47 +00:00
--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
```
Move more docs
2019-08-02 23:35:54 +00:00
## 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
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
2020-04-02 17:48:47 +00:00
### Synopsis
Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list
Move more docs
2019-08-02 23:35:54 +00:00
```
minikube addons disable ADDON_NAME [flags]
```
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
2020-04-02 17:48:47 +00:00
### Options
```
-h, --help help for disable
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
Run generate-docs
2020-05-07 21:18:00 +00:00
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
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
2020-04-02 17:48:47 +00:00
--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
```
Move more docs
2019-08-02 23:35:54 +00:00
## 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
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
2020-04-02 17:48:47 +00:00
### Synopsis
Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list
Move more docs
2019-08-02 23:35:54 +00:00
```
minikube addons enable ADDON_NAME [flags]
```
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
2020-04-02 17:48:47 +00:00
### Options
remove repetitive addon list from command help and add --addons flag explanation to documents
2019-10-06 07:12:41 +00:00
```
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
2020-04-02 17:48:47 +00:00
-h, --help help for enable
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
Run generate-docs
2020-05-07 21:18:00 +00:00
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
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
2020-04-02 17:48:47 +00:00
--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
Run generate-docs
2020-05-07 21:18:00 +00:00
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
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
2020-04-02 17:48:47 +00:00
--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
remove repetitive addon list from command help and add --addons flag explanation to documents
2019-10-06 07:12:41 +00:00
```
Move more docs
2019-08-02 23:35:54 +00:00
## minikube addons list
Lists all available minikube addons as well as their current statuses (enabled/disabled)
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
2020-04-02 17:48:47 +00:00
### Synopsis
Lists all available minikube addons as well as their current statuses (enabled/disabled)
Move more docs
2019-08-02 23:35:54 +00:00
```
minikube addons list [flags]
```
Add initial Docker driver doc, updatte commands
2020-02-06 05:14:15 +00:00
### Options
```
-h, --help help for list
-o, --output string minikube addons list --output OUTPUT. json, list (default "list")
```
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
2020-04-02 17:48:47 +00:00
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
Run generate-docs
2020-05-07 21:18:00 +00:00
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
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
2020-04-02 17:48:47 +00:00
--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
```
Move more docs
2019-08-02 23:35:54 +00:00
## 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
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
2020-04-02 17:48:47 +00:00
### Synopsis
Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list
Move more docs
2019-08-02 23:35:54 +00:00
```
minikube addons open ADDON_NAME [flags]
```
### 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}}")
-h, --help help for open
--https Open the addons URL with https instead of http
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
2020-04-02 17:48:47 +00:00
--interval int The time interval for each check that wait performs in seconds (default 1)
Run generate-docs
2020-05-07 21:18:00 +00:00
--url Display the Kubernetes addons URL in the CLI instead of opening it in the default browser
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
2020-04-02 17:48:47 +00:00
--wait int Amount of time to wait for service in seconds (default 2)
Move more docs
2019-08-02 23:35:54 +00:00
```
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
2020-04-02 17:48:47 +00:00
### Options inherited from parent commands
Move more docs
2019-08-02 23:35:54 +00:00
```
--alsologtostderr log to standard error as well as files
Run generate-docs
2020-05-07 21:18:00 +00:00
-b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
Move more docs
2019-08-02 23:35:54 +00:00
--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
```
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
2020-04-02 17:48:47 +00:00