Chapter 33. Managing Environment Variables

OpenShift Container Platform provides the oc set env command to set or unset environment variables for objects that have a pod template, such as replication controllers or deployment configurations. It can also list environment variables in pods or any object that has a pod template. This command can also be used on BuildConfig objects.

To list environment variables in pods or pod templates:

oc set env <object-selection> --list [<common-options>]

$ oc set env <object-selection> --list [<common-options>]

This example lists all environment variables for pod p1:

oc set env pod/p1 --list

$ oc set env pod/p1 --list

To set environment variables in the pod templates:

oc set env <object-selection> KEY_1=VAL_1 ... KEY_N=VAL_N [<set-env-options>] [<common-options>]

$ oc set env <object-selection> KEY_1=VAL_1 ... KEY_N=VAL_N [<set-env-options>] [<common-options>]

Set environment options:

In the following example, both commands modify environment variable STORAGE in the deployment config registry. The first adds, with value /data. The second updates, with value /opt.

oc set env dc/registry STORAGE=/data
oc set env dc/registry --overwrite STORAGE=/opt

$ oc set env dc/registry STORAGE=/data
$ oc set env dc/registry --overwrite STORAGE=/opt

The following example finds environment variables in the current shell whose names begin with RAILS_ and adds them to the replication controller r1 on the server:

env | grep RAILS_ | oc set env rc/r1 -e -

$ env | grep RAILS_ | oc set env rc/r1 -e -

The following example does not modify the replication controller defined in file rc.json. Instead, it writes a YAML object with updated environment STORAGE=/local to new file rc.yaml.

oc set env -f rc.json STORAGE=/opt -o yaml > rc.yaml

$ oc set env -f rc.json STORAGE=/opt -o yaml > rc.yaml

KUBERNETES_SERVICE_PORT=53
MYSQL_DATABASE=root
KUBERNETES_PORT_53_TCP=tcp://10.0.0.11:53
KUBERNETES_SERVICE_HOST=10.0.0.11

KUBERNETES_SERVICE_PORT=53
MYSQL_DATABASE=root
KUBERNETES_PORT_53_TCP=tcp://10.0.0.11:53
KUBERNETES_SERVICE_HOST=10.0.0.11

To unset environment variables in the pod templates:

oc set env <object-selection> KEY_1- ... KEY_N- [<common-options>]

$ oc set env <object-selection> KEY_1- ... KEY_N- [<common-options>]

This example removes environment variables ENV1 and ENV2 from deployment config d1:

oc set env dc/d1 ENV1- ENV2-

$ oc set env dc/d1 ENV1- ENV2-

This removes environment variable ENV from all replication controllers:

oc set env rc --all ENV-

$ oc set env rc --all ENV-

This removes environment variable ENV from container c1 for replication controller r1:

oc set env rc r1 --containers='c1' ENV-

$ oc set env rc r1 --containers='c1' ENV-