From f061168ed3c85570fcfcb61a5fec3297eb9209ac Mon Sep 17 00:00:00 2001 From: Thomas Stromberg Date: Wed, 5 Feb 2020 22:31:55 -0800 Subject: [PATCH] improve pause/unpause docs --- site/content/en/docs/Reference/Commands/pause.md | 16 ++++++++++------ .../en/docs/Reference/Commands/unpause.md | 3 ++- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/site/content/en/docs/Reference/Commands/pause.md b/site/content/en/docs/Reference/Commands/pause.md index f6b3230f4b..c35ab6bfdd 100644 --- a/site/content/en/docs/Reference/Commands/pause.md +++ b/site/content/en/docs/Reference/Commands/pause.md @@ -4,29 +4,33 @@ linkTitle: "pause" weight: 1 date: 2020-02-05 description: > - Pause Kubernetes + pause the Kubernetes control plane or other namespaces --- +### Overview + +The pause command allows you to freeze containers using the Linux [cgroup freezer](https://www.kernel.org/doc/Documentation/cgroup-v1/freezer-subsystem.txt). Once frozen, processes will no longer consume CPU cycles, but will remain in memory. + +By default, the pause command will pause the Kubernetes control plane (kube-system namespace), leaving your applications running. This reduces the background CPU usage of a minikube cluster to a negligable 2-3% of a CPU. ### Usage ``` -minikube unpause [flags] +minikube pause [flags] ``` ### Options ``` - -n, ----namespaces strings namespaces to unpause (default [kube-system,kubernetes-dashboard,storage-gluster,istio-operator]) - -A, --all-namespaces If set, unpause all namespaces - -h, --help help for unpause + -n, ----namespaces strings namespaces to pause (default [kube-system,kubernetes-dashboard,storage-gluster,istio-operator]) + -A, --all-namespaces If set, pause all namespaces + -h, --help help for pause ``` ### 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 diff --git a/site/content/en/docs/Reference/Commands/unpause.md b/site/content/en/docs/Reference/Commands/unpause.md index f865350d88..1b71bce9df 100644 --- a/site/content/en/docs/Reference/Commands/unpause.md +++ b/site/content/en/docs/Reference/Commands/unpause.md @@ -4,7 +4,8 @@ linkTitle: "unpause" weight: 1 date: 2020-02-05 description: > - unpause Kubernetes + unpause the Kubernetes control plane or other namespaces + --- ### Usage