Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

kube

package module

Go to main page

Versions in this module

v2

v2.1.0

Oct 12, 2026

Changes in this version

+ const FieldManager

+ var PollInterval = 2 * time.Second

type Client

+ func (c *Client) ApplyBytes(ctx context.Context, defaultNamespace string, manifest []byte) error

+ func (c *Client) DeleteAll(ctx context.Context, namespace string, resources ...string) error

+ func (c *Client) Dynamic() (dynamic.Interface, error)

+ func (c *Client) ExecCommand(ctx context.Context, pod, container, namespace string, argv []string) (string, string, error)

+ func (c *Client) GetResource(ctx context.Context, resource, namespace, name string) (*unstructured.Unstructured, error)

+ func (c *Client) MergePatch(ctx context.Context, resource, namespace, name string, patch []byte) (*unstructured.Unstructured, error)

+ func (c *Client) PatchMetadata(ctx context.Context, resource, namespace, name string, p MetadataPatch) error

+ func (c *Client) RESTMapper() (meta.ResettableRESTMapper, error)

+ func (c *Client) WaitForPodsReady(ctx context.Context, namespace, selector string) error

+ type MetadataPatch struct

+ Annotations map[string]string

+ Labels map[string]string

+ RemoveAnnotations []string

+ RemoveLabels []string

v2.0.1

Jul 19, 2025

Changes in this version

+ const DefaultKubeConfigFileName

+ const DefaultKubeHomeDir

+ const DefaultTimeout

+ const EnvVarKubeConfig

+ const UsePersistentConfig

+ var ErrorMissingNamespace = errors.New("missing namespace")

+ func GetObjects(files ...string) ([]runtime.Object, error)

+ func Kubectl(cmdRaw []string) string

+ func LoadDefaultKubeConfig() (*clientcmdapi.Config, error)

+ func RetrievesDefaultKubeConfig() string

+ type Client struct

+ func FromKubeConfig() (*Client, error)

+ func FromKubeConfigWithKubeConn() (*Client, *kubernetes.Interface, error)

+ func New(cfg *Config) *Client

+ func NewDefault() *Client

+ func NewInCluster() *Client

+ func (c *Client) Apply(files ...string) error

+ func (c *Client) ApplyConfigMap(ctx context.Context, namespace, name string, data map[string]string) (*corev1.ConfigMap, error)

+ func (c *Client) ApplySecret(ctx context.Context, namespace, name string, data map[string]string) (*corev1.Secret, error)

+ func (c *Client) ApplySecretBytes(ctx context.Context, namespace, name string, data map[string][]byte) (*corev1.Secret, error)

+ func (c *Client) CreateClusterRole(ctx context.Context, role *rbacv1.ClusterRole) (*rbacv1.ClusterRole, error)

+ func (c *Client) CreateConfigMap(ctx context.Context, cm *corev1.ConfigMap) (*corev1.ConfigMap, error)

+ func (c *Client) CreateCronJob(ctx context.Context, cronjob *v1beta1.CronJob) (*v1beta1.CronJob, error)

+ func (c *Client) CreateDaemonSet(ctx context.Context, dsData *v1.DaemonSet) (*v1.DaemonSet, error)

+ func (c *Client) CreateDeployment(ctx context.Context, deploy *v1.Deployment) (*v1.Deployment, error)

+ func (c *Client) CreateIngress(ctx context.Context, ing *networkv1.Ingress) (*networkv1.Ingress, error)

+ func (c *Client) CreateIngressClass(ctx context.Context, ingc *networkv1.IngressClass) (*networkv1.IngressClass, error)

+ func (c *Client) CreateJob(ctx context.Context, jobData *batchv1.Job) (*batchv1.Job, error)

+ func (c *Client) CreateNamespace(ctx context.Context, namespace *corev1.Namespace) (*corev1.Namespace, error)

+ func (c *Client) CreatePod(ctx context.Context, pod *corev1.Pod) (*corev1.Pod, error)

