Skip to content
Permalink
Browse files

Improve h2/h3 titles

  • Loading branch information...
tstromberg committed Aug 10, 2019
1 parent 9d9763f commit 5a9da18cdac6b04389168ba595df54a3880fe323
@@ -7,28 +7,18 @@ description: >
Modifies minikube addons files using subcommands like "minikube addons enable heapster"
---

## Usage

```
minikube addons SUBCOMMAND [flags]
minikube addons [command]
```

## Subcommands
## Overview

* **configure**: Configures the addon w/ADDON_NAME within minikube
* **disable**: Disables the addon w/ADDON_NAME within minikube
* **enable**: Enables the addon w/ADDON_NAME within minikube
* **list**: Lists all available minikube addons as well as their current statuses (enabled/disabled)
* **open**: Opens the addon w/ADDON_NAME within minikube


## minikube addons 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

### Usage

```
minikube addons configure ADDON_NAME [flags]
```
@@ -37,8 +27,6 @@ minikube addons configure ADDON_NAME [flags]

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]
```
@@ -47,8 +35,6 @@ minikube addons disable ADDON_NAME [flags]

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]
```
@@ -57,17 +43,13 @@ minikube addons enable ADDON_NAME [flags]

Lists all available minikube addons as well as their current statuses (enabled/disabled)

### Usage

```
minikube addons list [flags]
```
## 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

### Usage

```
minikube addons open ADDON_NAME [flags]
```
@@ -84,7 +66,7 @@ minikube addons open ADDON_NAME [flags]
```


### Options inherited from parent commands
## Options inherited from parent commands

```
--alsologtostderr log to standard error as well as files
@@ -7,7 +7,6 @@ description: >
Add or delete an image from the local cache.
---

### Subcommands

## minikube cache add

@@ -8,38 +8,38 @@ description: >
---


### Synopsis
### Overview

Outputs minikube shell completion for the given shell (bash or zsh)
Outputs minikube shell completion for the given shell (bash or zsh)

This depends on the bash-completion binary. Example installation instructions:
OS X:
This depends on the bash-completion binary. Example installation instructions:

```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
```
### Usage

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
```
minikube completion SHELL [flags]
```

Additionally, you may want to output the completion to a file and source in your .bashrc
## Example: macOS

Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
```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
```

### Usage
## Example: Ubuntu

```shell
apt-get install bash-completion
source /etc/bash-completion
source <(minikube completion bash) # for bash users
source <(minikube completion zsh) # for zsh users
```
minikube completion SHELL [flags]
```

Additionally, you may want to output the completion to a file and source in your .bashrc

### Options inherited from parent commands

@@ -7,7 +7,7 @@ description: >
Modify minikube config
---

### Synopsis
### Overview

config modifies minikube config files using subcommands like "minikube config set vm-driver kvm"

@@ -93,7 +93,7 @@ minikube config unset PROPERTY_NAME [flags]

## minikube config view

### Synopsis
### Overview

Display values currently set in the minikube config file.

@@ -7,20 +7,20 @@ description: >
Access the kubernetes dashboard running within the minikube cluster
---

### Usage
## Usage

```
minikube dashboard [flags]
```

### Options
## Options

```
-h, --help help for dashboard
--url Display dashboard URL instead of opening a browser
```

### Options inherited from parent commands
## Options inherited from parent commands

```
--alsologtostderr log to standard error as well as files
@@ -32,4 +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
```
```
@@ -7,7 +7,7 @@ description: >
Deletes a local kubernetes cluster
---

### Synopsis
### Overview

Deletes a local kubernetes cluster. This command deletes the VM, and removes all
associated files.
@@ -7,7 +7,7 @@ description: >
Retrieves the IP address of the running cluster
---

### Synopsis
### Overview

Retrieves the IP address of the running cluster, and writes it to STDOUT.

@@ -8,7 +8,7 @@ description: >
---


### Synopsis
### Overview

Run the kubernetes client, download it if necessary.

@@ -7,7 +7,7 @@ description: >
Profile gets or sets the current minikube profile
---

### Synopsis
### Overview

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`

@@ -42,7 +42,7 @@ You can return to the default minikube profile by running `minikube profile defa

Lists all minikube profiles.

### Synopsis
### Overview

Lists all valid minikube profiles and detects all possible invalid profiles.

@@ -7,7 +7,7 @@ description: >
Gets the kubernetes URL(s) for the specified service in your local cluster
---

### Synopsis
### Overview

Gets the kubernetes URL(s) for the specified service in your local cluster. In the case of multiple URLs they will be printed one at a time.

@@ -8,7 +8,7 @@ description: >
---


### Synopsis
### Overview

Gets the status of a local kubernetes cluster.
Exit status contains the status of minikube's VM, cluster and kubernetes encoded on it's bits in this order from right to left.
@@ -7,7 +7,7 @@ description: >
Stops a running local kubernetes cluster
---

### Synopsis
### Overview

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.
@@ -7,7 +7,7 @@ description: >
tunnel makes services of type LoadBalancer accessible on localhost
---

### Synopsis
### Overview

tunnel creates a route to services deployed with type LoadBalancer and sets their Ingress to their ClusterIP

@@ -7,17 +7,13 @@ 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.

### Usage
The `update-context` command retrieves the IP address of the running cluster, checks it with IP in kubeconfig, and corrects kubeconfig if incorrect:

```
minikube update-context [flags]
```

### Options inherited from parent commands
## Options inherited from parent commands

```
--alsologtostderr log to standard error as well as files
@@ -2,7 +2,7 @@

Print the version of minikube

### Synopsis
### Overview

Print the version of minikube.

@@ -8,7 +8,7 @@ description: >

minikube has integrated support for the [Kubernetes Dashboard UI](https://github.com/kubernetes/dashboard).

## Synopsis
## Overview

The Dashboard is a web-based Kubernetes user interface. You can use it to:

0 comments on commit 5a9da18

Please sign in to comment.
You can’t perform that action at this time.