README
¶
client-go
Go clients for talking to a kubernetes cluster.
We currently recommend using the v2.0.0 tag. See INSTALL.md for
detailed installation instructions. go get k8s.io/client-go/...
works, but
will give you head and doesn't handle the dependencies well.
Table of Contents
What's included
- The
kubernetes
package contains the clientset to access Kubernetes API. - The
discovery
package is used to discover APIs supported by a Kubernetes API server. - The
dynamic
package contains a dynamic client that can perform generic operations on arbitrary Kubernetes API objects. - The
transport
package is used to set up auth and start a connection. - The
tools/cache
package is useful for writing controllers.
Versioning
client-go
follows semver. We will not make
backwards-incompatible changes without incrementing the major version number. A
change is backwards-incompatible either if it i) changes the public interfaces
of client-go
, or ii) makes client-go
incompatible with otherwise supported
versions of Kubernetes clusters.
Changes that add features in a backwards-compatible way will result in bumping the minor version (second digit) number.
Bugfixes will result in the patch version (third digit) changing. PRs that are
cherry-picked into an older Kubernetes release branch will result in an update
to the corresponding branch in client-go
, with a corresponding new tag
changing the patch version.
A consequence of this is that client-go
version numbers will be unrelated to
Kubernetes version numbers.
Branches and tags.
We will create a new branch and tag for each increment in the major version number or minor version number. We will create only a new tag for each increment in the patch version number. See semver for definitions of major, minor, and patch.
The master branch will track HEAD in the main Kubernetes repo and
accumulate changes. Consider HEAD to have the version x.(y+1).0-alpha
or
(x+1).0.0-alpha
(depending on whether it has accumulated a breaking change or
not), where x
and y
are the current major and minor versions.
Compatibility: your code <-> client-go
client-go
follows semver, so until the major version of
client-go gets increased, your code will compile and will continue to work with
explicitly supported versions of Kubernetes clusters. You must use a dependency
management system and pin a specific major version of client-go
to get this
benefit, as HEAD follows the upstream Kubernetes repo.
Compatibility: client-go <-> Kubernetes clusters
Since Kubernetes is backwards compatible with clients, older client-go
versions will work with many different Kubernetes cluster versions.
We will backport bugfixes--but not new features--into older versions of
client-go
.
Compatibility matrix
Kubernetes 1.3 | Kubernetes 1.4 | Kubernetes 1.5 | Kubernetes 1.6 | |
---|---|---|---|---|
client-go 1.4 | + | ✓ | - | - |
client-go 1.5 | + | + | - | - |
client-go 2.0 | + | + | ✓ | - |
client-go 3.0 beta | + | + | + | ✓ |
client-go HEAD | + | + | + | + |
Key:
✓
Exactly the same features / API objects in both client-go and the Kubernetes version.+
client-go has features or api objects that may not be present in the Kubernetes cluster, but everything they have in common will work.-
The Kubernetes cluster has features the client-go library can't use (additional API objects, etc).
See the CHANGELOG for a detailed description of changes between client-go versions.
Branch | Canonical source code location | Maintenance status |
---|---|---|
client-go 1.4 | Kubernetes main repo, 1.4 branch | = - |
client-go 1.5 | Kubernetes main repo, 1.5 branch | = - |
client-go 2.0 | Kubernetes main repo, 1.5 branch | ✓ |
client-go 3.0 | Kubernetes main repo, 1.6 branch | ✓ |
client-go HEAD | Kubernetes main repo, master branch | ✓ |
Key:
✓
Changes in main Kubernetes repo are actively published to client-go by a bot=
Maintenance is manual, only severe security bugs will be patched.-
Deprecated; please upgrade.
Deprecation policy
We will maintain branches for at least six months after their first stable tag is cut. (E.g., the clock for the release-2.0 branch started ticking when we tagged v2.0.0, not when we made the first alpha.) This policy applies to every version greater than or equal to 2.0.
Why do the 1.4 and 1.5 branch contain top-level folder named after the version?
For the initial release of client-go, we thought it would be easiest to keep separate directories for each minor version. That soon proved to be a mistake. We are keeping the top-level folders in the 1.4 and 1.5 branches so that existing users won't be broken.
How to get it
You can use go get k8s.io/client-go/...
to get client-go, but you will get
the unstable master branch and client-go
's vendored dependencies will not be
added to your $GOPATH
. So we think most users will want to use a dependency
management system. See INSTALL.md for detailed instructions.
How to use it
If your application runs in a Pod in the cluster, please refer to the in-cluster example, otherwise please refer to the out-of-cluster example.
Dependency management
If your application depends on a package that client-go depends on, and you let the Go compiler find the dependency in GOPATH
, you will end up with duplicated dependencies: one copy from the GOPATH
, and one from the vendor folder of client-go. This will cause unexpected runtime error like flag redefinition, since the go compiler ends up importing both packages separately, even if they are exactly the same thing. If this happens, you can either
- run
godep restore
(godep) in the client-go/ folder, then remove the vendor folder of client-go. Then the packages in your GOPATH will be the only copy - or run
godep save
in your application folder to flatten all dependencies.
Contributing code
Please send pull requests against the client packages in the Kubernetes main repository, and run the /staging/copy.sh
script to update the staging area in the main repository. Changes in the staging area will be published to this repository every day.
Directories
¶
Path | Synopsis |
---|---|
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. |
examples
|
|
create-update-delete-deployment
Note: the example only works with the code within the same release/branch.
|
Note: the example only works with the code within the same release/branch. |
in-cluster-client-configuration
Note: the example only works with the code within the same release/branch.
|
Note: the example only works with the code within the same release/branch. |
out-of-cluster-client-configuration
Note: the example only works with the code within the same release/branch.
|
Note: the example only works with the code within the same release/branch. |
third-party-resources-deprecated
Note: the example only works with the code within the same release/branch.
|
Note: the example only works with the code within the same release/branch. |
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
typed/admissionregistration/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/admissionregistration/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/apps/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/apps/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/authentication/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/authentication/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/authentication/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/authentication/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/authorization/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/authorization/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/authorization/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/authorization/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/autoscaling/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/autoscaling/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/autoscaling/v2alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/autoscaling/v2alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/batch/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/batch/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/batch/v2alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/batch/v2alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/certificates/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/certificates/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/core/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/core/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/extensions/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/extensions/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/networking/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/networking/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/policy/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/policy/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/rbac/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/rbac/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/rbac/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/rbac/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/settings/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/settings/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/storage/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/storage/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
typed/storage/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
typed/storage/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
listers
|
|
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/helper/qos
NOTE: DO NOT use those helper functions through client-go, the package path will be changed in the future.
|
NOTE: DO NOT use those helper functions through client-go, the package path will be changed in the future. |
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/v1
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
apis/admissionregistration
Package admissionregistration is the internal version of the API.
|
Package admissionregistration is the internal version of the API. |
apis/admissionregistration/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
|
Package v1alpha1 is the v1alpha1 version of the API. |
apis/apps/install
Package install installs the apps API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the apps API group, making it available as an option to all of the API encoding/decoding machinery. |
apis/apps/v1beta1
Package v1beta1 is a generated protocol buffer package.
|
Package v1beta1 is a generated protocol buffer package. |
apis/authentication
+groupName=authentication.k8s.io
|
+groupName=authentication.k8s.io |
apis/authentication/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/authentication/v1
+groupName=authentication.k8s.io
|
+groupName=authentication.k8s.io |
apis/authentication/v1beta1
+groupName=authentication.k8s.io
|
+groupName=authentication.k8s.io |
apis/authorization
+groupName=authorization.k8s.io
|
+groupName=authorization.k8s.io |
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/authorization/v1
+groupName=authorization.k8s.io
|
+groupName=authorization.k8s.io |
apis/authorization/v1beta1
+groupName=authorization.k8s.io
|
+groupName=authorization.k8s.io |
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/autoscaling/v1
Package v1 is a generated protocol buffer package.
|
Package v1 is a generated protocol buffer package. |
apis/autoscaling/v2alpha1
Package v2alpha1 is a generated protocol buffer package.
|
Package v2alpha1 is a generated protocol buffer package. |
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/batch/v1
Package v1 is a generated protocol buffer package.
|
Package v1 is a generated protocol buffer package. |
apis/batch/v2alpha1
Package v2alpha1 is a generated protocol buffer package.
|
Package v2alpha1 is a generated protocol buffer package. |
apis/certificates
+groupName=certificates.k8s.io
|
+groupName=certificates.k8s.io |
apis/certificates/install
Package install installs the certificates API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the certificates API group, making it available as an option to all of the API encoding/decoding machinery. |
apis/certificates/v1beta1
+groupName=certificates.k8s.io
|
+groupName=certificates.k8s.io |
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/extensions/v1beta1
Package v1beta1 is a generated protocol buffer package.
|
Package v1beta1 is a generated protocol buffer package. |
apis/networking
+groupName=networking.k8s.io
|
+groupName=networking.k8s.io |
apis/networking/v1
+groupName=networking.k8s.io
|
+groupName=networking.k8s.io |
apis/policy/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/policy/v1beta1
Package policy is for any kind of policy object.
|
Package policy is for any kind of policy object. |
apis/rbac
+groupName=rbac.authorization.k8s.io
|
+groupName=rbac.authorization.k8s.io |
apis/rbac/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/rbac/v1alpha1
+groupName=rbac.authorization.k8s.io
|
+groupName=rbac.authorization.k8s.io |
apis/rbac/v1beta1
+groupName=rbac.authorization.k8s.io
|
+groupName=rbac.authorization.k8s.io |
apis/settings
+groupName=settings.k8s.io
|
+groupName=settings.k8s.io |
apis/settings/install
Package install installs the settings API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the settings API group, making it available as an option to all of the API encoding/decoding machinery. |
apis/settings/v1alpha1
+groupName=settings.k8s.io
|
+groupName=settings.k8s.io |
apis/storage
+groupName=storage.k8s.io
|
+groupName=storage.k8s.io |
apis/storage/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/storage/v1
+groupName=storage.k8s.io
|
+groupName=storage.k8s.io |
apis/storage/v1beta1
+groupName=storage.k8s.io
|
+groupName=storage.k8s.io |
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. |
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. |
plugin
|
|
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 |
third_party
|
|
forked/golang/template
This package is copied from Go library text/template.
|
This package is copied from Go library text/template. |
tools
|
|
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. |
cache
Package cache is a client-side caching mechanism.
|
Package cache is a client-side caching mechanism. |
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. |
metrics
Package metrics provides abstractions for registering which metrics to record.
|
Package metrics provides abstractions for registering which metrics to record. |
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. |
util
|
|
cert/triple
Package triple generates key-certificate pairs for the triple (CA, Server, Client).
|
Package triple generates key-certificate pairs for the triple (CA, Server, Client). |
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/. |
workqueue
Package workqueue provides a simple queue that supports the following features:
|
Package workqueue provides a simple queue that supports the following features: |