Skip to content

Commit

Permalink
Address markdown lint issues, hide includes from tree
Browse files Browse the repository at this point in the history
  • Loading branch information
tstromberg committed Aug 10, 2019
1 parent 7713e88 commit ff4a532
Show file tree
Hide file tree
Showing 18 changed files with 34 additions and 38 deletions.
8 changes: 4 additions & 4 deletions site/content/en/docs/Getting started/linux.md
Expand Up @@ -55,16 +55,16 @@ If the above command outputs "no":
{{% tabs %}}

{{% tab "VirtualBox" %}}
{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.inc" %}}
{{% /tab %}}
{{% tab "KVM" %}}
{{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.inc" %}}
{{% /tab %}}
{{% tab "None (bare-metal)" %}}
If you are already running minikube from inside a VM, it is possible to skip the creation of an additional VM layer by using the `none` driver.

{{% readfile file="/docs/Reference/Drivers/includes/none_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/none_usage.inc" %}}
{{% /tab %}}
{{% /tabs %}}

{{% readfile file="/docs/Getting started/includes/post_install.md" %}}
{{% readfile file="/docs/Getting started/includes/post_install.inc" %}}
10 changes: 5 additions & 5 deletions site/content/en/docs/Getting started/macos.md
Expand Up @@ -36,18 +36,18 @@ curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin

{{% tabs %}}
{{% tab "VirtualBox" %}}
{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.inc" %}}
{{% /tab %}}
{{% tab "Hyperkit" %}}
{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_usage.inc" %}}
{{% /tab %}}
{{% tab "Parallels" %}}
{{% readfile file="/docs/Reference/Drivers/includes/parallels_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/parallels_usage.inc" %}}
{{% /tab %}}
{{% tab "VMware" %}}
{{% readfile file="/docs/Reference/Drivers/includes/vmware_macos_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/vmware_macos_usage.inc" %}}
{{% /tab %}}

{{% /tabs %}}

{{% readfile file="/docs/Getting started/includes/post_install.md" %}}
{{% readfile file="/docs/Getting started/includes/post_install.inc" %}}
17 changes: 8 additions & 9 deletions site/content/en/docs/Getting started/windows.md
Expand Up @@ -6,10 +6,10 @@ weight: 3

### Prerequisites

* Windows 8 or above
* A hypervisor, such as Hyper-V or VirtualBox
* Hardware virtualization support must be enabled in BIOS
* 4GB of RAM
* Windows 8 or above
* A hypervisor, such as Hyper-V or VirtualBox
* Hardware virtualization support must be enabled in BIOS
* 4GB of RAM

### Installation

Expand All @@ -30,7 +30,6 @@ After it has installed, close the current CLI session and reopen it. minikube sh
{{% /tab %}}
{{% /tabs %}}


## Hypervisor Setup

To check if virtualization is supported, run the following command on your Windows terminal or command prompt.
Expand All @@ -49,17 +48,17 @@ Hyper-V Requirements: VM Monitor Mode Extensions: Yes

If you see the following output, your system already has a Hypervisor installed and you can skip the next step.

```
```shell
Hyper-V Requirements: A hypervisor has been detected.
```

{{% tabs %}}
{{% tab "VirtualBox" %}}
{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.inc" %}}
{{% /tab %}}
{{% tab "Hyper-V" %}}
{{% readfile file="/docs/Reference/Drivers/includes/hyperv_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/hyperv_usage.inc" %}}
{{% /tab %}}
{{% /tabs %}}

{{% readfile file="/docs/Getting started/includes/post_install.md" %}}
{{% readfile file="/docs/Getting started/includes/post_install.inc" %}}
5 changes: 2 additions & 3 deletions site/content/en/docs/Reference/Drivers/hyperkit.md
Expand Up @@ -11,18 +11,17 @@ description: >

[HyperKit](https://github.com/moby/hyperkit) is an open-source hypervisor for macOS hypervisor, optimized for lightweight virtual machines and container deployment.

{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/hyperkit_usage.inc" %}}

## Special features

minikube start supports additional hyperkit specific flags:


* **`--hyperkit-vpnkit-sock`**: Location of the VPNKit socket used for networking. If empty, disables Hyperkit VPNKitSock, if 'auto' uses Docker for Mac VPNKit connection, otherwise uses the specified VSoc
* **`--hyperkit-vsock-ports`**: List of guest VSock ports that should be exposed as sockets on the host
* **`--nfs-share`**: Local folders to share with Guest via NFS mounts
* **`--nfs-shares-root`**: Where to root the NFS Shares (default "/nfsshares")
* **`--uuid`**: Provide VM UUID to restore MAC address
* **`--uuid`**: Provide VM UUID to restore MAC address

## Issues

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/Reference/Drivers/hyperv.md
Expand Up @@ -12,7 +12,7 @@ description: >

Hyper-V is a native hypervisor built in to modern versions of Microsoft Windows.

{{% readfile file="/docs/Reference/Drivers/includes/hyperv_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/hyperv_usage.inc" %}}

## Special features

Expand Down
@@ -1,6 +1,6 @@
## Requirements

* Windows 10 Pro
* Windows 10 Enterprise, Pro, or Education ([system requirements](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/reference/hyper-v-requirements))
* Hyper-V enabled
* An active Hyper-V switch

Expand All @@ -23,7 +23,7 @@ This command is speculative, and may not work in all environments. You may need
{{% /alert %}}

```powershell
New-VMSwitch -name ExternalSwitch -NetAdapterName Ethernet -AllowManagementOS $true
New-VMSwitch -name ExternalSwitch -NetAdapterName Ethernet -AllowManagementOS $true
```

Set this switch as the minikube default:
Expand Down
Expand Up @@ -6,7 +6,7 @@

If the [Brew Package Manager](https://brew.sh/) is installed, run:

```
```shell
brew install docker-machine-driver-parallels
```

Expand Down
Expand Up @@ -6,7 +6,7 @@

If the [Brew Package Manager](https://brew.sh/) is installed, run:

```
```shell
brew install docker-machine-driver-vmware
```

Expand All @@ -28,4 +28,4 @@ To make vmware the default driver:

```shell
minikube config set vm-driver vmware
```
```
5 changes: 2 additions & 3 deletions site/content/en/docs/Reference/Drivers/kvm2.md
Expand Up @@ -12,7 +12,7 @@ description: >

[KVM (Kernel-based Virtual Machine)](https://www.linux-kvm.org/page/Main_Page) is a full virtualization solution for Linux on x86 hardware containing virtualization extensions. To work with KVM, minikube uses the [libvirt virtualization API](https://libvirt.org/)

{{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/kvm2_usage.inc" %}}

## Special features

Expand All @@ -26,7 +26,7 @@ The `minikube start` command supports 3 additional kvm specific flags:

* `minikube` will repeatedly for the root password if user is not in the correct `libvirt` group [#3467](https://github.com/kubernetes/minikube/issues/3467)
* `Machine didn't return an IP after 120 seconds` when firewall prevents VM network access [#3566](https://github.com/kubernetes/minikube/issues/3566)
* `unable to set user and group to '65534:992` when `dynamic ownership = 1` in `qemu.conf` [#4467](https://github.com/kubernetes/minikube/issues/4467)
* `unable to set user and group to '65534:992` when `dynamic ownership = 1` in `qemu.conf` [#4467](https://github.com/kubernetes/minikube/issues/4467)
* KVM VM's cannot be used simultaneously with VirtualBox [#4913](https://github.com/kubernetes/minikube/issues/4913)
* On some distributions, libvirt bridge networking may fail until the host reboots

Expand All @@ -37,4 +37,3 @@ Also see [co/kvm2 open issues](https://github.com/kubernetes/minikube/labels/co%
* Run `minikube start --alsologtostderr -v=7` to debug crashes
* Run `docker-machine-driver-kvm2 version` to verify the kvm2 driver executes properly.
* Read [How to debug Virtualization problems](https://fedoraproject.org/wiki/How_to_debug_Virtualization_problems)

2 changes: 1 addition & 1 deletion site/content/en/docs/Reference/Drivers/none.md
Expand Up @@ -12,7 +12,7 @@ description: >

This document is written for system integrators who are familiar with minikube, and wish to run it within a customized VM environment. The `none` driver allows advanced minikube users to skip VM creation, allowing minikube to be run on a user-supplied VM.

{{% readfile file="/docs/Reference/Drivers/includes/none_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/none_usage.inc" %}}

## Issues

Expand Down
3 changes: 1 addition & 2 deletions site/content/en/docs/Reference/Drivers/parallels.md
Expand Up @@ -11,7 +11,7 @@ description: >

The Parallels driver is particularly useful for users who own Parallels Desktop, as it does not require VT-x hardware support.

{{% readfile file="/docs/Reference/Drivers/includes/parallels_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/parallels_usage.inc" %}}

## Issues

Expand All @@ -20,4 +20,3 @@ The Parallels driver is particularly useful for users who own Parallels Desktop,
## Troubleshooting

* Run `minikube start --alsologtostderr -v=7` to debug crashes
*
6 changes: 3 additions & 3 deletions site/content/en/docs/Reference/Drivers/virtualbox.md
Expand Up @@ -11,19 +11,19 @@ description: >

VirtualBox is the oldest and most stable VM driver for minikube.

{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/virtualbox_usage.inc" %}}

## Special features

minikube start supports some VirtualBox specific flags:

* **`--host-only-cidr`**: The CIDR to be used for the minikube VM (default "192.168.99.1/24")
* **`--no-vtx-check`**: Disable checking for the availability of hardware virtualization
* **`--no-vtx-check`**: Disable checking for the availability of hardware virtualization

## Issues

* [Full list of open 'virtualbox' driver issues](https://github.com/kubernetes/minikube/labels/co%2Fvirtualbox)

## Troubleshooting

* Run `minikube start --alsologtostderr -v=7` to debug crashes
* Run `minikube start --alsologtostderr -v=7` to debug crashes
4 changes: 2 additions & 2 deletions site/content/en/docs/Reference/Drivers/vmware.md
Expand Up @@ -13,7 +13,7 @@ The vmware driver supports virtualization across all VMware based hypervisors.

{{% tabs %}}
{{% tab "macOS" %}}
{{% readfile file="/docs/Reference/Drivers/includes/vmware_macos_usage.md" %}}
{{% readfile file="/docs/Reference/Drivers/includes/vmware_macos_usage.inc" %}}
{{% /tab %}}
{{% tab "Linux" %}}
No documentation is available yet.
Expand All @@ -29,4 +29,4 @@ No documentation is available yet.

## Troubleshooting

* Run `minikube start --alsologtostderr -v=7` to debug crashes
* Run `minikube start --alsologtostderr -v=7` to debug crashes

0 comments on commit ff4a532

Please sign in to comment.