 Directories
      ¶
      Directories
      ¶
    
    | Path | Synopsis | 
|---|---|
| Package api contains the latest (or "internal") version of the Kubernetes API objects. | Package api contains the latest (or "internal") version of the Kubernetes API objects. | 
| 
          
            errors
            
            
          
           Package errors provides detailed error types for api field validation. | Package errors provides detailed error types for api field validation. | 
| 
          
            errors/etcd
            
            
          
           Package etcd provides conversion of etcd errors to API errors. | Package etcd provides conversion of etcd errors to API errors. | 
| 
          
            latest
            
            
          
           Package latest defines the default output serializations that code should use and imports the required schemas. | Package latest defines the default output serializations that code should use and imports the required schemas. | 
| 
          
            meta
            
            
          
           Package meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API TODO: move everything in this file to pkg/api/rest | Package meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API TODO: move everything in this file to pkg/api/rest | 
| 
          
            registered
            
            
          
           Package to keep track of API Versions that should be registered in api.Scheme. | Package to keep track of API Versions that should be registered in api.Scheme. | 
| 
          
            rest
            
            
          
           Package rest defines common logic around changes to Kubernetes resources. | Package rest defines common logic around changes to Kubernetes resources. | 
| 
          
            testapi
            
            
          
           Package testapi provides a helper for retrieving the KUBE_API_VERSION environment variable. | Package testapi provides a helper for retrieving the KUBE_API_VERSION environment variable. | 
| 
          
            v1
            
            
          
           Package v1 is the v1 version of the API. | Package v1 is the v1 version of the API. | 
| 
          
            v1beta3
            
            
          
           Package v1beta3 is the v1beta3 version of the API. | Package v1beta3 is the v1beta3 version of the API. | 
| 
          
            validation
            
            
          
           Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid. | Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid. | 
| Package apiserver contains the code that provides a rest.ful api service. | Package apiserver contains the code that provides a rest.ful api service. | 
| auth
       | |
| 
          
            user
            
            
          
           Package user contains utilities for dealing with simple user exchange in the auth packages. | Package user contains utilities for dealing with simple user exchange in the auth packages. | 
| package capbabilities manages system level capabilities | package capbabilities manages system level capabilities | 
| Package client contains the implementation of the client side communication with the Kubernetes master. | Package client contains the implementation of the client side communication with the Kubernetes master. | 
| 
          
            cache
            
            
          
           Package cache is a client-side caching mechanism. | Package cache is a client-side caching mechanism. | 
| 
          
            chaosclient
            
            
          
           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. | 
| 
          
            clientcmd
            
            
          
           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. | 
| 
          
            portforward
            
            
          
           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. | 
| 
          
            record
            
            
          
           Package record has all client logic for recording and reporting events. | Package record has all client logic for recording and reporting events. | 
| 
          
            remotecommand
            
            
          
           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. | 
| Package authcfg defines a file format for holding authentication information needed by clients of Kubernetes. | Package authcfg defines a file format for holding authentication information needed by clients of Kubernetes. | 
| Package cloudprovider supplies interfaces and implementations for cloud service providers. | Package cloudprovider supplies interfaces and implementations for cloud service providers. | 
| 
          
            fake
            
            
          
           Package fake_cloud is a test-double implementation of cloudprovider Interface, TCPLoadBalancer and Instances. | Package fake_cloud is a test-double implementation of cloudprovider Interface, TCPLoadBalancer and Instances. | 
| 
          
            gce
            
            
          
           Package gce_cloud is an implementation of Interface, TCPLoadBalancer and Instances for Google Compute Engine. | Package gce_cloud is an implementation of Interface, TCPLoadBalancer and Instances for Google Compute Engine. | 
| 
          
            nodecontroller
            
            
          
           Package nodecontroller contains code for syncing cloud instances with minion registry | Package nodecontroller contains code for syncing cloud instances with minion registry | 
| 
          
            routecontroller
            
            
          
           Package routecontroller contains code for syncing cloud routing rules with the list of registered nodes. | Package routecontroller contains code for syncing cloud routing rules with the list of registered nodes. | 
