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

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), statefulset (sts), cronjob (cj), replicaset (rs)

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

Syntax

public sealed class KubectlSetEnvSettings : AutoToolSettings

Examples

# Update deployment 'registry' with a new environment variable kubectl set env deployment/registry STORAGE_DIR=/local # List the environment variables defined on a deployments 'sample-build' kubectl set env deployment/sample-build --list # List the environment variables defined on all pods kubectl set env pods --all --list # Output modified deployment in YAML, and does not alter the object on the server kubectl set env deployment/sample-build STORAGE_DIR=/data -o yaml # Update all containers in all replication controllers in the project to have ENV=prod kubectl set env rc --all ENV=prod # Import environment from a secret kubectl set env --from=secret/mysecret deployment/myapp # Import environment from a config map with a prefix kubectl set env --from=configmap/myconfigmap --prefix=MYSQL_ deployment/myapp # Import specific keys from a config map kubectl set env --keys=my-example-key --from=configmap/myconfigmap deployment/myapp # Remove the environment variable ENV from container 'c1' in all deployment configs kubectl set env deployments --all --containers="c1" ENV- # Remove the environment variable ENV from a deployment definition on disk and # update the deployment config on the server kubectl set env -f deploy.json ENV- # Set some of the local shell environment into a deployment config on the server env | grep RAILS_ | kubectl set env -e - deployment/registry

Attributes

Type	Description
NullableContextAttribute
NullableAttribute
CompilerGeneratedAttribute

Constructors

Name	Summary
KubectlSetEnvSettings()

Properties

Name	Value	Summary
All	Nullable<bool>	--all If true, 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 - 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.
Env	string	-e, --env Specify a key-value pair for an environment variable to set into each container.
FieldManager	string	--field-manager Name of the manager used to track field ownership.
Filename	string	-f, --filename Filename, directory, or URL to files the resource to update the env
From	string	--from The name of a resource from which to inject environment variables
Keys	string	--keys Comma-separated list of keys to import from specified resource
Kustomize	string	-k, --kustomize Process the kustomization directory. This flag can't be used together with -f or -R.
List	Nullable<bool>	--list If true, display the environment and any changes in the standard format. this flag will removed when we have kubectl view env.
Local	Nullable<bool>	--local If true, set env 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).
Overwrite	Nullable<bool>	--overwrite If true, allow environment to be overwritten, otherwise reject updates that overwrite existing environment.
Prefix	string	--prefix Prefix to append to variable names
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.
Resolve	Nullable<bool>	--resolve If true, show secret or configmap references when listing variables
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<KubectlSetEnvSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<KubectlSetEnvSettings>(KubectlSetEnvSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<KubectlSetEnvSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<KubectlSetEnvSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<KubectlSetEnvSettings>(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<KubectlSetEnvSettings>(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