+ func (c *Client) CreateRole(ctx context.Context, role *rbacv1.Role) (*rbacv1.Role, error)

+ func (c *Client) CreateSecret(ctx context.Context, secret *corev1.Secret) (*corev1.Secret, error)

+ func (c *Client) CreateService(ctx context.Context, svc *corev1.Service) (*corev1.Service, error)

+ func (c *Client) CreateServiceAccount(ctx context.Context, sa *corev1.ServiceAccount) (*corev1.ServiceAccount, error)

+ func (c *Client) CreateStatefulSet(ctx context.Context, statefulSet *v1.StatefulSet) (*v1.StatefulSet, error)

+ func (c *Client) Delete(files ...string) error

+ func (c *Client) DeleteClusterRole(ctx context.Context, name string) error

+ func (c *Client) DeleteConfigMap(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteCronJob(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteDaemonSet(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteDeployment(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteIngress(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteIngressClass(ctx context.Context, name string) error

+ func (c *Client) DeleteJob(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteNamespace(ctx context.Context, name string) error

+ func (c *Client) DeleteNode(ctx context.Context, name string) error

+ func (c *Client) DeletePod(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteRole(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteSecret(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteService(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteServiceAccount(ctx context.Context, namespace, name string) error

+ func (c *Client) DeleteStatefulSet(ctx context.Context, namespace, name string) error

+ func (c *Client) Dial() (kubernetes.Interface, error)

+ func (c *Client) DialMetrics() (*versioned.Clientset, error)

+ func (c *Client) Exec(pod, container, namespace, command string) (string, string, error)

+ func (c *Client) GetClusterRole(ctx context.Context, name string) (*rbacv1.ClusterRole, error)

+ func (c *Client) GetClusterRoles(ctx context.Context, label ...string) (*rbacv1.ClusterRoleList, error)

+ func (c *Client) GetConfigMap(ctx context.Context, namespace, name string) (*corev1.ConfigMap, error)

+ func (c *Client) GetConfigMaps(ctx context.Context, namespace string, label ...string) (*corev1.ConfigMapList, error)

+ func (c *Client) GetCronJob(ctx context.Context, namespace, name string) (*v1beta1.CronJob, error)

+ func (c *Client) GetCronJobs(ctx context.Context, namespace string, label ...string) (*v1beta1.CronJobList, error)

+ func (c *Client) GetDaemonSet(ctx context.Context, namespace, name string) (*v1.DaemonSet, error)

+ func (c *Client) GetDaemonSets(ctx context.Context, namespace string, label ...string) (*v1.DaemonSetList, error)

+ func (c *Client) GetDeployment(ctx context.Context, namespace, name string) (*v1.Deployment, error)

+ func (c *Client) GetDeployments(ctx context.Context, namespace string, label ...string) (*v1.DeploymentList, error)

+ func (c *Client) GetIngress(ctx context.Context, namespace, name string) (*networkv1.Ingress, error)

+ func (c *Client) GetIngressClass(ctx context.Context, name string) (*networkv1.IngressClass, error)

+ func (c *Client) GetIngressClasses(ctx context.Context, label ...string) (*networkv1.IngressClassList, error)

+ func (c *Client) GetIngresses(ctx context.Context, namespace string, label ...string) (*networkv1.IngressList, error)

+ func (c *Client) GetJob(ctx context.Context, namespace, name string) (*batchv1.Job, error)

+ func (c *Client) GetJobs(ctx context.Context, namespace string, label ...string) (*batchv1.JobList, error)

+ func (c *Client) GetKubeCli() kubernetes.Interface

+ func (c *Client) GetKubeConfig() *Config

+ func (c *Client) GetNamespace(ctx context.Context, name string) (*corev1.Namespace, error)

+ func (c *Client) GetNamespaces(ctx context.Context, label ...string) (*corev1.NamespaceList, error)

+ func (c *Client) GetNode(ctx context.Context, name string) (*corev1.Node, error)

+ func (c *Client) GetNodes(ctx context.Context, label ...string) (*corev1.NodeList, error)

+ func (c *Client) GetPod(ctx context.Context, namespace, name string) (*corev1.Pod, error)

+ func (c *Client) GetPods(ctx context.Context, namespace string, label ...string) (*corev1.PodList, error)

+ func (c *Client) GetRole(ctx context.Context, namespace, name string) (*rbacv1.Role, error)

+ func (c *Client) GetRoles(ctx context.Context, namespace string, label ...string) (*rbacv1.RoleList, error)

+ func (c *Client) GetSecret(ctx context.Context, namespace, name string) (*corev1.Secret, error)

+ func (c *Client) GetSecrets(ctx context.Context, namespace string, label ...string) (*corev1.SecretList, error)

+ func (c *Client) GetService(ctx context.Context, namespace, name string) (*corev1.Service, error)

+ func (c *Client) GetServiceAccount(ctx context.Context, namespace, name string) (*corev1.ServiceAccount, error)

+ func (c *Client) GetServiceAccounts(ctx context.Context, namespace string, label ...string) (*corev1.ServiceAccountList, error)

+ func (c *Client) GetServices(ctx context.Context, namespace string, label ...string) (*corev1.ServiceList, error)

+ func (c *Client) GetStatefulSet(ctx context.Context, namespace, name string) (*v1.StatefulSet, error)

+ func (c *Client) GetStatefulSets(ctx context.Context, namespace string, label ...string) (*v1.StatefulSetList, error)

+ func (c *Client) PatchConfigMap(ctx context.Context, namespace, name string, data []byte) (*corev1.ConfigMap, error)

+ func (c *Client) PatchSecret(ctx context.Context, namespace, name string, data []byte) (*corev1.Secret, error)

+ func (c *Client) ResourceClient(gv schema.GroupVersion) (rest.Interface, error)

+ func (c *Client) RestConfig() (*rest.Config, error)

+ func (c *Client) UpdateConfigMap(ctx context.Context, cm *corev1.ConfigMap) (*corev1.ConfigMap, error)

+ func (c *Client) UpdateSecret(ctx context.Context, secret *corev1.Secret) (*corev1.Secret, error)

+ func (c *Client) WithProxy(fn func(request *http.Request) (*url.URL, error)) *Client

+ type Config struct

+ func GetKubeConfig() *Config

+ func NewConfig(f *genericclioptions.ConfigFlags) *Config

+ func (c *Config) ClusterNameFromContext(context string) (string, error)

+ func (c *Config) ClusterNames() ([]string, error)

+ func (c *Config) ConfigAccess() (clientcmd.ConfigAccess, error)

+ func (c *Config) Contexts() (map[string]*clientcmdapi.Context, error)

+ func (c *Config) CurrentClusterName() (string, error)

+ func (c *Config) CurrentContextName() (string, error)

+ func (c *Config) CurrentNamespace() (string, error)

+ func (c *Config) CurrentUserName() (string, error)

+ func (c *Config) Flags() *genericclioptions.ConfigFlags

+ func (c *Config) GetCluster(name string) (*clientcmdapi.Cluster, error)

+ func (c *Config) GetContext(n string) (*clientcmdapi.Context, error)

+ func (c *Config) GetCredential(name string) (*clientcmdapi.AuthInfo, error)

+ func (c *Config) RESTConfig() (*rest.Config, error)

+ func (c *Config) RawConfig() (clientcmdapi.Config, error)

+ func (c *Config) RemoveCluster(name string) error

+ func (c *Config) RemoveContext(n string) error

+ func (c *Config) RemoveCredential(name string) error

+ func (c *Config) SetCluster(name string, cluster *clientcmdapi.Cluster) error

+ func (c *Config) SetContext(name string, ctx *clientcmdapi.Context) error

+ func (c *Config) SetCredential(name string, auth *clientcmdapi.AuthInfo) error

+ func (c *Config) Timeout() time.Duration

+ func (c *Config) UseContext(name string) error

+ type Operation int

+ const OperationApply

+ const OperationDelete

Other modules containing this package

github.com/benbenbang/kube