| 
          
            servicecontroller
            
            
          
           Package servicecontroller contains code for syncing cloud load balancers with the service registry. | Package servicecontroller contains code for syncing cloud load balancers with the service registry. | 
| 
          
            vagrant
            
            
          
           Package vagrant_cloud is an implementation of Interface, TCPLoadBalancer and Instances for developer managed Vagrant cluster. | Package vagrant_cloud is an implementation of Interface, TCPLoadBalancer and Instances for developer managed Vagrant cluster. | 
| Package controller contains logic for watching and synchronizing replicationControllers. | Package controller contains logic for watching and synchronizing replicationControllers. | 
| 
          
            framework
            
            
          
           Package framework implements all the grunt work involved in running a simple controller. | Package framework implements all the grunt work involved in running a simple controller. | 
| Package conversion provides go object versioning and encoding/decoding mechanisms. | Package conversion provides go object versioning and encoding/decoding mechanisms. | 
| 
          
            queryparams
            
            
          
           Package queryparams provides conversion from versioned runtime objects to URL query values | Package queryparams provides conversion from versioned runtime objects to URL query values | 
| Package credentialprovider supplies interfaces and implementations for docker registry providers to expose their authentication scheme. | Package credentialprovider supplies interfaces and implementations for docker registry providers to expose their authentication scheme. | 
| 
          
            gcp
            
            
          
           Package gcp_credentials contains implementations of DockerConfigProvider for Google Cloud Platform. | Package gcp_credentials contains implementations of DockerConfigProvider for Google Cloud Platform. | 
| Package fieldpath supplies methods for extracting fields from objects given a path to a field. | Package fieldpath supplies methods for extracting fields from objects given a path to a field. | 
| Package fields implements a simple field system, parsing and matching selectors with sets of fields. | Package fields implements a simple field system, parsing and matching selectors with sets of fields. | 
| Package healthz implements basic http server health checking. | Package healthz implements basic http server health checking. | 
| Package httplog contains a helper object and functions to maintain a log along with an http response. | Package httplog contains a helper object and functions to maintain a log along with an http response. | 
| Package hyperkube is a framework for kubernetes server components. | Package hyperkube is a framework for kubernetes server components. | 
| Package kubectl is a set of libraries that are used by the kubectl command line tool. | Package kubectl is a set of libraries that are used by the kubectl command line tool. | 
| 
          
            resource
            
            
          
           Package resource assists clients in dealing with RESTful objects that match the Kubernetes API conventions. | Package resource assists clients in dealing with RESTful objects that match the Kubernetes API conventions. | 
| Package kubelet is the package that contains the libraries that drive the Kubelet binary. | Package kubelet is the package that contains the libraries that drive the Kubelet binary. | 
| 
          
            cadvisor
            
            
          
           Kubelet interactions with cAdvisor. | Kubelet interactions with cAdvisor. | 
| 
          
            config
            
            
          
           Reads the pod configuration from the Kubernetes apiserver. | Reads the pod configuration from the Kubernetes apiserver. | 
| 
          
            envvars
            
            
          
           Package envvars is the package that build the environment variables that kubernetes provides to the containers run by it. | Package envvars is the package that build the environment variables that kubernetes provides to the containers run by it. | 
| 
          
            leaky
            
            
          
           Package leaky holds bits of kubelet that should be internal but have leaked out through bad abstractions. | Package leaky holds bits of kubelet that should be internal but have leaked out through bad abstractions. | 
| 
          
            lifecycle
            
            
          
           Handlers for pod lifecycle events. | Handlers for pod lifecycle events. | 
