package
0.21.4
Repository: https://github.com/sanchezl/kubernetes.git
Documentation: pkg.go.dev

# Packages

Package cache is a client-side caching mechanism.
Package chaosclient makes it easy to simulate network latency, misbehaving servers, and random errors from servers.
Package clientcmd provides one stop shopping for building a working client from a fixed config, from a .kubeconfig file, from command line flags, or from any merged combination.
No description provided by the author
Package portforward adds support for SSH-like port forwarding from the client's local host to remote containers.
Package record has all client logic for recording and reporting events.
Package remotecommand adds support for executing commands in containers, with support for separate stdin, stdout, and stderr streams, as well as TTY.
No description provided by the author

# Functions

BindClientConfigFlags registers a standard set of CLI flags for connecting to a Kubernetes API server.
No description provided by the author
ControllerHasDesiredReplicas returns a condition that will be true iff the desired replica count for a controller's ReplicaSelector equals the Replicas count.
DefaultKubernetesUserAgent returns the default user agent that clients can use.
DefaultServerURL converts a host, host:port, or URL string to the default base server API path to use with a Client at a given API version following the standard conventions for a Kubernetes API.
HTTPWrappersForConfig wraps a round tripper with any relevant layered behavior from the config.
InClusterConfig returns a config object which uses the service account kubernetes gives to pods.
IsConfigTransportTLS returns true iff the provided config will result in a protected connection to the server when it is passed to client.New() or client.RESTClientFor().
IsTimeout tests if this is a timeout error in the underlying transport.
LoadTLSFiles copies the data from the CertFile, KeyFile, and CAFile fields into the CertData, KeyData, and CAFile fields, or returns an error.
No description provided by the author
MatchesServerVersion queries the server to compares the build version (git hash) of the client with the server's build version.
NegotiateVersion queries the server's supported api versions to find a version that both client and server support.
New creates a Kubernetes client for the given config.
NewBasicAuthRoundTripper will apply a BASIC auth authorization header to a request unless it has already been set.
NewBearerAuthRoundTripper adds the provided bearer token to a request unless the authorization header has already been set.
No description provided by the author
No description provided by the author
NewInCluster is a shortcut for calling InClusterConfig() and then New().
TODO: this structure is questionable, it should be using client.Config and overriding defaults.
NewOrDie creates a Kubernetes client and panics if the provided API version is not recognized.
NewRequest creates a new request helper object for accessing runtime.Objects on a server.
NewRequestInfo creates a new RequestInfo based on an http request.
NewRESTClient creates a new RESTClient.
No description provided by the author
No description provided by the author
No description provided by the author
RESTClientFor returns a RESTClient that satisfies the requested attributes on a client Config object.
SetKubernetesDefaults sets default values on the provided client config for accessing the Kubernetes API or returns an error if any of the defaults are impossible or invalid.
TLSConfigFor returns a tls.Config that will provide the transport level security defined by the provided Config.
TransportFor returns an http.RoundTripper that will provide the authentication or transport level security defined by the provided Config.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A constant that clients can use to refer in a field selector to the object name field.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Client is the implementation of a Kubernetes client.
Config holds the common attributes that can be passed to a Kubernetes client on initialization.
DebuggingRoundTripper will display information about the requests passing through it based on what is configured.
FakeKubeletClient is a fake implementation of KubeletClient which returns an error when called.
FakeRESTClient provides a fake RESTClient interface.
No description provided by the author
HTTPKubeletClient is the default implementation of KubeletHealthchecker, accesses the kubelet over HTTP.
No description provided by the author
Request allows for building up a request to a server in a chained fashion.
RequestConstructionError is returned when there's an error assembling a request.
RequestInfo keeps track of information about a request/response combination.
RESTClient imposes common Kubernetes API conventions on a set of resource paths.
Result contains the result of calling Request.Do().
TLSClientConfig contains settings to enable transport layer security.

# Interfaces

APIStatus is exposed by errors that can be converted to an api.Status object for finer grained details.
No description provided by the author
ComponentStatusInterface contains methods to retrieve ComponentStatus.
No description provided by the author
No description provided by the author
No description provided by the author
EndpointsInterface has methods to work with Endpoints resources.
EndpointsNamespacer has methods to work with Endpoints resources in a namespace.
EventInterface has methods to work with Event resources.
EventNamespacer can return an EventInterface for the given namespace.
FlagSet abstracts the flag interface for compatibility with both Golang "flag" and cobra pflags (Posix style).
HTTPClient is an interface for testing a request object.
Interface holds the methods for clients of Kubernetes, an interface to allow mock testing.
KubeletClient is an interface for all kubelet functionality.
KubeletHealthchecker is an interface for healthchecking kubelets.
LimitRangeInterface has methods to work with LimitRange resources.
LimitRangesNamespacer has methods to work with LimitRange resources in a namespace.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PersistentVolumeClaimInterface has methods to work with PersistentVolumeClaim resources.
PersistentVolumeClaimsNamespacer has methods to work with PersistentVolumeClaim resources in a namespace.
PersistentVolumeInterface has methods to work with PersistentVolume resources.
No description provided by the author
PodInterface has methods to work with Pod resources.
PodsNamespacer has methods to work with Pod resources in a namespace.
PodTemplateInterface has methods to work with PodTemplate resources.
PodTemplatesNamespacer has methods to work with PodTemplate resources in a namespace.
ReplicationControllerInterface has methods to work with ReplicationController resources.
ReplicationControllersNamespacer has methods to work with ReplicationController resources in a namespace.
ResourceQuotaInterface has methods to work with ResourceQuota resources.
ResourceQuotasNamespacer has methods to work with ResourceQuota resources in a namespace.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServiceInterface has methods to work with Service resources.
ServicesNamespacer has methods to work with Service resources in a namespace.
VersionInterface has a method to retrieve the server version.

# Type aliases

No description provided by the author