KubectlAliases Class

Summary

Contains functionality for working with Kubectl commands.
Assembly
Cake.Kubectl.dll
Namespace
Cake.Kubectl
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["KubectlAliases"] class Type type-node

Syntax

public static class KubectlAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
KubectlAnnotate(ICakeContext, KubectlAnnotateSettings) void
Update the annotations on one or more resources All Kubectl 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.
static
KubectlAnnotateWithResult(ICakeContext, KubectlAnnotateSettings) IEnumerable<string>
Update the annotations on one or more resources All Kubectl 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.
static
KubectlApiResources(ICakeContext, KubectlApiResourcesSettings) void
Print the supported API resources on the server
static
KubectlApiResourcesWithResult(ICakeContext, KubectlApiResourcesSettings) IEnumerable<string>
Print the supported API resources on the server
static
KubectlApiVersions(ICakeContext, KubectlApiVersionsSettings) void
Print the supported API versions on the server, in the form of "group/version"
static
KubectlApiVersionsWithResult(ICakeContext, KubectlApiVersionsSettings) IEnumerable<string>
Print the supported API versions on the server, in the form of "group/version"
static
KubectlApply(ICakeContext, KubectlApplySettings) void
Apply a configuration to a resource by filename 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.
static
KubectlApplyEditLastApplied(ICakeContext, KubectlApplyEditLastAppliedSettings) void
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 filenames 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.
static
KubectlApplyEditLastAppliedWithResult(ICakeContext, KubectlApplyEditLastAppliedSettings) IEnumerable<string>
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 filenames 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.
static
KubectlApplySetLastApplied(ICakeContext, KubectlApplySetLastAppliedSettings) void
static
KubectlApplySetLastAppliedWithResult(ICakeContext, KubectlApplySetLastAppliedSettings) IEnumerable<string>
static
KubectlApplyViewLastApplied(ICakeContext, KubectlApplyViewLastAppliedSettings) void
View the latest last-applied-configuration annotations by type/name or file. The default output will be printed to stdout in YAML format. One can use -o option to change output format.
static
KubectlApplyViewLastAppliedWithResult(ICakeContext, KubectlApplyViewLastAppliedSettings) IEnumerable<string>
View the latest last-applied-configuration annotations by type/name or file. The default output will be printed to stdout in YAML format. One can use -o option to change output format.
static
KubectlApplyWithResult(ICakeContext, KubectlApplySettings) IEnumerable<string>
Apply a configuration to a resource by filename 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.
static
KubectlAttach(ICakeContext, KubectlAttachSettings) void
Attach to a process that is already running inside an existing container.
static
KubectlAttachWithResult(ICakeContext, KubectlAttachSettings) IEnumerable<string>
Attach to a process that is already running inside an existing container.
static
KubectlAuth(ICakeContext, KubectlAuthSettings) void
Inspect authorization
static
KubectlAuthCanI(ICakeContext, KubectlAuthCanISettings) void
Check whether an action is allowed. VERB is a logical Kubectl API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubectl resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL starts with "/". NAME is the name of a particular Kubectl resource.
static
KubectlAuthCanIWithResult(ICakeContext, KubectlAuthCanISettings) IEnumerable<string>
Check whether an action is allowed. VERB is a logical Kubectl API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubectl resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL starts with "/". NAME is the name of a particular Kubectl resource.
static
KubectlAuthReconcile(ICakeContext, KubectlAuthReconcileSettings) void
Reconciles rules for RBAC Role, RoleBinding, ClusterRole, and ClusterRole 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.
static
KubectlAuthReconcileWithResult(ICakeContext, KubectlAuthReconcileSettings) IEnumerable<string>
Reconciles rules for RBAC Role, RoleBinding, ClusterRole, and ClusterRole 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.
static
KubectlAuthWithResult(ICakeContext, KubectlAuthSettings) IEnumerable<string>
Inspect authorization
static
KubectlAutoscale(ICakeContext, KubectlAutoscaleSettings) void
Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. Looks up a Deployment, ReplicaSet, StatefulSet, or ReplicationController 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.
static
KubectlAutoscaleWithResult(ICakeContext, KubectlAutoscaleSettings) IEnumerable<string>
Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. Looks up a Deployment, ReplicaSet, StatefulSet, or ReplicationController 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.
static
KubectlCertificate(ICakeContext, KubectlCertificateSettings) void
Modify certificate resources.
static
KubectlCertificateApprove(ICakeContext, KubectlCertificateApproveSettings) void
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.
static
KubectlCertificateApproveWithResult(ICakeContext, KubectlCertificateApproveSettings) IEnumerable<string>
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.
static
KubectlCertificateDeny(ICakeContext, KubectlCertificateDenySettings) void
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.
static
KubectlCertificateDenyWithResult(ICakeContext, KubectlCertificateDenySettings) IEnumerable<string>
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.
static
KubectlCertificateWithResult(ICakeContext, KubectlCertificateSettings) IEnumerable<string>
Modify certificate resources.
static
KubectlClusterInfo(ICakeContext, KubectlClusterInfoSettings) void
Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
static
KubectlClusterInfoDump(ICakeContext, KubectlClusterInfoDumpSettings) void
Dumps cluster info 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 '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.
static
KubectlClusterInfoDumpWithResult(ICakeContext, KubectlClusterInfoDumpSettings) IEnumerable<string>
Dumps cluster info 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 '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.
static
KubectlClusterInfoWithResult(ICakeContext, KubectlClusterInfoSettings) IEnumerable<string>
Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
static
KubectlCompletion(ICakeContext, KubectlCompletionSettings) void
Output shell completion code for the specified shell (bash or zsh). 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: https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
static
KubectlCompletionWithResult(ICakeContext, KubectlCompletionSettings) IEnumerable<string>
Output shell completion code for the specified shell (bash or zsh). 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: https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
static
KubectlConfig(ICakeContext, KubectlConfigSettings) void
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.
static
KubectlConfigCurrentContext(ICakeContext, KubectlConfigCurrentContextSettings) void
Displays the current-context
static
KubectlConfigCurrentContextWithResult(ICakeContext, KubectlConfigCurrentContextSettings) IEnumerable<string>
Displays the current-context
static
KubectlConfigDeleteCluster(ICakeContext, KubectlConfigDeleteClusterSettings) void
Delete the specified cluster from the kubeconfig
static
KubectlConfigDeleteClusterWithResult(ICakeContext, KubectlConfigDeleteClusterSettings) IEnumerable<string>
Delete the specified cluster from the kubeconfig
static
KubectlConfigDeleteContext(ICakeContext, KubectlConfigDeleteContextSettings) void
Delete the specified context from the kubeconfig
static
KubectlConfigDeleteContextWithResult(ICakeContext, KubectlConfigDeleteContextSettings) IEnumerable<string>
Delete the specified context from the kubeconfig
static
KubectlConfigGetClusters(ICakeContext, KubectlConfigGetClustersSettings) void
Display clusters defined in the kubeconfig.
static
KubectlConfigGetClustersWithResult(ICakeContext, KubectlConfigGetClustersSettings) IEnumerable<string>
Display clusters defined in the kubeconfig.
static
KubectlConfigGetContexts(ICakeContext, KubectlConfigGetContextsSettings) void
Displays one or many contexts from the kubeconfig file.
static
KubectlConfigGetContextsWithResult(ICakeContext, KubectlConfigGetContextsSettings) IEnumerable<string>
Displays one or many contexts from the kubeconfig file.
static
KubectlConfigRenameContext(ICakeContext, KubectlConfigRenameContextSettings) void
Renames a context from the kubeconfig file. CONTEXT_NAME is the context name that you wish change. NEW_NAME is the new name you wish to set. Note: In case the context being renamed is the 'current-context', this field will also be updated.
static
KubectlConfigRenameContextWithResult(ICakeContext, KubectlConfigRenameContextSettings) IEnumerable<string>
Renames a context from the kubeconfig file. CONTEXT_NAME is the context name that you wish change. NEW_NAME is the new name you wish to set. Note: In case the context being renamed is the 'current-context', this field will also be updated.
static
KubectlConfigSet(ICakeContext, KubectlConfigSetSettings) void
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 may not contain dots. PROPERTY_VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used. Specifying a attribute name that already exists will merge new fields on top of existing values.
static
KubectlConfigSetCluster(ICakeContext, KubectlConfigSetClusterSettings) void
Sets a cluster entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields.
static
KubectlConfigSetClusterWithResult(ICakeContext, KubectlConfigSetClusterSettings) IEnumerable<string>
Sets a cluster entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields.
static
KubectlConfigSetContext(ICakeContext, KubectlConfigSetContextSettings) void
Sets a context entry in kubeconfig Specifying a name that already exists will merge new fields on top of existing values for those fields.
static
KubectlConfigSetContextWithResult(ICakeContext, KubectlConfigSetContextSettings) IEnumerable<string>
Sets a context entry in kubeconfig Specifying a name that already exists will merge new fields on top of existing values for those fields.
static
KubectlConfigSetCredentials(ICakeContext, KubectlConfigSetCredentialsSettings) void
Sets 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.
static
KubectlConfigSetCredentialsWithResult(ICakeContext, KubectlConfigSetCredentialsSettings) IEnumerable<string>
Sets 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.
static
KubectlConfigSetWithResult(ICakeContext, KubectlConfigSetSettings) IEnumerable<string>
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 may not contain dots. PROPERTY_VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used. Specifying a attribute name that already exists will merge new fields on top of existing values.
static
KubectlConfigUnset(ICakeContext, KubectlConfigUnsetSettings) void
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 keys may not contain dots.
static
KubectlConfigUnsetWithResult(ICakeContext, KubectlConfigUnsetSettings) IEnumerable<string>
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 keys may not contain dots.
static
KubectlConfigUseContext(ICakeContext, KubectlConfigUseContextSettings) void
Sets the current-context in a kubeconfig file
static
KubectlConfigUseContextWithResult(ICakeContext, KubectlConfigUseContextSettings) IEnumerable<string>
Sets the current-context in a kubeconfig file
static
KubectlConfigView(ICakeContext, KubectlConfigViewSettings) void
Display merged kubeconfig settings or a specified kubeconfig file. You can use --output jsonpath={...} to extract specific values using a jsonpath expression.
static
KubectlConfigViewWithResult(ICakeContext, KubectlConfigViewSettings) IEnumerable<string>
Display merged kubeconfig settings or a specified kubeconfig file. You can use --output jsonpath={...} to extract specific values using a jsonpath expression.
static
KubectlConfigWithResult(ICakeContext, KubectlConfigSettings) IEnumerable<string>
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.
static
KubectlConvert(ICakeContext, KubectlConvertSettings) void
Convert config files between different API versions. Both YAML and JSON formats are accepted. The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version. The default output will be printed to stdout in YAML format. One can use -o option to change to output destination.
static
KubectlConvertWithResult(ICakeContext, KubectlConvertSettings) IEnumerable<string>
Convert config files between different API versions. Both YAML and JSON formats are accepted. The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version. The default output will be printed to stdout in YAML format. One can use -o option to change to output destination.
static
KubectlCordon(ICakeContext, KubectlCordonSettings) void
Mark node as unschedulable.
static
KubectlCordonWithResult(ICakeContext, KubectlCordonSettings) IEnumerable<string>
Mark node as unschedulable.
static
KubectlCp(ICakeContext, KubectlCpSettings) void
Copy files and directories to and from containers.
static
KubectlCpWithResult(ICakeContext, KubectlCpSettings) IEnumerable<string>
Copy files and directories to and from containers.
static
KubectlCreate(ICakeContext, KubectlCreateSettings) void
Create a resource from a file or from stdin. JSON and YAML formats are accepted.
static
KubectlCreateClusterrole(ICakeContext, KubectlCreateClusterroleSettings) void
Create a ClusterRole.
static
KubectlCreateClusterrolebinding(ICakeContext, KubectlCreateClusterrolebindingSettings) void
Create a ClusterRoleBinding for a particular ClusterRole.
static
KubectlCreateClusterrolebindingWithResult(ICakeContext, KubectlCreateClusterrolebindingSettings) IEnumerable<string>
Create a ClusterRoleBinding for a particular ClusterRole.
static
KubectlCreateClusterroleWithResult(ICakeContext, KubectlCreateClusterroleSettings) IEnumerable<string>
Create a ClusterRole.
static
KubectlCreateConfigmap(ICakeContext, KubectlCreateConfigmapSettings) void
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 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 configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
static
KubectlCreateConfigmapWithResult(ICakeContext, KubectlCreateConfigmapSettings) IEnumerable<string>
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 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 configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
static
KubectlCreateCronjob(ICakeContext, KubectlCreateCronjobSettings) void
Create a cronjob with the specified name.
static
KubectlCreateCronjobWithResult(ICakeContext, KubectlCreateCronjobSettings) IEnumerable<string>
Create a cronjob with the specified name.
static
KubectlCreateDeployment(ICakeContext, KubectlCreateDeploymentSettings) void
Create a deployment with the specified name.
static
KubectlCreateDeploymentWithResult(ICakeContext, KubectlCreateDeploymentSettings) IEnumerable<string>
Create a deployment with the specified name.
static
KubectlCreateJob(ICakeContext, KubectlCreateJobSettings) void
Create a job with the specified name.
static
KubectlCreateJobWithResult(ICakeContext, KubectlCreateJobSettings) IEnumerable<string>
Create a job with the specified name.
static
KubectlCreateNamespace(ICakeContext, KubectlCreateNamespaceSettings) void
Create a namespace with the specified name.
static
KubectlCreateNamespaceWithResult(ICakeContext, KubectlCreateNamespaceSettings) IEnumerable<string>
Create a namespace with the specified name.
static
KubectlCreatePoddisruptionbudget(ICakeContext, KubectlCreatePoddisruptionbudgetSettings) void
Create a pod disruption budget with the specified name, selector, and desired minimum available pods
static
KubectlCreatePoddisruptionbudgetWithResult(ICakeContext, KubectlCreatePoddisruptionbudgetSettings) IEnumerable<string>
Create a pod disruption budget with the specified name, selector, and desired minimum available pods
static
KubectlCreatePriorityclass(ICakeContext, KubectlCreatePriorityclassSettings) void
Create a priorityclass with the specified name, value, globalDefault and description
static
KubectlCreatePriorityclassWithResult(ICakeContext, KubectlCreatePriorityclassSettings) IEnumerable<string>
Create a priorityclass with the specified name, value, globalDefault and description
static
KubectlCreateQuota(ICakeContext, KubectlCreateQuotaSettings) void
Create a resourcequota with the specified name, hard limits and optional scopes
static
KubectlCreateQuotaWithResult(ICakeContext, KubectlCreateQuotaSettings) IEnumerable<string>
Create a resourcequota with the specified name, hard limits and optional scopes
static
KubectlCreateRole(ICakeContext, KubectlCreateRoleSettings) void
Create a role with single rule.
static
KubectlCreateRolebinding(ICakeContext, KubectlCreateRolebindingSettings) void
Create a RoleBinding for a particular Role or ClusterRole.
static
KubectlCreateRolebindingWithResult(ICakeContext, KubectlCreateRolebindingSettings) IEnumerable<string>
Create a RoleBinding for a particular Role or ClusterRole.
static
KubectlCreateRoleWithResult(ICakeContext, KubectlCreateRoleSettings) IEnumerable<string>
Create a role with single rule.
static
KubectlCreateSecret(ICakeContext, KubectlCreateSecretSettings) void
Create a secret using specified subcommand.
static
KubectlCreateSecretDockerRegistry(ICakeContext, KubectlCreateSecretDockerRegistrySettings) void
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 have to have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account.
static
KubectlCreateSecretDockerRegistryWithResult(ICakeContext, KubectlCreateSecretDockerRegistrySettings) IEnumerable<string>
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 have to have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account.
static
KubectlCreateSecretGeneric(ICakeContext, KubectlCreateSecretGenericSettings) void
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).
static
KubectlCreateSecretGenericWithResult(ICakeContext, KubectlCreateSecretGenericSettings) IEnumerable<string>
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).
static
KubectlCreateSecretTls(ICakeContext, KubectlCreateSecretTlsSettings) void
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 and match the given private key.
static
KubectlCreateSecretTlsWithResult(ICakeContext, KubectlCreateSecretTlsSettings) IEnumerable<string>
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 and match the given private key.
static
KubectlCreateSecretWithResult(ICakeContext, KubectlCreateSecretSettings) IEnumerable<string>
Create a secret using specified subcommand.
static
KubectlCreateService(ICakeContext, KubectlCreateServiceSettings) void
Create a service using specified subcommand.
static
KubectlCreateServiceaccount(ICakeContext, KubectlCreateServiceaccountSettings) void
Create a service account with the specified name.
static
KubectlCreateServiceaccountWithResult(ICakeContext, KubectlCreateServiceaccountSettings) IEnumerable<string>
Create a service account with the specified name.
static
KubectlCreateServiceClusterip(ICakeContext, KubectlCreateServiceClusteripSettings) void
Create a ClusterIP service with the specified name.
static
KubectlCreateServiceClusteripWithResult(ICakeContext, KubectlCreateServiceClusteripSettings) IEnumerable<string>
Create a ClusterIP service with the specified name.
static
KubectlCreateServiceExternalname(ICakeContext, KubectlCreateServiceExternalnameSettings) void
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.
static
KubectlCreateServiceExternalnameWithResult(ICakeContext, KubectlCreateServiceExternalnameSettings) IEnumerable<string>
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.
static
KubectlCreateServiceLoadbalancer(ICakeContext, KubectlCreateServiceLoadbalancerSettings) void
Create a LoadBalancer service with the specified name.
static
KubectlCreateServiceLoadbalancerWithResult(ICakeContext, KubectlCreateServiceLoadbalancerSettings) IEnumerable<string>
Create a LoadBalancer service with the specified name.
static
KubectlCreateServiceNodeport(ICakeContext, KubectlCreateServiceNodeportSettings) void
Create a NodePort service with the specified name.
static
KubectlCreateServiceNodeportWithResult(ICakeContext, KubectlCreateServiceNodeportSettings) IEnumerable<string>
Create a NodePort service with the specified name.
static
KubectlCreateServiceWithResult(ICakeContext, KubectlCreateServiceSettings) IEnumerable<string>
Create a service using specified subcommand.
static
KubectlCreateWithResult(ICakeContext, KubectlCreateSettings) IEnumerable<string>
Create a resource from a file or from stdin. JSON and YAML formats are accepted.
static
KubectlDelete(ICakeContext, KubectlDeleteSettings) void
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 arguments may be specified: filenames, 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 pass a grace period of 0 and specify the --force flag. 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.
static
KubectlDeleteWithResult(ICakeContext, KubectlDeleteSettings) IEnumerable<string>
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 arguments may be specified: filenames, 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 pass a grace period of 0 and specify the --force flag. 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.
static
KubectlDescribe(ICakeContext, KubectlDescribeSettings) void
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.
static
KubectlDescribeWithResult(ICakeContext, KubectlDescribeSettings) IEnumerable<string>
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.
static
KubectlDiff(ICakeContext, KubectlDiffSettings) void
Diff configurations specified by filename or stdin between the current online configuration, and the configuration as it would be if applied. Output is always YAML. KUBECTL_EXTERNAL_DIFF environment variable can be used to select your own diff command. By default, the "diff" command available in your path will be run with "-u" (unicode) and "-N" (treat new files as empty) options.
static
KubectlDiffWithResult(ICakeContext, KubectlDiffSettings) IEnumerable<string>
Diff configurations specified by filename or stdin between the current online configuration, and the configuration as it would be if applied. Output is always YAML. KUBECTL_EXTERNAL_DIFF environment variable can be used to select your own diff command. By default, the "diff" command available in your path will be run with "-u" (unicode) and "-N" (treat new files as empty) options.
static
KubectlDrain(ICakeContext, KubectlDrainSettings) void
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 APIServer supportshttp://kubernetes.io/docs/admin/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 DaemonSet-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings. If there are any pods that are neither mirror pods nor managed by ReplicationController, ReplicaSet, DaemonSet, StatefulSet 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. http://kubernetes.io/images/docs/kubectl_drain.svg
static
KubectlDrainWithResult(ICakeContext, KubectlDrainSettings) IEnumerable<string>
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 APIServer supportshttp://kubernetes.io/docs/admin/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 DaemonSet-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings. If there are any pods that are neither mirror pods nor managed by ReplicationController, ReplicaSet, DaemonSet, StatefulSet 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. http://kubernetes.io/images/docs/kubectl_drain.svg
static
KubectlEdit(ICakeContext, KubectlEditSettings) void
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 filenames 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.
static
KubectlEditWithResult(ICakeContext, KubectlEditSettings) IEnumerable<string>
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 filenames 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.
static
KubectlExec(ICakeContext, KubectlExecSettings) void
Execute a command in a container.
static
KubectlExecWithResult(ICakeContext, KubectlExecSettings) IEnumerable<string>
Execute a command in a container.
static
KubectlExplain(ICakeContext, KubectlExplainSettings) void
static
KubectlExplainWithResult(ICakeContext, KubectlExplainSettings) IEnumerable<string>
static
KubectlExpose(ICakeContext, KubectlExposeSettings) void
Expose a resource as a new Kubectl 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)
static
KubectlExposeWithResult(ICakeContext, KubectlExposeSettings) IEnumerable<string>
Expose a resource as a new Kubectl 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)
static
KubectlGet(ICakeContext, KubectlGetSettings) void
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. Uninitialized objects are not shown unless --include-uninitialized is passed. 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.
static
KubectlGetWithResult(ICakeContext, KubectlGetSettings) IEnumerable<string>
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. Uninitialized objects are not shown unless --include-uninitialized is passed. 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.
static
KubectlKustomize(ICakeContext, KubectlKustomizeSettings) void
Print a set of API resources generated from instructions in a kustomization.yaml file. The argument must be the path to the directory containing the file, or a git repository URL with a path suffix specifying same with respect to the repository root. kubectl kustomize somedir
static
KubectlKustomizeWithResult(ICakeContext, KubectlKustomizeSettings) IEnumerable<string>
Print a set of API resources generated from instructions in a kustomization.yaml file. The argument must be the path to the directory containing the file, or a git repository URL with a path suffix specifying same with respect to the repository root. kubectl kustomize somedir
static
KubectlLabel(ICakeContext, KubectlLabelSettings) void
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.
static
KubectlLabelWithResult(ICakeContext, KubectlLabelSettings) IEnumerable<string>
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.
static
KubectlLogs(ICakeContext, KubectlLogsSettings) void
Print the logs for a container in a pod or specified resource. If the pod has only one container, the container name is optional.
static
KubectlLogsWithResult(ICakeContext, KubectlLogsSettings) IEnumerable<string>
Print the logs for a container in a pod or specified resource. If the pod has only one container, the container name is optional.
static
KubectlPatch(ICakeContext, KubectlPatchSettings) void
Update field(s) of a resource using strategic merge patch, a JSON merge patch, or a JSON patch. JSON and YAML formats are accepted.
static
KubectlPatchWithResult(ICakeContext, KubectlPatchSettings) IEnumerable<string>
Update field(s) of a resource using strategic merge patch, a JSON merge patch, or a JSON patch. JSON and YAML formats are accepted.
static
KubectlPlugin(ICakeContext, KubectlPluginSettings) void
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.
static
KubectlPluginList(ICakeContext, KubectlPluginListSettings) void
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-"
static
KubectlPluginListWithResult(ICakeContext, KubectlPluginListSettings) IEnumerable<string>
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-"
static
KubectlPluginWithResult(ICakeContext, KubectlPluginSettings) IEnumerable<string>
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.
static
KubectlPortForward(ICakeContext, KubectlPortForwardSettings) void
Forward one or more local ports to a pod. This command requires the node to have 'socat' installed. 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 rerun of the command is needed to resume forwarding.
static
KubectlPortForwardWithResult(ICakeContext, KubectlPortForwardSettings) IEnumerable<string>
Forward one or more local ports to a pod. This command requires the node to have 'socat' installed. 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 rerun of the command is needed to resume forwarding.
static
KubectlProxy(ICakeContext, KubectlProxySettings) void
Creates a proxy server or application-level gateway between localhost and the Kubectl 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.
static
KubectlProxyWithResult(ICakeContext, KubectlProxySettings) IEnumerable<string>
Creates a proxy server or application-level gateway between localhost and the Kubectl 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.
static
KubectlReplace(ICakeContext, KubectlReplaceSettings) void
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. This can be obtained by $ kubectl get TYPE NAME -o yaml
static
KubectlReplaceWithResult(ICakeContext, KubectlReplaceSettings) IEnumerable<string>
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. This can be obtained by $ kubectl get TYPE NAME -o yaml
static
KubectlRollout(ICakeContext, KubectlRolloutSettings) void
Manage the rollout of a resource. Valid resource types include: * deployments * daemonsets * statefulsets
static
KubectlRolloutHistory(ICakeContext, KubectlRolloutHistorySettings) void
View previous rollout revisions and configurations.
static
KubectlRolloutHistoryWithResult(ICakeContext, KubectlRolloutHistorySettings) IEnumerable<string>
View previous rollout revisions and configurations.
static
KubectlRolloutPause(ICakeContext, KubectlRolloutPauseSettings) void
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.
static
KubectlRolloutPauseWithResult(ICakeContext, KubectlRolloutPauseSettings) IEnumerable<string>
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.
static
KubectlRolloutResume(ICakeContext, KubectlRolloutResumeSettings) void
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.
static
KubectlRolloutResumeWithResult(ICakeContext, KubectlRolloutResumeSettings) IEnumerable<string>
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.
static
KubectlRolloutStatus(ICakeContext, KubectlRolloutStatusSettings) void
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.
static
KubectlRolloutStatusWithResult(ICakeContext, KubectlRolloutStatusSettings) IEnumerable<string>
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.
static
KubectlRolloutUndo(ICakeContext, KubectlRolloutUndoSettings) void
Rollback to a previous rollout.
static
KubectlRolloutUndoWithResult(ICakeContext, KubectlRolloutUndoSettings) IEnumerable<string>
Rollback to a previous rollout.
static
KubectlRolloutWithResult(ICakeContext, KubectlRolloutSettings) IEnumerable<string>
Manage the rollout of a resource. Valid resource types include: * deployments * daemonsets * statefulsets
static
KubectlRun(ICakeContext, KubectlRunSettings) void
Create and run a particular image, possibly replicated. Creates a deployment or job to manage the created container(s).
static
KubectlRunWithResult(ICakeContext, KubectlRunSettings) IEnumerable<string>
Create and run a particular image, possibly replicated. Creates a deployment or job to manage the created container(s).
static
KubectlScale(ICakeContext, KubectlScaleSettings) void
Set a new size for a Deployment, ReplicaSet, Replication Controller, or StatefulSet. 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.
static
KubectlScaleWithResult(ICakeContext, KubectlScaleSettings) IEnumerable<string>
Set a new size for a Deployment, ReplicaSet, Replication Controller, or StatefulSet. 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.
static
KubectlSet(ICakeContext, KubectlSetSettings) void
Configure application resources These commands help you make changes to existing application resources.
static
KubectlSetEnv(ICakeContext, KubectlSetEnvSettings) void
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), job, replicaset (rs)
static
KubectlSetEnvWithResult(ICakeContext, KubectlSetEnvSettings) IEnumerable<string>
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), job, replicaset (rs)
static
KubectlSetImage(ICakeContext, KubectlSetImageSettings) void
Update existing container image(s) of resources. Possible resources include (case insensitive): pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), replicaset (rs)
static
KubectlSetImageWithResult(ICakeContext, KubectlSetImageSettings) IEnumerable<string>
Update existing container image(s) of resources. Possible resources include (case insensitive): pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), replicaset (rs)
static
KubectlSetResources(ICakeContext, KubectlSetResourcesSettings) void
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..
static
KubectlSetResourcesWithResult(ICakeContext, KubectlSetResourcesSettings) IEnumerable<string>
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..
static
KubectlSetSelector(ICakeContext, KubectlSetSelectorSettings) void
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.
static
KubectlSetSelectorWithResult(ICakeContext, KubectlSetSelectorSettings) IEnumerable<string>
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.
static
KubectlSetServiceaccount(ICakeContext, KubectlSetServiceaccountSettings) void
Update ServiceAccount of pod template resources. Possible resources (case insensitive) can be: replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs), statefulset
static
KubectlSetServiceaccountWithResult(ICakeContext, KubectlSetServiceaccountSettings) IEnumerable<string>
Update ServiceAccount of pod template resources. Possible resources (case insensitive) can be: replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs), statefulset
static
KubectlSetSubject(ICakeContext, KubectlSetSubjectSettings) void
Update User, Group or ServiceAccount in a RoleBinding/ClusterRoleBinding.
static
KubectlSetSubjectWithResult(ICakeContext, KubectlSetSubjectSettings) IEnumerable<string>
Update User, Group or ServiceAccount in a RoleBinding/ClusterRoleBinding.
static
KubectlSetWithResult(ICakeContext, KubectlSetSettings) IEnumerable<string>
Configure application resources These commands help you make changes to existing application resources.
static
KubectlTaint(ICakeContext, KubectlTaintSettings) void
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 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.
static
KubectlTaintWithResult(ICakeContext, KubectlTaintSettings) IEnumerable<string>
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 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.
static
KubectlTop(ICakeContext, KubectlTopSettings) void
Display Resource (CPU/Memory/Storage) usage. The top command allows you to see the resource consumption for nodes or pods. This command requires Heapster to be correctly configured and working on the server.
static
KubectlTopNode(ICakeContext, KubectlTopNodeSettings) void
Display Resource (CPU/Memory/Storage) usage of nodes. The top-node command allows you to see the resource consumption of nodes.
static
KubectlTopNodeWithResult(ICakeContext, KubectlTopNodeSettings) IEnumerable<string>
Display Resource (CPU/Memory/Storage) usage of nodes. The top-node command allows you to see the resource consumption of nodes.
static
KubectlTopPod(ICakeContext, KubectlTopPodSettings) void
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 delay, they may be unavailable for a few minutes since pod creation.
static
KubectlTopPodWithResult(ICakeContext, KubectlTopPodSettings) IEnumerable<string>
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 delay, they may be unavailable for a few minutes since pod creation.
static
KubectlTopWithResult(ICakeContext, KubectlTopSettings) IEnumerable<string>
Display Resource (CPU/Memory/Storage) usage. The top command allows you to see the resource consumption for nodes or pods. This command requires Heapster to be correctly configured and working on the server.
static
KubectlUncordon(ICakeContext, KubectlUncordonSettings) void
Mark node as schedulable.
static
KubectlUncordonWithResult(ICakeContext, KubectlUncordonSettings) IEnumerable<string>
Mark node as schedulable.
static
KubectlVersion(ICakeContext, KubectlVersionSettings) void
Print the client and server version information for the current context
static
KubectlVersionWithResult(ICakeContext, KubectlVersionSettings) IEnumerable<string>
Print the client and server version information for the current context
static
KubectlWait(ICakeContext, KubectlWaitSettings) void
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. One can use -o option to change to output destination.
static
KubectlWaitWithResult(ICakeContext, KubectlWaitSettings) IEnumerable<string>
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. One can use -o option to change to output destination.
static