| 
          
            network/exec
            
            
          
           Package exec scans and loads networking plugins that are installed under /usr/libexec/kubernetes/kubelet-plugins/net/exec/ The layout convention for a plugin is: plugin-name/ (plugins have to be directories first) plugin-name/plugin-name (executable that will be called out, see Vendoring Note for more nuances) plugin-name/<other-files> where, 'executable' has the following requirements: - should have exec permissions - should give non-zero exit code on failure, and zero on sucess - the arguments will be <action> <pod_namespace> <pod_name> <docker_id_of_infra_container> whereupon, <action> will be one of: - init, called when the kubelet loads the plugin - setup, called after the infra container of a pod is created, but before other containers of the pod are created - teardown, called before the pod infra container is killed As the executables are called, the file-descriptors stdin, stdout, stderr remain open. | Package exec scans and loads networking plugins that are installed under /usr/libexec/kubernetes/kubelet-plugins/net/exec/ The layout convention for a plugin is: plugin-name/ (plugins have to be directories first) plugin-name/plugin-name (executable that will be called out, see Vendoring Note for more nuances) plugin-name/<other-files> where, 'executable' has the following requirements: - should have exec permissions - should give non-zero exit code on failure, and zero on sucess - the arguments will be <action> <pod_namespace> <pod_name> <docker_id_of_infra_container> whereupon, <action> will be one of: - init, called when the kubelet loads the plugin - setup, called after the infra container of a pod is created, but before other containers of the pod are created - teardown, called before the pod infra container is killed As the executables are called, the file-descriptors stdin, stdout, stderr remain open. | 
| 
          
            types
            
            
          
           Common types in the Kubelet. | Common types in the Kubelet. | 
| Package labels implements a simple label system, parsing and matching selectors with sets of labels. | Package labels implements a simple label system, parsing and matching selectors with sets of labels. | 
| Package master contains code for setting up and running a Kubernetes cluster master. | Package master contains code for setting up and running a Kubernetes cluster master. | 
| 
          
            ports
            
            
          
           Package ports defines ports used by various pieces of the kubernetes infrastructure. | Package ports defines ports used by various pieces of the kubernetes infrastructure. | 
| namespace contains a controller that handles namespace lifecycle | namespace contains a controller that handles namespace lifecycle | 
| Package probe contains utilities for health probing, as well as health status information. | Package probe contains utilities for health probing, as well as health status information. | 
| Package proxy implements the layer-3 network proxy. | Package proxy implements the layer-3 network proxy. | 
| 
          
            config
            
            
          
           Package config provides decoupling between various configuration sources (etcd, files,...) and the pieces that actually care about them (loadbalancer, proxy). | Package config provides decoupling between various configuration sources (etcd, files,...) and the pieces that actually care about them (loadbalancer, proxy). | 
| Package registry implements the storage and system logic for the core of the api server. | Package registry implements the storage and system logic for the core of the api server. | 
| 
          
            componentstatus
            
            
          
           Package componentstatus provides interfaces and implementation for retrieving cluster component status. | Package componentstatus provides interfaces and implementation for retrieving cluster component status. | 
| 
          
            controller
            
            
          
           Package controller provides Registry interface and it's RESTStorage implementation for storing ReplicationController api objects. | Package controller provides Registry interface and it's RESTStorage implementation for storing ReplicationController api objects. | 
| 
          
            endpoint
            
            
          
           Package endpoint provides Registry interface and it's RESTStorage implementation for storing Endpoint api objects. | Package endpoint provides Registry interface and it's RESTStorage implementation for storing Endpoint api objects. | 
| 
          
            etcd
            
            
          
           Package etcd provides etcd backend implementation for storing PodRegistry, ControllerRegistry and ServiceRegistry api objects. | Package etcd provides etcd backend implementation for storing PodRegistry, ControllerRegistry and ServiceRegistry api objects. | 
| 
          
            event
            
            
          
           Package event provides Registry interface and it's REST implementation for storing Event api objects. | Package event provides Registry interface and it's REST implementation for storing Event api objects. | 
| 
          
            generic
            
            
          
           Package generic provides a generic object store interface and a generic label/field matching type. | Package generic provides a generic object store interface and a generic label/field matching type. | 
| 
          
            generic/etcd
            
            
          
           Package etcd has a generic implementation of a registry that stores things in etcd. | Package etcd has a generic implementation of a registry that stores things in etcd. | 
| 
          
            generic/rest
            
            
          
           Package rest has generic implementations of resources used for REST responses | Package rest has generic implementations of resources used for REST responses | 
| 
          
            limitrange
            
            
          
           Package limitrange provides Registry interface and it's REST implementation for storing LimitRange api objects. | Package limitrange provides Registry interface and it's REST implementation for storing LimitRange api objects. | 
