Cake.Kubectl

Kubectl Addin for Cake Deployment Automation System. 

#addin nuget:?package=Cake.Kubectl&version=1.1.0

dotnet add package Cake.Kubectl --version 1.1.0

<PackageReference Include="Cake.Kubectl" Version="1.1.0" />

Aliases

Contains functionality for working with Kubectl commands.

General

KubectlAnnotate(KubectlAnnotateSettings) Update the annotations on one or more resources. All Kubernetes objects support the ability to store additional data with the object as annotations. Annotations are key/value pairs that can be larger than labels and include arbitrary string values such as structured JSON. Tools and system extensions may use annotations to store their own data. Attempting to set an annotation that already exists will fail unless --overwrite is set. If --resource-version is specified and does not match the current resource version on the server the command will fail.
KubectlAnnotateWithResult(KubectlAnnotateSettings) Update the annotations on one or more resources. All Kubernetes objects support the ability to store additional data with the object as annotations. Annotations are key/value pairs that can be larger than labels and include arbitrary string values such as structured JSON. Tools and system extensions may use annotations to store their own data. Attempting to set an annotation that already exists will fail unless --overwrite is set. If --resource-version is specified and does not match the current resource version on the server the command will fail.
KubectlApiResources(KubectlApiResourcesSettings) Print the supported API resources on the server.
KubectlApiResourcesWithResult(KubectlApiResourcesSettings) Print the supported API resources on the server.
KubectlApiVersions(KubectlApiVersionsSettings) Print the supported API versions on the server, in the form of "group/version".
KubectlApiVersionsWithResult(KubectlApiVersionsSettings) Print the supported API versions on the server, in the form of "group/version".
KubectlApply(KubectlApplySettings) Apply a configuration to a resource by file name or stdin. The resource name must be specified. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'. JSON and YAML formats are accepted. Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.
KubectlApplyEditLastApplied(KubectlApplyEditLastAppliedSettings) Edit the latest last-applied-configuration annotations of resources from the default editor. The edit-last-applied command allows you to directly edit any API resource you can retrieve via the command-line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts file names as well as command-line arguments, although the files you point to must be previously saved versions of resources. The default format is YAML. To edit in JSON, specify "-o json". The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.
KubectlApplyEditLastAppliedWithResult(KubectlApplyEditLastAppliedSettings) Edit the latest last-applied-configuration annotations of resources from the default editor. The edit-last-applied command allows you to directly edit any API resource you can retrieve via the command-line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts file names as well as command-line arguments, although the files you point to must be previously saved versions of resources. The default format is YAML. To edit in JSON, specify "-o json". The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.
KubectlApplySetLastApplied(KubectlApplySetLastAppliedSettings) Set the latest last-applied-configuration annotations by setting it to match the contents of a file. This results in the last-applied-configuration being updated as though 'kubectl apply -f<file> ' was run, without updating any other parts of the object.
KubectlApplySetLastAppliedWithResult(KubectlApplySetLastAppliedSettings) Set the latest last-applied-configuration annotations by setting it to match the contents of a file. This results in the last-applied-configuration being updated as though 'kubectl apply -f<file> ' was run, without updating any other parts of the object.
KubectlApplyViewLastApplied(KubectlApplyViewLastAppliedSettings) View the latest last-applied-configuration annotations by type/name or file. The default output will be printed to stdout in YAML format. You can use the -o option to change the output format.
KubectlApplyViewLastAppliedWithResult(KubectlApplyViewLastAppliedSettings) View the latest last-applied-configuration annotations by type/name or file. The default output will be printed to stdout in YAML format. You can use the -o option to change the output format.
KubectlApplyWithResult(KubectlApplySettings) Apply a configuration to a resource by file name or stdin. The resource name must be specified. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'. JSON and YAML formats are accepted. Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.
KubectlAttach(KubectlAttachSettings) Attach to a process that is already running inside an existing container.
KubectlAttachWithResult(KubectlAttachSettings) Attach to a process that is already running inside an existing container.
KubectlAuth(KubectlAuthSettings) Inspect authorization
KubectlAuthCanI(KubectlAuthCanISettings) Check whether an action is allowed. VERB is a logical Kubernetes API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubernetes resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL that starts with "/". NAME is the name of a particular Kubernetes resource. This command pairs nicely with impersonation. See --as global flag.
KubectlAuthCanIWithResult(KubectlAuthCanISettings) Check whether an action is allowed. VERB is a logical Kubernetes API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubernetes resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL that starts with "/". NAME is the name of a particular Kubernetes resource. This command pairs nicely with impersonation. See --as global flag.
KubectlAuthReconcile(KubectlAuthReconcileSettings) Reconciles rules for RBAC role, role binding, cluster role, and cluster role binding objects. Missing objects are created, and the containing namespace is created for namespaced objects, if required. Existing roles are updated to include the permissions in the input objects, and remove extra permissions if --remove-extra-permissions is specified. Existing bindings are updated to include the subjects in the input objects, and remove extra subjects if --remove-extra-subjects is specified. This is preferred to 'apply' for RBAC resources so that semantically-aware merging of rules and subjects is done.
KubectlAuthReconcileWithResult(KubectlAuthReconcileSettings) Reconciles rules for RBAC role, role binding, cluster role, and cluster role binding objects. Missing objects are created, and the containing namespace is created for namespaced objects, if required. Existing roles are updated to include the permissions in the input objects, and remove extra permissions if --remove-extra-permissions is specified. Existing bindings are updated to include the subjects in the input objects, and remove extra subjects if --remove-extra-subjects is specified. This is preferred to 'apply' for RBAC resources so that semantically-aware merging of rules and subjects is done.
KubectlAuthWhoami(KubectlAuthWhoamiSettings) Experimental: Check who you are and your attributes (groups, extra). This command is helpful to get yourself aware of the current user attributes, especially when dynamic authentication, e.g., token webhook, auth proxy, or OIDC provider, is enabled in the Kubernetes cluster.
KubectlAuthWhoamiWithResult(KubectlAuthWhoamiSettings) Experimental: Check who you are and your attributes (groups, extra). This command is helpful to get yourself aware of the current user attributes, especially when dynamic authentication, e.g., token webhook, auth proxy, or OIDC provider, is enabled in the Kubernetes cluster.
KubectlAuthWithResult(KubectlAuthSettings) Inspect authorization
KubectlAutoscale(KubectlAutoscaleSettings) Creates an autoscaler that automatically chooses and sets the number of pods that run in a Kubernetes cluster. Looks up a deployment, replica set, stateful set, or replication controller by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.
KubectlAutoscaleWithResult(KubectlAutoscaleSettings) Creates an autoscaler that automatically chooses and sets the number of pods that run in a Kubernetes cluster. Looks up a deployment, replica set, stateful set, or replication controller by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.
KubectlCertificate(KubectlCertificateSettings) Modify certificate resources.
KubectlCertificateApprove(KubectlCertificateApproveSettings) Approve a certificate signing request. kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR. SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.
KubectlCertificateApproveWithResult(KubectlCertificateApproveSettings) Approve a certificate signing request. kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR. SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.
KubectlCertificateDeny(KubectlCertificateDenySettings) Deny a certificate signing request. kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor.
KubectlCertificateDenyWithResult(KubectlCertificateDenySettings) Deny a certificate signing request. kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor.
KubectlCertificateWithResult(KubectlCertificateSettings) Modify certificate resources.
KubectlClusterInfo(KubectlClusterInfoSettings) Display addresses of the control plane and services with label kubernetes.io/cluster-service=true. To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
KubectlClusterInfoDump(KubectlClusterInfoDumpSettings) Dump cluster information out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, Kubernetes will build a set of files in that directory. By default, only dumps things in the current namespace and 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. The command also dumps the logs of all of the pods in the cluster; these logs are dumped into different directories based on namespace and pod name.
KubectlClusterInfoDumpWithResult(KubectlClusterInfoDumpSettings) Dump cluster information out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, Kubernetes will build a set of files in that directory. By default, only dumps things in the current namespace and 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. The command also dumps the logs of all of the pods in the cluster; these logs are dumped into different directories based on namespace and pod name.
KubectlClusterInfoWithResult(KubectlClusterInfoSettings) Display addresses of the control plane and services with label kubernetes.io/cluster-service=true. To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
KubectlCompletion(KubectlCompletionSettings) Output shell completion code for the specified shell (bash, zsh, fish, or powershell). The shell code must be evaluated to provide interactive completion of kubectl commands. This can be done by sourcing it from the .bash_profile. Detailed instructions on how to do this are available here: for macOS: https://kubernetes.io/docs/tasks/tools/install-kubectl-macos/#enable-shell-autocompletion for linux: https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#enable-shell-autocompletion for windows: https://kubernetes.io/docs/tasks/tools/install-kubectl-windows/#enable-shell-autocompletion Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2.
KubectlCompletionWithResult(KubectlCompletionSettings) Output shell completion code for the specified shell (bash, zsh, fish, or powershell). The shell code must be evaluated to provide interactive completion of kubectl commands. This can be done by sourcing it from the .bash_profile. Detailed instructions on how to do this are available here: for macOS: https://kubernetes.io/docs/tasks/tools/install-kubectl-macos/#enable-shell-autocompletion for linux: https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#enable-shell-autocompletion for windows: https://kubernetes.io/docs/tasks/tools/install-kubectl-windows/#enable-shell-autocompletion Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2.
KubectlConfig(KubectlConfigSettings) Modify kubeconfig files using subcommands like "kubectl config set current-context my-context" The loading order follows these rules: 1. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place. 2. If $KUBECONFIG environment variable is set, then it is used as a list of paths (normal path delimiting rules for your system). These paths are merged. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list. 3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.
KubectlConfigCurrentContext(KubectlConfigCurrentContextSettings) Display the current-context.
KubectlConfigCurrentContextWithResult(KubectlConfigCurrentContextSettings) Display the current-context.
KubectlConfigDeleteCluster(KubectlConfigDeleteClusterSettings) Delete the specified cluster from the kubeconfig.
KubectlConfigDeleteClusterWithResult(KubectlConfigDeleteClusterSettings) Delete the specified cluster from the kubeconfig.
KubectlConfigDeleteContext(KubectlConfigDeleteContextSettings) Delete the specified context from the kubeconfig.
KubectlConfigDeleteContextWithResult(KubectlConfigDeleteContextSettings) Delete the specified context from the kubeconfig.
KubectlConfigDeleteUser(KubectlConfigDeleteUserSettings) Delete the specified user from the kubeconfig.
KubectlConfigDeleteUserWithResult(KubectlConfigDeleteUserSettings) Delete the specified user from the kubeconfig.
KubectlConfigGetClusters(KubectlConfigGetClustersSettings) Display clusters defined in the kubeconfig.
KubectlConfigGetClustersWithResult(KubectlConfigGetClustersSettings) Display clusters defined in the kubeconfig.
KubectlConfigGetContexts(KubectlConfigGetContextsSettings) Display one or many contexts from the kubeconfig file.
KubectlConfigGetContextsWithResult(KubectlConfigGetContextsSettings) Display one or many contexts from the kubeconfig file.
KubectlConfigGetUsers(KubectlConfigGetUsersSettings) Display users defined in the kubeconfig.
KubectlConfigGetUsersWithResult(KubectlConfigGetUsersSettings) Display users defined in the kubeconfig.
KubectlConfigRenameContext(KubectlConfigRenameContextSettings) Renames a context from the kubeconfig file. CONTEXT_NAME is the context name that you want to change. NEW_NAME is the new name you want to set. Note: If the context being renamed is the 'current-context', this field will also be updated.
KubectlConfigRenameContextWithResult(KubectlConfigRenameContextSettings) Renames a context from the kubeconfig file. CONTEXT_NAME is the context name that you want to change. NEW_NAME is the new name you want to set. Note: If the context being renamed is the 'current-context', this field will also be updated.
KubectlConfigSet(KubectlConfigSetSettings) Set 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 may not contain dots. PROPERTY_VALUE is the new value you want to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used. Specifying an attribute name that already exists will merge new fields on top of existing values.
KubectlConfigSetCluster(KubectlConfigSetClusterSettings) Set a cluster entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields.
KubectlConfigSetClusterWithResult(KubectlConfigSetClusterSettings) Set a cluster entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields.
KubectlConfigSetContext(KubectlConfigSetContextSettings) Set a context entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields.
KubectlConfigSetContextWithResult(KubectlConfigSetContextSettings) Set a context entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields.
KubectlConfigSetCredentials(KubectlConfigSetCredentialsSettings) Set a user entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values. Client-certificate flags: --client-certificate=certfile --client-key=keyfile Bearer token flags: --token=bearer_token Basic auth flags: --username=basic_user --password=basic_password Bearer token and basic auth are mutually exclusive.
KubectlConfigSetCredentialsWithResult(KubectlConfigSetCredentialsSettings) Set a user entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values. Client-certificate flags: --client-certificate=certfile --client-key=keyfile Bearer token flags: --token=bearer_token Basic auth flags: --username=basic_user --password=basic_password Bearer token and basic auth are mutually exclusive.
KubectlConfigSetWithResult(KubectlConfigSetSettings) Set 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 may not contain dots. PROPERTY_VALUE is the new value you want to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used. Specifying an attribute name that already exists will merge new fields on top of existing values.
KubectlConfigUnset(KubectlConfigUnsetSettings) Unset 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 may not contain dots.
KubectlConfigUnsetWithResult(KubectlConfigUnsetSettings) Unset 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 may not contain dots.
KubectlConfigUseContext(KubectlConfigUseContextSettings) Set the current-context in a kubeconfig file.
KubectlConfigUseContextWithResult(KubectlConfigUseContextSettings) Set the current-context in a kubeconfig file.
KubectlConfigView(KubectlConfigViewSettings) Display merged kubeconfig settings or a specified kubeconfig file. You can use --output jsonpath={...} to extract specific values using a jsonpath expression.
KubectlConfigViewWithResult(KubectlConfigViewSettings) Display merged kubeconfig settings or a specified kubeconfig file. You can use --output jsonpath={...} to extract specific values using a jsonpath expression.
KubectlConfigWithResult(KubectlConfigSettings) Modify kubeconfig files using subcommands like "kubectl config set current-context my-context" The loading order follows these rules: 1. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place. 2. If $KUBECONFIG environment variable is set, then it is used as a list of paths (normal path delimiting rules for your system). These paths are merged. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list. 3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.
KubectlCordon(KubectlCordonSettings) Mark node as unschedulable.
KubectlCordonWithResult(KubectlCordonSettings) Mark node as unschedulable.
KubectlCp(KubectlCpSettings) Copy files and directories to and from containers.
KubectlCpWithResult(KubectlCpSettings) Copy files and directories to and from containers.
KubectlCreate(KubectlCreateSettings) Create a resource from a file or from stdin. JSON and YAML formats are accepted.
KubectlCreateClusterrole(KubectlCreateClusterroleSettings) Create a cluster role.
KubectlCreateClusterrolebinding(KubectlCreateClusterrolebindingSettings) Create a cluster role binding for a particular cluster role.
KubectlCreateClusterrolebindingWithResult(KubectlCreateClusterrolebindingSettings) Create a cluster role binding for a particular cluster role.
KubectlCreateClusterroleWithResult(KubectlCreateClusterroleSettings) Create a cluster role.
KubectlCreateConfigmap(KubectlCreateConfigmapSettings) Create a config map based on a file, directory, or specified literal value. A single config map may package one or more key/value pairs. When creating a config map based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key. When creating a config map based on a directory, each file whose basename is a valid key in the directory will be packaged into the config map. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
KubectlCreateConfigmapWithResult(KubectlCreateConfigmapSettings) Create a config map based on a file, directory, or specified literal value. A single config map may package one or more key/value pairs. When creating a config map based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key. When creating a config map based on a directory, each file whose basename is a valid key in the directory will be packaged into the config map. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
KubectlCreateCronjob(KubectlCreateCronjobSettings) Create a cron job with the specified name.
KubectlCreateCronjobWithResult(KubectlCreateCronjobSettings) Create a cron job with the specified name.
KubectlCreateDeployment(KubectlCreateDeploymentSettings) Create a deployment with the specified name.
KubectlCreateDeploymentWithResult(KubectlCreateDeploymentSettings) Create a deployment with the specified name.
KubectlCreateIngress(KubectlCreateIngressSettings) Create an ingress with the specified name.
KubectlCreateIngressWithResult(KubectlCreateIngressSettings) Create an ingress with the specified name.
KubectlCreateJob(KubectlCreateJobSettings) Create a job with the specified name.
KubectlCreateJobWithResult(KubectlCreateJobSettings) Create a job with the specified name.
KubectlCreateNamespace(KubectlCreateNamespaceSettings) Create a namespace with the specified name.
KubectlCreateNamespaceWithResult(KubectlCreateNamespaceSettings) Create a namespace with the specified name.
KubectlCreatePoddisruptionbudget(KubectlCreatePoddisruptionbudgetSettings) Create a pod disruption budget with the specified name, selector, and desired minimum available pods.
KubectlCreatePoddisruptionbudgetWithResult(KubectlCreatePoddisruptionbudgetSettings) Create a pod disruption budget with the specified name, selector, and desired minimum available pods.
KubectlCreatePriorityclass(KubectlCreatePriorityclassSettings) Create a priority class with the specified name, value, globalDefault and description.
KubectlCreatePriorityclassWithResult(KubectlCreatePriorityclassSettings) Create a priority class with the specified name, value, globalDefault and description.
KubectlCreateQuota(KubectlCreateQuotaSettings) Create a resource quota with the specified name, hard limits, and optional scopes.
KubectlCreateQuotaWithResult(KubectlCreateQuotaSettings) Create a resource quota with the specified name, hard limits, and optional scopes.
KubectlCreateRole(KubectlCreateRoleSettings) Create a role with single rule.
KubectlCreateRolebinding(KubectlCreateRolebindingSettings) Create a role binding for a particular role or cluster role.
KubectlCreateRolebindingWithResult(KubectlCreateRolebindingSettings) Create a role binding for a particular role or cluster role.
KubectlCreateRoleWithResult(KubectlCreateRoleSettings) Create a role with single rule.
KubectlCreateSecret(KubectlCreateSecretSettings) Create a secret using specified subcommand.
KubectlCreateSecretDockerRegistry(KubectlCreateSecretDockerRegistrySettings) 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 push images, you can authenticate to a given registry by running: '$ docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'. That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry. The email address is optional. When creating applications, you may have a Docker registry that requires authentication. In order for the nodes to pull images on your behalf, they must have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account.
KubectlCreateSecretDockerRegistryWithResult(KubectlCreateSecretDockerRegistrySettings) 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 push images, you can authenticate to a given registry by running: '$ docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'. That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry. The email address is optional. When creating applications, you may have a Docker registry that requires authentication. In order for the nodes to pull images on your behalf, they must have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account.
KubectlCreateSecretGeneric(KubectlCreateSecretGenericSettings) 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 a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key or you wish to chose your own, you may specify an alternate key. When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
KubectlCreateSecretGenericWithResult(KubectlCreateSecretGenericSettings) 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 a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key or you wish to chose your own, you may specify an alternate key. When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
KubectlCreateSecretTls(KubectlCreateSecretTlsSettings) Create a TLS secret from the given public/private key pair. The public/private key pair must exist beforehand. The public key certificate must be .PEM encoded and match the given private key.
KubectlCreateSecretTlsWithResult(KubectlCreateSecretTlsSettings) Create a TLS secret from the given public/private key pair. The public/private key pair must exist beforehand. The public key certificate must be .PEM encoded and match the given private key.
KubectlCreateSecretWithResult(KubectlCreateSecretSettings) Create a secret using specified subcommand.
KubectlCreateService(KubectlCreateServiceSettings) Create a service using a specified subcommand.
KubectlCreateServiceaccount(KubectlCreateServiceaccountSettings) Create a service account with the specified name.
KubectlCreateServiceaccountWithResult(KubectlCreateServiceaccountSettings) Create a service account with the specified name.
KubectlCreateServiceClusterip(KubectlCreateServiceClusteripSettings) Create a ClusterIP service with the specified name.
KubectlCreateServiceClusteripWithResult(KubectlCreateServiceClusteripSettings) Create a ClusterIP service with the specified name.
KubectlCreateServiceExternalname(KubectlCreateServiceExternalnameSettings) Create an ExternalName service with the specified name. ExternalName service references to an external DNS address instead of only pods, which will allow application authors to reference services that exist off platform, on other clusters, or locally.
KubectlCreateServiceExternalnameWithResult(KubectlCreateServiceExternalnameSettings) Create an ExternalName service with the specified name. ExternalName service references to an external DNS address instead of only pods, which will allow application authors to reference services that exist off platform, on other clusters, or locally.
KubectlCreateServiceLoadbalancer(KubectlCreateServiceLoadbalancerSettings) Create a LoadBalancer service with the specified name.
KubectlCreateServiceLoadbalancerWithResult(KubectlCreateServiceLoadbalancerSettings) Create a LoadBalancer service with the specified name.
KubectlCreateServiceNodeport(KubectlCreateServiceNodeportSettings) Create a NodePort service with the specified name.
KubectlCreateServiceNodeportWithResult(KubectlCreateServiceNodeportSettings) Create a NodePort service with the specified name.
KubectlCreateServiceWithResult(KubectlCreateServiceSettings) Create a service using a specified subcommand.
KubectlCreateToken(KubectlCreateTokenSettings) Request a service account token.
KubectlCreateTokenWithResult(KubectlCreateTokenSettings) Request a service account token.
KubectlCreateWithResult(KubectlCreateSettings) Create a resource from a file or from stdin. JSON and YAML formats are accepted.
KubectlDelete(KubectlDeleteSettings) Delete resources by file names, stdin, resources and names, or by resources and label selector. JSON and YAML formats are accepted. Only one type of argument may be specified: file names, resources and names, or resources and label selector. Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must specify the --force flag. Note: only a subset of resources support graceful deletion. In absence of the support, the --grace-period flag is ignored. IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods, the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately. Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource. After a CustomResourceDefinition is deleted, invalidation of discovery cache may take up to 6 hours. If you don't want to wait, you might want to run "kubectl api-resources" to refresh the discovery cache.
KubectlDeleteWithResult(KubectlDeleteSettings) Delete resources by file names, stdin, resources and names, or by resources and label selector. JSON and YAML formats are accepted. Only one type of argument may be specified: file names, resources and names, or resources and label selector. Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must specify the --force flag. Note: only a subset of resources support graceful deletion. In absence of the support, the --grace-period flag is ignored. IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods, the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately. Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource. After a CustomResourceDefinition is deleted, invalidation of discovery cache may take up to 6 hours. If you don't want to wait, you might want to run "kubectl api-resources" to refresh the discovery cache.
KubectlDescribe(KubectlDescribeSettings) Show details of a specific resource or group of resources. Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example: $ kubectl describe TYPE NAME_PREFIX will first check for an exact match on TYPE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX.
KubectlDescribeWithResult(KubectlDescribeSettings) Show details of a specific resource or group of resources. Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example: $ kubectl describe TYPE NAME_PREFIX will first check for an exact match on TYPE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX.
KubectlDiff(KubectlDiffSettings) Diff configurations specified by file name or stdin between the current online configuration, and the configuration as it would be if applied. The output is always YAML. KUBECTL_EXTERNAL_DIFF environment variable can be used to select your own diff command. Users can use external commands with params too, example: KUBECTL_EXTERNAL_DIFF="colordiff -N -u" By default, the "diff" command available in your path will be run with the "-u" (unified diff) and "-N" (treat absent files as empty) options. Exit status: 0 No differences were found. 1 Differences were found. >1 Kubectl or diff failed with an error. Note: KUBECTL_EXTERNAL_DIFF, if used, is expected to follow that convention.
KubectlDiffWithResult(KubectlDiffSettings) Diff configurations specified by file name or stdin between the current online configuration, and the configuration as it would be if applied. The output is always YAML. KUBECTL_EXTERNAL_DIFF environment variable can be used to select your own diff command. Users can use external commands with params too, example: KUBECTL_EXTERNAL_DIFF="colordiff -N -u" By default, the "diff" command available in your path will be run with the "-u" (unified diff) and "-N" (treat absent files as empty) options. Exit status: 0 No differences were found. 1 Differences were found. >1 Kubectl or diff failed with an error. Note: KUBECTL_EXTERNAL_DIFF, if used, is expected to follow that convention.
KubectlDrain(KubectlDrainSettings) 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 API server supports https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ eviction https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ . Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server). If there are daemon set-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any daemon set-managed pods, because those pods would be immediately replaced by the daemon set controller, which ignores unschedulable markings. If there are any pods that are neither mirror pods nor managed by a replication controller, replica set, daemon set, stateful set, or job, then drain will not delete any pods unless you use --force. --force will also allow deletion to proceed if the managing resource of one or more pods is missing. 'drain' waits for graceful termination. You should not operate on the machine until the command completes. When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again.
KubectlDrainWithResult(KubectlDrainSettings) 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 API server supports https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ eviction https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ . Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server). If there are daemon set-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any daemon set-managed pods, because those pods would be immediately replaced by the daemon set controller, which ignores unschedulable markings. If there are any pods that are neither mirror pods nor managed by a replication controller, replica set, daemon set, stateful set, or job, then drain will not delete any pods unless you use --force. --force will also allow deletion to proceed if the managing resource of one or more pods is missing. 'drain' waits for graceful termination. You should not operate on the machine until the command completes. When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again.
KubectlEdit(KubectlEditSettings) 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 the editor defined by your KUBE_EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts file names as well as command-line arguments, although the files you point to must be previously saved versions of resources. Editing is done with the API version used to fetch the resource. To edit using a specific API version, fully-qualify the resource, version, and group. The default format is YAML. To edit in JSON, specify "-o json". The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.
KubectlEditWithResult(KubectlEditSettings) 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 the editor defined by your KUBE_EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts file names as well as command-line arguments, although the files you point to must be previously saved versions of resources. Editing is done with the API version used to fetch the resource. To edit using a specific API version, fully-qualify the resource, version, and group. The default format is YAML. To edit in JSON, specify "-o json". The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.
KubectlEvents(KubectlEventsSettings) Display events Prints a table of the most important information about events. You can request events for a namespace, for all namespace, or filtered to only those pertaining to a specified resource.
KubectlEventsWithResult(KubectlEventsSettings) Display events Prints a table of the most important information about events. You can request events for a namespace, for all namespace, or filtered to only those pertaining to a specified resource.
KubectlExec(KubectlExecSettings) Execute a command in a container.
KubectlExecWithResult(KubectlExecSettings) Execute a command in a container.
KubectlExplain(KubectlExplainSettings) List the fields for supported resources. This command describes the fields associated with each supported API resource. Fields are identified via a simple JSONPath identifier: <type>.<fieldName>[.<fieldName>] Add the --recursive flag to display all of the fields at once without descriptions. Information about each field is retrieved from the server in OpenAPI format.
KubectlExplainWithResult(KubectlExplainSettings) List the fields for supported resources. This command describes the fields associated with each supported API resource. Fields are identified via a simple JSONPath identifier: <type>.<fieldName>[.<fieldName>] Add the --recursive flag to display all of the fields at once without descriptions. Information about each field is retrieved from the server in OpenAPI format.
KubectlExpose(KubectlExposeSettings) 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 resource as the selector for a new service on the specified port. A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports, i.e. when the selector contains only the matchLabels component. Note that if no port is specified via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no labels are specified, the new service will re-use the labels from the resource it exposes. Possible resources include (case insensitive): pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)
KubectlExposeWithResult(KubectlExposeSettings) 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 resource as the selector for a new service on the specified port. A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports, i.e. when the selector contains only the matchLabels component. Note that if no port is specified via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no labels are specified, the new service will re-use the labels from the resource it exposes. Possible resources include (case insensitive): pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)
KubectlGet(KubectlGetSettings) Display one or many resources. Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the --selector flag. If the desired resource type is namespaced you will only see results in your current namespace unless you pass --all-namespaces. By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resources.
KubectlGetWithResult(KubectlGetSettings) Display one or many resources. Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the --selector flag. If the desired resource type is namespaced you will only see results in your current namespace unless you pass --all-namespaces. By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resources.
KubectlKustomize(KubectlKustomizeSettings) Build a set of KRM resources using a 'kustomization.yaml' file. The DIR argument must be a path to a directory containing 'kustomization.yaml', or a git repository URL with a path suffix specifying same with respect to the repository root. If DIR is omitted, '.' is assumed.
KubectlKustomizeWithResult(KubectlKustomizeSettings) Build a set of KRM resources using a 'kustomization.yaml' file. The DIR argument must be a path to a directory containing 'kustomization.yaml', or a git repository URL with a path suffix specifying same with respect to the repository root. If DIR is omitted, '.' is assumed.
KubectlLabel(KubectlLabelSettings) Update the labels on a resource. * A label key and value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters each. * Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app. * If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error. * If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
KubectlLabelWithResult(KubectlLabelSettings) Update the labels on a resource. * A label key and value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters each. * Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app. * If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error. * If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
KubectlLogs(KubectlLogsSettings) Print the logs for a container in a pod or specified resource. If the pod has only one container, the container name is optional.
KubectlLogsWithResult(KubectlLogsSettings) Print the logs for a container in a pod or specified resource. If the pod has only one container, the container name is optional.
KubectlPatch(KubectlPatchSettings) Update fields of a resource using strategic merge patch, a JSON merge patch, or a JSON patch. JSON and YAML formats are accepted. Note: Strategic merge patch is not supported for custom resources.
KubectlPatchWithResult(KubectlPatchSettings) Update fields of a resource using strategic merge patch, a JSON merge patch, or a JSON patch. JSON and YAML formats are accepted. Note: Strategic merge patch is not supported for custom resources.
KubectlPlugin(KubectlPluginSettings) Provides utilities for interacting with plugins. Plugins provide extended functionality that is not part of the major command-line distribution. Please refer to the documentation and examples for more information about how write your own plugins. The easiest way to discover and install plugins is via the kubernetes sub-project krew. To install krew, visit https://krew.sigs.k8s.io/docs/user-guide/setup/install/ krew.sigs.k8s.io https://krew.sigs.k8s.io/docs/user-guide/setup/install/
KubectlPluginList(KubectlPluginListSettings) List all available plugin files on a user's PATH. Available plugin files are those that are: - executable - anywhere on the user's PATH - begin with "kubectl-"
KubectlPluginListWithResult(KubectlPluginListSettings) List all available plugin files on a user's PATH. Available plugin files are those that are: - executable - anywhere on the user's PATH - begin with "kubectl-"
KubectlPluginWithResult(KubectlPluginSettings) Provides utilities for interacting with plugins. Plugins provide extended functionality that is not part of the major command-line distribution. Please refer to the documentation and examples for more information about how write your own plugins. The easiest way to discover and install plugins is via the kubernetes sub-project krew. To install krew, visit https://krew.sigs.k8s.io/docs/user-guide/setup/install/ krew.sigs.k8s.io https://krew.sigs.k8s.io/docs/user-guide/setup/install/
KubectlPortForward(KubectlPortForwardSettings) Forward one or more local ports to a pod. Use resource type/name such as deployment/mydeployment to select a pod. Resource type defaults to 'pod' if omitted. If there are multiple pods matching the criteria, a pod will be selected automatically. The forwarding session ends when the selected pod terminates, and a rerun of the command is needed to resume forwarding.
KubectlPortForwardWithResult(KubectlPortForwardSettings) Forward one or more local ports to a pod. Use resource type/name such as deployment/mydeployment to select a pod. Resource type defaults to 'pod' if omitted. If there are multiple pods matching the criteria, a pod will be selected automatically. The forwarding session ends when the selected pod terminates, and a rerun of the command is needed to resume forwarding.
KubectlProxy(KubectlProxySettings) Creates a proxy server or application-level gateway between localhost and the Kubernetes API server. It also allows serving static content over specified HTTP path. All incoming data enters through one port and gets forwarded to the remote Kubernetes API server port, except for the path matching the static content path.
KubectlProxyWithResult(KubectlProxySettings) Creates a proxy server or application-level gateway between localhost and the Kubernetes API server. It also allows serving static content over specified HTTP path. All incoming data enters through one port and gets forwarded to the remote Kubernetes API server port, except for the path matching the static content path.
KubectlReplace(KubectlReplaceSettings) Replace a resource by file name or stdin. JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by $ kubectl get TYPE NAME -o yaml
KubectlReplaceWithResult(KubectlReplaceSettings) Replace a resource by file name or stdin. JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by $ kubectl get TYPE NAME -o yaml
KubectlRollout(KubectlRolloutSettings) Manage the rollout of one or many resources. Valid resource types include: * deployments * daemonsets * statefulsets
KubectlRolloutHistory(KubectlRolloutHistorySettings) View previous rollout revisions and configurations.
KubectlRolloutHistoryWithResult(KubectlRolloutHistorySettings) View previous rollout revisions and configurations.
KubectlRolloutPause(KubectlRolloutPauseSettings) Mark the provided resource as paused. Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. Currently only deployments support being paused.
KubectlRolloutPauseWithResult(KubectlRolloutPauseSettings) Mark the provided resource as paused. Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. Currently only deployments support being paused.
KubectlRolloutRestart(KubectlRolloutRestartSettings) Restart a resource. Resource rollout will be restarted.
KubectlRolloutRestartWithResult(KubectlRolloutRestartSettings) Restart a resource. Resource rollout will be restarted.
KubectlRolloutResume(KubectlRolloutResumeSettings) 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 deployments support being resumed.
KubectlRolloutResumeWithResult(KubectlRolloutResumeSettings) 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 deployments support being resumed.
KubectlRolloutStatus(KubectlRolloutStatusSettings) 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 rollout to finish then you can use --watch=false. Note that if a new rollout starts in-between, then 'rollout status' will continue watching the latest revision. If you want to pin to a specific revision and abort if it is rolled over by another revision, use --revision=N where N is the revision you need to watch for.
KubectlRolloutStatusWithResult(KubectlRolloutStatusSettings) 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 rollout to finish then you can use --watch=false. Note that if a new rollout starts in-between, then 'rollout status' will continue watching the latest revision. If you want to pin to a specific revision and abort if it is rolled over by another revision, use --revision=N where N is the revision you need to watch for.
KubectlRolloutUndo(KubectlRolloutUndoSettings) Roll back to a previous rollout.
KubectlRolloutUndoWithResult(KubectlRolloutUndoSettings) Roll back to a previous rollout.
KubectlRolloutWithResult(KubectlRolloutSettings) Manage the rollout of one or many resources. Valid resource types include: * deployments * daemonsets * statefulsets
KubectlRun(KubectlRunSettings) Create and run a particular image in a pod.
KubectlRunWithResult(KubectlRunSettings) Create and run a particular image in a pod.
KubectlScale(KubectlScaleSettings) Set a new size for a deployment, replica set, replication controller, or stateful set. Scale also allows users to specify one or more preconditions for the scale action. If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server.
KubectlScaleWithResult(KubectlScaleSettings) Set a new size for a deployment, replica set, replication controller, or stateful set. Scale also allows users to specify one or more preconditions for the scale action. If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server.
KubectlSet(KubectlSetSettings) Configure application resources. These commands help you make changes to existing application resources.
KubectlSetEnv(KubectlSetEnvSettings) Update environment variables on a pod template. List environment variable definitions in one or more pods, pod templates. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations). View or modify the environment variable definitions on all containers in the specified pods or pod templates, or just those that match a wildcard. If "--env -" is passed, environment variables can be read from STDIN using the standard env syntax. Possible resources include (case insensitive): pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), statefulset (sts), cronjob (cj), replicaset (rs)
KubectlSetEnvWithResult(KubectlSetEnvSettings) Update environment variables on a pod template. List environment variable definitions in one or more pods, pod templates. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations). View or modify the environment variable definitions on all containers in the specified pods or pod templates, or just those that match a wildcard. If "--env -" is passed, environment variables can be read from STDIN using the standard env syntax. Possible resources include (case insensitive): pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), statefulset (sts), cronjob (cj), replicaset (rs)
KubectlSetImage(KubectlSetImageSettings) Update existing container image(s) of resources. Possible resources include (case insensitive): pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), statefulset (sts), cronjob (cj), replicaset (rs)
KubectlSetImageWithResult(KubectlSetImageSettings) Update existing container image(s) of resources. Possible resources include (case insensitive): pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), statefulset (sts), cronjob (cj), replicaset (rs)
KubectlSetResources(KubectlSetResourcesSettings) Specify compute resource requirements (CPU, memory) for any resource that defines a pod template. If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits. For each compute resource, if a limit is specified and a request is omitted, the request will default to the limit. Possible resources include (case insensitive): Use "kubectl api-resources" for a complete list of supported resources..
KubectlSetResourcesWithResult(KubectlSetResourcesSettings) Specify compute resource requirements (CPU, memory) for any resource that defines a pod template. If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits. For each compute resource, if a limit is specified and a request is omitted, the request will default to the limit. Possible resources include (case insensitive): Use "kubectl api-resources" for a complete list of supported resources..
KubectlSetSelector(KubectlSetSelectorSettings) Set the selector on a resource. Note that the new selector will overwrite the old selector if the resource had one prior to the invocation of 'set selector'. A selector must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. Note: currently selectors can only be set on Service objects.
KubectlSetSelectorWithResult(KubectlSetSelectorSettings) Set the selector on a resource. Note that the new selector will overwrite the old selector if the resource had one prior to the invocation of 'set selector'. A selector must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. Note: currently selectors can only be set on Service objects.
KubectlSetServiceaccount(KubectlSetServiceaccountSettings) Update the service account of pod template resources. Possible resources (case insensitive) can be: replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs), statefulset
KubectlSetServiceaccountWithResult(KubectlSetServiceaccountSettings) Update the service account of pod template resources. Possible resources (case insensitive) can be: replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs), statefulset
KubectlSetSubject(KubectlSetSubjectSettings) Update the user, group, or service account in a role binding or cluster role binding.
KubectlSetSubjectWithResult(KubectlSetSubjectSettings) Update the user, group, or service account in a role binding or cluster role binding.
KubectlSetWithResult(KubectlSetSettings) Configure application resources. These commands help you make changes to existing application resources.
KubectlTaint(KubectlTaintSettings) Update the taints on one or more nodes. * A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. * The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. * Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app. * The value is optional. If given, it must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. * The effect must be NoSchedule, PreferNoSchedule or NoExecute. * Currently taint can only apply to node.
KubectlTaintWithResult(KubectlTaintSettings) Update the taints on one or more nodes. * A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. * The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. * Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app. * The value is optional. If given, it must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. * The effect must be NoSchedule, PreferNoSchedule or NoExecute. * Currently taint can only apply to node.
KubectlTop(KubectlTopSettings) Display Resource (CPU/Memory) usage. The top command allows you to see the resource consumption for nodes or pods. This command requires Metrics Server to be correctly configured and working on the server.
KubectlTopNode(KubectlTopNodeSettings) Display resource (CPU/memory) usage of nodes. The top-node command allows you to see the resource consumption of nodes.
KubectlTopNodeWithResult(KubectlTopNodeSettings) Display resource (CPU/memory) usage of nodes. The top-node command allows you to see the resource consumption of nodes.
KubectlTopPod(KubectlTopPodSettings) Display resource (CPU/memory) usage of pods. The 'top pod' command allows you to see the resource consumption of pods. Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation.
KubectlTopPodWithResult(KubectlTopPodSettings) Display resource (CPU/memory) usage of pods. The 'top pod' command allows you to see the resource consumption of pods. Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation.
KubectlTopWithResult(KubectlTopSettings) Display Resource (CPU/Memory) usage. The top command allows you to see the resource consumption for nodes or pods. This command requires Metrics Server to be correctly configured and working on the server.
KubectlUncordon(KubectlUncordonSettings) Mark node as schedulable.
KubectlUncordonWithResult(KubectlUncordonSettings) Mark node as schedulable.
KubectlVersion(KubectlVersionSettings) Print the client and server version information for the current context.
KubectlVersionWithResult(KubectlVersionSettings) Print the client and server version information for the current context.
KubectlWait(KubectlWaitSettings) Experimental: Wait for a specific condition on one or many resources. The command takes multiple resources and waits until the specified condition is seen in the Status field of every given resource. Alternatively, the command can wait for the given set of resources to be deleted by providing the "delete" keyword as the value to the --for flag. A successful message will be printed to stdout indicating when the specified condition has been met. You can use -o option to change to output destination.
KubectlWaitWithResult(KubectlWaitSettings) Experimental: Wait for a specific condition on one or many resources. The command takes multiple resources and waits until the specified condition is seen in the Status field of every given resource. Alternatively, the command can wait for the given set of resources to be deleted by providing the "delete" keyword as the value to the --for flag. A successful message will be printed to stdout indicating when the specified condition has been met. You can use -o option to change to output destination.