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

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.

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

Syntax

public sealed class KubectlKustomizeSettings : AutoToolSettings

Examples

# Build the current working directory kubectl kustomize # Build some shared configuration directory kubectl kustomize /home/config/production # Build from github kubectl kustomize https://github.com/kubernetes-sigs/kustomize.git/examples/helloWorld?ref=v1.0.6

Attributes

Type	Description
NullableContextAttribute
NullableAttribute
CompilerGeneratedAttribute

Constructors

Name	Summary
KubectlKustomizeSettings()

Properties

Name	Value	Summary
AsCurrentUser	Nullable<bool>	--as-current-user use the uid and gid of the command executor to run the function in the container
EnableAlphaPlugins	Nullable<bool>	--enable-alpha-plugins enable kustomize plugins
EnableHelm	Nullable<bool>	--enable-helm Enable use of the Helm chart inflator generator.
Env	string	-e, --env a list of environment variables to be used by functions
HelmCommand	string	--helm-command helm command (path to executable)
LoadRestrictor	string	--load-restrictor if set to 'LoadRestrictionsNone', local kustomizations may load files from outside their root. This does, however, break the relocatability of the kustomization.
Mount	string	--mount a list of storage options read from the filesystem
Network	Nullable<bool>	--network enable network access for functions that declare it
NetworkName	string	--network-name the docker network to run the container in
Output	string	-o, --output If specified, write output to this path.

Extension Methods

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