1KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)
2Eric Paris Jan 2015
6
9 kubectl set env - Update environment variables on a pod template
10
14 kubectl set env [OPTIONS]
15
19 Update environment variables on a pod template.
20 List environment variable definitions in one or more pods, pod tem‐
23 plates. Add, update, or remove container environment variable defini‐
24 tions in one or more pod templates (within replication controllers or
25 deployment configurations). View or modify the environment variable
26 definitions on all containers in the specified pods or pod templates,
27 or just those that match a wildcard.
28 If "--env -" is passed, environment variables can be read from STDIN
31 using the standard env syntax.
32 Possible resources include (case insensitive):
35 pod (po), replicationcontroller (rc), deployment (deploy), daemonset
38 (ds), statefulset (sts), cronjob (cj), replicaset (rs)
39
43 --all=false If true, select all resources in the namespace of the
44 specified resource types
45 --allow-missing-template-keys=true If true, ignore any errors in
48 templates when a field or map key is missing in the template. Only ap‐
49 plies to golang and jsonpath output formats.
50 -c, --containers="*" The names of containers in the selected pod
53 templates to change - may use wildcards
54 --dry-run="none" Must be "none", "server", or "client". If client
57 strategy, only print the object that would be sent, without sending it.
58 If server strategy, submit server-side request without persisting the
59 resource.
60 -e, --env=[] Specify a key-value pair for an environment variable
63 to set into each container.
64 --field-manager="kubectl-set" Name of the manager used to track
67 field ownership.
68 -f, --filename=[] Filename, directory, or URL to files the re‐
71 source to update the env
72 --from="" The name of a resource from which to inject environment
75 variables
76 --keys=[] Comma-separated list of keys to import from specified
79 resource
80 -k, --kustomize="" Process the kustomization directory. This flag
83 can't be used together with -f or -R.
84 --list=false If true, display the environment and any changes in
87 the standard format. this flag will removed when we have kubectl view
88 env.
89 --local=false If true, set env will NOT contact api-server but run
92 locally.
93 -o, --output="" Output format. One of: (json, yaml, name, go-tem‐
96 plate, go-template-file, template, templatefile, jsonpath, jsonpath-as-
97 json, jsonpath-file).
98 --overwrite=true If true, allow environment to be overwritten,
101 otherwise reject updates that overwrite existing environment.
102 --prefix="" Prefix to append to variable names
105 -R, --recursive=false Process the directory used in -f, --filename
108 recursively. Useful when you want to manage related manifests organized
109 within the same directory.
110 --resolve=false If true, show secret or configmap references when
113 listing variables
114 -l, --selector="" Selector (label query) to filter on, supports
117 '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects
118 must satisfy all of the specified label constraints.
119 --show-managed-fields=false If true, keep the managedFields when
122 printing objects in JSON or YAML format.
123 --template="" Template string or path to template file to use when
126 -o=go-template, -o=go-template-file. The template format is golang tem‐
127 plates [http://golang.org/pkg/text/template/#pkg-overview].
128
132 --as="" Username to impersonate for the operation. User could be a
133 regular user or a service account in a namespace.
134 --as-group=[] Group to impersonate for the operation, this flag
137 can be repeated to specify multiple groups.
138 --as-uid="" UID to impersonate for the operation.
141 --azure-container-registry-config="" Path to the file containing
144 Azure container registry configuration information.
145 --cache-dir="/builddir/.kube/cache" Default cache directory
148 --certificate-authority="" Path to a cert file for the certificate
151 authority
152 --client-certificate="" Path to a client certificate file for TLS
155 --client-key="" Path to a client key file for TLS
158 --cluster="" The name of the kubeconfig cluster to use
161 --context="" The name of the kubeconfig context to use
164 --disable-compression=false If true, opt-out of response compres‐
167 sion for all requests to the server
168 --insecure-skip-tls-verify=false If true, the server's certificate
171 will not be checked for validity. This will make your HTTPS connections
172 insecure
173 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
176 quests.
177 --match-server-version=false Require server version to match
180 client version
181 -n, --namespace="" If present, the namespace scope for this CLI
184 request
185 --password="" Password for basic authentication to the API server
188 --profile="none" Name of profile to capture. One of
191 (none|cpu|heap|goroutine|threadcreate|block|mutex)
192 --profile-output="profile.pprof" Name of the file to write the
195 profile to
196 --request-timeout="0" The length of time to wait before giving up
199 on a single server request. Non-zero values should contain a corre‐
200 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
201 out requests.
202 -s, --server="" The address and port of the Kubernetes API server
205 --tls-server-name="" Server name to use for server certificate
208 validation. If it is not provided, the hostname used to contact the
209 server is used
210 --token="" Bearer token for authentication to the API server
213 --user="" The name of the kubeconfig user to use
216 --username="" Username for basic authentication to the API server
219 --version=false Print version information and quit
222 --warnings-as-errors=false Treat warnings received from the server
225 as errors and exit with a non-zero exit code
226
230 # Update deployment 'registry' with a new environment variable
231 kubectl set env deployment/registry STORAGE_DIR=/local
232 # List the environment variables defined on a deployments 'sample-build'
234 kubectl set env deployment/sample-build --list
235 # List the environment variables defined on all pods
237 kubectl set env pods --all --list
238 # Output modified deployment in YAML, and does not alter the object on the server
240 kubectl set env deployment/sample-build STORAGE_DIR=/data -o yaml
241 # Update all containers in all replication controllers in the project to have ENV=prod
243 kubectl set env rc --all ENV=prod
244 # Import environment from a secret
246 kubectl set env --from=secret/mysecret deployment/myapp
247 # Import environment from a config map with a prefix
249 kubectl set env --from=configmap/myconfigmap --prefix=MYSQL_ deployment/myapp
250 # Import specific keys from a config map
252 kubectl set env --keys=my-example-key --from=configmap/myconfigmap deployment/myapp
253 # Remove the environment variable ENV from container 'c1' in all deployment configs
255 kubectl set env deployments --all --containers="c1" ENV-
256 # Remove the environment variable ENV from a deployment definition on disk and
258 # update the deployment config on the server
259 kubectl set env -f deploy.json ENV-
260 # Set some of the local shell environment into a deployment config on the server
262 env | grep RAILS_ | kubectl set env -e - deployment/registry
263
268 kubectl-set(1),
269
273 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
274 com) based on the kubernetes source material, but hopefully they have
275 been automatically generated since!
276Manuals User KUBERNETES(1)(kubernetes)