This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Kubectl.

Summary

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.

Assembly

Cake.Kubectl.dll

Namespace

Cake.Kubectl

Base Types

ToolSettings
AutoToolSettings

graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlDeleteSettings"] class Type type-node

Syntax

public sealed class KubectlDeleteSettings : AutoToolSettings

Examples

# Delete a pod using the type and name specified in pod.json kubectl delete -f ./pod.json # Delete resources from a directory containing kustomization.yaml - e.g. dir/kustomization.yaml kubectl delete -k dir # Delete resources from all files that end with '.json' - i.e. expand wildcard characters in file names kubectl delete -f '*.json' # Delete a pod based on the type and name in the JSON passed into stdin cat pod.json | kubectl delete -f - # Delete pods and services with same names "baz" and "foo" kubectl delete pod,service baz foo # Delete pods and services with label name=myLabel kubectl delete pods,services -l name=myLabel # Delete a pod with minimal delay kubectl delete pod foo --now # Force delete a pod on a dead node kubectl delete pod foo --force # Delete all pods kubectl delete pods --all

Attributes

Type	Description
NullableContextAttribute
NullableAttribute
CompilerGeneratedAttribute

Constructors

Name	Summary
KubectlDeleteSettings()

Properties

Name	Value	Summary
All	Nullable<bool>	--all Delete all resources, in the namespace of the specified resource types.
AllNamespaces	Nullable<bool>	-A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
Cascade	string	--cascade Must be "background", "orphan", or "foreground". Selects the deletion cascading strategy for the dependents (e.g. Pods created by a ReplicationController). Defaults to background.
DryRun	string	--dry-run Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.
FieldSelector	string	--field-selector Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type.
Filename	string	-f, --filename containing the resource to delete.
Force	Nullable<bool>	--force If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.
GracePeriod	Nullable<int>	--grace-period Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion).
IgnoreNotFound	Nullable<bool>	--ignore-not-found Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified.
Kustomize	string	-k, --kustomize Process a kustomization directory. This flag can't be used together with -f or -R.
Now	Nullable<bool>	--now If true, resources are signaled for immediate shutdown (same as --grace-period=1).
Output	string	-o, --output Output mode. Use "-o name" for shorter output (resource/name).
Raw	string	--raw Raw URI to DELETE to the server. Uses the transport specified by the kubeconfig file.
Recursive	Nullable<bool>	-R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
Selector	string	-l, --selector Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.
Timeout	string	--timeout The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object
Wait	Nullable<bool>	--wait If true, wait for resources to be gone before returning. This waits for finalizers.

Extension Methods

Name	Value	Summary
Dump<KubectlDeleteSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<KubectlDeleteSettings>(KubectlDeleteSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<KubectlDeleteSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<KubectlDeleteSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<KubectlDeleteSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<KubectlDeleteSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin