kubernetes
/
minikube
mirror of https://github.com/kubernetes/minikube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
minikube/site/content/en/docs/commands/status.md

46 lines
2.0 KiB
Markdown
Raw Normal View History

Massage autogenerated output to Hugo form
2019-08-03 01:04:09 +00:00
---
title: "status"
description: >
Add unit test to check that docs are up to date This requires the following changes: 1. We need to pass in -ldflags to `go test`, since we need to know the curren iso version to correctly generate the description for --iso-url 2. We need to rewrite the description of the --driver flag on `minikube start` because it is operating system specific, which doesn't make sense for our documentation
2020-04-02 17:48:47 +00:00
Gets the status of a local kubernetes cluster
Massage autogenerated output to Hugo form
2019-08-03 01:04:09 +00:00
---
Move more docs
2019-08-02 23:35:54 +00:00
Add unit test to check that docs are up to date This requires the following changes: 1. We need to pass in -ldflags to `go test`, since we need to know the curren iso version to correctly generate the description for --iso-url 2. We need to rewrite the description of the --driver flag on `minikube start` because it is operating system specific, which doesn't make sense for our documentation
2020-04-02 17:48:47 +00:00
## minikube status
Move more docs
2019-08-02 23:35:54 +00:00
Add unit test to check that docs are up to date This requires the following changes: 1. We need to pass in -ldflags to `go test`, since we need to know the curren iso version to correctly generate the description for --iso-url 2. We need to rewrite the description of the --driver flag on `minikube start` because it is operating system specific, which doesn't make sense for our documentation
2020-04-02 17:48:47 +00:00
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)
Massage autogenerated output to Hugo form
2019-08-03 01:04:09 +00:00
Move more docs
2019-08-02 23:35:54 +00:00
```
minikube status [flags]
```
### Options
```
Add unit test to check that docs are up to date This requires the following changes: 1. We need to pass in -ldflags to `go test`, since we need to know the curren iso version to correctly generate the description for --iso-url 2. We need to rewrite the description of the --driver flag on `minikube start` because it is operating system specific, which doesn't make sense for our documentation
2020-04-02 17:48:47 +00:00
-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/
Add node type to each node in `minikube status`
2020-04-11 09:37:20 +00:00
For the list accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#Status (default "{{.Name}}\ntype: Control Plane\nhost: {{.Host}}\nkubelet: {{.Kubelet}}\napiserver: {{.APIServer}}\nkubeconfig: {{.Kubeconfig}}\n\n")
Move more docs
2019-08-02 23:35:54 +00:00
-h, --help help for status
Add initial Docker driver doc, updatte commands
2020-02-06 05:14:15 +00:00
-o, --output string minikube status --output OUTPUT. json, text (default "text")
Move more docs
2019-08-02 23:35:54 +00:00
```
### 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
```
Add unit test to check that docs are up to date This requires the following changes: 1. We need to pass in -ldflags to `go test`, since we need to know the curren iso version to correctly generate the description for --iso-url 2. We need to rewrite the description of the --driver flag on `minikube start` because it is operating system specific, which doesn't make sense for our documentation
2020-04-02 17:48:47 +00:00