Initial checkin of v1.1 -- does not build

2016-02-10 16:55:31 -08:00
parent d1da8c3615
commit a0fb30a6fb
420 changed files with 49449 additions and 158 deletions
@@ -0,0 +1,120 @@
+---
+layout: docwithnav
+title: "kubectl proxy"
+---
+<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
+
+
+<!-- END MUNGE: UNVERSIONED_WARNING -->
+
+## kubectl proxy
+
+Run a proxy to the Kubernetes API server
+
+### Synopsis
+
+
+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'
+
+
+```
+{% raw %}
+kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]
+{% endraw %}
+```
+
+### Examples
+
+```
+{% raw %}
+# Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/
+$ kubectl proxy --port=8011 --www=./local/www/
+
+# Run a proxy to kubernetes apiserver on an arbitrary local port.
+# The chosen port for the server will be output to stdout.
+$ kubectl proxy --port=0
+
+# Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api
+# This makes e.g. the pods api available at localhost:8011/k8s-api/v1/pods/
+$ kubectl proxy --api-prefix=/k8s-api
+{% endraw %}
+```
+
+### Options
+
+```
+{% raw %}
+      --accept-hosts="^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$": Regular expression for hosts that the proxy should accept.
+      --accept-paths="^/.*": Regular expression for paths that the proxy should accept.
+      --api-prefix="/": Prefix to serve the proxied API under.
+      --disable-filter[=false]: If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port.
+  -p, --port=8001: The port on which to run the proxy. Set to 0 to pick a random port.
+      --reject-methods="POST,PUT,PATCH": Regular expression for HTTP methods that the proxy should reject.
+      --reject-paths="^/api/.*/exec,^/api/.*/run": Regular expression for paths that the proxy should reject.
+  -u, --unix-socket="": Unix socket on which to run the proxy.
+  -w, --www="": Also serve static files from the given directory under the specified prefix.
+  -P, --www-prefix="/static/": Prefix to serve static files under, if static file directory is specified.
+{% endraw %}
+```
+
+### Options inherited from parent commands
+
+```
+{% raw %}
+      --alsologtostderr[=false]: log to standard error as well as files
+      --api-version="": The API version to use when talking to the server
+      --certificate-authority="": Path to a cert. file for the certificate authority.
+      --client-certificate="": Path to a client key file for TLS.
+      --client-key="": Path to a client key file for TLS.
+      --cluster="": The name of the kubeconfig cluster to use
+      --context="": The name of the kubeconfig context to use
+      --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
+      --kubeconfig="": Path to the kubeconfig file to use for CLI requests.
+      --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
+      --log-dir="": If non-empty, write log files in this directory
+      --log-flush-frequency=5s: Maximum number of seconds between log flushes
+      --logtostderr[=true]: log to standard error instead of files
+      --match-server-version[=false]: Require server version to match client version
+      --namespace="": If present, the namespace scope for this CLI request.
+      --password="": Password for basic authentication to the API server.
+  -s, --server="": The address and port of the Kubernetes API server
+      --stderrthreshold=2: logs at or above this threshold go to stderr
+      --token="": Bearer token for authentication to the API server.
+      --user="": The name of the kubeconfig user to use
+      --username="": Username for basic authentication to the API server.
+      --v=0: log level for V logs
+      --vmodule=: comma-separated list of pattern=N settings for file-filtered logging
+{% endraw %}
+```
+
+### SEE ALSO
+
+* [kubectl](kubectl.html)	 - kubectl controls the Kubernetes cluster manager
+
+###### Auto generated by spf13/cobra at 2015-09-10 18:53:03.156927042 +0000 UTC
+
+
+
+<!-- BEGIN MUNGE: IS_VERSIONED -->
+<!-- TAG IS_VERSIONED -->
+<!-- END MUNGE: IS_VERSIONED -->
+
+
+<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_proxy.md?pixel)]()
+<!-- END MUNGE: GENERATED_ANALYTICS -->
+