Documentation
¶
Overview ¶
Package client contains the implementation of the client side communication with the Kubernetes master. The Client class provides methods for reading, creating, updating, and deleting pods, replication controllers, services, and minions.
Most consumers should use the Config object to create a Client:
config := &client.Config{ Host: "http://localhost:8080", Username: "test", Password: "password", } client, err := client.New(&config) if err != nil { // handle error } client.Pods(ns).List()
More advanced consumers may wish to provide their own transport via a http.RoundTripper:
config := &client.Config{ Host: "https://localhost:8080", Transport: oauthclient.Transport(), } client, err := client.New(&config)
The RESTClient type implements the Kubernetes API conventions (see `docs/api-conventions.md`) for a given API path and is intended for use by consumers implementing their own Kubernetes compatible APIs.
Index ¶
- Constants
- func BindClientConfigFlags(flags FlagSet, config *Config)
- func BindKubeletClientConfigFlags(flags FlagSet, config *KubeletConfig)
- func ControllerHasDesiredReplicas(c Interface, controller *api.ReplicationController) wait.ConditionFunc
- func DefaultKubernetesUserAgent() string
- func DefaultServerURL(host, prefix, version string, defaultTLS bool) (*url.URL, error)
- func HTTPWrappersForConfig(config *Config, rt http.RoundTripper) (http.RoundTripper, error)
- func IsConfigTransportTLS(config Config) bool
- func IsTimeout(err error) bool
- func LoadTLSFiles(config *Config) error
- func MakeTransport(config *KubeletConfig) (http.RoundTripper, error)
- func MatchesServerVersion(c *Config) error
- func NegotiateVersion(c *Config, version string) (string, error)
- func NewBasicAuthRoundTripper(username, password string, rt http.RoundTripper) http.RoundTripper
- func NewBearerAuthRoundTripper(bearer string, rt http.RoundTripper) http.RoundTripper
- func NewClientCertTLSConfig(certData, keyData, caData []byte) (*tls.Config, error)
- func NewTLSConfig(caData []byte) (*tls.Config, error)
- func NewUnsafeTLSConfig() *tls.Config
- func NewUserAgentRoundTripper(agent string, rt http.RoundTripper) http.RoundTripper
- func SetKubernetesDefaults(config *Config) error
- func TLSConfigFor(config *Config) (*tls.Config, error)
- func TransportFor(config *Config) (http.RoundTripper, error)
- type APIStatus
- type Client
- func (c *Client) ComponentStatuses() ComponentStatusInterface
- func (c *Client) Endpoints(namespace string) EndpointsInterface
- func (c *Client) Events(namespace string) EventInterface
- func (c *Client) LimitRanges(namespace string) LimitRangeInterface
- func (c *Client) Namespaces() NamespaceInterface
- func (c *Client) Nodes() NodeInterface
- func (c *Client) PersistentVolumeClaims(namespace string) PersistentVolumeClaimInterface
- func (c *Client) PersistentVolumes() PersistentVolumeInterface
- func (c *Client) PodTemplates(namespace string) PodTemplateInterface
- func (c *Client) Pods(namespace string) PodInterface
- func (c *Client) ReplicationControllers(namespace string) ReplicationControllerInterface
- func (c *Client) ResourceQuotas(namespace string) ResourceQuotaInterface
- func (c *Client) Secrets(namespace string) SecretsInterface
- func (c *Client) ServerAPIVersions() (*api.APIVersions, error)
- func (c *Client) ServerVersion() (*version.Info, error)
- func (c *Client) ServiceAccounts(namespace string) ServiceAccountsInterface
- func (c *Client) Services(namespace string) ServiceInterface
- func (c *Client) ValidateComponents() (*api.ComponentStatusList, error)
- type ComponentStatusInterface
- type ComponentStatusesInterface
- type ComponentValidatorInterface
- type Config
- type ConnectionInfoGetter
- type ContainerInfoGetter
- type EndpointsInterface
- type EndpointsNamespacer
- type EventInterface
- type EventNamespacer
- type FakeKubeletClient
- type FakeRESTClient
- type FlagSet
- type HTTPClient
- type HTTPClientFunc
- type HTTPContainerInfoGetter
- func (self *HTTPContainerInfoGetter) GetContainerInfo(host, podID, containerID string, req *cadvisorApi.ContainerInfoRequest) (*cadvisorApi.ContainerInfo, error)
- func (self *HTTPContainerInfoGetter) GetMachineInfo(host string) (*cadvisorApi.MachineInfo, error)
- func (self *HTTPContainerInfoGetter) GetRootInfo(host string, req *cadvisorApi.ContainerInfoRequest) (*cadvisorApi.ContainerInfo, error)
- type HTTPKubeletClient
- type Interface
- type KubeletClient
- type KubeletConfig
- type KubeletHealthChecker
- type LimitRangeInterface
- type LimitRangesNamespacer
- type NamespaceInterface
- type NamespacesInterface
- type NodeInterface
- type NodesInterface
- type PersistentVolumeClaimInterface
- type PersistentVolumeClaimsNamespacer
- type PersistentVolumeInterface
- type PersistentVolumesInterface
- type PodInterface
- type PodTemplateInterface
- type PodTemplatesNamespacer
- type PodsNamespacer
- type RESTClient
- type ReplicationControllerInterface
- type ReplicationControllersNamespacer
- type Request
- func (r *Request) AbsPath(segments ...string) *Request
- func (r *Request) Body(obj interface{}) *Request
- func (r *Request) Do() Result
- func (r *Request) DoRaw() ([]byte, error)
- func (r *Request) FieldsSelectorParam(s fields.Selector) *Request
- func (r *Request) LabelsSelectorParam(s labels.Selector) *Request
- func (r *Request) Name(resourceName string) *Request
- func (r *Request) Namespace(namespace string) *Request
- func (r *Request) NamespaceIfScoped(namespace string, scoped bool) *Request
- func (r *Request) Param(paramName, s string) *Request
- func (r *Request) Prefix(segments ...string) *Request
- func (r *Request) RequestURI(uri string) *Request
- func (r *Request) Resource(resource string) *Request
- func (r *Request) SetHeader(key, value string) *Request
- func (r *Request) Stream() (io.ReadCloser, error)
- func (r *Request) SubResource(subresources ...string) *Request
- func (r *Request) Suffix(segments ...string) *Request
- func (r *Request) Timeout(d time.Duration) *Request
- func (r *Request) URL() *url.URL
- func (r *Request) UintParam(paramName string, u uint64) *Request
- func (r *Request) UnversionedPath(segments ...string) *Request
- func (r *Request) Upgrade(config *Config, ...) (httpstream.Connection, error)
- func (r *Request) Watch() (watch.Interface, error)
- type RequestConstructionError
- type ResourceQuotaInterface
- type ResourceQuotasNamespacer
- type Result
- type SecretsInterface
- type SecretsNamespacer
- type ServiceAccountsInterface
- type ServiceAccountsNamespacer
- type ServiceInterface
- type ServicesNamespacer
- type TLSClientConfig
- type VersionInterface
Constants ¶
const ( // A constant that clients can use to refer in a field selector to the object name field. // Will be automatically emitted as the correct name for the API version. NodeUnschedulable = "spec.unschedulable" ObjectNameField = "metadata.name" PodHost = "spec.host" SecretType = "type" )
Variables ¶
This section is empty.
Functions ¶
func BindClientConfigFlags ¶
BindClientConfigFlags registers a standard set of CLI flags for connecting to a Kubernetes API server. TODO this method is superceded by pkg/client/clientcmd/client_builder.go
func BindKubeletClientConfigFlags ¶ added in v0.5.1
func BindKubeletClientConfigFlags(flags FlagSet, config *KubeletConfig)
func ControllerHasDesiredReplicas ¶ added in v0.9.0
func ControllerHasDesiredReplicas(c Interface, controller *api.ReplicationController) wait.ConditionFunc
ControllerHasDesiredReplicas returns a condition that will be true iff the desired replica count for a controller's ReplicaSelector equals the Replicas count.
func DefaultKubernetesUserAgent ¶ added in v0.11.0
func DefaultKubernetesUserAgent() string
DefaultKubernetesUserAgent returns the default user agent that clients can use.
func DefaultServerURL ¶
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.
func HTTPWrappersForConfig ¶ added in v0.10.0
func HTTPWrappersForConfig(config *Config, rt http.RoundTripper) (http.RoundTripper, error)
HTTPWrappersForConfig wraps a round tripper with any relevant layered behavior from the config. Exposed to allow more clients that need HTTP-like behavior but then must hijack the underlying connection (like WebSocket or HTTP2 clients). Pure HTTP clients should use the higher level TransportFor or RESTClientFor methods.
func IsConfigTransportTLS ¶ added in v0.5.1
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(). Use to determine when to send credentials over the wire.
Note: the Insecure flag is ignored when testing for this value, so MITM attacks are still possible.
func IsTimeout ¶ added in v0.8.0
IsTimeout tests if this is a timeout error in the underlying transport. This is unbelievably ugly. See: http://stackoverflow.com/questions/23494950/specifically-check-for-timeout-error for details
func LoadTLSFiles ¶ added in v0.12.0
LoadTLSFiles copies the data from the CertFile, KeyFile, and CAFile fields into the CertData, KeyData, and CAFile fields, or returns an error. If no error is returned, all three fields are either populated or were empty to start.
func MakeTransport ¶ added in v0.19.0
func MakeTransport(config *KubeletConfig) (http.RoundTripper, error)
func MatchesServerVersion ¶ added in v0.9.0
MatchesServerVersion queries the server to compares the build version (git hash) of the client with the server's build version. It returns an error if it failed to contact the server or if the versions are not an exact match.
func NegotiateVersion ¶ added in v0.19.1
NegotiateVersion queries the server's supported api versions to find a version that both client and server support.
- If no version is provided, try the client's registered versions in order of preference.
- If version is provided, but not default config (explicitly requested via commandline flag), and is unsupported by the server, print a warning to stderr and try client's registered versions in order of preference.
- If version is config default, and the server does not support it, return an error.
func NewBasicAuthRoundTripper ¶
func NewBasicAuthRoundTripper(username, password string, rt http.RoundTripper) http.RoundTripper
func NewBearerAuthRoundTripper ¶
func NewBearerAuthRoundTripper(bearer string, rt http.RoundTripper) http.RoundTripper
func NewClientCertTLSConfig ¶ added in v0.10.0
func NewUnsafeTLSConfig ¶ added in v0.10.0
func NewUserAgentRoundTripper ¶ added in v0.11.0
func NewUserAgentRoundTripper(agent string, rt http.RoundTripper) http.RoundTripper
func SetKubernetesDefaults ¶ added in v0.9.0
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.
func TLSConfigFor ¶ added in v0.10.0
TLSConfigFor returns a tls.Config that will provide the transport level security defined by the provided Config. Will return nil if no transport level security is requested.
func TransportFor ¶
func TransportFor(config *Config) (http.RoundTripper, error)
TransportFor returns an http.RoundTripper that will provide the authentication or transport level security defined by the provided Config. Will return the default http.DefaultTransport if no special case behavior is needed.
Types ¶
type APIStatus ¶
APIStatus is exposed by errors that can be converted to an api.Status object for finer grained details.
type Client ¶
type Client struct {
*RESTClient
}
Client is the implementation of a Kubernetes client.
func New ¶
New creates a Kubernetes client for the given config. This client works with pods, replication controllers and services. It allows operations such as list, get, update and delete on these objects. An error is returned if the provided configuration is not valid.
func NewInCluster ¶ added in v0.19.0
NewInCluster is a shortcut for calling InClusterConfig() and then New().
func NewOrDie ¶
NewOrDie creates a Kubernetes client and panics if the provided API version is not recognized.
func (*Client) ComponentStatuses ¶ added in v0.16.1
func (c *Client) ComponentStatuses() ComponentStatusInterface
func (*Client) Endpoints ¶ added in v0.5.1
func (c *Client) Endpoints(namespace string) EndpointsInterface
func (*Client) Events ¶ added in v0.5.1
func (c *Client) Events(namespace string) EventInterface
func (*Client) LimitRanges ¶ added in v0.10.0
func (c *Client) LimitRanges(namespace string) LimitRangeInterface
func (*Client) Namespaces ¶ added in v0.11.0
func (c *Client) Namespaces() NamespaceInterface
func (*Client) Nodes ¶ added in v0.7.0
func (c *Client) Nodes() NodeInterface
func (*Client) PersistentVolumeClaims ¶ added in v0.15.0
func (c *Client) PersistentVolumeClaims(namespace string) PersistentVolumeClaimInterface
func (*Client) PersistentVolumes ¶ added in v0.15.0
func (c *Client) PersistentVolumes() PersistentVolumeInterface
func (*Client) PodTemplates ¶ added in v0.18.0
func (c *Client) PodTemplates(namespace string) PodTemplateInterface
func (*Client) Pods ¶ added in v0.5.1
func (c *Client) Pods(namespace string) PodInterface
func (*Client) ReplicationControllers ¶ added in v0.5.1
func (c *Client) ReplicationControllers(namespace string) ReplicationControllerInterface
func (*Client) ResourceQuotas ¶ added in v0.10.0
func (c *Client) ResourceQuotas(namespace string) ResourceQuotaInterface
func (*Client) Secrets ¶ added in v0.12.0
func (c *Client) Secrets(namespace string) SecretsInterface
func (*Client) ServerAPIVersions ¶ added in v0.5.1
func (c *Client) ServerAPIVersions() (*api.APIVersions, error)
ServerAPIVersions retrieves and parses the list of API versions the server supports.
func (*Client) ServerVersion ¶
ServerVersion retrieves and parses the server's version.
func (*Client) ServiceAccounts ¶ added in v0.18.0
func (c *Client) ServiceAccounts(namespace string) ServiceAccountsInterface
func (*Client) Services ¶ added in v0.5.1
func (c *Client) Services(namespace string) ServiceInterface
func (*Client) ValidateComponents ¶ added in v0.16.1
func (c *Client) ValidateComponents() (*api.ComponentStatusList, error)
ValidateComponents retrieves and parses the master's self-monitored cluster state. TODO: This should hit the versioned endpoint when that is implemented.
type ComponentStatusInterface ¶ added in v0.16.1
type ComponentStatusInterface interface { List(label labels.Selector, field fields.Selector) (*api.ComponentStatusList, error) Get(name string) (*api.ComponentStatus, error) }
ComponentStatusInterface contains methods to retrieve ComponentStatus
type ComponentStatusesInterface ¶ added in v0.16.1
type ComponentStatusesInterface interface {
ComponentStatuses() ComponentStatusInterface
}
type ComponentValidatorInterface ¶ added in v0.16.1
type ComponentValidatorInterface interface {
ValidateComponents() (*api.ComponentStatusList, error)
}
type Config ¶
type Config struct { // Host must be a host string, a host:port pair, or a URL to the base of the API. Host string // Prefix is the sub path of the server. If not specified, the client will set // a default value. Use "/" to indicate the server root should be used Prefix string // Version is the API version to talk to. Must be provided when initializing // a RESTClient directly. When initializing a Client, will be set with the default // code version. Version string // LegacyBehavior defines whether the RESTClient should follow conventions that // existed prior to v1beta3 in Kubernetes - namely, namespace (if specified) // not being part of the path, and resource names allowing mixed case. Set to // true when using Kubernetes v1beta1 or v1beta2. LegacyBehavior bool // Codec specifies the encoding and decoding behavior for runtime.Objects passed // to a RESTClient or Client. Required when initializing a RESTClient, optional // when initializing a Client. Codec runtime.Codec // Server requires Basic authentication Username string Password string // Server requires Bearer authentication. This client will not attempt to use // refresh tokens for an OAuth2 flow. // TODO: demonstrate an OAuth2 compatible client. BearerToken string // TLSClientConfig contains settings to enable transport layer security TLSClientConfig // Server should be accessed without verifying the TLS // certificate. For testing only. Insecure bool // UserAgent is an optional field that specifies the caller of this request. UserAgent string // Transport may be used for custom HTTP behavior. This attribute may not // be specified with the TLS client certificate options. Use WrapTransport // for most client level operations. Transport http.RoundTripper // WrapTransport will be invoked for custom HTTP behavior after the underlying // transport is initialized (either the transport created from TLSClientConfig, // Transport, or http.DefaultTransport). The config may layer other RoundTrippers // on top of the returned RoundTripper. WrapTransport func(rt http.RoundTripper) http.RoundTripper // QPS indicates the maximum QPS to the master from this client. If zero, QPS is unlimited. QPS float32 // Maximum burst for throttle Burst int }
Config holds the common attributes that can be passed to a Kubernetes client on initialization.
func InClusterConfig ¶ added in v0.19.0
InClusterConfig returns a config object which uses the service account kubernetes gives to pods. It's intended for clients that expect to be running inside a pod running on kuberenetes. It will return an error if called from a process not running in a kubernetes environment.
type ConnectionInfoGetter ¶ added in v0.14.0
type ContainerInfoGetter ¶
type ContainerInfoGetter interface { // GetContainerInfo returns information about a container. GetContainerInfo(host, podID, containerID string, req *cadvisorApi.ContainerInfoRequest) (*cadvisorApi.ContainerInfo, error) // GetRootInfo returns information about the root container on a machine. GetRootInfo(host string, req *cadvisorApi.ContainerInfoRequest) (*cadvisorApi.ContainerInfo, error) // GetMachineInfo returns the machine's information like number of cores, memory capacity. GetMachineInfo(host string) (*cadvisorApi.MachineInfo, error) }
type EndpointsInterface ¶
type EndpointsInterface interface { Create(endpoints *api.Endpoints) (*api.Endpoints, error) List(selector labels.Selector) (*api.EndpointsList, error) Get(name string) (*api.Endpoints, error) Delete(name string) error Update(endpoints *api.Endpoints) (*api.Endpoints, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
EndpointsInterface has methods to work with Endpoints resources
type EndpointsNamespacer ¶ added in v0.5.1
type EndpointsNamespacer interface {
Endpoints(namespace string) EndpointsInterface
}
EndpointsNamespacer has methods to work with Endpoints resources in a namespace
type EventInterface ¶ added in v0.5.1
type EventInterface interface { Create(event *api.Event) (*api.Event, error) Update(event *api.Event) (*api.Event, error) List(label labels.Selector, field fields.Selector) (*api.EventList, error) Get(name string) (*api.Event, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) // Search finds events about the specified object Search(objOrRef runtime.Object) (*api.EventList, error) Delete(name string) error // Returns the appropriate field selector based on the API version being used to communicate with the server. // The returned field selector can be used with List and Watch to filter desired events. GetFieldSelector(involvedObjectName, involvedObjectNamespace, involvedObjectKind, involvedObjectUID *string) fields.Selector }
EventInterface has methods to work with Event resources
type EventNamespacer ¶ added in v0.5.1
type EventNamespacer interface {
Events(namespace string) EventInterface
}
EventNamespacer can return an EventInterface for the given namespace.
type FakeKubeletClient ¶ added in v0.5.1
type FakeKubeletClient struct{}
FakeKubeletClient is a fake implementation of KubeletClient which returns an error when called. It is useful to pass to the master in a test configuration with no kubelets.
func (FakeKubeletClient) GetConnectionInfo ¶ added in v0.14.0
func (c FakeKubeletClient) GetConnectionInfo(host string) (string, uint, http.RoundTripper, error)
func (FakeKubeletClient) HealthCheck ¶ added in v0.5.1
type FakeRESTClient ¶ added in v0.6.0
type FakeRESTClient struct { Client HTTPClient Codec runtime.Codec Legacy bool Req *http.Request Resp *http.Response Err error }
FakeRESTClient provides a fake RESTClient interface.
func (*FakeRESTClient) Delete ¶ added in v0.6.0
func (c *FakeRESTClient) Delete() *Request
func (*FakeRESTClient) Get ¶ added in v0.6.0
func (c *FakeRESTClient) Get() *Request
func (*FakeRESTClient) Post ¶ added in v0.6.0
func (c *FakeRESTClient) Post() *Request
func (*FakeRESTClient) Put ¶ added in v0.6.0
func (c *FakeRESTClient) Put() *Request
type FlagSet ¶
type FlagSet interface { StringVar(p *string, name, value, usage string) BoolVar(p *bool, name string, value bool, usage string) UintVar(p *uint, name string, value uint, usage string) DurationVar(p *time.Duration, name string, value time.Duration, usage string) Float32Var(p *float32, name string, value float32, usage string) IntVar(p *int, name string, value int, usage string) }
FlagSet abstracts the flag interface for compatibility with both Golang "flag" and cobra pflags (Posix style).
type HTTPClient ¶ added in v0.5.1
HTTPClient is an interface for testing a request object.
type HTTPClientFunc ¶ added in v0.8.0
type HTTPContainerInfoGetter ¶
func (*HTTPContainerInfoGetter) GetContainerInfo ¶
func (self *HTTPContainerInfoGetter) GetContainerInfo(host, podID, containerID string, req *cadvisorApi.ContainerInfoRequest) (*cadvisorApi.ContainerInfo, error)
func (*HTTPContainerInfoGetter) GetMachineInfo ¶
func (self *HTTPContainerInfoGetter) GetMachineInfo(host string) (*cadvisorApi.MachineInfo, error)
func (*HTTPContainerInfoGetter) GetRootInfo ¶
func (self *HTTPContainerInfoGetter) GetRootInfo(host string, req *cadvisorApi.ContainerInfoRequest) (*cadvisorApi.ContainerInfo, error)
type HTTPKubeletClient ¶ added in v0.5.1
type HTTPKubeletClient struct { Client *http.Client Config *KubeletConfig Port uint EnableHttps bool }
HTTPKubeletClient is the default implementation of KubeletHealthchecker, accesses the kubelet over HTTP.
func (*HTTPKubeletClient) GetConnectionInfo ¶ added in v0.14.0
func (c *HTTPKubeletClient) GetConnectionInfo(host string) (string, uint, http.RoundTripper, error)
func (*HTTPKubeletClient) HealthCheck ¶ added in v0.5.1
type Interface ¶
type Interface interface { PodsNamespacer PodTemplatesNamespacer ReplicationControllersNamespacer ServicesNamespacer EndpointsNamespacer VersionInterface NodesInterface EventNamespacer LimitRangesNamespacer ResourceQuotasNamespacer ServiceAccountsNamespacer SecretsNamespacer NamespacesInterface PersistentVolumesInterface PersistentVolumeClaimsNamespacer ComponentStatusesInterface }
Interface holds the methods for clients of Kubernetes, an interface to allow mock testing.
type KubeletClient ¶ added in v0.5.1
type KubeletClient interface { KubeletHealthChecker ConnectionInfoGetter }
KubeletClient is an interface for all kubelet functionality
func NewKubeletClient ¶ added in v0.5.1
func NewKubeletClient(config *KubeletConfig) (KubeletClient, error)
TODO: this structure is questionable, it should be using client.Config and overriding defaults.
type KubeletConfig ¶ added in v0.5.1
type KubeletConfig struct { // ToDo: Add support for different kubelet instances exposing different ports Port uint EnableHttps bool // TLSClientConfig contains settings to enable transport layer security TLSClientConfig // HTTPTimeout is used by the client to timeout http requests to Kubelet. HTTPTimeout time.Duration // Dial is a custom dialer used for the client Dial func(net, addr string) (net.Conn, error) }
type KubeletHealthChecker ¶ added in v0.5.1
type KubeletHealthChecker interface {
HealthCheck(host string) (result probe.Result, output string, err error)
}
KubeletHealthchecker is an interface for healthchecking kubelets
type LimitRangeInterface ¶ added in v0.10.0
type LimitRangeInterface interface { List(selector labels.Selector) (*api.LimitRangeList, error) Get(name string) (*api.LimitRange, error) Delete(name string) error Create(limitRange *api.LimitRange) (*api.LimitRange, error) Update(limitRange *api.LimitRange) (*api.LimitRange, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
LimitRangeInterface has methods to work with LimitRange resources.
type LimitRangesNamespacer ¶ added in v0.10.0
type LimitRangesNamespacer interface {
LimitRanges(namespace string) LimitRangeInterface
}
LimitRangesNamespacer has methods to work with LimitRange resources in a namespace
type NamespaceInterface ¶ added in v0.11.0
type NamespaceInterface interface { Create(item *api.Namespace) (*api.Namespace, error) Get(name string) (result *api.Namespace, err error) List(label labels.Selector, field fields.Selector) (*api.NamespaceList, error) Delete(name string) error Update(item *api.Namespace) (*api.Namespace, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) Finalize(item *api.Namespace) (*api.Namespace, error) Status(item *api.Namespace) (*api.Namespace, error) }
type NamespacesInterface ¶ added in v0.11.0
type NamespacesInterface interface {
Namespaces() NamespaceInterface
}
type NodeInterface ¶ added in v0.7.0
type NodeInterface interface { Get(name string) (result *api.Node, err error) Create(node *api.Node) (*api.Node, error) List(label labels.Selector, field fields.Selector) (*api.NodeList, error) Delete(name string) error Update(*api.Node) (*api.Node, error) UpdateStatus(*api.Node) (*api.Node, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
type NodesInterface ¶ added in v0.7.0
type NodesInterface interface {
Nodes() NodeInterface
}
type PersistentVolumeClaimInterface ¶ added in v0.15.0
type PersistentVolumeClaimInterface interface { List(label labels.Selector, field fields.Selector) (*api.PersistentVolumeClaimList, error) Get(name string) (*api.PersistentVolumeClaim, error) Create(claim *api.PersistentVolumeClaim) (*api.PersistentVolumeClaim, error) Update(claim *api.PersistentVolumeClaim) (*api.PersistentVolumeClaim, error) UpdateStatus(claim *api.PersistentVolumeClaim) (*api.PersistentVolumeClaim, error) Delete(name string) error Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
PersistentVolumeClaimInterface has methods to work with PersistentVolumeClaim resources.
type PersistentVolumeClaimsNamespacer ¶ added in v0.15.0
type PersistentVolumeClaimsNamespacer interface {
PersistentVolumeClaims(namespace string) PersistentVolumeClaimInterface
}
PersistentVolumeClaimsNamespacer has methods to work with PersistentVolumeClaim resources in a namespace
type PersistentVolumeInterface ¶ added in v0.15.0
type PersistentVolumeInterface interface { List(label labels.Selector, field fields.Selector) (*api.PersistentVolumeList, error) Get(name string) (*api.PersistentVolume, error) Create(volume *api.PersistentVolume) (*api.PersistentVolume, error) Update(volume *api.PersistentVolume) (*api.PersistentVolume, error) UpdateStatus(persistentVolume *api.PersistentVolume) (*api.PersistentVolume, error) Delete(name string) error Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
PersistentVolumeInterface has methods to work with PersistentVolume resources.
type PersistentVolumesInterface ¶ added in v0.15.0
type PersistentVolumesInterface interface {
PersistentVolumes() PersistentVolumeInterface
}
type PodInterface ¶
type PodInterface interface { List(label labels.Selector, field fields.Selector) (*api.PodList, error) Get(name string) (*api.Pod, error) Delete(name string, options *api.DeleteOptions) error Create(pod *api.Pod) (*api.Pod, error) Update(pod *api.Pod) (*api.Pod, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) Bind(binding *api.Binding) error UpdateStatus(pod *api.Pod) (*api.Pod, error) }
PodInterface has methods to work with Pod resources.
type PodTemplateInterface ¶ added in v0.18.0
type PodTemplateInterface interface { List(label labels.Selector, field fields.Selector) (*api.PodTemplateList, error) Get(name string) (*api.PodTemplate, error) Delete(name string, options *api.DeleteOptions) error Create(podTemplate *api.PodTemplate) (*api.PodTemplate, error) Update(podTemplate *api.PodTemplate) (*api.PodTemplate, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
PodTemplateInterface has methods to work with PodTemplate resources.
type PodTemplatesNamespacer ¶ added in v0.18.0
type PodTemplatesNamespacer interface {
PodTemplates(namespace string) PodTemplateInterface
}
PodTemplatesNamespacer has methods to work with PodTemplate resources in a namespace
type PodsNamespacer ¶ added in v0.5.1
type PodsNamespacer interface {
Pods(namespace string) PodInterface
}
PodsNamespacer has methods to work with Pod resources in a namespace
type RESTClient ¶
type RESTClient struct { // LegacyBehavior controls if URLs should encode the namespace as a query param, // and if resource case is preserved for supporting older API conventions of // Kubernetes. Newer clients should leave this false. LegacyBehavior bool // Codec is the encoding and decoding scheme that applies to a particular set of // REST resources. Codec runtime.Codec // Set specific behavior of the client. If not set http.DefaultClient will be // used. Client HTTPClient Timeout time.Duration // TODO extract this into a wrapper interface via the RESTClient interface in kubectl. Throttle util.RateLimiter // contains filtered or unexported fields }
RESTClient imposes common Kubernetes API conventions on a set of resource paths. The baseURL is expected to point to an HTTP or HTTPS path that is the parent of one or more resources. The server should return a decodable API resource object, or an api.Status object which contains information about the reason for any failure.
Most consumers should use client.New() to get a Kubernetes API client.
func NewRESTClient ¶
func NewRESTClient(baseURL *url.URL, apiVersion string, c runtime.Codec, legacyBehavior bool, maxQPS float32, maxBurst int) *RESTClient
NewRESTClient creates a new RESTClient. This client performs generic REST functions such as Get, Put, Post, and Delete on specified paths. Codec controls encoding and decoding of responses from the server. If this client should use the older, legacy API conventions from Kubernetes API v1beta1 and v1beta2, set legacyBehavior true.
func RESTClientFor ¶
func RESTClientFor(config *Config) (*RESTClient, error)
RESTClientFor returns a RESTClient that satisfies the requested attributes on a client Config object. Note that a RESTClient may require fields that are optional when initializing a Client. A RESTClient created by this method is generic - it expects to operate on an API that follows the Kubernetes conventions, but may not be the Kubernetes API.
func (*RESTClient) APIVersion ¶ added in v0.9.0
func (c *RESTClient) APIVersion() string
APIVersion returns the APIVersion this RESTClient is expected to use.
func (*RESTClient) Delete ¶
func (c *RESTClient) Delete() *Request
Delete begins a DELETE request. Short for c.Verb("DELETE").
func (*RESTClient) Get ¶
func (c *RESTClient) Get() *Request
Get begins a GET request. Short for c.Verb("GET").
func (*RESTClient) Patch ¶ added in v0.13.0
func (c *RESTClient) Patch(pt api.PatchType) *Request
Patch begins a PATCH request. Short for c.Verb("Patch").
func (*RESTClient) Post ¶
func (c *RESTClient) Post() *Request
Post begins a POST request. Short for c.Verb("POST").
func (*RESTClient) Put ¶
func (c *RESTClient) Put() *Request
Put begins a PUT request. Short for c.Verb("PUT").
func (*RESTClient) Verb ¶
func (c *RESTClient) Verb(verb string) *Request
Verb begins a request with a verb (GET, POST, PUT, DELETE).
Example usage of RESTClient's request building interface: c := NewRESTClient(url, codec) resp, err := c.Verb("GET").
Path("pods"). SelectorParam("labels", "area=staging"). Timeout(10*time.Second). Do()
if err != nil { ... } list, ok := resp.(*api.PodList)
type ReplicationControllerInterface ¶
type ReplicationControllerInterface interface { List(selector labels.Selector) (*api.ReplicationControllerList, error) Get(name string) (*api.ReplicationController, error) Create(ctrl *api.ReplicationController) (*api.ReplicationController, error) Update(ctrl *api.ReplicationController) (*api.ReplicationController, error) Delete(name string) error Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
ReplicationControllerInterface has methods to work with ReplicationController resources.
type ReplicationControllersNamespacer ¶ added in v0.5.1
type ReplicationControllersNamespacer interface {
ReplicationControllers(namespace string) ReplicationControllerInterface
}
ReplicationControllersNamespacer has methods to work with ReplicationController resources in a namespace
type Request ¶
type Request struct {
// contains filtered or unexported fields
}
Request allows for building up a request to a server in a chained fashion. Any errors are stored until the end of your call, so you only have to check once.
func NewRequest ¶ added in v0.5.1
func NewRequest(client HTTPClient, verb string, baseURL *url.URL, apiVersion string, codec runtime.Codec, namespaceInQuery bool, preserveResourceCase bool) *Request
NewRequest creates a new request helper object for accessing runtime.Objects on a server.
func (*Request) AbsPath ¶
AbsPath overwrites an existing path with the segments provided. Trailing slashes are preserved when a single segment is passed.
func (*Request) Body ¶
Body makes the request use obj as the body. Optional. If obj is a string, try to read a file of that name. If obj is a []byte, send it directly. If obj is an io.Reader, use it directly. If obj is a runtime.Object, marshal it correctly. Otherwise, set an error.
func (*Request) Do ¶
Do formats and executes the request. Returns a Result object for easy response processing.
Error type:
- If the request can't be constructed, or an error happened earlier while building its arguments: *RequestConstructionError
- If the server responds with a status: *errors.StatusError or *errors.UnexpectedObjectError
- http.Client.Do errors are returned directly.
func (*Request) DoRaw ¶ added in v0.13.0
DoRaw executes the request but does not process the response body.
func (*Request) FieldsSelectorParam ¶ added in v0.14.0
FieldsSelectorParam adds the given selector as a query parameter with the name paramName.
func (*Request) LabelsSelectorParam ¶ added in v0.14.0
LabelsSelectorParam adds the given selector as a query parameter
func (*Request) Name ¶ added in v0.8.0
Name sets the name of a resource to access (<resource>/[ns/<namespace>/]<name>)
func (*Request) Namespace ¶ added in v0.5.1
Namespace applies the namespace scope to a request (<resource>/[ns/<namespace>/]<name>)
func (*Request) NamespaceIfScoped ¶ added in v0.11.0
NamespaceIfScoped is a convenience function to set a namespace if scoped is true
func (*Request) Prefix ¶ added in v0.8.0
Prefix adds segments to the relative beginning to the request path. These items will be placed before the optional Namespace, Resource, or Name sections. Setting AbsPath will clear any previously set Prefix segments
func (*Request) RequestURI ¶ added in v0.11.0
RequestURI overwrites existing path and parameters with the value of the provided server relative URI. Some parameters (those in specialParameters) cannot be overwritten.
func (*Request) Resource ¶ added in v0.8.0
Resource sets the resource to access (<resource>/[ns/<namespace>/]<name>)
func (*Request) Stream ¶
func (r *Request) Stream() (io.ReadCloser, error)
Stream formats and executes the request, and offers streaming of the response. Returns io.ReadCloser which could be used for streaming of the response, or an error Any non-2xx http status code causes an error. If we get a non-2xx code, we try to convert the body into an APIStatus object. If we can, we return that as an error. Otherwise, we create an error that lists the http status and the content of the response.
func (*Request) SubResource ¶ added in v0.13.0
SubResource sets a sub-resource path which can be multiple segments segment after the resource name but before the suffix.
func (*Request) Suffix ¶ added in v0.8.0
Suffix appends segments to the end of the path. These items will be placed after the prefix and optional Namespace, Resource, or Name sections.
func (*Request) Timeout ¶
Timeout makes the request use the given duration as a timeout. Sets the "timeout" parameter.
func (*Request) UnversionedPath ¶ added in v0.19.0
UnversionedPath strips the apiVersion from the baseURL before appending segments.
func (*Request) Upgrade ¶ added in v0.12.0
func (r *Request) Upgrade(config *Config, newRoundTripperFunc func(*tls.Config) httpstream.UpgradeRoundTripper) (httpstream.Connection, error)
Upgrade upgrades the request so that it supports multiplexed bidirectional streams. The current implementation uses SPDY, but this could be replaced with HTTP/2 once it's available, or something else.
type RequestConstructionError ¶ added in v0.6.0
type RequestConstructionError struct {
Err error
}
RequestConstructionError is returned when there's an error assembling a request.
func (*RequestConstructionError) Error ¶ added in v0.6.0
func (r *RequestConstructionError) Error() string
Error returns a textual description of 'r'.
type ResourceQuotaInterface ¶ added in v0.10.0
type ResourceQuotaInterface interface { List(selector labels.Selector) (*api.ResourceQuotaList, error) Get(name string) (*api.ResourceQuota, error) Delete(name string) error Create(resourceQuota *api.ResourceQuota) (*api.ResourceQuota, error) Update(resourceQuota *api.ResourceQuota) (*api.ResourceQuota, error) UpdateStatus(resourceQuota *api.ResourceQuota) (*api.ResourceQuota, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
ResourceQuotaInterface has methods to work with ResourceQuota resources.
type ResourceQuotasNamespacer ¶ added in v0.10.0
type ResourceQuotasNamespacer interface {
ResourceQuotas(namespace string) ResourceQuotaInterface
}
ResourceQuotasNamespacer has methods to work with ResourceQuota resources in a namespace
type Result ¶
type Result struct {
// contains filtered or unexported fields
}
Result contains the result of calling Request.Do().
func (Result) Error ¶
Error returns the error executing the request, nil if no error occurred. See the Request.Do() comment for what errors you might get.
func (Result) WasCreated ¶ added in v0.5.1
WasCreated updates the provided bool pointer to whether the server returned 201 created or a different response.
type SecretsInterface ¶ added in v0.12.0
type SecretsInterface interface { Create(secret *api.Secret) (*api.Secret, error) Update(secret *api.Secret) (*api.Secret, error) Delete(name string) error List(label labels.Selector, field fields.Selector) (*api.SecretList, error) Get(name string) (*api.Secret, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
type SecretsNamespacer ¶ added in v0.12.0
type SecretsNamespacer interface {
Secrets(namespace string) SecretsInterface
}
type ServiceAccountsInterface ¶ added in v0.18.0
type ServiceAccountsInterface interface { Create(serviceAccount *api.ServiceAccount) (*api.ServiceAccount, error) Update(serviceAccount *api.ServiceAccount) (*api.ServiceAccount, error) Delete(name string) error List(label labels.Selector, field fields.Selector) (*api.ServiceAccountList, error) Get(name string) (*api.ServiceAccount, error) Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
type ServiceAccountsNamespacer ¶ added in v0.18.0
type ServiceAccountsNamespacer interface {
ServiceAccounts(namespace string) ServiceAccountsInterface
}
type ServiceInterface ¶
type ServiceInterface interface { List(selector labels.Selector) (*api.ServiceList, error) Get(name string) (*api.Service, error) Create(srv *api.Service) (*api.Service, error) Update(srv *api.Service) (*api.Service, error) Delete(name string) error Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error) }
ServiceInterface has methods to work with Service resources.
type ServicesNamespacer ¶ added in v0.5.1
type ServicesNamespacer interface {
Services(namespace string) ServiceInterface
}
ServicesNamespacer has methods to work with Service resources in a namespace
type TLSClientConfig ¶ added in v0.10.0
type TLSClientConfig struct { // Server requires TLS client certificate authentication CertFile string // Server requires TLS client certificate authentication KeyFile string // Trusted root certificates for server CAFile string // CertData holds PEM-encoded bytes (typically read from a client certificate file). // CertData takes precedence over CertFile CertData []byte // KeyData holds PEM-encoded bytes (typically read from a client certificate key file). // KeyData takes precedence over KeyFile KeyData []byte // CAData holds PEM-encoded bytes (typically read from a root certificates bundle). // CAData takes precedence over CAFile CAData []byte }
TLSClientConfig contains settings to enable transport layer security
type VersionInterface ¶
type VersionInterface interface { ServerVersion() (*version.Info, error) ServerAPIVersions() (*api.APIVersions, error) }
VersionInterface has a method to retrieve the server version.
Source Files
¶
- client.go
- componentstatuses.go
- conditions.go
- containerinfo.go
- doc.go
- endpoints.go
- events.go
- fake.go
- flags.go
- helper.go
- kubelet.go
- limit_ranges.go
- namespaces.go
- nodes.go
- persistentvolumeclaim.go
- persistentvolumes.go
- pod_templates.go
- pods.go
- replication_controllers.go
- request.go
- resource_quotas.go
- restclient.go
- secrets.go
- service_accounts.go
- services.go
- transport.go
Directories
¶
Path | Synopsis |
---|---|
Package cache is a client-side caching mechanism.
|
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 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.
|
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. |
Package portforward adds support for SSH-like port forwarding from the client's local host to remote containers.
|
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 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.
|
Package remotecommand adds support for executing commands in containers, with support for separate stdin, stdout, and stderr streams, as well as TTY. |