table of contents
OC SET(1) | June 2016 | OC SET(1) |
NAME¶
oc set env - Update environment variables on a pod template
SYNOPSIS¶
oc set env [OPTIONS]
DESCRIPTION¶
Update environment variables on a pod template or a build config.
List environment variable definitions in one or more pods, pod templates or build configuration. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations) or build 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.
OPTIONS¶
--all=false
If true, select all resources in the namespace of the specified resource
types
--allow-missing-template-keys=true
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.
-c, --containers="*"
The names of containers in the selected pod templates to change - may use
wildcards
--dry-run="none"
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.
-e, --env=[]
Specify a key-value pair for an environment variable to set into each
container.
--field-manager="kubectl-set"
Name of the manager used to track field ownership.
-f, --filename=[]
Filename, directory, or URL to files to use to edit the resource
--from=""
The name of a resource from which to inject environment variables
-k, --kustomize=""
Process the kustomization directory. This flag can't be used together with -f
or -R.
--list=false
If true, display the environment and any changes in the standard format
--local=false
If true, set image will NOT contact api-server but run locally.
-o, --output=""
Output format. One of: (json, yaml, name, go-template, go-template-file,
template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
--overwrite=true
If true, allow environment to be overwritten, otherwise reject updates that
overwrite existing environment.
--prefix=""
Prefix to append to variable names
-R, --recursive=false
Process the directory used in -f, --filename recursively. Useful when you
want to manage related manifests organized within the same directory.
--resolve=false
If true, show secret or configmap references when listing variables
--resource-version=""
If non-empty, the labels update will only succeed if this is the current
resource-version for the object. Only valid when specifying a single
resource.
-l, --selector=""
Selector (label query) to filter on
--show-managed-fields=false
If true, keep the managedFields when printing objects in JSON or YAML
format.
--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⟩].
OPTIONS INHERITED FROM PARENT COMMANDS¶
--as=""
Username to impersonate for the operation. User could be a regular user or a
service account in a namespace.
--as-group=[]
Group to impersonate for the operation, this flag can be repeated to specify
multiple groups.
--as-uid=""
UID to impersonate for the operation.
--cache-dir="/home/abuild/.kube/cache"
Default cache directory
--certificate-authority=""
Path to a cert file for the certificate authority
--client-certificate=""
Path to a client certificate file for TLS
--client-key=""
Path to a client key file for TLS
--cluster=""
The name of the kubeconfig cluster to use
--context=""
The name of the kubeconfig context to use
--disable-compression=false
If true, opt-out of response compression for all requests to the server
--insecure-skip-tls-verify=false
If true, the server's certificate will not be checked for validity. This will
make your HTTPS connections insecure
--kubeconfig=""
Path to the kubeconfig file to use for CLI requests.
--match-server-version=false
Require server version to match client version
-n, --namespace=""
If present, the namespace scope for this CLI request
--profile="none"
Name of profile to capture. One of
(none|cpu|heap|goroutine|threadcreate|block|mutex)
--profile-output="profile.pprof"
Name of the file to write the profile to
--request-timeout="0"
The length of time to wait before giving up on a single server request.
Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h).
A value of zero means don't timeout requests.
-s, --server=""
The address and port of the Kubernetes API server
--tls-server-name=""
Server name to use for server certificate validation. If it is not provided,
the hostname used to contact the server is used
--token=""
Bearer token for authentication to the API server
--user=""
The name of the kubeconfig user to use
--warnings-as-errors=false
Treat warnings received from the server as errors and exit with a non-zero
exit code
EXAMPLE¶
# Update deployment config 'myapp' with a new environment variable
oc set env dc/myapp STORAGE_DIR=/local
# List the environment variables defined on a build config 'sample-build'
oc set env bc/sample-build --list
# List the environment variables defined on all pods
oc set env pods --all --list
# Output modified build config in YAML
oc set env bc/sample-build STORAGE_DIR=/data -o yaml
# Update all containers in all replication controllers in the project to have ENV=prod
oc set env rc --all ENV=prod
# Import environment from a secret
oc set env --from=secret/mysecret dc/myapp
# Import environment from a config map with a prefix
oc set env --from=configmap/myconfigmap --prefix=MYSQL_ dc/myapp
# Remove the environment variable ENV from container 'c1' in all deployment configs
oc set env dc --all --containers="c1" ENV-
# Remove the environment variable ENV from a deployment config definition on disk and
# update the deployment config on the server
oc set env -f dc.json ENV-
# Set some of the local shell environment into a deployment config on the server
oc set env | grep RAILS_ | oc env -e - dc/myapp
SEE ALSO¶
HISTORY¶
June 2016, Ported from the Kubernetes man-doc generator
Openshift CLI User Manuals | Openshift |