| 
          
            minion
            
            
          
           Package minion provides Registry interface and implementation for storing Minions. | Package minion provides Registry interface and implementation for storing Minions. | 
| 
          
            namespace
            
            
          
           Package namespace provides Registry interface and it's REST implementation for storing Namespace api objects. | Package namespace provides Registry interface and it's REST implementation for storing Namespace api objects. | 
| 
          
            pod
            
            
          
           Package pod provides Registry interface and it's RESTStorage implementation for storing Pod api objects. | Package pod provides Registry interface and it's RESTStorage implementation for storing Pod api objects. | 
| 
          
            podtemplate
            
            
          
           Package podtemplate provides RESTStorage implementations for storing PodTemplate API objects. | Package podtemplate provides RESTStorage implementations for storing PodTemplate API objects. | 
| 
          
            registrytest
            
            
          
           Package registrytest provides tests for Registry implementations for storing Minions, Pods, Schedulers and Services. | Package registrytest provides tests for Registry implementations for storing Minions, Pods, Schedulers and Services. | 
| 
          
            resourcequota
            
            
          
           Package resourcequota provides Registry interface and it's REST implementation for storing ResourceQuota api objects. | Package resourcequota provides Registry interface and it's REST implementation for storing ResourceQuota api objects. | 
| 
          
            secret
            
            
          
           Package secrets provides Registry interface and its REST implementation for storing Secret api objects. | Package secrets provides Registry interface and its REST implementation for storing Secret api objects. | 
| 
          
            service
            
            
          
           Package service provides the Registry interface and its RESTStorage implementation for storing Service api objects. | Package service provides the Registry interface and its RESTStorage implementation for storing Service api objects. | 
| 
          
            serviceaccount
            
            
          
           Package serviceaccount provides a Registry interface and a strategy implementation for storing ServiceAccount API objects. | Package serviceaccount provides a Registry interface and a strategy implementation for storing ServiceAccount API objects. | 
| resourcequota contains a controller that makes resource quota usage observations | resourcequota contains a controller that makes resource quota usage observations | 
| Defines conversions between generic types and structs to map query strings to struct objects. | Defines conversions between generic types and structs to map query strings to struct objects. | 
| Package securitycontext contains security context api implementations | Package securitycontext contains security context api implementations | 
| Package service provides EndpointController implementation to manage and sync service endpoints. | Package service provides EndpointController implementation to manage and sync service endpoints. | 
| Package serviceaccount provides implementations to manage service accounts and service account tokens | Package serviceaccount provides implementations to manage service accounts and service account tokens | 
| Package tools implements types which help work with etcd which depend on the api package. | Package tools implements types which help work with etcd which depend on the api package. | 
| Package types implements various generic types used throughout kubernetes. | Package types implements various generic types used throughout kubernetes. | 
| package ui contains static data files compiled to go, and utilities for accessing them. | package ui contains static data files compiled to go, and utilities for accessing them. | 
| Package util implements various utility functions used in both testing and implementation of Kubernetes. | Package util implements various utility functions used in both testing and implementation of Kubernetes. | 
| 
          
            config
            
            
          
           Package config provides utility objects for decoupling sources of configuration and the actual configuration state. | Package config provides utility objects for decoupling sources of configuration and the actual configuration state. | 
| 
          
            errors
            
            
          
           Package errors implements various utility functions and types around errors. | Package errors implements various utility functions and types around errors. | 
| 
          
            exec
            
            
          
           Package exec provides an injectable interface and implementations for running commands. | Package exec provides an injectable interface and implementations for running commands. | 
| 
          
            flushwriter
            
            
          
           Package flushwriter implements a wrapper for a writer that flushes on every write if that writer implements the io.Flusher interface | Package flushwriter implements a wrapper for a writer that flushes on every write if that writer implements the io.Flusher interface | 
| 
          
            httpstream
            
            
          
           Package httpstream adds multiplexed streaming support to HTTP requests and responses via connection upgrades. | Package httpstream adds multiplexed streaming support to HTTP requests and responses via connection upgrades. | 
