From 7900b63d2b470306cfea94b022f1e53dbf1ced8a Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 10:10:51 -0700 Subject: [PATCH 01/10] Wait for only apiserver by default This PR changes --wait=false to be the default, but to still check for the apiserver in this case. If wait=true, we still wait for all pods to be up and running. This change should speed up `minikube start`, since we won't have to wait for other pods which can take a longer time to start up. Ref #5681 --- cmd/minikube/cmd/start.go | 16 ++++++++++++---- pkg/minikube/bootstrapper/bootstrapper.go | 2 +- pkg/minikube/bootstrapper/kubeadm/kubeadm.go | 16 ++++++++++++---- 3 files changed, 25 insertions(+), 9 deletions(-) diff --git a/cmd/minikube/cmd/start.go b/cmd/minikube/cmd/start.go index 2033a331a0ad..415974615c68 100644 --- a/cmd/minikube/cmd/start.go +++ b/cmd/minikube/cmd/start.go @@ -170,7 +170,7 @@ func initMinikubeFlags() { startCmd.Flags().String(criSocket, "", "The cri socket path to be used.") startCmd.Flags().String(networkPlugin, "", "The name of the network plugin.") startCmd.Flags().Bool(enableDefaultCNI, false, "Enable the default CNI plugin (/etc/cni/net.d/k8s.conf). Used in conjunction with \"--network-plugin=cni\".") - startCmd.Flags().Bool(waitUntilHealthy, true, "Wait until Kubernetes core services are healthy before exiting.") + startCmd.Flags().Bool(waitUntilHealthy, false, "Wait until Kubernetes core services are healthy before exiting.") startCmd.Flags().Duration(waitTimeout, 6*time.Minute, "max time to wait per Kubernetes core services to be healthy.") startCmd.Flags().Bool(nativeSSH, true, "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'.") startCmd.Flags().Bool(autoUpdate, true, "If set, automatically updates drivers to the latest version. Defaults to true.") @@ -370,11 +370,19 @@ func runStart(cmd *cobra.Command, args []string) { if driverName == driver.None { prepareNone() } - if viper.GetBool(waitUntilHealthy) { - if err := bs.WaitCluster(config.KubernetesConfig, viper.GetDuration(waitTimeout)); err != nil { - exit.WithError("Wait failed", err) + + var podsToWaitFor map[string]struct{} + + if !viper.GetBool(waitUntilHealthy) { + // only wait for apiserver if wait=false + fmt.Println("only waiting for api server") + podsToWaitFor = map[string]struct{}{ + "apiserver": struct{}{}, } } + if err := bs.WaitCluster(config.KubernetesConfig, viper.GetDuration(waitTimeout), podsToWaitFor); err != nil { + exit.WithError("Wait failed", err) + } if err := showKubectlInfo(kubeconfig, k8sVersion); err != nil { glog.Errorf("kubectl info: %v", err) } diff --git a/pkg/minikube/bootstrapper/bootstrapper.go b/pkg/minikube/bootstrapper/bootstrapper.go index 43d0ac7ce77c..a0526379f529 100644 --- a/pkg/minikube/bootstrapper/bootstrapper.go +++ b/pkg/minikube/bootstrapper/bootstrapper.go @@ -41,7 +41,7 @@ type Bootstrapper interface { UpdateCluster(config.KubernetesConfig) error RestartCluster(config.KubernetesConfig) error DeleteCluster(config.KubernetesConfig) error - WaitCluster(config.KubernetesConfig, time.Duration) error + WaitCluster(config.KubernetesConfig, time.Duration, map[string]struct{}) error // LogCommands returns a map of log type to a command which will display that log. LogCommands(LogOptions) map[string]string SetupCerts(cfg config.KubernetesConfig) error diff --git a/pkg/minikube/bootstrapper/kubeadm/kubeadm.go b/pkg/minikube/bootstrapper/kubeadm/kubeadm.go index 95c35a087ce7..ca5373ea8689 100644 --- a/pkg/minikube/bootstrapper/kubeadm/kubeadm.go +++ b/pkg/minikube/bootstrapper/kubeadm/kubeadm.go @@ -368,7 +368,9 @@ func (k *Bootstrapper) client(k8s config.KubernetesConfig) (*kubernetes.Clientse } // WaitCluster blocks until Kubernetes appears to be healthy. -func (k *Bootstrapper) WaitCluster(k8s config.KubernetesConfig, timeout time.Duration) error { +// if waitForPods is nil, then wait for everything. Otherwise, only +// wait for pods specified. +func (k *Bootstrapper) WaitCluster(k8s config.KubernetesConfig, timeout time.Duration, waitForPods map[string]struct{}) error { // Do not wait for "k8s-app" pods in the case of CNI, as they are managed // by a CNI plugin which is usually started after minikube has been brought // up. Otherwise, minikube won't start, as "k8s-app" pods are not ready. @@ -377,9 +379,12 @@ func (k *Bootstrapper) WaitCluster(k8s config.KubernetesConfig, timeout time.Dur // Wait until the apiserver can answer queries properly. We don't care if the apiserver // pod shows up as registered, but need the webserver for all subsequent queries. - out.String(" apiserver") - if err := k.waitForAPIServer(k8s); err != nil { - return errors.Wrap(err, "waiting for apiserver") + + if _, ok := waitForPods["apiserver"]; ok || waitForPods == nil { + out.String(" apiserver") + if err := k.waitForAPIServer(k8s); err != nil { + return errors.Wrap(err, "waiting for apiserver") + } } client, err := k.client(k8s) @@ -391,6 +396,9 @@ func (k *Bootstrapper) WaitCluster(k8s config.KubernetesConfig, timeout time.Dur if componentsOnly && p.key != "component" { // skip component check if network plugin is cni continue } + if _, ok := waitForPods[p.name]; waitForPods != nil && !ok { + continue + } out.String(" %s", p.name) selector := labels.SelectorFromSet(labels.Set(map[string]string{p.key: p.value})) if err := kapi.WaitForPodsWithLabelRunning(client, "kube-system", selector, timeout); err != nil { From cf62ff62b247548fad4b014df99f63c84c0093ec Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 10:46:14 -0700 Subject: [PATCH 02/10] Remove extra log --- cmd/minikube/cmd/start.go | 1 - 1 file changed, 1 deletion(-) diff --git a/cmd/minikube/cmd/start.go b/cmd/minikube/cmd/start.go index 415974615c68..876175fdfa9e 100644 --- a/cmd/minikube/cmd/start.go +++ b/cmd/minikube/cmd/start.go @@ -375,7 +375,6 @@ func runStart(cmd *cobra.Command, args []string) { if !viper.GetBool(waitUntilHealthy) { // only wait for apiserver if wait=false - fmt.Println("only waiting for api server") podsToWaitFor = map[string]struct{}{ "apiserver": struct{}{}, } From 67901b457c4c798b9b6a7ad46cab25dd8e671f27 Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 11:37:23 -0700 Subject: [PATCH 03/10] update start flags --- .../en/docs/Reference/Commands/start.md | 125 ++++++++++-------- 1 file changed, 72 insertions(+), 53 deletions(-) diff --git a/site/content/en/docs/Reference/Commands/start.md b/site/content/en/docs/Reference/Commands/start.md index 6e1c1b13dfae..055e8f0567b5 100644 --- a/site/content/en/docs/Reference/Commands/start.md +++ b/site/content/en/docs/Reference/Commands/start.md @@ -16,59 +16,78 @@ minikube start [flags] ### Options ``` ---addons 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 []) ---apiserver-name string The apiserver name which is used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine (default "minikubeCA") ---apiserver-names stringArray 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 ---apiserver-port int The apiserver listening port (default 8443) ---cache-images If true, cache docker images for the current bootstrapper and load them into the machine. Always false with --vm-driver=none. (default true) ---container-runtime string The container runtime to be used (docker, crio, containerd). (default "docker") ---cpus int Number of CPUs allocated to the minikube VM. (default 2) ---cri-socket string The cri socket path to be used. ---disable-driver-mounts Disables the filesystem mounts provided by the hypervisors ---disk-size string Disk size allocated to the minikube VM (format: [], where unit = b, k, m or g). (default "20000mb") ---dns-domain string The cluster dns domain name used in the kubernetes cluster (default "cluster.local") ---dns-proxy Enable proxy for NAT DNS requests (virtualbox) ---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. ---embed-certs if true, will embed the certs in kubeconfig. ---enable-default-cni Enable the default CNI plugin (/etc/cni/net.d/k8s.conf). Used in conjunction with "--network-plugin=cni". ---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, 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 --h, --help help for start ---host-dns-resolver Enable host resolver for NAT DNS requests (virtualbox) (default true) ---host-only-cidr string The CIDR to be used for the minikube VM (only supported with Virtualbox driver) (default "192.168.99.1/24") ---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-vsock-ports strings List of guest VSock ports that should be exposed as sockets on the host (Only supported on with hyperkit now). ---hyperv-virtual-switch string The hyperv virtual switch name. Defaults to first found. (only supported with HyperV driver) ---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. ---iso-url string Location of the minikube iso. (default "https://storage.googleapis.com/minikube/iso/minikube-v1.3.0.iso") ---keep-context This will keep the existing kubectl context and will create a minikube context. ---kubernetes-version string The kubernetes version that the minikube VM will use (ex: v1.2.3) (default "v1.15.2") ---kvm-gpu Enable experimental NVIDIA GPU support in minikube ---kvm-hidden Hide the hypervisor signature from the guest in minikube ---kvm-network string The KVM network name. (only supported with KVM driver) (default "default") ---kvm-qemu-uri string The KVM QEMU connection URI. (works only with kvm2 driver on linux) (default "qemu:///system") ---memory string Amount of RAM allocated to the minikube VM (format: [], where unit = b, k, m or g). (default "2000mb") ---mount This will start the mount daemon and automatically mount files into minikube. ---mount-string string The argument to pass the minikube mount command on start. (default "/Users:/minikube-host") ---network-plugin string The name of the network plugin. ---nfs-share strings Local folders to share with Guest via NFS mounts (Only supported on with hyperkit now) ---nfs-shares-root string Where to root the NFS Shares (defaults to /nfsshares, only supported with hyperkit now) (default "/nfsshares") ---no-vtx-check Disable checking for the availability of hardware virtualization before the vm is started (virtualbox) ---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") ---uuid string Provide VM UUID to restore MAC address (only supported with Hyperkit driver). ---vm-driver string VM driver is one of: [virtualbox parallels vmwarefusion hyperkit vmware] (default "virtualbox") ---wait Wait until Kubernetes core services are healthy before exiting. (default true) ---wait-timeout duration max time to wait per Kubernetes core services to be healthy. (default 3m0s) + --addons=[]: Enable addons. see `minikube addons list` for a list of valid addon names. + --apiserver-ips=[]: 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 + --apiserver-name='minikubeCA': The apiserver name which is used in the generated certificate for kubernetes. This + can be used if you want to make the apiserver available from outside the machine + --apiserver-names=[]: 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 + --apiserver-port=8443: The apiserver listening port + --auto-update-drivers=true: If set, automatically updates drivers to the latest version. Defaults to true. + --cache-images=true: If true, cache docker images for the current bootstrapper and load them into the machine. + Always false with --vm-driver=none. + --container-runtime='docker': The container runtime to be used (docker, crio, containerd). + --cpus=2: Number of CPUs allocated to the minikube VM. + --cri-socket='': The cri socket path to be used. + --disable-driver-mounts=false: Disables the filesystem mounts provided by the hypervisors + --disk-size='20000mb': Disk size allocated to the minikube VM (format: [], where unit = b, k, m or + g). + --dns-domain='cluster.local': The cluster dns domain name used in the kubernetes cluster + --dns-proxy=false: Enable proxy for NAT DNS requests (virtualbox driver only) + --docker-env=[]: Environment variables to pass to the Docker daemon. (format: key=value) + --docker-opt=[]: Specify arbitrary flags to pass to the Docker daemon. (format: key=value) + --download-only=false: If true, only download and cache files for later use - don't install or start anything. + --embed-certs=false: if true, will embed the certs in kubeconfig. + --enable-default-cni=false: Enable the default CNI plugin (/etc/cni/net.d/k8s.conf). Used in conjunction with + "--network-plugin=cni". + --extra-config=: 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, pod-network-cidr + --feature-gates='': A set of key=value pairs that describe feature gates for alpha/experimental features. + --force=false: Force minikube to perform possibly dangerous operations + --host-dns-resolver=true: Enable host resolver for NAT DNS requests (virtualbox driver only) + --host-only-cidr='192.168.99.1/24': The CIDR to be used for the minikube VM (virtualbox driver only) + --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 VSock (hyperkit driver only) + --hyperkit-vsock-ports=[]: List of guest VSock ports that should be exposed as sockets on the host (hyperkit + driver only) + --hyperv-virtual-switch='': The hyperv virtual switch name. Defaults to first found. (hyperv driver only) + --image-mirror-country='': 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='': 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=[]: Insecure Docker registries to pass to the Docker daemon. The default service CIDR range + will automatically be added. + --interactive=true: Allow user prompts for more information + --iso-url='https://storage.googleapis.com/minikube/iso/minikube-v1.5.0.iso': Location of the minikube iso. + --keep-context=false: This will keep the existing kubectl context and will create a minikube context. + --kubernetes-version='v1.16.2': The kubernetes version that the minikube VM will use (ex: v1.2.3) + --kvm-gpu=false: Enable experimental NVIDIA GPU support in minikube + --kvm-hidden=false: Hide the hypervisor signature from the guest in minikube (kvm2 driver only) + --kvm-network='default': The KVM network name. (kvm2 driver only) + --kvm-qemu-uri='qemu:///system': The KVM QEMU connection URI. (kvm2 driver only) + --memory='2000mb': Amount of RAM allocated to the minikube VM (format: [], where unit = b, k, m or + g). + --mount=false: This will start the mount daemon and automatically mount files into minikube. + --mount-string='/Users:/minikube-host': The argument to pass the minikube mount command on start. + --native-ssh=true: 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'. + --network-plugin='': The name of the network plugin. + --nfs-share=[]: Local folders to share with Guest via NFS mounts (hyperkit driver only) + --nfs-shares-root='/nfsshares': Where to root the NFS Shares, defaults to /nfsshares (hyperkit driver only) + --no-vtx-check=false: Disable checking for the availability of hardware virtualization before the vm is started + (virtualbox driver only) + --registry-mirror=[]: Registry mirrors to pass to the Docker daemon + --service-cluster-ip-range='10.96.0.0/12': The CIDR to be used for service cluster IPs. + --uuid='': Provide VM UUID to restore MAC address (hyperkit driver only) + --vm-driver='': Driver is one of: [virtualbox parallels vmwarefusion hyperkit vmware] (defaults to auto-detect) + --wait=false: Wait until Kubernetes core services are healthy before exiting. + --wait-timeout=6m0s: max time to wait per Kubernetes core services to be healthy. ``` ### Options inherited from parent commands From 993967bcc7e22c436866a3e719260b1c2640b5d9 Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 15:20:13 -0700 Subject: [PATCH 04/10] make sure we can get api server pod --- pkg/minikube/bootstrapper/kubeadm/kubeadm.go | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/pkg/minikube/bootstrapper/kubeadm/kubeadm.go b/pkg/minikube/bootstrapper/kubeadm/kubeadm.go index ca5373ea8689..3174294aa2a7 100644 --- a/pkg/minikube/bootstrapper/kubeadm/kubeadm.go +++ b/pkg/minikube/bootstrapper/kubeadm/kubeadm.go @@ -36,6 +36,7 @@ import ( "github.com/golang/glog" "github.com/pkg/errors" "golang.org/x/sync/errgroup" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/labels" "k8s.io/apimachinery/pkg/util/wait" "k8s.io/client-go/kubernetes" @@ -495,11 +496,21 @@ func (k *Bootstrapper) waitForAPIServer(k8s config.KubernetesConfig) error { if status != "Running" { return false, nil } - return true, nil + // Make sure apiserver pod is retrievable + client, err := k.client(k8s) + if err != nil { + glog.Warningf("get kubernetes client: %v", err) + return false, nil + } + _, err = client.CoreV1().Pods("kube-system").Get("kube-apiserver-minikube", metav1.GetOptions{}) + if err != nil { + return false, nil + } + + return true, nil // TODO: Check apiserver/kubelet logs for fatal errors so that users don't // need to wait minutes to find out their flag didn't work. - } err = wait.PollImmediate(kconst.APICallRetryInterval, 2*kconst.DefaultControlPlaneTimeout, f) return err From c3dd5bc0c60a4681baab4fa8408565f73e756b2e Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 16:50:01 -0700 Subject: [PATCH 05/10] Add integration test to make sure apiserver is up and running and that the pod can be accessed via kubectl. --- test/integration/functional_test.go | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/test/integration/functional_test.go b/test/integration/functional_test.go index b3af56ec5c07..a3a76efbc899 100644 --- a/test/integration/functional_test.go +++ b/test/integration/functional_test.go @@ -60,6 +60,7 @@ func TestFunctional(t *testing.T) { }{ {"StartWithProxy", validateStartWithProxy}, // Set everything else up for success {"KubeContext", validateKubeContext}, // Racy: must come immediately after "minikube start" + {"KubeContext", validateKubectlGetPods}, // Make sure apiserver is up {"CacheCmd", validateCacheCmd}, // Caches images needed for subsequent tests because of proxy } for _, tc := range tests { @@ -142,6 +143,17 @@ func validateKubeContext(ctx context.Context, t *testing.T, profile string) { } } +// validateKubectlGetPods asserts that `kubectl get pod -A` returns non-zero content +func validateKubectlGetPods(ctx context.Context, t *testing.T, profile string) { + rr, err := Run(t, exec.CommandContext(ctx, "kubectl", "get", "pod", "-A")) + if err != nil { + t.Errorf("%s failed: %v", rr.Args, err) + } + if !strings.Contains(rr.Stdout.String(), "kube-apiserver-minikube") { + t.Errorf("kube-apiserver-minikube is not up in running, got: %s\n", rr.Stdout.String()) + } +} + // validateAddonManager asserts that the kube-addon-manager pod is deployed properly func validateAddonManager(ctx context.Context, t *testing.T, profile string) { // If --wait=false, this may take a couple of minutes From 5f12e9afa170608abe747370ebc3ccd461d75866 Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 17:12:03 -0700 Subject: [PATCH 06/10] Update docs and add error message to generate-docs --- cmd/minikube/cmd/generate-docs.go | 3 + docs/minikube.md | 50 +++++++++++++++++ docs/minikube_addons.md | 42 ++++++++++++++ docs/minikube_addons_configure.md | 37 +++++++++++++ docs/minikube_addons_disable.md | 37 +++++++++++++ docs/minikube_addons_enable.md | 37 +++++++++++++ docs/minikube_addons_list.md | 40 ++++++++++++++ docs/minikube_addons_open.md | 42 ++++++++++++++ docs/minikube_cache.md | 36 ++++++++++++ docs/minikube_cache_add.md | 37 +++++++++++++ docs/minikube_cache_delete.md | 37 +++++++++++++ docs/minikube_cache_list.md | 39 +++++++++++++ docs/minikube_completion.md | 56 +++++++++++++++++++ docs/minikube_config.md | 88 +++++++++++++++++++++++++++++ docs/minikube_config_get.md | 37 +++++++++++++ docs/minikube_config_set.md | 38 +++++++++++++ docs/minikube_config_unset.md | 37 +++++++++++++ docs/minikube_config_view.md | 39 +++++++++++++ docs/minikube_dashboard.md | 38 +++++++++++++ docs/minikube_delete.md | 40 ++++++++++++++ docs/minikube_docker-env.md | 40 ++++++++++++++ docs/minikube_ip.md | 37 +++++++++++++ docs/minikube_kubectl.md | 40 ++++++++++++++ docs/minikube_logs.md | 40 ++++++++++++++ docs/minikube_mount.md | 46 ++++++++++++++++ docs/minikube_profile.md | 38 +++++++++++++ docs/minikube_profile_list.md | 38 +++++++++++++ docs/minikube_service.md | 44 +++++++++++++++ docs/minikube_service_list.md | 39 +++++++++++++ docs/minikube_ssh-key.md | 37 +++++++++++++ docs/minikube_ssh.md | 38 +++++++++++++ docs/minikube_start.md | 92 +++++++++++++++++++++++++++++++ docs/minikube_status.md | 42 ++++++++++++++ docs/minikube_stop.md | 38 +++++++++++++ docs/minikube_tunnel.md | 38 +++++++++++++ docs/minikube_update-check.md | 37 +++++++++++++ docs/minikube_update-context.md | 38 +++++++++++++ docs/minikube_version.md | 37 +++++++++++++ 38 files changed, 1569 insertions(+) create mode 100644 docs/minikube.md create mode 100644 docs/minikube_addons.md create mode 100644 docs/minikube_addons_configure.md create mode 100644 docs/minikube_addons_disable.md create mode 100644 docs/minikube_addons_enable.md create mode 100644 docs/minikube_addons_list.md create mode 100644 docs/minikube_addons_open.md create mode 100644 docs/minikube_cache.md create mode 100644 docs/minikube_cache_add.md create mode 100644 docs/minikube_cache_delete.md create mode 100644 docs/minikube_cache_list.md create mode 100644 docs/minikube_completion.md create mode 100644 docs/minikube_config.md create mode 100644 docs/minikube_config_get.md create mode 100644 docs/minikube_config_set.md create mode 100644 docs/minikube_config_unset.md create mode 100644 docs/minikube_config_view.md create mode 100644 docs/minikube_dashboard.md create mode 100644 docs/minikube_delete.md create mode 100644 docs/minikube_docker-env.md create mode 100644 docs/minikube_ip.md create mode 100644 docs/minikube_kubectl.md create mode 100644 docs/minikube_logs.md create mode 100644 docs/minikube_mount.md create mode 100644 docs/minikube_profile.md create mode 100644 docs/minikube_profile_list.md create mode 100644 docs/minikube_service.md create mode 100644 docs/minikube_service_list.md create mode 100644 docs/minikube_ssh-key.md create mode 100644 docs/minikube_ssh.md create mode 100644 docs/minikube_start.md create mode 100644 docs/minikube_status.md create mode 100644 docs/minikube_stop.md create mode 100644 docs/minikube_tunnel.md create mode 100644 docs/minikube_update-check.md create mode 100644 docs/minikube_update-context.md create mode 100644 docs/minikube_version.md diff --git a/cmd/minikube/cmd/generate-docs.go b/cmd/minikube/cmd/generate-docs.go index 3bd6aba070fc..a69d38b78a73 100644 --- a/cmd/minikube/cmd/generate-docs.go +++ b/cmd/minikube/cmd/generate-docs.go @@ -35,6 +35,9 @@ var generateDocs = &cobra.Command{ Example: "minikube generate-docs --path ", Hidden: true, Run: func(cmd *cobra.Command, args []string) { + if path == "" { + exit.UsageT("Please specify a directory to write docs to via the --path flag.") + } // if directory does not exist docsPath, err := os.Stat(path) diff --git a/docs/minikube.md b/docs/minikube.md new file mode 100644 index 000000000000..65a43d66aa7a --- /dev/null +++ b/docs/minikube.md @@ -0,0 +1,50 @@ +## minikube + +Minikube is a tool for managing local Kubernetes clusters. + +### Synopsis + +Minikube is a CLI tool that provisions and manages single-node Kubernetes clusters optimized for development workflows. + +### Options + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + -h, --help help for minikube + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons +* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache. +* [minikube completion](minikube_completion.md) - Outputs minikube shell completion for the given shell (bash or zsh) +* [minikube config](minikube_config.md) - Modify minikube config +* [minikube dashboard](minikube_dashboard.md) - Access the kubernetes dashboard running within the minikube cluster +* [minikube delete](minikube_delete.md) - Deletes a local kubernetes cluster +* [minikube delete](minikube_delete.md) - Deletes a local kubernetes cluster +* [minikube docker-env](minikube_docker-env.md) - Sets up docker env variables; similar to '$(docker-machine env)' +* [minikube ip](minikube_ip.md) - Retrieves the IP address of the running cluster +* [minikube kubectl](minikube_kubectl.md) - Run kubectl +* [minikube logs](minikube_logs.md) - Gets the logs of the running instance, used for debugging minikube, not user code. +* [minikube mount](minikube_mount.md) - Mounts the specified directory into minikube +* [minikube profile](minikube_profile.md) - Profile gets or sets the current minikube profile +* [minikube service](minikube_service.md) - Gets the kubernetes URL(s) for the specified service in your local cluster +* [minikube ssh](minikube_ssh.md) - Log into or run a command on a machine with SSH; similar to 'docker-machine ssh' +* [minikube ssh-key](minikube_ssh-key.md) - Retrieve the ssh identity key path of the specified cluster +* [minikube start](minikube_start.md) - Starts a local kubernetes cluster +* [minikube status](minikube_status.md) - Gets the status of a local kubernetes cluster +* [minikube stop](minikube_stop.md) - Stops a running local kubernetes cluster +* [minikube tunnel](minikube_tunnel.md) - tunnel makes services of type LoadBalancer accessible on localhost +* [minikube update-check](minikube_update-check.md) - Print current and latest version number +* [minikube update-context](minikube_update-context.md) - Verify the IP address of the running cluster in kubeconfig. +* [minikube version](minikube_version.md) - Print the version of minikube + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons.md b/docs/minikube_addons.md new file mode 100644 index 000000000000..ba853bd757a6 --- /dev/null +++ b/docs/minikube_addons.md @@ -0,0 +1,42 @@ +## minikube addons + +Modify minikube's kubernetes addons + +### Synopsis + +addons modifies minikube addons files using subcommands like "minikube addons enable heapster" + +``` +minikube addons SUBCOMMAND [flags] +``` + +### Options + +``` + -h, --help help for addons +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. +* [minikube addons configure](minikube_addons_configure.md) - Configures the addon w/ADDON_NAME within minikube (example: minikube addons configure registry-creds). For a list of available addons use: minikube addons list +* [minikube addons disable](minikube_addons_disable.md) - Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list +* [minikube addons enable](minikube_addons_enable.md) - Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list +* [minikube addons list](minikube_addons_list.md) - Lists all available minikube addons as well as their current statuses (enabled/disabled) +* [minikube addons open](minikube_addons_open.md) - Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_configure.md b/docs/minikube_addons_configure.md new file mode 100644 index 000000000000..bba463561a25 --- /dev/null +++ b/docs/minikube_addons_configure.md @@ -0,0 +1,37 @@ +## 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 + +### Synopsis + +Configures the addon w/ADDON_NAME within minikube (example: minikube addons configure registry-creds). For a list of available addons use: minikube addons list + +``` +minikube addons configure ADDON_NAME [flags] +``` + +### Options + +``` + -h, --help help for configure +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_disable.md b/docs/minikube_addons_disable.md new file mode 100644 index 000000000000..23ad2604214b --- /dev/null +++ b/docs/minikube_addons_disable.md @@ -0,0 +1,37 @@ +## minikube addons disable + +Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list + +### Synopsis + +Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list + +``` +minikube addons disable ADDON_NAME [flags] +``` + +### Options + +``` + -h, --help help for disable +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_enable.md b/docs/minikube_addons_enable.md new file mode 100644 index 000000000000..358b982868e1 --- /dev/null +++ b/docs/minikube_addons_enable.md @@ -0,0 +1,37 @@ +## minikube addons enable + +Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list + +### Synopsis + +Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list + +``` +minikube addons enable ADDON_NAME [flags] +``` + +### Options + +``` + -h, --help help for enable +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_list.md b/docs/minikube_addons_list.md new file mode 100644 index 000000000000..63984710c837 --- /dev/null +++ b/docs/minikube_addons_list.md @@ -0,0 +1,40 @@ +## minikube addons list + +Lists all available minikube addons as well as their current statuses (enabled/disabled) + +### Synopsis + +Lists all available minikube addons as well as their current statuses (enabled/disabled) + +``` +minikube addons list [flags] +``` + +### Options + +``` + -f, --format string Go template format string for the addon list output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ + For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#AddonListTemplate (default "- {{.AddonName}}: {{.AddonStatus}}\n") + -h, --help help for list + -o, --output string minikube addons list --output OUTPUT. json, list (default "list") +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_open.md b/docs/minikube_addons_open.md new file mode 100644 index 000000000000..de5b9e9c599d --- /dev/null +++ b/docs/minikube_addons_open.md @@ -0,0 +1,42 @@ +## 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 + +### Synopsis + +Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list + +``` +minikube addons open ADDON_NAME [flags] +``` + +### Options + +``` + --format string Format to output addons URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") + -h, --help help for open + --https Open the addons URL with https instead of http + --interval int The time interval for each check that wait performs in seconds (default 6) + --url Display the kubernetes addons URL in the CLI instead of opening it in the default browser + --wait int Amount of time to wait for service in seconds (default 20) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_cache.md b/docs/minikube_cache.md new file mode 100644 index 000000000000..5a968a5372ef --- /dev/null +++ b/docs/minikube_cache.md @@ -0,0 +1,36 @@ +## minikube cache + +Add or delete an image from the local cache. + +### Synopsis + +Add or delete an image from the local cache. + +### Options + +``` + -h, --help help for cache +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. +* [minikube cache add](minikube_cache_add.md) - Add an image to local cache. +* [minikube cache delete](minikube_cache_delete.md) - Delete an image from the local cache. +* [minikube cache list](minikube_cache_list.md) - List all available images from the local cache. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_cache_add.md b/docs/minikube_cache_add.md new file mode 100644 index 000000000000..47b0d56a4f4d --- /dev/null +++ b/docs/minikube_cache_add.md @@ -0,0 +1,37 @@ +## minikube cache add + +Add an image to local cache. + +### Synopsis + +Add an image to local cache. + +``` +minikube cache add [flags] +``` + +### Options + +``` + -h, --help help for add +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_cache_delete.md b/docs/minikube_cache_delete.md new file mode 100644 index 000000000000..feaaf3298140 --- /dev/null +++ b/docs/minikube_cache_delete.md @@ -0,0 +1,37 @@ +## minikube cache delete + +Delete an image from the local cache. + +### Synopsis + +Delete an image from the local cache. + +``` +minikube cache delete [flags] +``` + +### Options + +``` + -h, --help help for delete +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_cache_list.md b/docs/minikube_cache_list.md new file mode 100644 index 000000000000..4c23d2bc6334 --- /dev/null +++ b/docs/minikube_cache_list.md @@ -0,0 +1,39 @@ +## minikube cache list + +List all available images from the local cache. + +### Synopsis + +List all available images from the local cache. + +``` +minikube cache list [flags] +``` + +### Options + +``` + --format string Go template format string for the cache list output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ + For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#CacheListTemplate (default "{{.CacheImage}}\n") + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_completion.md b/docs/minikube_completion.md new file mode 100644 index 000000000000..20ae5e85a1a0 --- /dev/null +++ b/docs/minikube_completion.md @@ -0,0 +1,56 @@ +## minikube completion + +Outputs minikube shell completion for the given shell (bash or zsh) + +### Synopsis + + + Outputs minikube shell completion for the given shell (bash or zsh) + + This depends on the bash-completion binary. Example installation instructions: + OS X: + $ 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 + Ubuntu: + $ apt-get install bash-completion + $ source /etc/bash-completion + $ source <(minikube completion bash) # for bash users + $ source <(minikube completion zsh) # for zsh users + + Additionally, you may want to output the completion to a file and source in your .bashrc + + Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2 + + +``` +minikube completion SHELL [flags] +``` + +### Options + +``` + -h, --help help for completion +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config.md b/docs/minikube_config.md new file mode 100644 index 000000000000..7c1f67fd71db --- /dev/null +++ b/docs/minikube_config.md @@ -0,0 +1,88 @@ +## minikube config + +Modify minikube config + +### Synopsis + +config modifies minikube config files using subcommands like "minikube config set vm-driver kvm" +Configurable fields: + + * vm-driver + * container-runtime + * feature-gates + * v + * cpus + * disk-size + * host-only-cidr + * memory + * log_dir + * kubernetes-version + * iso-url + * WantUpdateNotification + * ReminderWaitPeriodInHours + * WantReportError + * WantReportErrorPrompt + * WantKubectlDownloadMsg + * WantNoneDriverWarning + * profile + * bootstrapper + * ShowDriverDeprecationNotification + * ShowBootstrapperDeprecationNotification + * dashboard + * addon-manager + * default-storageclass + * heapster + * efk + * ingress + * insecure-registry + * registry + * registry-creds + * freshpod + * storage-provisioner + * storage-provisioner-gluster + * metrics-server + * nvidia-driver-installer + * nvidia-gpu-device-plugin + * logviewer + * gvisor + * helm-tiller + * ingress-dns + * hyperv-virtual-switch + * disable-driver-mounts + * cache + * embed-certs + * native-ssh + +``` +minikube config SUBCOMMAND [flags] +``` + +### Options + +``` + -h, --help help for config +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. +* [minikube config get](minikube_config_get.md) - Gets the value of PROPERTY_NAME from the minikube config file +* [minikube config set](minikube_config_set.md) - Sets an individual value in a minikube config file +* [minikube config unset](minikube_config_unset.md) - unsets an individual value in a minikube config file +* [minikube config view](minikube_config_view.md) - Display values currently set in the minikube config file + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config_get.md b/docs/minikube_config_get.md new file mode 100644 index 000000000000..b7107b87fb35 --- /dev/null +++ b/docs/minikube_config_get.md @@ -0,0 +1,37 @@ +## minikube config get + +Gets the value of PROPERTY_NAME from the minikube config file + +### Synopsis + +Returns the value of PROPERTY_NAME from the minikube config file. Can be overwritten at runtime by flags or environmental variables. + +``` +minikube config get PROPERTY_NAME [flags] +``` + +### Options + +``` + -h, --help help for get +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube config](minikube_config.md) - Modify minikube config + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config_set.md b/docs/minikube_config_set.md new file mode 100644 index 000000000000..dbaaec498efe --- /dev/null +++ b/docs/minikube_config_set.md @@ -0,0 +1,38 @@ +## minikube config set + +Sets an individual value in a minikube config file + +### Synopsis + +Sets the PROPERTY_NAME config value to PROPERTY_VALUE + These values can be overwritten by flags or environment variables at runtime. + +``` +minikube config set PROPERTY_NAME PROPERTY_VALUE [flags] +``` + +### Options + +``` + -h, --help help for set +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube config](minikube_config.md) - Modify minikube config + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config_unset.md b/docs/minikube_config_unset.md new file mode 100644 index 000000000000..a07feef17338 --- /dev/null +++ b/docs/minikube_config_unset.md @@ -0,0 +1,37 @@ +## minikube config unset + +unsets an individual value in a minikube config file + +### Synopsis + +unsets PROPERTY_NAME from the minikube config file. Can be overwritten by flags or environmental variables + +``` +minikube config unset PROPERTY_NAME [flags] +``` + +### Options + +``` + -h, --help help for unset +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube config](minikube_config.md) - Modify minikube config + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config_view.md b/docs/minikube_config_view.md new file mode 100644 index 000000000000..13e4fd86fd71 --- /dev/null +++ b/docs/minikube_config_view.md @@ -0,0 +1,39 @@ +## minikube config view + +Display values currently set in the minikube config file + +### Synopsis + +Display values currently set in the minikube config file. + +``` +minikube config view [flags] +``` + +### Options + +``` + --format string Go template format string for the config view output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ + For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#ConfigViewTemplate (default "- {{.ConfigKey}}: {{.ConfigValue}}\n") + -h, --help help for view +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube config](minikube_config.md) - Modify minikube config + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_dashboard.md b/docs/minikube_dashboard.md new file mode 100644 index 000000000000..fe84c2584058 --- /dev/null +++ b/docs/minikube_dashboard.md @@ -0,0 +1,38 @@ +## minikube dashboard + +Access the kubernetes dashboard running within the minikube cluster + +### Synopsis + +Access the kubernetes dashboard running within the minikube cluster + +``` +minikube dashboard [flags] +``` + +### Options + +``` + -h, --help help for dashboard + --url Display dashboard URL instead of opening a browser +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_delete.md b/docs/minikube_delete.md new file mode 100644 index 000000000000..848affabad77 --- /dev/null +++ b/docs/minikube_delete.md @@ -0,0 +1,40 @@ +## minikube delete + +Deletes a local kubernetes cluster + +### Synopsis + +Deletes a local kubernetes cluster. This command deletes the VM, and removes all +associated files. + +``` +minikube delete [flags] +``` + +### Options + +``` + --all Set flag to delete all profiles + -h, --help help for delete + --purge Set this flag to delete the '.minikube' folder from your user directory. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_docker-env.md b/docs/minikube_docker-env.md new file mode 100644 index 000000000000..3872364df926 --- /dev/null +++ b/docs/minikube_docker-env.md @@ -0,0 +1,40 @@ +## minikube docker-env + +Sets up docker env variables; similar to '$(docker-machine env)' + +### Synopsis + +Sets up docker env variables; similar to '$(docker-machine env)'. + +``` +minikube docker-env [flags] +``` + +### Options + +``` + -h, --help help for docker-env + --no-proxy Add machine IP to NO_PROXY environment variable + --shell string Force environment to be configured for a specified shell: [fish, cmd, powershell, tcsh, bash, zsh], default is auto-detect + -u, --unset Unset variables instead of setting them +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_ip.md b/docs/minikube_ip.md new file mode 100644 index 000000000000..cdb57ccd726d --- /dev/null +++ b/docs/minikube_ip.md @@ -0,0 +1,37 @@ +## minikube ip + +Retrieves the IP address of the running cluster + +### Synopsis + +Retrieves the IP address of the running cluster, and writes it to STDOUT. + +``` +minikube ip [flags] +``` + +### Options + +``` + -h, --help help for ip +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_kubectl.md b/docs/minikube_kubectl.md new file mode 100644 index 000000000000..782535407414 --- /dev/null +++ b/docs/minikube_kubectl.md @@ -0,0 +1,40 @@ +## minikube kubectl + +Run kubectl + +### Synopsis + +Run the kubernetes client, download it if necessary. +Examples: +minikube kubectl -- --help +kubectl get pods --namespace kube-system + +``` +minikube kubectl [flags] +``` + +### Options + +``` + -h, --help help for kubectl +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_logs.md b/docs/minikube_logs.md new file mode 100644 index 000000000000..dbfb686a91d9 --- /dev/null +++ b/docs/minikube_logs.md @@ -0,0 +1,40 @@ +## minikube logs + +Gets the logs of the running instance, used for debugging minikube, not user code. + +### Synopsis + +Gets the logs of the running instance, used for debugging minikube, not user code. + +``` +minikube logs [flags] +``` + +### Options + +``` + -f, --follow Show only the most recent journal entries, and continuously print new entries as they are appended to the journal. + -h, --help help for logs + -n, --length int Number of lines back to go within the log (default 60) + --problems Show only log entries which point to known problems +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_mount.md b/docs/minikube_mount.md new file mode 100644 index 000000000000..f161a63f3bce --- /dev/null +++ b/docs/minikube_mount.md @@ -0,0 +1,46 @@ +## minikube mount + +Mounts the specified directory into minikube + +### Synopsis + +Mounts the specified directory into minikube. + +``` +minikube mount [flags] : +``` + +### Options + +``` + --9p-version string Specify the 9p version that the mount should use (default "9p2000.L") + --gid string Default group id used for the mount (default "docker") + -h, --help help for mount + --ip string Specify the ip that the mount should be setup on + --kill Kill the mount process spawned by minikube start + --mode uint File permissions used for the mount (default 493) + --msize int The number of bytes to use for 9p packet payload (default 262144) + --options strings Additional mount options, such as cache=fscache + --type string Specify the mount filesystem type (supported types: 9p) (default "9p") + --uid string Default user id used for the mount (default "docker") +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_profile.md b/docs/minikube_profile.md new file mode 100644 index 000000000000..6999e0c94673 --- /dev/null +++ b/docs/minikube_profile.md @@ -0,0 +1,38 @@ +## minikube profile + +Profile gets or sets the current minikube profile + +### Synopsis + +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` + +``` +minikube profile [MINIKUBE_PROFILE_NAME]. You can return to the default minikube profile by running `minikube profile default` [flags] +``` + +### Options + +``` + -h, --help help for profile +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. +* [minikube profile list](minikube_profile_list.md) - Lists all minikube profiles. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_profile_list.md b/docs/minikube_profile_list.md new file mode 100644 index 000000000000..852c22bfae04 --- /dev/null +++ b/docs/minikube_profile_list.md @@ -0,0 +1,38 @@ +## minikube profile list + +Lists all minikube profiles. + +### Synopsis + +Lists all valid minikube profiles and detects all possible invalid profiles. + +``` +minikube profile list [flags] +``` + +### Options + +``` + -h, --help help for list + -o, --output string The output format. One of 'json', 'table' (default "table") +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube profile](minikube_profile.md) - Profile gets or sets the current minikube profile + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_service.md b/docs/minikube_service.md new file mode 100644 index 000000000000..63bf3b828fe6 --- /dev/null +++ b/docs/minikube_service.md @@ -0,0 +1,44 @@ +## minikube service + +Gets the kubernetes URL(s) for the specified service in your local cluster + +### Synopsis + +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. + +``` +minikube service [flags] SERVICE +``` + +### Options + +``` + --format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") + -h, --help help for service + --https Open the service URL with https instead of http + --interval int The initial time interval for each check that wait performs in seconds (default 6) + -n, --namespace string The service namespace (default "default") + --url Display the kubernetes service URL in the CLI instead of opening it in the default browser + --wait int Amount of time to wait for a service in seconds (default 20) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. +* [minikube service list](minikube_service_list.md) - Lists the URLs for the services in your local cluster + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_service_list.md b/docs/minikube_service_list.md new file mode 100644 index 000000000000..8389527911a8 --- /dev/null +++ b/docs/minikube_service_list.md @@ -0,0 +1,39 @@ +## minikube service list + +Lists the URLs for the services in your local cluster + +### Synopsis + +Lists the URLs for the services in your local cluster + +``` +minikube service list [flags] +``` + +### Options + +``` + -h, --help help for list + -n, --namespace string The services namespace +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube service](minikube_service.md) - Gets the kubernetes URL(s) for the specified service in your local cluster + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_ssh-key.md b/docs/minikube_ssh-key.md new file mode 100644 index 000000000000..f746a9212573 --- /dev/null +++ b/docs/minikube_ssh-key.md @@ -0,0 +1,37 @@ +## minikube ssh-key + +Retrieve the ssh identity key path of the specified cluster + +### Synopsis + +Retrieve the ssh identity key path of the specified cluster. + +``` +minikube ssh-key [flags] +``` + +### Options + +``` + -h, --help help for ssh-key +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_ssh.md b/docs/minikube_ssh.md new file mode 100644 index 000000000000..255ea86e40ab --- /dev/null +++ b/docs/minikube_ssh.md @@ -0,0 +1,38 @@ +## minikube ssh + +Log into or run a command on a machine with SSH; similar to 'docker-machine ssh' + +### Synopsis + +Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'. + +``` +minikube ssh [flags] +``` + +### Options + +``` + -h, --help help for ssh + --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) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_start.md b/docs/minikube_start.md new file mode 100644 index 000000000000..f4fb80384a47 --- /dev/null +++ b/docs/minikube_start.md @@ -0,0 +1,92 @@ +## minikube start + +Starts a local kubernetes cluster + +### Synopsis + +Starts a local kubernetes cluster + +``` +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 []) + --apiserver-name string The apiserver name which is used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine (default "minikubeCA") + --apiserver-names stringArray 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 + --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) + --cache-images If true, cache docker images for the current bootstrapper and load them into the machine. Always false with --vm-driver=none. (default true) + --container-runtime string The container runtime to be used (docker, crio, containerd). (default "docker") + --cpus int Number of CPUs allocated to the minikube VM. (default 2) + --cri-socket string The cri socket path to be used. + --disable-driver-mounts Disables the filesystem mounts provided by the hypervisors + --disk-size string Disk size allocated to the minikube VM (format: [], where unit = b, k, m or g). (default "20000mb") + --dns-domain string The cluster dns domain name used in the kubernetes cluster (default "cluster.local") + --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. + --embed-certs if true, will embed the certs in kubeconfig. + --enable-default-cni Enable the default CNI plugin (/etc/cni/net.d/k8s.conf). Used in conjunction with "--network-plugin=cni". + --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, 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 + -h, --help help for start + --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") + --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-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. + --interactive Allow user prompts for more information (default true) + --iso-url string Location of the minikube iso. (default "https://storage.googleapis.com/minikube/iso/minikube-v1.5.0.iso") + --keep-context This will keep the existing kubectl context and will create a minikube context. + --kubernetes-version string The kubernetes version that the minikube VM will use (ex: v1.2.3) (default "v1.16.2") + --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 allocated to the minikube VM (format: [], where unit = b, k, m or g). (default "2000mb") + --mount This will start the mount daemon and automatically mount files into minikube. + --mount-string string The argument to pass the minikube mount command on start. (default "/usr/local/google/home/priyawadhwa:/minikube-host") + --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) + --network-plugin string The name of the network plugin. + --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) + --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") + --uuid string Provide VM UUID to restore MAC address (hyperkit driver only) + --vm-driver string Driver is one of: [virtualbox parallels vmwarefusion kvm2 vmware none] (defaults to auto-detect) + --wait Wait until Kubernetes core services are healthy before exiting. + --wait-timeout duration max time to wait per Kubernetes core services to be healthy. (default 6m0s) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_status.md b/docs/minikube_status.md new file mode 100644 index 000000000000..15ab74c5de49 --- /dev/null +++ b/docs/minikube_status.md @@ -0,0 +1,42 @@ +## minikube status + +Gets the status of a local kubernetes cluster + +### Synopsis + +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. + Eg: 7 meaning: 1 (for minikube NOK) + 2 (for cluster NOK) + 4 (for kubernetes NOK) + +``` +minikube status [flags] +``` + +### Options + +``` + -f, --format string Go template format string for the status output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ + For the list accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#Status (default "host: {{.Host}}\nkubelet: {{.Kubelet}}\napiserver: {{.APIServer}}\nkubeconfig: {{.Kubeconfig}}\n") + -h, --help help for status + -o, --output string minikube status --output OUTPUT. json, text (default "text") +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_stop.md b/docs/minikube_stop.md new file mode 100644 index 000000000000..8c27b52a4793 --- /dev/null +++ b/docs/minikube_stop.md @@ -0,0 +1,38 @@ +## minikube stop + +Stops a running local kubernetes cluster + +### Synopsis + +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. + +``` +minikube stop [flags] +``` + +### Options + +``` + -h, --help help for stop +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_tunnel.md b/docs/minikube_tunnel.md new file mode 100644 index 000000000000..ae5a7f152982 --- /dev/null +++ b/docs/minikube_tunnel.md @@ -0,0 +1,38 @@ +## minikube tunnel + +tunnel makes services of type LoadBalancer accessible on localhost + +### Synopsis + +tunnel creates a route to services deployed with type LoadBalancer and sets their Ingress to their ClusterIP + +``` +minikube tunnel [flags] +``` + +### Options + +``` + -c, --cleanup call with cleanup=true to remove old tunnels + -h, --help help for tunnel +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_update-check.md b/docs/minikube_update-check.md new file mode 100644 index 000000000000..3447333b216f --- /dev/null +++ b/docs/minikube_update-check.md @@ -0,0 +1,37 @@ +## minikube update-check + +Print current and latest version number + +### Synopsis + +Print current and latest version number + +``` +minikube update-check [flags] +``` + +### Options + +``` + -h, --help help for update-check +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_update-context.md b/docs/minikube_update-context.md new file mode 100644 index 000000000000..53865c83b37e --- /dev/null +++ b/docs/minikube_update-context.md @@ -0,0 +1,38 @@ +## minikube update-context + +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. + +``` +minikube update-context [flags] +``` + +### Options + +``` + -h, --help help for update-context +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_version.md b/docs/minikube_version.md new file mode 100644 index 000000000000..30ab0ca4b3f8 --- /dev/null +++ b/docs/minikube_version.md @@ -0,0 +1,37 @@ +## minikube version + +Print the version of minikube + +### Synopsis + +Print the version of minikube. + +``` +minikube version [flags] +``` + +### Options + +``` + -h, --help help for version +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") + --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 + --logtostderr log to standard error instead of files + -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") + --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 +``` + +### SEE ALSO + +* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. + +###### Auto generated by spf13/cobra on 28-Oct-2019 From 5113270c81f31a6e5be0237e016f46748f5a7224 Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 17:13:41 -0700 Subject: [PATCH 07/10] Update integration test name --- test/integration/functional_test.go | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/test/integration/functional_test.go b/test/integration/functional_test.go index a3a76efbc899..d96b7dd3f1e2 100644 --- a/test/integration/functional_test.go +++ b/test/integration/functional_test.go @@ -60,7 +60,7 @@ func TestFunctional(t *testing.T) { }{ {"StartWithProxy", validateStartWithProxy}, // Set everything else up for success {"KubeContext", validateKubeContext}, // Racy: must come immediately after "minikube start" - {"KubeContext", validateKubectlGetPods}, // Make sure apiserver is up + {"KubectlGetPods", validateKubectlGetPods}, // Make sure apiserver is up {"CacheCmd", validateCacheCmd}, // Caches images needed for subsequent tests because of proxy } for _, tc := range tests { @@ -149,8 +149,9 @@ func validateKubectlGetPods(ctx context.Context, t *testing.T, profile string) { if err != nil { t.Errorf("%s failed: %v", rr.Args, err) } - if !strings.Contains(rr.Stdout.String(), "kube-apiserver-minikube") { - t.Errorf("kube-apiserver-minikube is not up in running, got: %s\n", rr.Stdout.String()) + podName := "kube-apiserver-minikube" + if !strings.Contains(rr.Stdout.String(), podName) { + t.Errorf("%s is not up in running, got: %s\n", podName, rr.Stdout.String()) } } From f3b1a09c3637309f88cfb5bf46e6682d6e66b91f Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 17:34:00 -0700 Subject: [PATCH 08/10] Clean up bootstrapper interface to accept list of pods to wait for when waiting for the cluster to start up. --- cmd/minikube/cmd/start.go | 8 ++-- pkg/minikube/bootstrapper/bootstrapper.go | 2 +- pkg/minikube/bootstrapper/kubeadm/kubeadm.go | 29 ++++++++++--- .../bootstrapper/kubeadm/kubeadm_test.go | 42 +++++++++++++++++++ 4 files changed, 70 insertions(+), 11 deletions(-) diff --git a/cmd/minikube/cmd/start.go b/cmd/minikube/cmd/start.go index 84a97c5438f8..4515eb9646fb 100644 --- a/cmd/minikube/cmd/start.go +++ b/cmd/minikube/cmd/start.go @@ -376,15 +376,13 @@ func runStart(cmd *cobra.Command, args []string) { prepareNone() } - var podsToWaitFor map[string]struct{} + var podsToWaitFor []string if !viper.GetBool(waitUntilHealthy) { // only wait for apiserver if wait=false - podsToWaitFor = map[string]struct{}{ - "apiserver": struct{}{}, - } + podsToWaitFor = []string{"apiserver"} } - if err := bs.WaitCluster(config.KubernetesConfig, viper.GetDuration(waitTimeout), podsToWaitFor); err != nil { + if err := bs.WaitForPods(config.KubernetesConfig, viper.GetDuration(waitTimeout), podsToWaitFor); err != nil { exit.WithError("Wait failed", err) } if err := showKubectlInfo(kubeconfig, k8sVersion); err != nil { diff --git a/pkg/minikube/bootstrapper/bootstrapper.go b/pkg/minikube/bootstrapper/bootstrapper.go index a0526379f529..f0b244f3e74b 100644 --- a/pkg/minikube/bootstrapper/bootstrapper.go +++ b/pkg/minikube/bootstrapper/bootstrapper.go @@ -41,7 +41,7 @@ type Bootstrapper interface { UpdateCluster(config.KubernetesConfig) error RestartCluster(config.KubernetesConfig) error DeleteCluster(config.KubernetesConfig) error - WaitCluster(config.KubernetesConfig, time.Duration, map[string]struct{}) error + WaitForPods(config.KubernetesConfig, time.Duration, []string) error // LogCommands returns a map of log type to a command which will display that log. LogCommands(LogOptions) map[string]string SetupCerts(cfg config.KubernetesConfig) error diff --git a/pkg/minikube/bootstrapper/kubeadm/kubeadm.go b/pkg/minikube/bootstrapper/kubeadm/kubeadm.go index 3174294aa2a7..727e42594cda 100644 --- a/pkg/minikube/bootstrapper/kubeadm/kubeadm.go +++ b/pkg/minikube/bootstrapper/kubeadm/kubeadm.go @@ -64,6 +64,7 @@ const ( defaultCNIConfigPath = "/etc/cni/net.d/k8s.conf" kubeletServiceFile = "/lib/systemd/system/kubelet.service" kubeletSystemdConfFile = "/etc/systemd/system/kubelet.service.d/10-kubeadm.conf" + AllPods = "ALL_PODS" ) const ( @@ -353,7 +354,7 @@ func addAddons(files *[]assets.CopyableFile, data interface{}) error { // client returns a Kubernetes client to use to speak to a kubeadm launched apiserver func (k *Bootstrapper) client(k8s config.KubernetesConfig) (*kubernetes.Clientset, error) { - // Catch case if WaitCluster was called with a stale ~/.kube/config + // Catch case if WaitForPods was called with a stale ~/.kube/config config, err := kapi.ClientConfig(k.contextName) if err != nil { return nil, errors.Wrap(err, "client config") @@ -368,10 +369,10 @@ func (k *Bootstrapper) client(k8s config.KubernetesConfig) (*kubernetes.Clientse return kubernetes.NewForConfig(config) } -// WaitCluster blocks until Kubernetes appears to be healthy. +// WaitForPods blocks until Kubernetes appears to be healthy. // if waitForPods is nil, then wait for everything. Otherwise, only // wait for pods specified. -func (k *Bootstrapper) WaitCluster(k8s config.KubernetesConfig, timeout time.Duration, waitForPods map[string]struct{}) error { +func (k *Bootstrapper) WaitForPods(k8s config.KubernetesConfig, timeout time.Duration, podsToWaitFor []string) error { // Do not wait for "k8s-app" pods in the case of CNI, as they are managed // by a CNI plugin which is usually started after minikube has been brought // up. Otherwise, minikube won't start, as "k8s-app" pods are not ready. @@ -381,7 +382,7 @@ func (k *Bootstrapper) WaitCluster(k8s config.KubernetesConfig, timeout time.Dur // Wait until the apiserver can answer queries properly. We don't care if the apiserver // pod shows up as registered, but need the webserver for all subsequent queries. - if _, ok := waitForPods["apiserver"]; ok || waitForPods == nil { + if shouldWaitForPod("apiserver", podsToWaitFor) { out.String(" apiserver") if err := k.waitForAPIServer(k8s); err != nil { return errors.Wrap(err, "waiting for apiserver") @@ -397,7 +398,7 @@ func (k *Bootstrapper) WaitCluster(k8s config.KubernetesConfig, timeout time.Dur if componentsOnly && p.key != "component" { // skip component check if network plugin is cni continue } - if _, ok := waitForPods[p.name]; waitForPods != nil && !ok { + if !shouldWaitForPod(p.name, podsToWaitFor) { continue } out.String(" %s", p.name) @@ -410,6 +411,24 @@ func (k *Bootstrapper) WaitCluster(k8s config.KubernetesConfig, timeout time.Dur return nil } +func shouldWaitForPod(name string, podsToWaitFor []string) bool { + if podsToWaitFor == nil { + return true + } + if len(podsToWaitFor) == 0 { + return false + } + for _, p := range podsToWaitFor { + if p == AllPods { + return true + } + if p == name { + return true + } + } + return false +} + // RestartCluster restarts the Kubernetes cluster configured by kubeadm func (k *Bootstrapper) RestartCluster(k8s config.KubernetesConfig) error { glog.Infof("RestartCluster start") diff --git a/pkg/minikube/bootstrapper/kubeadm/kubeadm_test.go b/pkg/minikube/bootstrapper/kubeadm/kubeadm_test.go index e638c32c4532..ffae60d48d59 100644 --- a/pkg/minikube/bootstrapper/kubeadm/kubeadm_test.go +++ b/pkg/minikube/bootstrapper/kubeadm/kubeadm_test.go @@ -363,3 +363,45 @@ func TestGenerateConfig(t *testing.T) { } } } + +func TestShouldWaitForPod(t *testing.T) { + tests := []struct { + description string + pod string + podsToWaitFor []string + expected bool + }{ + { + description: "pods to wait for is nil", + pod: "apiserver", + expected: true, + }, { + description: "pods to wait for is empty", + pod: "apiserver", + podsToWaitFor: []string{}, + }, { + description: "pod is in podsToWaitFor", + pod: "apiserver", + podsToWaitFor: []string{"etcd", "apiserver"}, + expected: true, + }, { + description: "pod is not in podsToWaitFor", + pod: "apiserver", + podsToWaitFor: []string{"etcd", "gvisor"}, + }, { + description: "wait for all pods", + pod: "apiserver", + podsToWaitFor: []string{"ALL_PODS"}, + expected: true, + }, + } + + for _, test := range tests { + t.Run(test.description, func(t *testing.T) { + actual := shouldWaitForPod(test.pod, test.podsToWaitFor) + if actual != test.expected { + t.Fatalf("unexpected diff: got %t, expected %t", actual, test.expected) + } + }) + } +} From c41eb8a835d5a3f13b9580ad53f7adf84c32c316 Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 17:58:51 -0700 Subject: [PATCH 09/10] Remove additional docs --- docs/minikube.md | 50 ----------------- docs/minikube_addons.md | 42 -------------- docs/minikube_addons_configure.md | 37 ------------- docs/minikube_addons_disable.md | 37 ------------- docs/minikube_addons_enable.md | 37 ------------- docs/minikube_addons_list.md | 40 -------------- docs/minikube_addons_open.md | 42 -------------- docs/minikube_cache.md | 36 ------------ docs/minikube_cache_add.md | 37 ------------- docs/minikube_cache_delete.md | 37 ------------- docs/minikube_cache_list.md | 39 ------------- docs/minikube_completion.md | 56 ------------------- docs/minikube_config.md | 88 ----------------------------- docs/minikube_config_get.md | 37 ------------- docs/minikube_config_set.md | 38 ------------- docs/minikube_config_unset.md | 37 ------------- docs/minikube_config_view.md | 39 ------------- docs/minikube_dashboard.md | 38 ------------- docs/minikube_delete.md | 40 -------------- docs/minikube_docker-env.md | 40 -------------- docs/minikube_ip.md | 37 ------------- docs/minikube_kubectl.md | 40 -------------- docs/minikube_logs.md | 40 -------------- docs/minikube_mount.md | 46 ---------------- docs/minikube_profile.md | 38 ------------- docs/minikube_profile_list.md | 38 ------------- docs/minikube_service.md | 44 --------------- docs/minikube_service_list.md | 39 ------------- docs/minikube_ssh-key.md | 37 ------------- docs/minikube_ssh.md | 38 ------------- docs/minikube_start.md | 92 ------------------------------- docs/minikube_status.md | 42 -------------- docs/minikube_stop.md | 38 ------------- docs/minikube_tunnel.md | 38 ------------- docs/minikube_update-check.md | 37 ------------- docs/minikube_update-context.md | 38 ------------- docs/minikube_version.md | 37 ------------- 37 files changed, 1566 deletions(-) delete mode 100644 docs/minikube.md delete mode 100644 docs/minikube_addons.md delete mode 100644 docs/minikube_addons_configure.md delete mode 100644 docs/minikube_addons_disable.md delete mode 100644 docs/minikube_addons_enable.md delete mode 100644 docs/minikube_addons_list.md delete mode 100644 docs/minikube_addons_open.md delete mode 100644 docs/minikube_cache.md delete mode 100644 docs/minikube_cache_add.md delete mode 100644 docs/minikube_cache_delete.md delete mode 100644 docs/minikube_cache_list.md delete mode 100644 docs/minikube_completion.md delete mode 100644 docs/minikube_config.md delete mode 100644 docs/minikube_config_get.md delete mode 100644 docs/minikube_config_set.md delete mode 100644 docs/minikube_config_unset.md delete mode 100644 docs/minikube_config_view.md delete mode 100644 docs/minikube_dashboard.md delete mode 100644 docs/minikube_delete.md delete mode 100644 docs/minikube_docker-env.md delete mode 100644 docs/minikube_ip.md delete mode 100644 docs/minikube_kubectl.md delete mode 100644 docs/minikube_logs.md delete mode 100644 docs/minikube_mount.md delete mode 100644 docs/minikube_profile.md delete mode 100644 docs/minikube_profile_list.md delete mode 100644 docs/minikube_service.md delete mode 100644 docs/minikube_service_list.md delete mode 100644 docs/minikube_ssh-key.md delete mode 100644 docs/minikube_ssh.md delete mode 100644 docs/minikube_start.md delete mode 100644 docs/minikube_status.md delete mode 100644 docs/minikube_stop.md delete mode 100644 docs/minikube_tunnel.md delete mode 100644 docs/minikube_update-check.md delete mode 100644 docs/minikube_update-context.md delete mode 100644 docs/minikube_version.md diff --git a/docs/minikube.md b/docs/minikube.md deleted file mode 100644 index 65a43d66aa7a..000000000000 --- a/docs/minikube.md +++ /dev/null @@ -1,50 +0,0 @@ -## minikube - -Minikube is a tool for managing local Kubernetes clusters. - -### Synopsis - -Minikube is a CLI tool that provisions and manages single-node Kubernetes clusters optimized for development workflows. - -### Options - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - -h, --help help for minikube - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons -* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache. -* [minikube completion](minikube_completion.md) - Outputs minikube shell completion for the given shell (bash or zsh) -* [minikube config](minikube_config.md) - Modify minikube config -* [minikube dashboard](minikube_dashboard.md) - Access the kubernetes dashboard running within the minikube cluster -* [minikube delete](minikube_delete.md) - Deletes a local kubernetes cluster -* [minikube delete](minikube_delete.md) - Deletes a local kubernetes cluster -* [minikube docker-env](minikube_docker-env.md) - Sets up docker env variables; similar to '$(docker-machine env)' -* [minikube ip](minikube_ip.md) - Retrieves the IP address of the running cluster -* [minikube kubectl](minikube_kubectl.md) - Run kubectl -* [minikube logs](minikube_logs.md) - Gets the logs of the running instance, used for debugging minikube, not user code. -* [minikube mount](minikube_mount.md) - Mounts the specified directory into minikube -* [minikube profile](minikube_profile.md) - Profile gets or sets the current minikube profile -* [minikube service](minikube_service.md) - Gets the kubernetes URL(s) for the specified service in your local cluster -* [minikube ssh](minikube_ssh.md) - Log into or run a command on a machine with SSH; similar to 'docker-machine ssh' -* [minikube ssh-key](minikube_ssh-key.md) - Retrieve the ssh identity key path of the specified cluster -* [minikube start](minikube_start.md) - Starts a local kubernetes cluster -* [minikube status](minikube_status.md) - Gets the status of a local kubernetes cluster -* [minikube stop](minikube_stop.md) - Stops a running local kubernetes cluster -* [minikube tunnel](minikube_tunnel.md) - tunnel makes services of type LoadBalancer accessible on localhost -* [minikube update-check](minikube_update-check.md) - Print current and latest version number -* [minikube update-context](minikube_update-context.md) - Verify the IP address of the running cluster in kubeconfig. -* [minikube version](minikube_version.md) - Print the version of minikube - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons.md b/docs/minikube_addons.md deleted file mode 100644 index ba853bd757a6..000000000000 --- a/docs/minikube_addons.md +++ /dev/null @@ -1,42 +0,0 @@ -## minikube addons - -Modify minikube's kubernetes addons - -### Synopsis - -addons modifies minikube addons files using subcommands like "minikube addons enable heapster" - -``` -minikube addons SUBCOMMAND [flags] -``` - -### Options - -``` - -h, --help help for addons -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. -* [minikube addons configure](minikube_addons_configure.md) - Configures the addon w/ADDON_NAME within minikube (example: minikube addons configure registry-creds). For a list of available addons use: minikube addons list -* [minikube addons disable](minikube_addons_disable.md) - Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list -* [minikube addons enable](minikube_addons_enable.md) - Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list -* [minikube addons list](minikube_addons_list.md) - Lists all available minikube addons as well as their current statuses (enabled/disabled) -* [minikube addons open](minikube_addons_open.md) - Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_configure.md b/docs/minikube_addons_configure.md deleted file mode 100644 index bba463561a25..000000000000 --- a/docs/minikube_addons_configure.md +++ /dev/null @@ -1,37 +0,0 @@ -## 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 - -### Synopsis - -Configures the addon w/ADDON_NAME within minikube (example: minikube addons configure registry-creds). For a list of available addons use: minikube addons list - -``` -minikube addons configure ADDON_NAME [flags] -``` - -### Options - -``` - -h, --help help for configure -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_disable.md b/docs/minikube_addons_disable.md deleted file mode 100644 index 23ad2604214b..000000000000 --- a/docs/minikube_addons_disable.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube addons disable - -Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list - -### Synopsis - -Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list - -``` -minikube addons disable ADDON_NAME [flags] -``` - -### Options - -``` - -h, --help help for disable -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_enable.md b/docs/minikube_addons_enable.md deleted file mode 100644 index 358b982868e1..000000000000 --- a/docs/minikube_addons_enable.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube addons enable - -Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list - -### Synopsis - -Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list - -``` -minikube addons enable ADDON_NAME [flags] -``` - -### Options - -``` - -h, --help help for enable -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_list.md b/docs/minikube_addons_list.md deleted file mode 100644 index 63984710c837..000000000000 --- a/docs/minikube_addons_list.md +++ /dev/null @@ -1,40 +0,0 @@ -## minikube addons list - -Lists all available minikube addons as well as their current statuses (enabled/disabled) - -### Synopsis - -Lists all available minikube addons as well as their current statuses (enabled/disabled) - -``` -minikube addons list [flags] -``` - -### Options - -``` - -f, --format string Go template format string for the addon list output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ - For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#AddonListTemplate (default "- {{.AddonName}}: {{.AddonStatus}}\n") - -h, --help help for list - -o, --output string minikube addons list --output OUTPUT. json, list (default "list") -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_addons_open.md b/docs/minikube_addons_open.md deleted file mode 100644 index de5b9e9c599d..000000000000 --- a/docs/minikube_addons_open.md +++ /dev/null @@ -1,42 +0,0 @@ -## 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 - -### Synopsis - -Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list - -``` -minikube addons open ADDON_NAME [flags] -``` - -### Options - -``` - --format string Format to output addons URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") - -h, --help help for open - --https Open the addons URL with https instead of http - --interval int The time interval for each check that wait performs in seconds (default 6) - --url Display the kubernetes addons URL in the CLI instead of opening it in the default browser - --wait int Amount of time to wait for service in seconds (default 20) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_cache.md b/docs/minikube_cache.md deleted file mode 100644 index 5a968a5372ef..000000000000 --- a/docs/minikube_cache.md +++ /dev/null @@ -1,36 +0,0 @@ -## minikube cache - -Add or delete an image from the local cache. - -### Synopsis - -Add or delete an image from the local cache. - -### Options - -``` - -h, --help help for cache -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. -* [minikube cache add](minikube_cache_add.md) - Add an image to local cache. -* [minikube cache delete](minikube_cache_delete.md) - Delete an image from the local cache. -* [minikube cache list](minikube_cache_list.md) - List all available images from the local cache. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_cache_add.md b/docs/minikube_cache_add.md deleted file mode 100644 index 47b0d56a4f4d..000000000000 --- a/docs/minikube_cache_add.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube cache add - -Add an image to local cache. - -### Synopsis - -Add an image to local cache. - -``` -minikube cache add [flags] -``` - -### Options - -``` - -h, --help help for add -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_cache_delete.md b/docs/minikube_cache_delete.md deleted file mode 100644 index feaaf3298140..000000000000 --- a/docs/minikube_cache_delete.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube cache delete - -Delete an image from the local cache. - -### Synopsis - -Delete an image from the local cache. - -``` -minikube cache delete [flags] -``` - -### Options - -``` - -h, --help help for delete -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_cache_list.md b/docs/minikube_cache_list.md deleted file mode 100644 index 4c23d2bc6334..000000000000 --- a/docs/minikube_cache_list.md +++ /dev/null @@ -1,39 +0,0 @@ -## minikube cache list - -List all available images from the local cache. - -### Synopsis - -List all available images from the local cache. - -``` -minikube cache list [flags] -``` - -### Options - -``` - --format string Go template format string for the cache list output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ - For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#CacheListTemplate (default "{{.CacheImage}}\n") - -h, --help help for list -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube cache](minikube_cache.md) - Add or delete an image from the local cache. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_completion.md b/docs/minikube_completion.md deleted file mode 100644 index 20ae5e85a1a0..000000000000 --- a/docs/minikube_completion.md +++ /dev/null @@ -1,56 +0,0 @@ -## minikube completion - -Outputs minikube shell completion for the given shell (bash or zsh) - -### Synopsis - - - Outputs minikube shell completion for the given shell (bash or zsh) - - This depends on the bash-completion binary. Example installation instructions: - OS X: - $ 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 - Ubuntu: - $ apt-get install bash-completion - $ source /etc/bash-completion - $ source <(minikube completion bash) # for bash users - $ source <(minikube completion zsh) # for zsh users - - Additionally, you may want to output the completion to a file and source in your .bashrc - - Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2 - - -``` -minikube completion SHELL [flags] -``` - -### Options - -``` - -h, --help help for completion -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config.md b/docs/minikube_config.md deleted file mode 100644 index 7c1f67fd71db..000000000000 --- a/docs/minikube_config.md +++ /dev/null @@ -1,88 +0,0 @@ -## minikube config - -Modify minikube config - -### Synopsis - -config modifies minikube config files using subcommands like "minikube config set vm-driver kvm" -Configurable fields: - - * vm-driver - * container-runtime - * feature-gates - * v - * cpus - * disk-size - * host-only-cidr - * memory - * log_dir - * kubernetes-version - * iso-url - * WantUpdateNotification - * ReminderWaitPeriodInHours - * WantReportError - * WantReportErrorPrompt - * WantKubectlDownloadMsg - * WantNoneDriverWarning - * profile - * bootstrapper - * ShowDriverDeprecationNotification - * ShowBootstrapperDeprecationNotification - * dashboard - * addon-manager - * default-storageclass - * heapster - * efk - * ingress - * insecure-registry - * registry - * registry-creds - * freshpod - * storage-provisioner - * storage-provisioner-gluster - * metrics-server - * nvidia-driver-installer - * nvidia-gpu-device-plugin - * logviewer - * gvisor - * helm-tiller - * ingress-dns - * hyperv-virtual-switch - * disable-driver-mounts - * cache - * embed-certs - * native-ssh - -``` -minikube config SUBCOMMAND [flags] -``` - -### Options - -``` - -h, --help help for config -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. -* [minikube config get](minikube_config_get.md) - Gets the value of PROPERTY_NAME from the minikube config file -* [minikube config set](minikube_config_set.md) - Sets an individual value in a minikube config file -* [minikube config unset](minikube_config_unset.md) - unsets an individual value in a minikube config file -* [minikube config view](minikube_config_view.md) - Display values currently set in the minikube config file - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config_get.md b/docs/minikube_config_get.md deleted file mode 100644 index b7107b87fb35..000000000000 --- a/docs/minikube_config_get.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube config get - -Gets the value of PROPERTY_NAME from the minikube config file - -### Synopsis - -Returns the value of PROPERTY_NAME from the minikube config file. Can be overwritten at runtime by flags or environmental variables. - -``` -minikube config get PROPERTY_NAME [flags] -``` - -### Options - -``` - -h, --help help for get -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube config](minikube_config.md) - Modify minikube config - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config_set.md b/docs/minikube_config_set.md deleted file mode 100644 index dbaaec498efe..000000000000 --- a/docs/minikube_config_set.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube config set - -Sets an individual value in a minikube config file - -### Synopsis - -Sets the PROPERTY_NAME config value to PROPERTY_VALUE - These values can be overwritten by flags or environment variables at runtime. - -``` -minikube config set PROPERTY_NAME PROPERTY_VALUE [flags] -``` - -### Options - -``` - -h, --help help for set -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube config](minikube_config.md) - Modify minikube config - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config_unset.md b/docs/minikube_config_unset.md deleted file mode 100644 index a07feef17338..000000000000 --- a/docs/minikube_config_unset.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube config unset - -unsets an individual value in a minikube config file - -### Synopsis - -unsets PROPERTY_NAME from the minikube config file. Can be overwritten by flags or environmental variables - -``` -minikube config unset PROPERTY_NAME [flags] -``` - -### Options - -``` - -h, --help help for unset -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube config](minikube_config.md) - Modify minikube config - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_config_view.md b/docs/minikube_config_view.md deleted file mode 100644 index 13e4fd86fd71..000000000000 --- a/docs/minikube_config_view.md +++ /dev/null @@ -1,39 +0,0 @@ -## minikube config view - -Display values currently set in the minikube config file - -### Synopsis - -Display values currently set in the minikube config file. - -``` -minikube config view [flags] -``` - -### Options - -``` - --format string Go template format string for the config view output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ - For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#ConfigViewTemplate (default "- {{.ConfigKey}}: {{.ConfigValue}}\n") - -h, --help help for view -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube config](minikube_config.md) - Modify minikube config - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_dashboard.md b/docs/minikube_dashboard.md deleted file mode 100644 index fe84c2584058..000000000000 --- a/docs/minikube_dashboard.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube dashboard - -Access the kubernetes dashboard running within the minikube cluster - -### Synopsis - -Access the kubernetes dashboard running within the minikube cluster - -``` -minikube dashboard [flags] -``` - -### Options - -``` - -h, --help help for dashboard - --url Display dashboard URL instead of opening a browser -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_delete.md b/docs/minikube_delete.md deleted file mode 100644 index 848affabad77..000000000000 --- a/docs/minikube_delete.md +++ /dev/null @@ -1,40 +0,0 @@ -## minikube delete - -Deletes a local kubernetes cluster - -### Synopsis - -Deletes a local kubernetes cluster. This command deletes the VM, and removes all -associated files. - -``` -minikube delete [flags] -``` - -### Options - -``` - --all Set flag to delete all profiles - -h, --help help for delete - --purge Set this flag to delete the '.minikube' folder from your user directory. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_docker-env.md b/docs/minikube_docker-env.md deleted file mode 100644 index 3872364df926..000000000000 --- a/docs/minikube_docker-env.md +++ /dev/null @@ -1,40 +0,0 @@ -## minikube docker-env - -Sets up docker env variables; similar to '$(docker-machine env)' - -### Synopsis - -Sets up docker env variables; similar to '$(docker-machine env)'. - -``` -minikube docker-env [flags] -``` - -### Options - -``` - -h, --help help for docker-env - --no-proxy Add machine IP to NO_PROXY environment variable - --shell string Force environment to be configured for a specified shell: [fish, cmd, powershell, tcsh, bash, zsh], default is auto-detect - -u, --unset Unset variables instead of setting them -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_ip.md b/docs/minikube_ip.md deleted file mode 100644 index cdb57ccd726d..000000000000 --- a/docs/minikube_ip.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube ip - -Retrieves the IP address of the running cluster - -### Synopsis - -Retrieves the IP address of the running cluster, and writes it to STDOUT. - -``` -minikube ip [flags] -``` - -### Options - -``` - -h, --help help for ip -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_kubectl.md b/docs/minikube_kubectl.md deleted file mode 100644 index 782535407414..000000000000 --- a/docs/minikube_kubectl.md +++ /dev/null @@ -1,40 +0,0 @@ -## minikube kubectl - -Run kubectl - -### Synopsis - -Run the kubernetes client, download it if necessary. -Examples: -minikube kubectl -- --help -kubectl get pods --namespace kube-system - -``` -minikube kubectl [flags] -``` - -### Options - -``` - -h, --help help for kubectl -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_logs.md b/docs/minikube_logs.md deleted file mode 100644 index dbfb686a91d9..000000000000 --- a/docs/minikube_logs.md +++ /dev/null @@ -1,40 +0,0 @@ -## minikube logs - -Gets the logs of the running instance, used for debugging minikube, not user code. - -### Synopsis - -Gets the logs of the running instance, used for debugging minikube, not user code. - -``` -minikube logs [flags] -``` - -### Options - -``` - -f, --follow Show only the most recent journal entries, and continuously print new entries as they are appended to the journal. - -h, --help help for logs - -n, --length int Number of lines back to go within the log (default 60) - --problems Show only log entries which point to known problems -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_mount.md b/docs/minikube_mount.md deleted file mode 100644 index f161a63f3bce..000000000000 --- a/docs/minikube_mount.md +++ /dev/null @@ -1,46 +0,0 @@ -## minikube mount - -Mounts the specified directory into minikube - -### Synopsis - -Mounts the specified directory into minikube. - -``` -minikube mount [flags] : -``` - -### Options - -``` - --9p-version string Specify the 9p version that the mount should use (default "9p2000.L") - --gid string Default group id used for the mount (default "docker") - -h, --help help for mount - --ip string Specify the ip that the mount should be setup on - --kill Kill the mount process spawned by minikube start - --mode uint File permissions used for the mount (default 493) - --msize int The number of bytes to use for 9p packet payload (default 262144) - --options strings Additional mount options, such as cache=fscache - --type string Specify the mount filesystem type (supported types: 9p) (default "9p") - --uid string Default user id used for the mount (default "docker") -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_profile.md b/docs/minikube_profile.md deleted file mode 100644 index 6999e0c94673..000000000000 --- a/docs/minikube_profile.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube profile - -Profile gets or sets the current minikube profile - -### Synopsis - -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` - -``` -minikube profile [MINIKUBE_PROFILE_NAME]. You can return to the default minikube profile by running `minikube profile default` [flags] -``` - -### Options - -``` - -h, --help help for profile -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. -* [minikube profile list](minikube_profile_list.md) - Lists all minikube profiles. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_profile_list.md b/docs/minikube_profile_list.md deleted file mode 100644 index 852c22bfae04..000000000000 --- a/docs/minikube_profile_list.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube profile list - -Lists all minikube profiles. - -### Synopsis - -Lists all valid minikube profiles and detects all possible invalid profiles. - -``` -minikube profile list [flags] -``` - -### Options - -``` - -h, --help help for list - -o, --output string The output format. One of 'json', 'table' (default "table") -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube profile](minikube_profile.md) - Profile gets or sets the current minikube profile - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_service.md b/docs/minikube_service.md deleted file mode 100644 index 63bf3b828fe6..000000000000 --- a/docs/minikube_service.md +++ /dev/null @@ -1,44 +0,0 @@ -## minikube service - -Gets the kubernetes URL(s) for the specified service in your local cluster - -### Synopsis - -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. - -``` -minikube service [flags] SERVICE -``` - -### Options - -``` - --format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") - -h, --help help for service - --https Open the service URL with https instead of http - --interval int The initial time interval for each check that wait performs in seconds (default 6) - -n, --namespace string The service namespace (default "default") - --url Display the kubernetes service URL in the CLI instead of opening it in the default browser - --wait int Amount of time to wait for a service in seconds (default 20) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. -* [minikube service list](minikube_service_list.md) - Lists the URLs for the services in your local cluster - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_service_list.md b/docs/minikube_service_list.md deleted file mode 100644 index 8389527911a8..000000000000 --- a/docs/minikube_service_list.md +++ /dev/null @@ -1,39 +0,0 @@ -## minikube service list - -Lists the URLs for the services in your local cluster - -### Synopsis - -Lists the URLs for the services in your local cluster - -``` -minikube service list [flags] -``` - -### Options - -``` - -h, --help help for list - -n, --namespace string The services namespace -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube service](minikube_service.md) - Gets the kubernetes URL(s) for the specified service in your local cluster - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_ssh-key.md b/docs/minikube_ssh-key.md deleted file mode 100644 index f746a9212573..000000000000 --- a/docs/minikube_ssh-key.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube ssh-key - -Retrieve the ssh identity key path of the specified cluster - -### Synopsis - -Retrieve the ssh identity key path of the specified cluster. - -``` -minikube ssh-key [flags] -``` - -### Options - -``` - -h, --help help for ssh-key -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_ssh.md b/docs/minikube_ssh.md deleted file mode 100644 index 255ea86e40ab..000000000000 --- a/docs/minikube_ssh.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube ssh - -Log into or run a command on a machine with SSH; similar to 'docker-machine ssh' - -### Synopsis - -Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'. - -``` -minikube ssh [flags] -``` - -### Options - -``` - -h, --help help for ssh - --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) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_start.md b/docs/minikube_start.md deleted file mode 100644 index f4fb80384a47..000000000000 --- a/docs/minikube_start.md +++ /dev/null @@ -1,92 +0,0 @@ -## minikube start - -Starts a local kubernetes cluster - -### Synopsis - -Starts a local kubernetes cluster - -``` -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 []) - --apiserver-name string The apiserver name which is used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine (default "minikubeCA") - --apiserver-names stringArray 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 - --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) - --cache-images If true, cache docker images for the current bootstrapper and load them into the machine. Always false with --vm-driver=none. (default true) - --container-runtime string The container runtime to be used (docker, crio, containerd). (default "docker") - --cpus int Number of CPUs allocated to the minikube VM. (default 2) - --cri-socket string The cri socket path to be used. - --disable-driver-mounts Disables the filesystem mounts provided by the hypervisors - --disk-size string Disk size allocated to the minikube VM (format: [], where unit = b, k, m or g). (default "20000mb") - --dns-domain string The cluster dns domain name used in the kubernetes cluster (default "cluster.local") - --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. - --embed-certs if true, will embed the certs in kubeconfig. - --enable-default-cni Enable the default CNI plugin (/etc/cni/net.d/k8s.conf). Used in conjunction with "--network-plugin=cni". - --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, 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 - -h, --help help for start - --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") - --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-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. - --interactive Allow user prompts for more information (default true) - --iso-url string Location of the minikube iso. (default "https://storage.googleapis.com/minikube/iso/minikube-v1.5.0.iso") - --keep-context This will keep the existing kubectl context and will create a minikube context. - --kubernetes-version string The kubernetes version that the minikube VM will use (ex: v1.2.3) (default "v1.16.2") - --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 allocated to the minikube VM (format: [], where unit = b, k, m or g). (default "2000mb") - --mount This will start the mount daemon and automatically mount files into minikube. - --mount-string string The argument to pass the minikube mount command on start. (default "/usr/local/google/home/priyawadhwa:/minikube-host") - --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) - --network-plugin string The name of the network plugin. - --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) - --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") - --uuid string Provide VM UUID to restore MAC address (hyperkit driver only) - --vm-driver string Driver is one of: [virtualbox parallels vmwarefusion kvm2 vmware none] (defaults to auto-detect) - --wait Wait until Kubernetes core services are healthy before exiting. - --wait-timeout duration max time to wait per Kubernetes core services to be healthy. (default 6m0s) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_status.md b/docs/minikube_status.md deleted file mode 100644 index 15ab74c5de49..000000000000 --- a/docs/minikube_status.md +++ /dev/null @@ -1,42 +0,0 @@ -## minikube status - -Gets the status of a local kubernetes cluster - -### Synopsis - -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. - Eg: 7 meaning: 1 (for minikube NOK) + 2 (for cluster NOK) + 4 (for kubernetes NOK) - -``` -minikube status [flags] -``` - -### Options - -``` - -f, --format string Go template format string for the status output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ - For the list accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#Status (default "host: {{.Host}}\nkubelet: {{.Kubelet}}\napiserver: {{.APIServer}}\nkubeconfig: {{.Kubeconfig}}\n") - -h, --help help for status - -o, --output string minikube status --output OUTPUT. json, text (default "text") -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_stop.md b/docs/minikube_stop.md deleted file mode 100644 index 8c27b52a4793..000000000000 --- a/docs/minikube_stop.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube stop - -Stops a running local kubernetes cluster - -### Synopsis - -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. - -``` -minikube stop [flags] -``` - -### Options - -``` - -h, --help help for stop -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_tunnel.md b/docs/minikube_tunnel.md deleted file mode 100644 index ae5a7f152982..000000000000 --- a/docs/minikube_tunnel.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube tunnel - -tunnel makes services of type LoadBalancer accessible on localhost - -### Synopsis - -tunnel creates a route to services deployed with type LoadBalancer and sets their Ingress to their ClusterIP - -``` -minikube tunnel [flags] -``` - -### Options - -``` - -c, --cleanup call with cleanup=true to remove old tunnels - -h, --help help for tunnel -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_update-check.md b/docs/minikube_update-check.md deleted file mode 100644 index 3447333b216f..000000000000 --- a/docs/minikube_update-check.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube update-check - -Print current and latest version number - -### Synopsis - -Print current and latest version number - -``` -minikube update-check [flags] -``` - -### Options - -``` - -h, --help help for update-check -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_update-context.md b/docs/minikube_update-context.md deleted file mode 100644 index 53865c83b37e..000000000000 --- a/docs/minikube_update-context.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube update-context - -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. - -``` -minikube update-context [flags] -``` - -### Options - -``` - -h, --help help for update-context -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 diff --git a/docs/minikube_version.md b/docs/minikube_version.md deleted file mode 100644 index 30ab0ca4b3f8..000000000000 --- a/docs/minikube_version.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube version - -Print the version of minikube - -### Synopsis - -Print the version of minikube. - -``` -minikube version [flags] -``` - -### Options - -``` - -h, --help help for version -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - -b, --bootstrapper string The name of the cluster bootstrapper that will set up the kubernetes cluster. (default "kubeadm") - --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 - --logtostderr log to standard error instead of files - -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") - --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 -``` - -### SEE ALSO - -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - -###### Auto generated by spf13/cobra on 28-Oct-2019 From bd5840aacf834cbca08d02c432ce3bc241e57525 Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Mon, 28 Oct 2019 18:01:16 -0700 Subject: [PATCH 10/10] improve comments --- cmd/minikube/cmd/generate-docs.go | 3 - pkg/minikube/bootstrapper/kubeadm/kubeadm.go | 9 +- .../en/docs/Reference/Commands/start.md | 125 ++++++++---------- 3 files changed, 59 insertions(+), 78 deletions(-) diff --git a/cmd/minikube/cmd/generate-docs.go b/cmd/minikube/cmd/generate-docs.go index a69d38b78a73..3bd6aba070fc 100644 --- a/cmd/minikube/cmd/generate-docs.go +++ b/cmd/minikube/cmd/generate-docs.go @@ -35,9 +35,6 @@ var generateDocs = &cobra.Command{ Example: "minikube generate-docs --path ", Hidden: true, Run: func(cmd *cobra.Command, args []string) { - if path == "" { - exit.UsageT("Please specify a directory to write docs to via the --path flag.") - } // if directory does not exist docsPath, err := os.Stat(path) diff --git a/pkg/minikube/bootstrapper/kubeadm/kubeadm.go b/pkg/minikube/bootstrapper/kubeadm/kubeadm.go index 727e42594cda..a81f9aa21abc 100644 --- a/pkg/minikube/bootstrapper/kubeadm/kubeadm.go +++ b/pkg/minikube/bootstrapper/kubeadm/kubeadm.go @@ -369,9 +369,7 @@ func (k *Bootstrapper) client(k8s config.KubernetesConfig) (*kubernetes.Clientse return kubernetes.NewForConfig(config) } -// WaitForPods blocks until Kubernetes appears to be healthy. -// if waitForPods is nil, then wait for everything. Otherwise, only -// wait for pods specified. +// WaitForPods blocks until pods specified in podsToWaitFor appear to be healthy. func (k *Bootstrapper) WaitForPods(k8s config.KubernetesConfig, timeout time.Duration, podsToWaitFor []string) error { // Do not wait for "k8s-app" pods in the case of CNI, as they are managed // by a CNI plugin which is usually started after minikube has been brought @@ -411,6 +409,11 @@ func (k *Bootstrapper) WaitForPods(k8s config.KubernetesConfig, timeout time.Dur return nil } +// shouldWaitForPod returns true if: +// 1. podsToWaitFor is nil +// 2. name is in podsToWaitFor +// 3. ALL_PODS is in podsToWaitFor +// else, return false func shouldWaitForPod(name string, podsToWaitFor []string) bool { if podsToWaitFor == nil { return true diff --git a/site/content/en/docs/Reference/Commands/start.md b/site/content/en/docs/Reference/Commands/start.md index 055e8f0567b5..6e1c1b13dfae 100644 --- a/site/content/en/docs/Reference/Commands/start.md +++ b/site/content/en/docs/Reference/Commands/start.md @@ -16,78 +16,59 @@ minikube start [flags] ### Options ``` - --addons=[]: Enable addons. see `minikube addons list` for a list of valid addon names. - --apiserver-ips=[]: 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 - --apiserver-name='minikubeCA': The apiserver name which is used in the generated certificate for kubernetes. This - can be used if you want to make the apiserver available from outside the machine - --apiserver-names=[]: 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 - --apiserver-port=8443: The apiserver listening port - --auto-update-drivers=true: If set, automatically updates drivers to the latest version. Defaults to true. - --cache-images=true: If true, cache docker images for the current bootstrapper and load them into the machine. - Always false with --vm-driver=none. - --container-runtime='docker': The container runtime to be used (docker, crio, containerd). - --cpus=2: Number of CPUs allocated to the minikube VM. - --cri-socket='': The cri socket path to be used. - --disable-driver-mounts=false: Disables the filesystem mounts provided by the hypervisors - --disk-size='20000mb': Disk size allocated to the minikube VM (format: [], where unit = b, k, m or - g). - --dns-domain='cluster.local': The cluster dns domain name used in the kubernetes cluster - --dns-proxy=false: Enable proxy for NAT DNS requests (virtualbox driver only) - --docker-env=[]: Environment variables to pass to the Docker daemon. (format: key=value) - --docker-opt=[]: Specify arbitrary flags to pass to the Docker daemon. (format: key=value) - --download-only=false: If true, only download and cache files for later use - don't install or start anything. - --embed-certs=false: if true, will embed the certs in kubeconfig. - --enable-default-cni=false: Enable the default CNI plugin (/etc/cni/net.d/k8s.conf). Used in conjunction with - "--network-plugin=cni". - --extra-config=: 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, pod-network-cidr - --feature-gates='': A set of key=value pairs that describe feature gates for alpha/experimental features. - --force=false: Force minikube to perform possibly dangerous operations - --host-dns-resolver=true: Enable host resolver for NAT DNS requests (virtualbox driver only) - --host-only-cidr='192.168.99.1/24': The CIDR to be used for the minikube VM (virtualbox driver only) - --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 VSock (hyperkit driver only) - --hyperkit-vsock-ports=[]: List of guest VSock ports that should be exposed as sockets on the host (hyperkit - driver only) - --hyperv-virtual-switch='': The hyperv virtual switch name. Defaults to first found. (hyperv driver only) - --image-mirror-country='': 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='': 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=[]: Insecure Docker registries to pass to the Docker daemon. The default service CIDR range - will automatically be added. - --interactive=true: Allow user prompts for more information - --iso-url='https://storage.googleapis.com/minikube/iso/minikube-v1.5.0.iso': Location of the minikube iso. - --keep-context=false: This will keep the existing kubectl context and will create a minikube context. - --kubernetes-version='v1.16.2': The kubernetes version that the minikube VM will use (ex: v1.2.3) - --kvm-gpu=false: Enable experimental NVIDIA GPU support in minikube - --kvm-hidden=false: Hide the hypervisor signature from the guest in minikube (kvm2 driver only) - --kvm-network='default': The KVM network name. (kvm2 driver only) - --kvm-qemu-uri='qemu:///system': The KVM QEMU connection URI. (kvm2 driver only) - --memory='2000mb': Amount of RAM allocated to the minikube VM (format: [], where unit = b, k, m or - g). - --mount=false: This will start the mount daemon and automatically mount files into minikube. - --mount-string='/Users:/minikube-host': The argument to pass the minikube mount command on start. - --native-ssh=true: 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'. - --network-plugin='': The name of the network plugin. - --nfs-share=[]: Local folders to share with Guest via NFS mounts (hyperkit driver only) - --nfs-shares-root='/nfsshares': Where to root the NFS Shares, defaults to /nfsshares (hyperkit driver only) - --no-vtx-check=false: Disable checking for the availability of hardware virtualization before the vm is started - (virtualbox driver only) - --registry-mirror=[]: Registry mirrors to pass to the Docker daemon - --service-cluster-ip-range='10.96.0.0/12': The CIDR to be used for service cluster IPs. - --uuid='': Provide VM UUID to restore MAC address (hyperkit driver only) - --vm-driver='': Driver is one of: [virtualbox parallels vmwarefusion hyperkit vmware] (defaults to auto-detect) - --wait=false: Wait until Kubernetes core services are healthy before exiting. - --wait-timeout=6m0s: max time to wait per Kubernetes core services to be healthy. +--addons 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 []) +--apiserver-name string The apiserver name which is used in the generated certificate for kubernetes. This can be used if you want to make the apiserver available from outside the machine (default "minikubeCA") +--apiserver-names stringArray 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 +--apiserver-port int The apiserver listening port (default 8443) +--cache-images If true, cache docker images for the current bootstrapper and load them into the machine. Always false with --vm-driver=none. (default true) +--container-runtime string The container runtime to be used (docker, crio, containerd). (default "docker") +--cpus int Number of CPUs allocated to the minikube VM. (default 2) +--cri-socket string The cri socket path to be used. +--disable-driver-mounts Disables the filesystem mounts provided by the hypervisors +--disk-size string Disk size allocated to the minikube VM (format: [], where unit = b, k, m or g). (default "20000mb") +--dns-domain string The cluster dns domain name used in the kubernetes cluster (default "cluster.local") +--dns-proxy Enable proxy for NAT DNS requests (virtualbox) +--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. +--embed-certs if true, will embed the certs in kubeconfig. +--enable-default-cni Enable the default CNI plugin (/etc/cni/net.d/k8s.conf). Used in conjunction with "--network-plugin=cni". +--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, 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 +-h, --help help for start +--host-dns-resolver Enable host resolver for NAT DNS requests (virtualbox) (default true) +--host-only-cidr string The CIDR to be used for the minikube VM (only supported with Virtualbox driver) (default "192.168.99.1/24") +--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-vsock-ports strings List of guest VSock ports that should be exposed as sockets on the host (Only supported on with hyperkit now). +--hyperv-virtual-switch string The hyperv virtual switch name. Defaults to first found. (only supported with HyperV driver) +--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. +--iso-url string Location of the minikube iso. (default "https://storage.googleapis.com/minikube/iso/minikube-v1.3.0.iso") +--keep-context This will keep the existing kubectl context and will create a minikube context. +--kubernetes-version string The kubernetes version that the minikube VM will use (ex: v1.2.3) (default "v1.15.2") +--kvm-gpu Enable experimental NVIDIA GPU support in minikube +--kvm-hidden Hide the hypervisor signature from the guest in minikube +--kvm-network string The KVM network name. (only supported with KVM driver) (default "default") +--kvm-qemu-uri string The KVM QEMU connection URI. (works only with kvm2 driver on linux) (default "qemu:///system") +--memory string Amount of RAM allocated to the minikube VM (format: [], where unit = b, k, m or g). (default "2000mb") +--mount This will start the mount daemon and automatically mount files into minikube. +--mount-string string The argument to pass the minikube mount command on start. (default "/Users:/minikube-host") +--network-plugin string The name of the network plugin. +--nfs-share strings Local folders to share with Guest via NFS mounts (Only supported on with hyperkit now) +--nfs-shares-root string Where to root the NFS Shares (defaults to /nfsshares, only supported with hyperkit now) (default "/nfsshares") +--no-vtx-check Disable checking for the availability of hardware virtualization before the vm is started (virtualbox) +--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") +--uuid string Provide VM UUID to restore MAC address (only supported with Hyperkit driver). +--vm-driver string VM driver is one of: [virtualbox parallels vmwarefusion hyperkit vmware] (default "virtualbox") +--wait Wait until Kubernetes core services are healthy before exiting. (default true) +--wait-timeout duration max time to wait per Kubernetes core services to be healthy. (default 3m0s) ``` ### Options inherited from parent commands