KubectlProxySettings Class

Summary

Creates a proxy server or application-level gateway between localhost and the Kubectl API Server. It also allows serving static content over specified HTTP path. All incoming data enters through one port and gets forwarded to the remote kubernetes API Server port, except for the path matching the static content path.
Assembly
Cake.Kubectl.dll
Namespace
Cake.Kubectl
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlProxySettings"] class Type type-node

Syntax

public sealed class KubectlProxySettings : AutoToolSettings

Examples

# 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' # 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:8001/k8s-api/v1/pods/ kubectl proxy --api-prefix=/k8s-api

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Name Summary
KubectlProxySettings()

Properties

Name Value Summary
AcceptHosts string
--accept-hosts :1\]$': Regular expression for hosts that the proxy should accept.
AcceptPaths string
--accept-paths Regular expression for paths that the proxy should accept.
Address string
--address The IP address on which to serve on.
ApiPrefix string
--api-prefix Prefix to serve the proxied API under.
DisableFilter Nullable<bool>
--disable-filter 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.
Keepalive string
--keepalive keepalive specifies the keep-alive period for an active network connection. Set to 0 to disable keepalive.
Port Nullable<int>
-p, --port The port on which to run the proxy. Set to 0 to pick a random port.
RejectMethods string
--reject-methods Regular expression for HTTP methods that the proxy should reject (example --reject-methods='POST,PUT,PATCH').
RejectPaths string
--reject-paths Regular expression for paths that the proxy should reject. Paths specified here will be rejected even accepted by --accept-paths.
UnixSocket string
-u, --unix-socket Unix socket on which to run the proxy.
Www string
-w, --www Also serve static files from the given directory under the specified prefix.
WwwPrefix string
-P, --www-prefix Prefix to serve static files under, if static file directory is specified.

Extension Methods

Name Value Summary
Dump<KubectlProxySettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<KubectlProxySettings>(KubectlProxySettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<KubectlProxySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<KubectlProxySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<KubectlProxySettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<KubectlProxySettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin