From d615bbb23387b309f05ca88641c3b9c550de53e0 Mon Sep 17 00:00:00 2001 From: Daniel Smith Date: Wed, 3 Jun 2015 18:34:37 -0700 Subject: [PATCH] gendocs --- docs/kubectl_proxy.md | 19 +++++++++++++++++-- docs/man/man1/kubectl-proxy.1 | 23 ++++++++++++++++++++++- 2 files changed, 39 insertions(+), 3 deletions(-) diff --git a/docs/kubectl_proxy.md b/docs/kubectl_proxy.md index ea38efe158a..192a6c5ecb4 100644 --- a/docs/kubectl_proxy.md +++ b/docs/kubectl_proxy.md @@ -5,7 +5,22 @@ Run a proxy to the Kubernetes API server ### Synopsis -Run a proxy to the Kubernetes API server. +To proxy all of the kubernetes api and nothing else, use: + +kubectl proxy --api-prefix=/ + +To proxy only part of the kubernetes api and also some static files: + +kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/ + +The above lets you 'curl localhost:8001/api/v1/pods'. + +To proxy the entire kubernetes api at a different root, use: + +kubectl proxy --api-prefix=/custom/ + +The above lets you 'curl localhost:8001/custom/api/v1/pods' + ``` kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix] @@ -64,6 +79,6 @@ $ kubectl proxy --api-prefix=/k8s-api ### SEE ALSO * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-05-28 20:57:46.689818993 +0000 UTC +###### Auto generated by spf13/cobra at 2015-06-04 01:34:05.594492715 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/kubectl_proxy.md?pixel)]() diff --git a/docs/man/man1/kubectl-proxy.1 b/docs/man/man1/kubectl-proxy.1 index 0875897c694..ba67f875ba9 100644 --- a/docs/man/man1/kubectl-proxy.1 +++ b/docs/man/man1/kubectl-proxy.1 @@ -13,7 +13,28 @@ kubectl proxy \- Run a proxy to the Kubernetes API server .SH DESCRIPTION .PP -Run a proxy to the Kubernetes API server. +To proxy all of the kubernetes api and nothing else, use: + +.PP +kubectl proxy \-\-api\-prefix=/ + +.PP +To proxy only part of the kubernetes api and also some static files: + +.PP +kubectl proxy \-\-www=/my/files \-\-www\-prefix=/static/ \-\-api\-prefix=/api/ + +.PP +The above lets you 'curl localhost:8001/api/v1/pods'. + +.PP +To proxy the entire kubernetes api at a different root, use: + +.PP +kubectl proxy \-\-api\-prefix=/custom/ + +.PP +The above lets you 'curl localhost:8001/custom/api/v1/pods' .SH OPTIONS