Skip to content

Commit

Permalink
Add placeholder for docs for the generic driver
Browse files Browse the repository at this point in the history
But most of it is identical to the "none" driver
  • Loading branch information
afbjorklund committed Jan 8, 2021
1 parent e4ebaea commit fb6cf6b
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
2 changes: 2 additions & 0 deletions pkg/drivers/generic/generic.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ import (
"k8s.io/minikube/pkg/minikube/sysinit"
)

// Driver is a driver designed to run kubeadm w/o VM management.
// https://minikube.sigs.k8s.io/docs/reference/drivers/generic/
type Driver struct {
*drivers.BaseDriver
*pkgdrivers.CommonDriver
Expand Down
22 changes: 22 additions & 0 deletions site/content/en/docs/drivers/generic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "generic"
weight: 3
description: >
Linux generic (remote) driver
aliases:
- /docs/reference/drivers/generic
---

## Overview

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

{{% readfile file="/docs/drivers/includes/generic_usage.inc" %}}

## Issues

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

## Troubleshooting

* Run `minikube start --alsologtostderr -v=4` to debug crashes
25 changes: 25 additions & 0 deletions site/content/en/docs/drivers/includes/generic_usage.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## Requirements

A Linux VM with the following:

* systemd or OpenRC
* a container runtime, such as Docker or CRIO

This VM must also meet the [kubeadm requirements](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/), such as:

* 2 CPU's
* 2GB RAM
* iptables (in legacy mode)
* conntrack
* crictl
* SELinux permissive
* cgroups v1 (v2 is not yet supported by Kubernetes)
## Usage
The generic driver requires the IP address of the VM to use.
```shell
minikube start --driver=generic --generic-ip-address=vm.example.com
```

0 comments on commit fb6cf6b

Please sign in to comment.