README

client-go

Go clients for talking to a kubernetes cluster.

We recommend using the v0.x.y tags for Kubernetes releases >= v1.17.0 and kubernetes-1.x.y tags for Kubernetes releases < v1.17.0.

The fastest way to add this library to a project is to run go get k8s.io/client-go@latest with go1.16+. See INSTALL.md for detailed installation instructions and troubleshooting.

BuildStatus Widget GoReport Widget GoDocWidget

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 plugin/pkg/client/auth packages contain optional authentication plugins for obtaining credentials from external sources.
  • The transport package is used to set up auth and start a connection.
  • The tools/cache package is useful for writing controllers.
Versioning
  • For each v1.x.y Kubernetes release, the major version (first digit) would remain 0.

  • 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.

Branches and tags.

We will create a new branch and tag for each increment in the 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 HEAD of the master branch in client-go will track the HEAD of the master branch in the main Kubernetes repo.

Compatibility: your code <-> client-go

The v0.x.y tags indicate that go APIs may change in incompatible ways in different versions.

See INSTALL.md for guidelines on requiring a specific version of client-go.

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.15 Kubernetes 1.16 Kubernetes 1.17 Kubernetes 1.18 Kubernetes 1.19 Kubernetes 1.20
kubernetes-1.15.0 +- +- +- +- +-
kubernetes-1.16.0 +- +- +- +- +-
kubernetes-1.17.0/v0.17.0 +- +- +- +- +-
kubernetes-1.18.0/v0.18.0 +- +- +- +- +-
kubernetes-1.19.0/v0.19.0 +- +- +- +- +-
kubernetes-1.20.0/v0.20.0 +- +- +- +- +-
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, either due to that client-go has additional new API, or that the server has removed old API. However, everything they have in common (i.e., most APIs) will work. Please note that alpha APIs may vanish or change significantly in a single release.
  • - The Kubernetes cluster has features the client-go library can't use, either due to the server has additional new API, or that client-go has removed old API. However, everything they share in common (i.e., most APIs) will work.

See the CHANGELOG for a detailed description of changes between client-go versions.

Branch Canonical source code location Maintenance status
release-1.4 Kubernetes main repo, 1.4 branch = -
release-1.5 Kubernetes main repo, 1.5 branch = -
release-2.0 Kubernetes main repo, 1.5 branch = -
release-3.0 Kubernetes main repo, 1.6 branch = -
release-4.0 Kubernetes main repo, 1.7 branch = -
release-5.0 Kubernetes main repo, 1.8 branch = -
release-6.0 Kubernetes main repo, 1.9 branch = -
release-7.0 Kubernetes main repo, 1.10 branch = -
release-8.0 Kubernetes main repo, 1.11 branch =-
release-9.0 Kubernetes main repo, 1.12 branch =-
release-10.0 Kubernetes main repo, 1.13 branch =-
release-11.0 Kubernetes main repo, 1.14 branch =-
release-12.0 Kubernetes main repo, 1.15 branch =-
release-13.0 Kubernetes main repo, 1.16 branch =-
release-14.0 Kubernetes main repo, 1.17 branch
release-1.18 Kubernetes main repo, 1.18 branch
release-1.19 Kubernetes main repo, 1.19 branch
release-1.20 Kubernetes main repo, 1.20 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.

Kubernetes tags

This repository is still a mirror of k8s.io/kubernetes/staging/src/client-go, the code development is still done in the staging area.

Since Kubernetes v1.8.0, when syncing the code from the staging area, we also sync the Kubernetes version tags to client-go, prefixed with kubernetes-. From Kubernetes v1.17.0, we also create matching semver v0.x.y tags for each v1.x.y Kubernetes release.

For example, if you check out the kubernetes-1.17.0 or the v0.17.0 tag in client-go, the code you get is exactly the same as if you check out the v1.17.0 tag in Kubernetes, and change directory to staging/src/k8s.io/client-go.

The purpose is to let users quickly find matching commits among published repos, like sample-apiserver, apiextension-apiserver, etc. The Kubernetes version tag does NOT claim any backwards compatibility guarantees for client-go. Please check the semantic versions if you care about backwards compatibility.

