README
¶
Kubernetes
Are you ...
- Interested in learning more about using Kubernetes? Please see our user-facing documentation on kubernetes.io
- Interested in hacking on the core Kubernetes code base? Keep reading!
Kubernetes is an open source system for managing containerized applications across multiple hosts, providing basic mechanisms for deployment, maintenance, and scaling of applications.
Kubernetes is:
- lean: lightweight, simple, accessible
- portable: public, private, hybrid, multi cloud
- extensible: modular, pluggable, hookable, composable
- self-healing: auto-placement, auto-restart, auto-replication
Kubernetes builds upon a decade and a half of experience at Google running production workloads at scale, combined with best-of-breed ideas and practices from the community.
Kubernetes can run anywhere!
However, initial development was done on GCE and so our instructions and scripts are built around that. If you make it work on other infrastructure please let us know and contribute instructions/code.
Kubernetes is ready for Production!
With the 1.0.1 release Kubernetes is ready to serve your production workloads.
Concepts
Kubernetes works with the following concepts:
Cluster : A cluster is a set of physical or virtual machines and other infrastructure resources used by Kubernetes to run your applications. Kubernetes can run anywhere! See the Getting Started Guides for instructions for a variety of services.
Node : A node is a physical or virtual machine running Kubernetes, onto which pods can be scheduled.
Pod : Pods are a colocated group of application containers with shared volumes. They're the smallest deployable units that can be created, scheduled, and managed with Kubernetes. Pods can be created individually, but it's recommended that you use a replication controller even if creating a single pod.
Replication controller : Replication controllers manage the lifecycle of pods. They ensure that a specified number of pods are running at any given time, by creating or killing pods as required.
Service : Services provide a single, stable name and address for a set of pods. They act as basic load balancers.
Label : Labels are used to organize and select groups of objects based on key:value pairs.
Documentation
Kubernetes documentation is organized into several categories.
- Getting started guides
- for people who want to create a Kubernetes cluster
- for people who want to port Kubernetes to a new environment
- User documentation
- for people who want to run programs on an existing Kubernetes cluster
- in the Kubernetes User Guide: Managing Applications Tip: You can also view help documentation out on http://kubernetes.io/docs/.
- the Kubectl Command Line Interface is a detailed reference on
the
kubectlCLI - User FAQ
- Cluster administrator documentation
- for people who want to create a Kubernetes cluster and administer it
- in the Kubernetes Cluster Admin Guide
- Developer and API documentation
- for people who want to write programs that access the Kubernetes API, write plugins or extensions, or modify the core Kubernetes code
- in the Kubernetes Developer Guide
- see also notes on the API
- see also the API object documentation, a detailed description of all fields found in the core API objects
- Walkthroughs and examples
- hands-on introduction and example config files
- in the user guide
- in the docs/examples directory
- Contributions from the Kubernetes community
- in the docs/contrib directory
- Design documentation and design proposals
- for people who want to understand the design of Kubernetes, and feature proposals
- design docs in the Kubernetes Design Overview and the docs/design directory
- proposals in the docs/proposals directory
- Wiki/FAQ
- in the wiki
- troubleshooting information in the troubleshooting guide
Community, discussion, contribution, and support
See which companies are committed to driving quality in Kubernetes on our community page.
Do you want to help "shape the evolution of technologies that are container packaged, dynamically scheduled and microservices oriented?"
You should consider joining the Cloud Native Computing Foundation. For details about who's involved and how Kubernetes plays a role, read their announcement.
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Are you ready to add to the discussion?
We have presence on:
You can also view recordings of past events and presentations on our Media page.
For Q&A, our threads are at:
Want to do more than just 'discuss' Kubernetes?
If you're interested in being a contributor and want to get involved in developing Kubernetes, start in the Kubernetes Developer Guide and also review the contributor guidelines.
Support
While there are many different channels that you can use to get ahold of us, you can help make sure that we are efficient in getting you the help that you need.
If you need support, start with the troubleshooting guide and work your way through the process that we've outlined.
That said, if you have questions, reach out to us one way or another. We don't bite!
Community resources:
- Awesome-kubernetes:
You can find more projects, tools and articles related to Kubernetes on the awesome-kubernetes list. Add your project there and help us make it better.
- CoreKube - https://corekube.com:
Instructive & educational resources for the Kubernetes community. By the community.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
integration
A basic integration test for the service.
|
A basic integration test for the service. |
|
kube-apiserver
apiserver is the main api server and master for the cluster.
|
apiserver is the main api server and master for the cluster. |
|
kube-apiserver/app
Package app does all of the work necessary to create a Kubernetes APIServer by binding together the API, master and APIServer infrastructure.
|
Package app does all of the work necessary to create a Kubernetes APIServer by binding together the API, master and APIServer infrastructure. |
|
kube-apiserver/app/options
Package options contains flags and options for initializing an apiserver
|
Package options contains flags and options for initializing an apiserver |
|
kube-controller-manager
The controller manager is responsible for monitoring replication controllers, and creating corresponding pods to achieve the desired state.
|
The controller manager is responsible for monitoring replication controllers, and creating corresponding pods to achieve the desired state. |
|
kube-controller-manager/app
Package app implements a server that runs a set of active components.
|
Package app implements a server that runs a set of active components. |
|
kube-controller-manager/app/options
Package options provides the flags used for the controller manager.
|
Package options provides the flags used for the controller manager. |
|
kube-proxy/app
Package app does all of the work necessary to configure and run a Kubernetes app process.
|
Package app does all of the work necessary to configure and run a Kubernetes app process. |
|
kube-proxy/app/options
Package options contains flags for initializing a proxy.
|
Package options contains flags for initializing a proxy. |
|
kubelet
The kubelet binary is responsible for maintaining a set of containers on a particular host VM.
|
The kubelet binary is responsible for maintaining a set of containers on a particular host VM. |
|
kubelet/app
Package app makes it easy to create a kubelet server for various contexts.
|
Package app makes it easy to create a kubelet server for various contexts. |
|
kubelet/app/options
Package options contains all of the primary arguments for a kubelet.
|
Package options contains all of the primary arguments for a kubelet. |
|
libs/go2idl/args
Package args has common command-line flags for generation programs.
|
Package args has common command-line flags for generation programs. |
|
libs/go2idl/client-gen
client-gen makes the individual typed clients using go2idl.
|
client-gen makes the individual typed clients using go2idl. |
|
libs/go2idl/client-gen/generators
Package generators has the generators for the client-gen utility.
|
Package generators has the generators for the client-gen utility. |
|
libs/go2idl/client-gen/testoutput/clientset_generated/test_internalclientset
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
libs/go2idl/client-gen/testoutput/clientset_generated/test_internalclientset/typed/testgroup/unversioned
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
libs/go2idl/conversion-gen
conversion-gen is a tool for auto-generating Conversion functions.
|
conversion-gen is a tool for auto-generating Conversion functions. |
|
libs/go2idl/deepcopy-gen
deepcopy-gen is a tool for auto-generating DeepCopy functions.
|
deepcopy-gen is a tool for auto-generating DeepCopy functions. |
|
libs/go2idl/generator
Package generator defines an interface for code generators to implement.
|
Package generator defines an interface for code generators to implement. |
|
libs/go2idl/go-to-protobuf
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct.
|
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct. |
|
libs/go2idl/go-to-protobuf/protobuf
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct.
|
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct. |
|
libs/go2idl/go-to-protobuf/protoc-gen-gogo
Package main defines the protoc-gen-gogo binary we use to generate our proto go files, as well as takes dependencies on the correct gogo/protobuf packages for godeps.
|
Package main defines the protoc-gen-gogo binary we use to generate our proto go files, as well as takes dependencies on the correct gogo/protobuf packages for godeps. |
|
libs/go2idl/import-boss
import-boss enforces import restrictions in a given repository.
|
import-boss enforces import restrictions in a given repository. |
|
libs/go2idl/import-boss/generators
Package generators has the generators for the import-boss utility.
|
Package generators has the generators for the import-boss utility. |
|
libs/go2idl/namer
Package namer has support for making different type naming systems.
|
Package namer has support for making different type naming systems. |
|
libs/go2idl/parser
Package parser provides code to parse go files, type-check them, extract the types.
|
Package parser provides code to parse go files, type-check them, extract the types. |
|
libs/go2idl/set-gen
set-gen is an example usage of go2idl.
|
set-gen is an example usage of go2idl. |
|
libs/go2idl/set-gen/generators
Package generators has the generators for the set-gen utility.
|
Package generators has the generators for the set-gen utility. |
|
libs/go2idl/types
Package types contains go type information, packaged in a way that makes auto-generation convenient, whether by template or straight go functions.
|
Package types contains go type information, packaged in a way that makes auto-generation convenient, whether by template or straight go functions. |
|
Examples contains sample applications for trying out the concepts in Kubernetes.
|
Examples contains sample applications for trying out the concepts in Kubernetes. |
|
explorer
A tiny web server for viewing the environment kubernetes creates for your containers.
|
A tiny web server for viewing the environment kubernetes creates for your containers. |
|
https-nginx
A small script that converts the given open ssl public/private keys to a secret that it writes to stdout as json.
|
A small script that converts the given open ssl public/private keys to a secret that it writes to stdout as json. |
|
sharing-clusters
A tiny script to help conver a given kubeconfig into a secret.
|
A tiny script to help conver a given kubeconfig into a secret. |
|
pkg
|
|
|
api
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. |
|
api/errors
Package errors provides detailed error types for api field validation.
|
Package errors provides detailed error types for api field validation. |
|
api/errors/storage
Package etcd provides conversion of etcd errors to API errors.
|
Package etcd provides conversion of etcd errors to API errors. |
|
api/install
Package install installs the v1 monolithic api, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the v1 monolithic api, making it available as an option to all of the API encoding/decoding machinery. |
|
api/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 |
|
api/rest
Package rest defines common logic around changes to Kubernetes resources.
|
Package rest defines common logic around changes to Kubernetes resources. |
|
api/testapi
Package testapi provides a helper for retrieving the KUBE_TEST_API environment variable.
|
Package testapi provides a helper for retrieving the KUBE_TEST_API environment variable. |
|
api/unversioned
Package unversioned contains API types that are common to all versions.
|
Package unversioned contains API types that are common to all versions. |
|
api/util
TODO: This GetVersion/GetGroup arrangement is temporary and will be replaced with a GroupAndVersion type.
|
TODO: This GetVersion/GetGroup arrangement is temporary and will be replaced with a GroupAndVersion type. |
|
api/v1
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
|
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. |
|
apimachinery
Package apimachinery contains the generic API machinery code that is common to both server and clients.
|
Package apimachinery contains the generic API machinery code that is common to both server and clients. |
|
apimachinery/registered
Package to keep track of API Versions that can be registered and are enabled in api.Scheme.
|
Package to keep track of API Versions that can be registered and are enabled in api.Scheme. |
|
apis/authorization/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/autoscaling/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/batch/install
Package install installs the batch API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the batch API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/componentconfig/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/extensions/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apis/metrics/install
Package install installs the metrics API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the metrics API group, making it available as an option to all of the API encoding/decoding machinery. |
|
apiserver
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. |
|
capabilities
package capbabilities manages system level capabilities
|
package capbabilities manages system level capabilities |
|
client/cache
Package cache is a client-side caching mechanism.
|
Package cache is a client-side caching mechanism. |
|
client/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. |
|
client/clientset_generated/internalclientset
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset_generated/internalclientset/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset_generated/internalclientset/typed/core/unversioned
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset_generated/internalclientset/typed/core/unversioned/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset_generated/internalclientset/typed/extensions/unversioned
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset_generated/internalclientset/typed/extensions/unversioned/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset_generated/release_1_2
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset_generated/release_1_2/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset_generated/release_1_2/typed/core/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset_generated/release_1_2/typed/core/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset_generated/release_1_2/typed/extensions/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset_generated/release_1_2/typed/extensions/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/leaderelection
Package leaderelection implements leader election of a set of endpoints.
|
Package leaderelection implements leader election of a set of endpoints. |
|
client/metrics
Package metrics provides utilities for registering client metrics to Prometheus.
|
Package metrics provides utilities for registering client metrics to Prometheus. |
|
client/record
Package record has all client logic for recording and reporting events.
|
Package record has all client logic for recording and reporting events. |
|
client/typed/dynamic
Package dynamic provides a client interface to arbitrary Kubernetes APIs that exposes common high level operations and exposes common metadata.
|
Package dynamic provides a client interface to arbitrary Kubernetes APIs that exposes common high level operations and exposes common metadata. |
|
client/typed/generated/core/unversioned
Package unversioned has the automatically generated clients for unversioned resources.
|
Package unversioned has the automatically generated clients for unversioned resources. |
|
client/typed/generated/core/unversioned/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/typed/generated/core/v1
Package unversioned has the automatically generated clients for unversioned resources.
|
Package unversioned has the automatically generated clients for unversioned resources. |
|
client/typed/generated/core/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/typed/generated/extensions/unversioned
Package unversioned has the automatically generated clients for unversioned resources.
|
Package unversioned has the automatically generated clients for unversioned resources. |
|
client/typed/generated/extensions/unversioned/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/typed/generated/extensions/v1beta1
Package unversioned has the automatically generated clients for unversioned resources.
|
Package unversioned has the automatically generated clients for unversioned resources. |
|
client/typed/generated/extensions/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/unversioned
Package unversioned contains the implementation of the client side communication with the Kubernetes master.
|
Package unversioned contains the implementation of the client side communication with the Kubernetes master. |
|
client/unversioned/auth
Package auth defines a file format for holding authentication information needed by clients of Kubernetes.
|
Package auth defines a file format for holding authentication information needed by clients of Kubernetes. |
|
client/unversioned/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. |
|
client/unversioned/fake
This is made a separate package and should only be imported by tests, because it imports testapi
|
This is made a separate package and should only be imported by tests, because it imports testapi |
|
client/unversioned/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. |
|
client/unversioned/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. |
|
cloudprovider
Package cloudprovider supplies interfaces and implementations for cloud service providers.
|
Package cloudprovider supplies interfaces and implementations for cloud service providers. |
|
cloudprovider/providers/fake
Package fake is a test-double implementation of cloudprovider Interface, LoadBalancer and Instances.
|
Package fake is a test-double implementation of cloudprovider Interface, LoadBalancer and Instances. |
|
cloudprovider/providers/gce
Package gce is an implementation of Interface, LoadBalancer and Instances for Google Compute Engine.
|
Package gce is an implementation of Interface, LoadBalancer and Instances for Google Compute Engine. |
|
controller
Package controller contains code for controllers (like the replication controller).
|
Package controller contains code for controllers (like the replication controller). |
|
controller/daemon
Package daemon contains logic for watching and synchronizing daemons.
|
Package daemon contains logic for watching and synchronizing daemons. |
|
controller/endpoint
Package service provides EndpointController implementation to manage and sync service endpoints.
|
Package service provides EndpointController implementation to manage and sync service endpoints. |
|
controller/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. |
|
controller/gc
Package gc contains a very simple pod "garbage collector" implementation, GCController, that runs in the controller manager.
|
Package gc contains a very simple pod "garbage collector" implementation, GCController, that runs in the controller manager. |
|
controller/job
Package job contains logic for watching and synchronizing jobs.
|
Package job contains logic for watching and synchronizing jobs. |
|
controller/namespace
namespace contains a controller that handles namespace lifecycle
|
namespace contains a controller that handles namespace lifecycle |
|
controller/node
Package node contains code for syncing cloud instances with node registry
|
Package node contains code for syncing cloud instances with node registry |
|
controller/replicaset
Package replicaset contains logic for watching and synchronizing ReplicaSets.
|
Package replicaset contains logic for watching and synchronizing ReplicaSets. |
|
controller/replication
Package replication contains logic for watching and synchronizing replication controllers.
|
Package replication contains logic for watching and synchronizing replication controllers. |
|
controller/resourcequota
resourcequota contains a controller that makes resource quota usage observations
|
resourcequota contains a controller that makes resource quota usage observations |
|
controller/route
Package route contains code for syncing cloud routing rules with the list of registered nodes.
|
Package route contains code for syncing cloud routing rules with the list of registered nodes. |
|
controller/service
Package service contains code for syncing cloud load balancers with the service registry.
|
Package service contains code for syncing cloud load balancers with the service registry. |
|
controller/serviceaccount
Package serviceaccount provides implementations to manage service accounts and service account tokens
|
Package serviceaccount provides implementations to manage service accounts and service account tokens |
|
conversion
Package conversion provides go object versioning.
|
Package conversion provides go object versioning. |
|
conversion/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 |
|
credentialprovider
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. |
|
credentialprovider/gcp
Package gcp_credentials contains implementations of DockerConfigProvider for Google Cloud Platform.
|
Package gcp_credentials contains implementations of DockerConfigProvider for Google Cloud Platform. |
|
fieldpath
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. |
|
fields
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. |
|
genericapiserver
Package genericapiserver contains code to setup a generic kubernetes-like API server.
|
Package genericapiserver contains code to setup a generic kubernetes-like API server. |
|
healthz
Package healthz implements basic http server health checking.
|
Package healthz implements basic http server health checking. |
|
httplog
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. |
|
hyperkube
Package hyperkube is a framework for kubernetes server components.
|
Package hyperkube is a framework for kubernetes server components. |
|
kubectl
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. |
|
kubectl/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. |
|
kubelet
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. |
|
kubelet/cadvisor
Kubelet interactions with cAdvisor.
|
Kubelet interactions with cAdvisor. |
|
kubelet/config
Reads the pod configuration from the Kubernetes apiserver.
|
Reads the pod configuration from the Kubernetes apiserver. |
|
kubelet/custommetrics
Package custommetrics contains support for instrumenting cAdvisor to gather custom metrics from pods.
|
Package custommetrics contains support for instrumenting cAdvisor to gather custom metrics from pods. |
|
kubelet/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. |
|
kubelet/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. |
|
kubelet/lifecycle
Handlers for pod lifecycle events.
|
Handlers for pod lifecycle events. |
|
kubelet/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 success - 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 - status, called at regular intervals and is supposed to return a json formatted output indicating the pod's IPAddress(v4/v6).
|
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 success - 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 - status, called at regular intervals and is supposed to return a json formatted output indicating the pod's IPAddress(v4/v6). |
|
kubelet/pleg
Package pleg contains types and a generic implementation of the pod lifecycle event generator.
|
Package pleg contains types and a generic implementation of the pod lifecycle event generator. |
|
kubelet/qos
package qos contains helper functions for quality of service.
|
package qos contains helper functions for quality of service. |
|
kubelet/rkt
Package rkt contains the Containerruntime interface implementation for rkt.
|
Package rkt contains the Containerruntime interface implementation for rkt. |
|
kubelet/server
Package server contains functions related to serving Kubelet's external interface.
|
Package server contains functions related to serving Kubelet's external interface. |
|
kubelet/server/portforward
package portforward contains server-side logic for handling port forwarding requests.
|
package portforward contains server-side logic for handling port forwarding requests. |
|
kubelet/server/remotecommand
package remotecommand contains functions related to executing commands in and attaching to pods.
|
package remotecommand contains functions related to executing commands in and attaching to pods. |
|
kubelet/server/stats
Package stats handles exporting Kubelet and container stats.
|
Package stats handles exporting Kubelet and container stats. |
|
kubelet/types
Common types in the Kubelet.
|
Common types in the Kubelet. |
|
kubelet/util
Utility functions.
|
Utility functions. |
|
labels
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. |
|
master
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. |
|
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. |
|
probe
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. |
|
proxy
Package proxy implements the layer-3 network proxy.
|
Package proxy implements the layer-3 network proxy. |
|
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). |
|
quota/evaluator/core
core contains modules that interface with the core api group
|
core contains modules that interface with the core api group |
|
registry
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. |
|
registry/cachesize
use for --watch-cache-sizes param of kube-apiserver make watch cache size of resources configurable
|
use for --watch-cache-sizes param of kube-apiserver make watch cache size of resources configurable |
|
registry/componentstatus
Package componentstatus provides interfaces and implementation for retrieving cluster component status.
|
Package componentstatus provides interfaces and implementation for retrieving cluster component status. |
|
registry/configmap
Package configmap provides Registry interface and its REST implementation for storing ConfigMap API objects.
|
Package configmap provides Registry interface and its REST implementation for storing ConfigMap API objects. |
|
registry/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. |
|
registry/daemonset
Package daemonset provides Registry interface and its RESTStorage implementation for storing DaemonSet api objects.
|
Package daemonset provides Registry interface and its RESTStorage implementation for storing DaemonSet api objects. |
|
registry/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. |
|
registry/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. |
|
registry/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. |
|
registry/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. |
|
registry/generic/rest
Package rest has generic implementations of resources used for REST responses
|
Package rest has generic implementations of resources used for REST responses |
|
registry/job
Package job provides Registry interface and it's RESTStorage implementation for storing Job api objects.
|
Package job provides Registry interface and it's RESTStorage implementation for storing Job api objects. |
|
registry/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. |
|
registry/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. |
|
registry/node
Package node provides Registry interface and implementation for storing Nodes.
|
Package node provides Registry interface and implementation for storing Nodes. |
|
registry/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. |
|
registry/podsecuritypolicy
Package podsecuritypolicy provides Registry interface and its REST implementation for storing PodSecurityPolicy api objects.
|
Package podsecuritypolicy provides Registry interface and its REST implementation for storing PodSecurityPolicy api objects. |
|
registry/podtemplate
Package podtemplate provides RESTStorage implementations for storing PodTemplate API objects.
|
Package podtemplate provides RESTStorage implementations for storing PodTemplate API objects. |
|
registry/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. |
|
registry/replicaset
Package replicaset provides Registry interface and it's RESTStorage implementation for storing ReplicaSet api objects.
|
Package replicaset provides Registry interface and it's RESTStorage implementation for storing ReplicaSet api objects. |
|
registry/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. |
|
registry/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. |
|
registry/securitycontextconstraints
Package securitycontextconstraints provides Registry interface and its REST implementation for storing SecurityContextConstraints api objects.
|
Package securitycontextconstraints provides Registry interface and its REST implementation for storing SecurityContextConstraints api objects. |
|
registry/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. |
|
registry/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. |
|
registry/thirdpartyresource
Package thirdpartyresource provides Registry interface and its REST implementation for storing ThirdPartyResource api objects.
|
Package thirdpartyresource provides Registry interface and its REST implementation for storing ThirdPartyResource api objects. |
|
registry/thirdpartyresourcedata
Package thirdpartyresourcedata provides Registry interface and its REST implementation for storing ThirdPartyResourceData api objects.
|
Package thirdpartyresourcedata provides Registry interface and its REST implementation for storing ThirdPartyResourceData api objects. |
|
runtime
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. |
|
runtime/serializer/protobuf
Package protobuf provides a Kubernetes serializer for the protobuf format.
|
Package protobuf provides a Kubernetes serializer for the protobuf format. |
|
runtime/serializer/streaming
Package streaming implements encoder and decoder for streams of runtime.Objects over io.Writer/Readers.
|
Package streaming implements encoder and decoder for streams of runtime.Objects over io.Writer/Readers. |
|
securitycontext
Package securitycontext contains security context api implementations
|
Package securitycontext contains security context api implementations |
|
securitycontextconstraints/selinux
Package selinux contains security context constraints SELinux strategy implementations.
|
Package selinux contains security context constraints SELinux strategy implementations. |
|
securitycontextconstraints/user
Package user contains security context constraints user strategy implementations.
|
Package user contains security context constraints user strategy implementations. |
|
storage
Interfaces for database-related operations.
|
Interfaces for database-related operations. |
|
storage/etcd/util
Package util holds generic etcd-related utility functions that any user of ectd might want to use, without pulling in kubernetes-specific code.
|
Package util holds generic etcd-related utility functions that any user of ectd might want to use, without pulling in kubernetes-specific code. |
|
types
Package types implements various generic types used throughout kubernetes.
|
Package types implements various generic types used throughout kubernetes. |
|
ui
package ui contains utilities for accessing the static data files compiled in the data/* subdirectories.
|
package ui contains utilities for accessing the static data files compiled in the data/* subdirectories. |
|
util
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. |
|
util/bandwidth
Package bandwidth provides utilities for bandwidth shaping
|
Package bandwidth provides utilities for bandwidth shaping |
|
util/chmod
Package chown provides an interface and implementations for things that run run the chmod system call.
|
Package chown provides an interface and implementations for things that run run the chmod system call. |
|
util/chown
Package chown provides utilities to chown a path
|
Package chown provides utilities to chown a path |
|
util/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. |
|
util/dbus
Package dbus provides an injectable interface and implementations for D-Bus communication
|
Package dbus provides an injectable interface and implementations for D-Bus communication |
|
util/errors
Package errors implements various utility functions and types around errors.
|
Package errors implements various utility functions and types around errors. |
|
util/exec
Package exec provides an injectable interface and implementations for running commands.
|
Package exec provides an injectable interface and implementations for running commands. |
|
util/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 |
|
util/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. |
|
util/iptables
Package iptables provides an interface and implementations for running iptables commands.
|
Package iptables provides an interface and implementations for running iptables commands. |
|
util/jsonpath
package jsonpath is a template engine using jsonpath syntax, which can be seen at http://goessner.net/articles/JsonPath/.
|
package jsonpath is a template engine using jsonpath syntax, which can be seen at http://goessner.net/articles/JsonPath/. |
|
util/labels
Package labels provides utilities to work with Kubernetes labels.
|
Package labels provides utilities to work with Kubernetes labels. |
|
util/limitwriter
Package limitwriter provides a writer that only allows a certain number of bytes to be written.
|
Package limitwriter provides a writer that only allows a certain number of bytes to be written. |
|
util/mount
Package mount defines an interface to mounting filesystems.
|
Package mount defines an interface to mounting filesystems. |
|
util/oom
Package oom implements utility functions relating to out of memory management.
|
Package oom implements utility functions relating to out of memory management. |
|
util/pod
Package pod provides utilities to work with Kubernetes pod and pod templates.
|
Package pod provides utilities to work with Kubernetes pod and pod templates. |
|
util/procfs
Package procfs implements utility functions relating to the /proc mount.
|
Package procfs implements utility functions relating to the /proc mount. |
|
util/proxy
Package proxy provides transport and upgrade support for proxies
|
Package proxy provides transport and upgrade support for proxies |
|
util/rand
Package rand provides utilities related to randomization.
|
Package rand provides utilities related to randomization. |
|
util/selinux
Package selinux contains selinux utility functions.
|
Package selinux contains selinux utility functions. |
|
util/sets
Package sets has auto-generated set types.
|
Package sets has auto-generated set types. |
|
util/sets/types
Package types just provides input types to the set generator.
|
Package types just provides input types to the set generator. |
|
util/slice
Package slice provides utility methods for common operations on slices.
|
Package slice provides utility methods for common operations on slices. |
|
util/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. |
|
util/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. |
|
util/wsstream
Package wsstream contains utilities for streaming content over WebSockets.
|
Package wsstream contains utilities for streaming content over WebSockets. |
|
version
Package version supplies version information collected at build time to kubernetes components.
|
Package version supplies version information collected at build time to kubernetes components. |
|
version/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. |
|
volume
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. |
|
volume/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. |
|
volume/azure_file
Package azure_file contains the internal representation of Azure File Service Volume
|
Package azure_file contains the internal representation of Azure File Service Volume |
|
volume/cephfs
Package nfs contains the internal representation of Ceph file system (CephFS) volumes.
|
Package nfs contains the internal representation of Ceph file system (CephFS) volumes. |
|
volume/cinder
Package cinder contains the internal representation of cinder volumes.
|
Package cinder contains the internal representation of cinder volumes. |
|
volume/configmap
Package configmap contains the internal representation of configMap volumes.
|
Package configmap contains the internal representation of configMap volumes. |
|
volume/empty_dir
Package empty_dir contains the internal representation of emptyDir volumes.
|
Package empty_dir contains the internal representation of emptyDir volumes. |
|
volume/fc
Package fc contains the internal representation of Fibre Channel (fc) volumes.
|
Package fc contains the internal representation of Fibre Channel (fc) volumes. |
|
volume/flocker
Package flocker contains the internal representation of Flocker volumes
|
Package flocker contains the internal representation of Flocker volumes |
|
volume/gce_pd
Package gce_pd contains the internal representation of GCE PersistentDisk volumes.
|
Package gce_pd contains the internal representation of GCE PersistentDisk volumes. |
|
volume/git_repo
Package git_repo contains the internal representation of git repo volumes.
|
Package git_repo contains the internal representation of git repo volumes. |
|
volume/glusterfs
Package glusterfs contains the internal representation of glusterfs volumes.
|
Package glusterfs contains the internal representation of glusterfs volumes. |
|
volume/host_path
Package host_path contains the internal representation of hostPath volumes.
|
Package host_path contains the internal representation of hostPath volumes. |
|
volume/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. |
|
volume/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. |
|
volume/persistent_claim
Package persistent_claim contains the internal representation of persistent volume claims.
|
Package persistent_claim contains the internal representation of persistent volume claims. |
|
volume/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. |
|
volume/secret
Package secret contains the internal representation of secret volumes.
|
Package secret contains the internal representation of secret volumes. |
|
volume/util
Contains utility code for use by volume plugins.
|
Contains utility code for use by volume plugins. |
|
watch
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. |
|
watch/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 |
|
plugin
|
|
|
cmd/kube-scheduler/app
Package app implements a Server object for running the scheduler.
|
Package app implements a Server object for running the scheduler. |
|
cmd/kube-scheduler/app/options
Package options provides the scheduler flags
|
Package options provides the scheduler flags |
|
pkg/admission/alwayspullimages
Package alwayspullimages contains an admission controller that modifies every new Pod to force the image pull policy to Always.
|
Package alwayspullimages contains an admission controller that modifies every new Pod to force the image pull policy to Always. |
|
pkg/admission/persistentvolume/label
labels created persistent volumes with zone information as provided by the cloud provider
|
labels created persistent volumes with zone information as provided by the cloud provider |
|
pkg/admission/resourcequota
resourcequota enforces all incoming requests against any applied quota in the namespace context of the request
|
resourcequota enforces all incoming requests against any applied quota in the namespace context of the request |
|
pkg/admission/serviceaccount
serviceaccount enforces all pods having an associated serviceaccount, and all containers mounting the API token for that serviceaccount at a known location
|
serviceaccount enforces all pods having an associated serviceaccount, and all containers mounting the API token for that serviceaccount at a known location |
|
pkg/auth
Package auth contains implementations for interfaces in the pkg/auth package
|
Package auth contains implementations for interfaces in the pkg/auth package |
|
pkg/auth/authenticator
Package authenticator contains implementations for pkg/auth/authenticator interfaces
|
Package authenticator contains implementations for pkg/auth/authenticator interfaces |
|
pkg/auth/authenticator/password
Package password contains authenticator.Password implementations
|
Package password contains authenticator.Password implementations |
|
pkg/auth/authenticator/password/keystone
Package keystone provides authentication via keystone.
|
Package keystone provides authentication via keystone. |
|
pkg/auth/authenticator/request/x509
Package x509 provides a request authenticator that validates and extracts user information from client certificates
|
Package x509 provides a request authenticator that validates and extracts user information from client certificates |
|
pkg/auth/authenticator/token/oidc
oidc implements the authenticator.Token interface using the OpenID Connect protocol.
|
oidc implements the authenticator.Token interface using the OpenID Connect protocol. |
|
pkg/auth/authorizer
Package authorizer contains implementations for pkg/auth/authorizer interfaces
|
Package authorizer contains implementations for pkg/auth/authorizer interfaces |
|
pkg/auth/authorizer/webhook
Package webhook implements the authorizer.Authorizer interface using HTTP webhooks.
|
Package webhook implements the authorizer.Authorizer interface using HTTP webhooks. |
|
pkg/scheduler/algorithm
Package scheduler contains a generic Scheduler interface and several implementations.
|
Package scheduler contains a generic Scheduler interface and several implementations. |
|
pkg/scheduler/algorithmprovider
This package is used to register algorithm provider plugins.
|
This package is used to register algorithm provider plugins. |
|
pkg/scheduler/algorithmprovider/defaults
This is the default algorithm provider for the scheduler.
|
This is the default algorithm provider for the scheduler. |
|
pkg/scheduler/factory
Package factory can set up a scheduler.
|
Package factory can set up a scheduler. |
|
test
|
|
|
e2e
This is a utility for prometheus pushing functionality.
|
This is a utility for prometheus pushing functionality. |
|
integration
Package integration provides integration tests for Kubernetes.
|
Package integration provides integration tests for Kubernetes. |
|
third_party
|
|
|
forked/json
Package json is forked from the Go standard library to enable us to find the field of a struct that a given JSON key maps to.
|
Package json is forked from the Go standard library to enable us to find the field of a struct that a given JSON key maps to. |
|
forked/reflect
Package reflect is a fork of go's standard library reflection package, which allows for deep equal with equality functions defined.
|
Package reflect is a fork of go's standard library reflection package, which allows for deep equal with equality functions defined. |
|
golang/go/ast
Package ast declares the types used to represent syntax trees for Go packages.
|
Package ast declares the types used to represent syntax trees for Go packages. |
|
golang/go/build
Package build gathers information about Go packages.
|
Package build gathers information about Go packages. |
|
golang/go/constant
Package constant implements Values representing untyped Go constants and the corresponding operations.
|
Package constant implements Values representing untyped Go constants and the corresponding operations. |
|
golang/go/doc
Package doc extracts source code documentation from a Go AST.
|
Package doc extracts source code documentation from a Go AST. |
|
golang/go/parser
Package parser implements a parser for Go source files.
|
Package parser implements a parser for Go source files. |
|
golang/go/printer
Package printer implements printing of AST nodes.
|
Package printer implements printing of AST nodes. |
|
golang/go/scanner
Package scanner implements a scanner for Go source text.
|
Package scanner implements a scanner for Go source text. |
|
golang/go/token
Package token defines constants representing the lexical tokens of the Go programming language and basic operations on tokens (printing, predicates).
|
Package token defines constants representing the lexical tokens of the Go programming language and basic operations on tokens (printing, predicates). |
|
golang/go/types
Package types declares the data types and implements the algorithms for type-checking of Go packages.
|
Package types declares the data types and implements the algorithms for type-checking of Go packages. |
|
golang/reflect
This package is copied from Go library reflect/type.go.
|
This package is copied from Go library reflect/type.go. |
|
golang/template
This package is copied from Go library text/template.
|
This package is copied from Go library text/template. |
Click to show internal directories.
Click to hide internal directories.