Package kubernetes-client

Kubernetes client tools

Kubernetes client tools like kubectl

General Commands (Section 1)
kubectl
kubectl controls the Kubernetes cluster manager. Find more information at ⟨https://github.com/kubernetes/kubernetes⟩.
kubectl-annotate
Update the annotations on one or more resources.
kubectl-api-versions
Print the supported API versions on the server, in the form of "group/version"
kubectl-apply
Apply a configuration to a resource by filename or stdin. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource...
kubectl-attach
Attach to a process that is already running inside an existing container.
kubectl-autoscale
Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. Looks up a Deployment, ReplicaSet, or...
kubectl-certificate
Modify certificate resources.
kubectl-certificate-approve
Approve a certificate signing request. kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a...
kubectl-certificate-deny
Deny a certificate signing request. kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate...
kubectl-cluster-info
Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl...
kubectl-cluster-info-dump
Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory...
kubectl-completion
Output shell completion code for the given shell (bash or zsh). This command prints shell code which must be evaluation to provide interactive completion of...
kubectl-config
Modify kubeconfig files
kubectl-config-current-context
Displays the current-context
kubectl-config-delete-cluster
Delete the specified cluster from the kubeconfig
kubectl-config-delete-context
Delete the specified context from the kubeconfig
kubectl-config-get-clusters
Display clusters defined in the kubeconfig
kubectl-config-get-contexts
Displays one or many contexts from the kubeconfig file.
kubectl-config-set
Sets an individual value in a kubeconfig file PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys...
kubectl-config-set-cluster
Sets a cluster entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields.
kubectl-config-set-context
Sets a context entry in kubeconfig Specifying a name that already exists will merge new fields on top of existing values for those fields.
kubectl-config-set-credentials
Sets a user entry in kubeconfig Specifying a name that already exists will merge new fields on top of existing values. Client-certificate flags...
kubectl-config-unset
Unsets an individual value in a kubeconfig file PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map...
kubectl-config-use-context
Sets the current-context in a kubeconfig file
kubectl-config-view
Display merged kubeconfig settings or a specified kubeconfig file. You can use --output jsonpath={...} to extract specific values using a jsonpath expression.
kubectl-convert
Convert config files between different API versions. Both YAML and JSON formats are accepted. The command takes filename, directory, or URL as input, and...
kubectl-cordon
Mark node as unschedulable.
kubectl-cp
Copy files and directories to and from containers.
kubectl-create
Create a resource by filename or stdin. JSON and YAML formats are accepted.
kubectl-create-configmap
Create a configmap based on a file, directory, or specified literal value. A single configmap may package one or more key/value pairs. When creating a configmap...
kubectl-create-deployment
Create a deployment with the specified name.
kubectl-create-namespace
Create a namespace with the specified name.
kubectl-create-quota
Create a resourcequota with the specified name, hard limits and optional scopes
kubectl-create-secret
Create a secret using specified subcommand.
kubectl-create-secret-docker-registry
Create a new secret for use with Docker registries. Dockercfg secrets are used to authenticate against Docker registries. When using the Docker command line to...
kubectl-create-secret-generic
Create a secret based on a file, directory, or specified literal value. A single secret may package one or more key/value pairs. When creating a secret based on...
kubectl-create-secret-tls
Create a TLS secret from the given public/private key pair. The public/private key pair must exist before hand. The public key certificate must be .PEM encoded...
kubectl-create-service
Create a service using specified subcommand.
kubectl-create-serviceaccount
Create a service account with the specified name.
kubectl-create-service-clusterip
Create a clusterIP service with the specified name.
kubectl-create-service-loadbalancer
Create a LoadBalancer service with the specified name.
kubectl-create-service-nodeport
Create a nodeport service with the specified name.
kubectl-delete
Delete resources by filenames, stdin, resources and names, or by resources and label selector. JSON and YAML formats are accepted. Only one type of the...
kubectl-describe
Show details of a specific resource or group of resources. This command joins many API calls together to form a detailed description of a given resource or...
kubectl-drain
Drain node in preparation for maintenance. The given node will be marked unschedulable to prevent new pods from arriving. 'drain' evicts the pods if the...
kubectl-edit
Edit a resource from the default editor. The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open...
kubectl-exec
Execute a command in a container.
kubectl-explain
Documentation of resources.
kubectl-expose
Expose a resource as a new Kubernetes service. Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector for that...
kubectl-get
Display one or many resources.
kubectl-label
Update the labels on a resource.
kubectl-logs
Print the logs for a container in a pod. If the pod has only one container, the container name is optional.
kubectl-options
kubectl options [OPTIONS]
kubectl-patch
Update field(s) of a resource using strategic merge patch JSON and YAML formats are accepted. Please refer to the models in...
kubectl-port-forward
Forward one or more local ports to a pod.
kubectl-proxy
To proxy all of the kubernetes api and nothing else, use: $ kubectl proxy --api-prefix=/ To proxy only part of the kubernetes api and also some static files: $...
kubectl-replace
Replace a resource by filename or stdin. JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided...
kubectl-rolling-update
Perform a rolling update of the given ReplicationController. Replaces the specified replication controller with a new replication controller by updating one pod...
kubectl-rollout
Manage a deployment using subcommands like "kubectl rollout undo deployment/abc"
kubectl-rollout-history
View previous rollout revisions and configurations.
kubectl-rollout-pause
Mark the provided resource as paused Paused resources will not be reconciled by a controller. Use \"kubectl rollout resume \" to resume a paused resource...
kubectl-rollout-resume
Resume a paused resource Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. Currently only...
kubectl-rollout-status
Show the status of the rollout. By default 'rollout status' will watch the status of the latest rollout until it's done. If you don't want to wait for the...
kubectl-rollout-undo
Rollback to a previous rollout.
kubectl-run
Create and run a particular image, possibly replicated. Creates a deployment or job to manage the created container(s).
kubectl-scale
Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. Scale also allows users to specify one or more preconditions for the scale action...
kubectl-set
Configure application resources These commands help you make changes to existing application resources.
kubectl-set-image
Update existing container image(s) of resources. Possible resources include (case insensitive): pod (po), replicationcontroller (rc), deployment (deploy)...
kubectl-set-resources
Specify compute resource requirements (cpu, memory) for any resource that defines a pod template. If a pod is successfully scheduled, it is guaranteed the...
kubectl-stop
Deprecated: This command is deprecated, all its functionalities are covered by "kubectl delete"
kubectl-taint
Update the taints on one or more nodes.
kubectl-top
Display Resource (CPU/Memory/Storage) usage. The top command allows you to see the resource consumption for nodes or pods.
kubectl-top-node
Display Resource (CPU/Memory/Storage) usage of nodes. The top-node command allows you to see the resource consumption of nodes.
kubectl-top-pod
Display Resource (CPU/Memory/Storage) usage of pods. The 'top pod' command allows you to see the resource consumption of pods. Due to the metrics pipeline...
kubectl-uncordon
Mark node as schedulable.
kubectl-version
Print the client and server version information