start.md 12.8 KB
Newer Older
P
Priya Wadhwa 已提交
1 2 3
---
title: "start"
description: >
T
Thomas Stromberg 已提交
4
  Starts a local Kubernetes cluster
P
Priya Wadhwa 已提交
5 6 7 8 9
---


## minikube start

T
Thomas Stromberg 已提交
10
Starts a local Kubernetes cluster
P
Priya Wadhwa 已提交
11 12 13

### Synopsis

T
Thomas Stromberg 已提交
14
Starts a local Kubernetes cluster
P
Priya Wadhwa 已提交
15

16
```shell
P
Priya Wadhwa 已提交
17 18 19 20 21 22 23 24
minikube start [flags]
```

### Options

```
      --addons minikube addons list       Enable addons. see minikube addons list for a list of valid addon names.
      --apiserver-ips ipSlice             A set of apiserver IP Addresses which are used in the generated certificate for kubernetes.  This can be used if you want to make the apiserver available from outside the machine (default [])
P
Priya Wadhwa 已提交
25
      --apiserver-name string             The authoritative apiserver hostname for apiserver certificates and connectivity. This can be used if you want to make the apiserver available from outside the machine (default "minikubeCA")
M
Michael Ryan Dempsey 已提交
26
      --apiserver-names strings           A set of apiserver names which are used in the generated certificate for kubernetes.  This can be used if you want to make the apiserver available from outside the machine
P
Priya Wadhwa 已提交
27 28
      --apiserver-port int                The apiserver listening port (default 8443)
      --auto-update-drivers               If set, automatically updates drivers to the latest version. Defaults to true. (default true)
29
      --base-image string                 The base image to use for docker/podman drivers. Intended for local development. (default "gcr.io/k8s-minikube/kicbase-builds:v0.0.17-1613934488-10548@sha256:5cacd48d07f699a171eedf65ef1490bd59a523ffcd90662e3b66eb838c5a1b5d")
P
Priya Wadhwa 已提交
30
      --cache-images                      If true, cache docker images for the current bootstrapper and load them into the machine. Always false with --driver=none. (default true)
T
Thomas Stromberg 已提交
31
      --cni string                        CNI plug-in to use. Valid options: auto, bridge, calico, cilium, flannel, kindnet, or path to a CNI manifest (default: auto)
32
      --container-runtime string          The container runtime to be used (docker, cri-o, containerd). (default "docker")
P
Priya Wadhwa 已提交
33 34
      --cpus int                          Number of CPUs allocated to Kubernetes. (default 2)
      --cri-socket string                 The cri socket path to be used.
P
Priya Wadhwa 已提交
35
      --delete-on-failure                 If set, delete the current cluster if start fails and try again. Defaults to false.
P
Priya Wadhwa 已提交
36 37
      --disable-driver-mounts             Disables the filesystem mounts provided by the hypervisors
      --disk-size string                  Disk size allocated to the minikube VM (format: <number>[<unit>], where unit = b, k, m or g). (default "20000mb")
T
Thomas Stromberg 已提交
38
      --dns-domain string                 The cluster dns domain name used in the Kubernetes cluster (default "cluster.local")
P
Priya Wadhwa 已提交
39 40 41 42
      --dns-proxy                         Enable proxy for NAT DNS requests (virtualbox driver only)
      --docker-env stringArray            Environment variables to pass to the Docker daemon. (format: key=value)
      --docker-opt stringArray            Specify arbitrary flags to pass to the Docker daemon. (format: key=value)
      --download-only                     If true, only download and cache files for later use - don't install or start anything.
T
Thomas Stromberg 已提交
43
      --driver string                     Used to specify the driver to run Kubernetes in. The list of available drivers depends on operating system.
P
Priya Wadhwa 已提交
44 45
      --dry-run                           dry-run mode. Validates configuration, but does not mutate system state
      --embed-certs                       if true, will embed the certs in kubeconfig.
T
Thomas Stromberg 已提交
46
      --enable-default-cni                DEPRECATED: Replaced by --cni=bridge
P
Priya Wadhwa 已提交
47 48 49 50 51 52
      --extra-config ExtraOption          A set of key=value pairs that describe configuration that may be passed to different components.
                                          		The key should be '.' separated, and the first part before the dot is the component to apply the configuration to.
                                          		Valid components are: kubelet, kubeadm, apiserver, controller-manager, etcd, proxy, scheduler
                                          		Valid kubeadm parameters: ignore-preflight-errors, dry-run, kubeconfig, kubeconfig-dir, node-name, cri-socket, experimental-upload-certs, certificate-key, rootfs, skip-phases, pod-network-cidr
      --feature-gates string              A set of key=value pairs that describe feature gates for alpha/experimental features.
      --force                             Force minikube to perform possibly dangerous operations
P
Priya Wadhwa 已提交
53
      --force-systemd                     If set, force the container runtime to use sytemd as cgroup manager. Defaults to false.
P
Priya Wadhwa 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66
      --host-dns-resolver                 Enable host resolver for NAT DNS requests (virtualbox driver only) (default true)
      --host-only-cidr string             The CIDR to be used for the minikube VM (virtualbox driver only) (default "192.168.99.1/24")
      --host-only-nic-type string         NIC Type used for host only network. One of Am79C970A, Am79C973, 82540EM, 82543GC, 82545EM, or virtio (virtualbox driver only) (default "virtio")
      --hyperkit-vpnkit-sock string       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 VSock (hyperkit driver only)
      --hyperkit-vsock-ports strings      List of guest VSock ports that should be exposed as sockets on the host (hyperkit driver only)
      --hyperv-external-adapter string    External Adapter on which external switch will be created if no external switch is found. (hyperv driver only)
      --hyperv-use-external-switch        Whether to use external switch over Default Switch if virtual switch not explicitly specified. (hyperv driver only)
      --hyperv-virtual-switch string      The hyperv virtual switch name. Defaults to first found. (hyperv driver only)
      --image-mirror-country string       Country code of the image mirror to be used. Leave empty to use the global one. For Chinese mainland users, set it to cn.
      --image-repository string           Alternative image repository to pull docker images from. This can be used when you have limited access to gcr.io. Set it to "auto" to let minikube decide one for you. For Chinese mainland users, you may use local gcr.io mirrors such as registry.cn-hangzhou.aliyuncs.com/google_containers
      --insecure-registry strings         Insecure Docker registries to pass to the Docker daemon.  The default service CIDR range will automatically be added.
      --install-addons                    If set, install addons. Defaults to true. (default true)
      --interactive                       Allow user prompts for more information (default true)
I
Ilya Zuyev 已提交
67
      --iso-url strings                   Locations to fetch the minikube ISO from. (default [https://storage.googleapis.com/minikube/iso/minikube-v1.18.0-beta.0.iso,https://github.com/kubernetes/minikube/releases/download/v1.18.0-beta.0/minikube-v1.18.0-beta.0.iso,https://kubernetes.oss-cn-hangzhou.aliyuncs.com/minikube/iso/minikube-v1.18.0-beta.0.iso])
P
Priya Wadhwa 已提交
68
      --keep-context                      This will keep the existing kubectl context and will create a minikube context.
M
Medya Gh 已提交
69
      --kubernetes-version string         The Kubernetes version that the minikube VM will use (ex: v1.2.3, 'stable' for v1.20.2, 'latest' for v1.20.5-rc.0). Defaults to 'stable'.
P
Priya Wadhwa 已提交
70 71 72 73 74 75
      --kvm-gpu                           Enable experimental NVIDIA GPU support in minikube
      --kvm-hidden                        Hide the hypervisor signature from the guest in minikube (kvm2 driver only)
      --kvm-network string                The KVM network name. (kvm2 driver only) (default "default")
      --kvm-qemu-uri string               The KVM QEMU connection URI. (kvm2 driver only) (default "qemu:///system")
      --memory string                     Amount of RAM to allocate to Kubernetes (format: <number>[<unit>], where unit = b, k, m or g).
      --mount                             This will start the mount daemon and automatically mount files into minikube.
76
      --mount-string string               The argument to pass the minikube mount command on start.
77
      --namespace string                  The named space to activate after start (default "default")
78
      --nat-nic-type string               NIC Type used for nat network. One of Am79C970A, Am79C973, 82540EM, 82543GC, 82545EM, or virtio (virtualbox driver only) (default "virtio")
P
Priya Wadhwa 已提交
79
      --native-ssh                        Use native Golang SSH client (default true). Set to 'false' to use the command line 'ssh' command when accessing the docker machine. Useful for the machine drivers when they will not start with 'Waiting for SSH'. (default true)
P
Priya Wadhwa 已提交
80
      --network string                    network to run minikube with. Only available with the docker/podman drivers. If left empty, minikube will create a new network.
81
      --network-plugin string             Kubelet network plug-in to use (default: auto)
P
Priya Wadhwa 已提交
82 83 84 85
      --nfs-share strings                 Local folders to share with Guest via NFS mounts (hyperkit driver only)
      --nfs-shares-root string            Where to root the NFS Shares, defaults to /nfsshares (hyperkit driver only) (default "/nfsshares")
      --no-vtx-check                      Disable checking for the availability of hardware virtualization before the vm is started (virtualbox driver only)
  -n, --nodes int                         The number of nodes to spin up. Defaults to 1. (default 1)
V
vinu2003 已提交
86
  -o, --output string                     Format to print stdout in. Options include: [text,json] (default "text")
T
ToonvanStrijp 已提交
87
      --ports strings                     List of ports that should be exposed (docker and podman driver only)
P
Priya Wadhwa 已提交
88 89 90
      --preload                           If set, download tarball of preloaded images if available to improve start time. Defaults to true. (default true)
      --registry-mirror strings           Registry mirrors to pass to the Docker daemon
      --service-cluster-ip-range string   The CIDR to be used for service cluster IPs. (default "10.96.0.0/12")
91
      --ssh-ip-address string             IP address (ssh driver only)
92 93 94
      --ssh-key string                    SSH key (ssh driver only)
      --ssh-port int                      SSH port (ssh driver only) (default 22)
      --ssh-user string                   SSH user (ssh driver only) (default "root")
P
Priya Wadhwa 已提交
95
      --trace string                      Send trace events. Options include: [gcp]
P
Priya Wadhwa 已提交
96 97 98
      --uuid string                       Provide VM UUID to restore MAC address (hyperkit driver only)
      --vm                                Filter to use only VM Drivers
      --vm-driver driver                  DEPRECATED, use driver instead.
M
Medya Gh 已提交
99
      --wait strings                      comma separated list of Kubernetes components to verify and wait for after starting a cluster. defaults to "apiserver,system_pods", available options: "apiserver,system_pods,default_sa,apps_running,node_ready,kubelet" . other acceptable values are 'all' or 'none', 'true' and 'false' (default [apiserver,system_pods])
P
Pablo Caderno 已提交
100
      --wait-timeout duration             max time to wait per Kubernetes or host to be healthy. (default 6m0s)
P
Priya Wadhwa 已提交
101 102 103 104 105
```

