KubectlApplySettings Class


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.
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlApplySettings"] class Type type-node


public sealed class KubectlApplySettings : AutoToolSettings


# Apply the configuration in pod.json to a pod. kubectl apply -f ./pod.json # Apply resources from a directory containing kustomization.yaml - e.g. dir/kustomization.yaml. kubectl apply -k dir/ # Apply the JSON passed into stdin to a pod. cat pod.json | kubectl apply -f - # Note: --prune is still in Alpha # Apply the configuration in manifest.yaml that matches label app=nginx and delete all the other resources that are not in the file and match label app=nginx. kubectl apply --prune -f manifest.yaml -l app=nginx # Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file. kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap


Type Description


Name Summary


Name Value Summary
All Nullable<bool>
--all Select all resources in the namespace of the specified resource types.
AllowMissingTemplateKeys Nullable<bool>
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.
Cascade Nullable<bool>
--cascade If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true.
DryRun Nullable<bool>
--dry-run If true, only print the object that would be sent, without sending it. Warning: --dry-run cannot accurately output the result of merging the local manifest and the server-side data. Use --server-dry-run to get the merged result instead.
ExperimentalFieldManager string
--experimental-field-manager Name of the manager used to track field ownership. This is an alpha feature and flag.
ExperimentalForceConflicts Nullable<bool>
--experimental-force-conflicts If true, server-side apply will force the changes against conflicts. This is an alpha feature and flag.
ExperimentalServerSide Nullable<bool>
--experimental-server-side If true, apply runs in the server instead of the client. This is an alpha feature and flag.
Filename string
-f, --filename that contains the configuration to apply
Force Nullable<bool>
--force Only used when grace-period=0. 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).
Kustomize string
-k, --kustomize Process a kustomization directory. This flag can't be used together with -f or -R.
OpenapiPatch Nullable<bool>
--openapi-patch If true, use openapi to calculate diff when the openapi presents and the resource can be found in the openapi spec. Otherwise, fall back to use baked-in types.
Output string
-o, --output Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file.
Overwrite Nullable<bool>
--overwrite Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration
Prune Nullable<bool>
--prune Automatically delete resource objects, including the uninitialized ones, that do not appear in the configs and are created by either apply or create --save-config. Should be used with either -l or --all.
PruneWhitelist string
Record Nullable<bool>
--record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
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)
ServerDryRun Nullable<bool>
--server-dry-run If true, request will be sent to server with dry-run flag, which means the modifications won't be persisted. This is an alpha feature and flag.
Template string
--template Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
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
Validate Nullable<bool>
--validate If true, use a schema to validate the input before sending it
Wait Nullable<bool>
--wait If true, wait for resources to be gone before returning. This waits for finalizers.

Extension Methods

Name Value Summary
Dump<KubectlApplySettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<KubectlApplySettings>(KubectlApplySettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<KubectlApplySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<KubectlApplySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<KubectlApplySettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<KubectlApplySettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin