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

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..

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["KubectlSetResourcesSettings"] class Type type-node

Syntax

public sealed class KubectlSetResourcesSettings : AutoToolSettings

Examples

# Set a deployments nginx container cpu limits to "200m" and memory to "512Mi" kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi # Set the resource request and limits for all containers in nginx kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi # Remove the resource requests for resources on containers in nginx kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0 # Print the result (in yaml format) of updating nginx container limits from a local, without hitting the server kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --local -o yaml

Attributes

Type	Description
NullableContextAttribute
NullableAttribute
CompilerGeneratedAttribute

Constructors

Name	Summary
KubectlSetResourcesSettings()

Properties

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.
Containers	string	-c, --containers The names of containers in the selected pod templates to change, all containers are selected by default - may use wildcards
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.
FieldManager	string	--field-manager Name of the manager used to track field ownership.
Filename	string	-f, --filename Filename, directory, or URL to files identifying the resource to get from a server.
Kustomize	string	-k, --kustomize Process the kustomization directory. This flag can't be used together with -f or -R.
Limits	string	--limits The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.
Local	Nullable<bool>	--local If true, set resources will NOT contact api-server but run locally.
Output	string	-o, --output Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-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.
Requests	string	--requests The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.
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.
ShowManagedFields	Nullable<bool>	--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
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].

Extension Methods

Name	Value	Summary
Dump<KubectlSetResourcesSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<KubectlSetResourcesSettings>(KubectlSetResourcesSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<KubectlSetResourcesSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<KubectlSetResourcesSettings>(string)	void	From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<KubectlSetResourcesSettings>(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<KubectlSetResourcesSettings>(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	From StringExtensions Requires the Cake.Issues addin