| 
          
            iptables
            
            
          
           Package iptables provides an interface and implementations for running iptables commands. | Package iptables provides an interface and implementations for running iptables commands. | 
| 
          
            mount
            
            
          
           Package mount defines an interface to mounting filesystems. | Package mount defines an interface to mounting filesystems. | 
| 
          
            proxy
            
            
          
           Package proxy provides transport and upgrade support for proxies | Package proxy provides transport and upgrade support for proxies | 
| 
          
            slice
            
            
          
           Package slice provides utility methods for common operations on slices. | Package slice provides utility methods for common operations on slices. | 
| 
          
            wait
            
            
          
           Package wait provides tools for polling or listening for changes to a condition. | Package wait provides tools for polling or listening for changes to a condition. | 
| 
          
            workqueue
            
            
          
           Package workqueue provides a simple queue that supports the following features: * Fair: items processed in the order in which they are added. | Package workqueue provides a simple queue that supports the following features: * Fair: items processed in the order in which they are added. | 
| Package version supplies version information collected at build time to kubernetes components. | Package version supplies version information collected at build time to kubernetes components. | 
| 
          
            verflag
            
            
          
           Package verflag defines utility functions to handle command line flags related to version of Kubernetes. | Package verflag defines utility functions to handle command line flags related to version of Kubernetes. | 
| Package volume includes internal representations of external volume types as well as utility methods required to mount/unmount volumes to kubelets. | Package volume includes internal representations of external volume types as well as utility methods required to mount/unmount volumes to kubelets. | 
| 
          
            aws_ebs
            
            
          
           Package aws_ebs contains the internal representation of AWS Elastic Block Store volumes. | Package aws_ebs contains the internal representation of AWS Elastic Block Store volumes. | 
| 
          
            empty_dir
            
            
          
           Package empty_dir contains the internal representation of emptyDir volumes. | Package empty_dir contains the internal representation of emptyDir volumes. | 
| 
          
            gce_pd
            
            
          
           Package gce_pd contains the internal representation of GCE PersistentDisk volumes. | Package gce_pd contains the internal representation of GCE PersistentDisk volumes. | 
| 
          
            git_repo
            
            
          
           Package git_repo contains the internal representation of git repo volumes. | Package git_repo contains the internal representation of git repo volumes. | 
| 
          
            glusterfs
            
            
          
           Package glusterfs contains the internal representation of glusterfs volumes. | Package glusterfs contains the internal representation of glusterfs volumes. | 
| 
          
            host_path
            
            
          
           Package host_path contains the internal representation of hostPath volumes. | Package host_path contains the internal representation of hostPath volumes. | 
| 
          
            iscsi
            
            
          
           Package iscsi contains the internal representation of Internet Small Computer System Interface (iSCSI) volumes. | Package iscsi contains the internal representation of Internet Small Computer System Interface (iSCSI) volumes. | 
| 
          
            nfs
            
            
          
           Package nfs contains the internal representation of network file system (NFS) volumes. | Package nfs contains the internal representation of network file system (NFS) volumes. | 
| 
          
            persistent_claim
            
            
          
           Package persistent_claim contains the internal representation of persistent volume claims. | Package persistent_claim contains the internal representation of persistent volume claims. | 
| 
          
            rbd
            
            
          
           Package rbd contains the internal representation of Rados Block Store (Ceph) volumes. | Package rbd contains the internal representation of Rados Block Store (Ceph) volumes. | 
| 
          
            secret
            
            
          
           Package secret contains the internal representation of secret volumes. | Package secret contains the internal representation of secret volumes. | 
| 
          
            util
            
            
          
           Contains utility code for use by volume plugins. | Contains utility code for use by volume plugins. | 
| Package watch contains a generic watchable interface, and a fake for testing code that uses the watch interface. | Package watch contains a generic watchable interface, and a fake for testing code that uses the watch interface. | 
| 
          
            json
            
            
          
           Package json implements a simple encoder and decoder for streams of watch events over io.Writer/Readers | Package json implements a simple encoder and decoder for streams of watch events over io.Writer/Readers | 
 Click to show internal directories. 
   Click to hide internal directories.