oc-proxy man page

oc proxy — Run a proxy to the Kubernetes API server

Synopsis

oc proxy [Options]

Description

Run a proxy to the API server

Options

--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.

--address="127.0.0.1"

The IP address on which to serve on.

--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/./pods/./exec,^/api/./pods/./attach"

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.

Options Inherited from Parent Commands

--api-version=""

DEPRECATED: The API version to use when talking to the server

--as=""

Username to impersonate for the operation

--certificate-authority=""

Path to a cert. file for the certificate authority

--client-certificate=""

Path to a client certificate file for TLS

--client-key=""

Path to a client key file for TLS

--cluster=""

The name of the kubeconfig cluster to use

--config=""

Path to the config file to use for CLI requests.

--context=""

The name of the kubeconfig context to use

--google-json-key=""

The Google Cloud Platform Service Account JSON Key to use for authentication.

--insecure-skip-tls-verify=false

If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--log-flush-frequency=0

Maximum number of seconds between log flushes

--match-server-version=false

Require server version to match client version

-n, --namespace=""

If present, the namespace scope for this CLI request

--request-timeout="0"

The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

--server=""

The address and port of the Kubernetes API server

--token=""

Bearer token for authentication to the API server

--user=""

The name of the kubeconfig user to use

Example

  # Run a proxy to the api server on port 8011, serving static content from ./local/www/
  oc proxy --port=8011 --www=./local/www/
  
  # Run a proxy to the api server on an arbitrary local port.
  # The chosen port for the server will be output to stdout.
  oc proxy --port=0
  
  # Run a proxy to the api server, changing the api prefix to my-api
  # This makes e.g. the pods api available at localhost:8011/my-api/api/v1/pods/
  oc proxy --api-prefix=/my-api

See Also

oc(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

oc(1).

Openshift CLI User Manuals June 2016