### Options inherited from parent commands

```
P
Priya Modali 已提交
106
      --add_dir_header                   If true, adds the file directory to the header of the log messages
P
Priya Wadhwa 已提交
107
      --alsologtostderr                  log to standard error as well as files
T
Thomas Stromberg 已提交
108
  -b, --bootstrapper string              The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm")
P
Priya Wadhwa 已提交
109
  -h, --help                             
P
Priya Wadhwa 已提交
110 111
      --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
P
Priya Modali 已提交
112 113
      --log_file string                  If non-empty, use this log file
      --log_file_max_size uint           Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
P
Priya Wadhwa 已提交
114
      --logtostderr                      log to standard error instead of files
P
Predrag Rogic 已提交
115
      --one_output                       If true, only write logs to their native severity level (vs also writing to each lower severity level
P
Priya Wadhwa 已提交
116
  -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")
P
Priya Modali 已提交
117 118
      --skip_headers                     If true, avoid header prefixes in the log messages
      --skip_log_headers                 If true, avoid headers when opening log files
P
Priya Wadhwa 已提交
119
      --stderrthreshold severity         logs at or above this threshold go to stderr (default 2)
120
      --user string                      Specifies the user executing the operation. Useful for auditing operations executed by 3rd party tools. Defaults to the operating system username.
P
Priya Modali 已提交
121
  -v, --v Level                          number for the log level verbosity
P
Priya Wadhwa 已提交
122 123 124
      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging
```