How to get it

To get the latest version, use go1.16+ and fetch using the go get command. For example:

go get k8s.io/client-go@latest

To get a specific version, use go1.11+ and fetch the desired version using the go get command. For example:

go get k8s.io/client-go@v0.20.4

See INSTALL.md for detailed instructions and troubleshooting.

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

For details on how to correctly use a dependency management for installing client-go, please see INSTALL.md.

Contributing code

Please send pull requests against the client packages in the Kubernetes main repository. Changes in the staging area will be published to this repository every day.

Expand ▾ Collapse ▴

Directories

Path Synopsis
Package discovery provides ways to discover server-supported API groups, versions and resources.
Package discovery provides ways to discover server-supported API groups, versions and resources.
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.
dynamic-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.
fake-client
Package fakeclient contains examples on how to use fakeclient in tests.
Package fakeclient contains examples on how to use fakeclient in tests.
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.
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/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/admissionregistration/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/admissionregistration/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/admissionregistration/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/apiserverinternal/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/apiserverinternal/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/apps/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/apps/v1/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/apps/v1beta2
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/apps/v1beta2/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/v2beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/autoscaling/v2beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/autoscaling/v2beta2
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/autoscaling/v2beta2/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/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/batch/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/certificates/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/certificates/v1/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/coordination/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/coordination/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/coordination/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/coordination/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/discovery/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/discovery/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/discovery/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/discovery/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/events/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/events/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/events/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/events/v1beta1/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/flowcontrol/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/flowcontrol/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/flowcontrol/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/flowcontrol/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/networking/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/networking/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/node/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/node/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/node/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/node/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/node/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/node/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/policy/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/policy/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/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/rbac/v1/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/scheduling/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/scheduling/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/scheduling/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/scheduling/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
typed/scheduling/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/scheduling/v1beta1/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/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
typed/storage/v1alpha1/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
apis/clientauthentication/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.
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
Package scale provides a polymorphic scale client capable of fetching and updating Scale for any resource which implements the `scale` subresource, as long as that subresource operates on a version of scale convertable to autoscaling.Scale.
Package scale provides a polymorphic scale client capable of fetching and updating Scale for any resource which implements the `scale` subresource, as long as that subresource operates on a version of scale convertable to autoscaling.Scale.
fake
Package fake provides a fake client interface to arbitrary Kubernetes APIs that exposes common high level operations and exposes common metadata.
Package fake provides a fake client interface to arbitrary Kubernetes APIs that exposes common high level operations and exposes common metadata.
scheme
Package scheme contains a runtime.Scheme to be used for serializing and deserializing different versions of Scale, and for converting in between them.
Package scheme contains a runtime.Scheme to be used for serializing and deserializing different versions of Scale, and for converting in between them.
scheme/appsint
Package appsint contains the necessary scaffolding of the internal version of extensions as required by conversion logic.
Package appsint contains the necessary scaffolding of the internal version of extensions as required by conversion logic.
scheme/extensionsint
Package extensionsint contains the necessary scaffolding of the internal version of extensions as required by conversion logic.
Package extensionsint contains the necessary scaffolding of the internal version of extensions as required by conversion logic.
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.
auth/exec
Package exec contains helper utilities for exec credential plugins.
Package exec contains helper utilities for exec credential plugins.
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.
events
Package events has all client logic for recording and reporting "k8s.io/api/events/v1beta1".Event events.
Package events has all client logic for recording and reporting "k8s.io/api/events/v1beta1".Event events.
leaderelection
Package leaderelection implements leader election of a set of endpoints.
Package leaderelection implements leader election of a set of endpoints.
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 "k8s.io/api/core/v1".Event events.
Package record has all client logic for recording and reporting "k8s.io/api/core/v1".Event 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
connrotation
Package connrotation implements a connection dialer that tracks and can close all created connections.
Package connrotation implements a connection dialer that tracks and can close all created connections.
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/.
keyutil
Package keyutil contains utilities for managing public/private key pairs.
Package keyutil contains utilities for managing public/private key pairs.
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.