diff --git a/pkg/drivers/generic/generic.go b/pkg/drivers/generic/generic.go index b04811c3f0a1..dd8f8ca3d8a8 100644 --- a/pkg/drivers/generic/generic.go +++ b/pkg/drivers/generic/generic.go @@ -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 diff --git a/site/content/en/docs/drivers/generic.md b/site/content/en/docs/drivers/generic.md new file mode 100644 index 000000000000..558c25b1b512 --- /dev/null +++ b/site/content/en/docs/drivers/generic.md @@ -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 diff --git a/site/content/en/docs/drivers/includes/generic_usage.inc b/site/content/en/docs/drivers/includes/generic_usage.inc new file mode 100644 index 000000000000..3a0d8a3bf7bb --- /dev/null +++ b/site/content/en/docs/drivers/includes/generic_usage.inc @@ -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 +``` +