Red Hat SummitThis documentation is for a release that is no longer maintained
See documentation for the latest supported version 3 or the latest supported version 4.Este conteúdo não está disponível no idioma selecionado.
Chapter 23. Managing Environment Variables
23.1. Overview
You can set, unset or list environment variables in pods or pod templates using the oc env command.
23.2. CLI Interface
OpenShift provides the oc 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.
The oc env command uses the following general syntax:
oc env <object-selection> <environment-variables> [options]
$ oc env <object-selection> <environment-variables> [options]
There are several ways to express <object-selection>.
| Syntax | Description | Example |
|---|---|---|
|
| Selects <object-name> of type <object-type>. |
|
|
| Selects <object-name> of type <object-type>. |
|
|
| Selects objects of type <object-type> that match <object-label-selector>. |
|
|
| Selects all objects of type <object-type>. |
|
|
| Look in <ref> — a filename, directory name, or URL — for the definition of the object to edit. |
|
Supported common options for set, unset or list environment variables:
| Option | Description |
|---|---|
|
|
Select containers by |
|
|
Display the changed objects in |
|
|
Output the changed objects with |
|
|
Proceed only if |
23.3. Set Environment Variables
To set environment variables in the pod templates:
oc env <object-selection> KEY_1=VAL_1 ... KEY_N=VAL_N [<set-env-options>] [<common-options>]
$ oc env <object-selection> KEY_1=VAL_1 ... KEY_N=VAL_N [<set-env-options>] [<common-options>]Set environment options:
| Option | Description |
|---|---|
|
| Set given key value pairs of environment variables. |
|
| Confirm updating existing environment variables. |
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 env dc/registry STORAGE=/data oc env dc/registry --overwrite STORAGE=/opt
$ oc env dc/registry STORAGE=/data
$ oc 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 env rc/r1 -e -
$ env | grep RAILS_ | oc 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 env -f rc.json STORAGE=/opt -o yaml > rc.yaml
$ oc env -f rc.json STORAGE=/opt -o yaml > rc.yaml23.4. Unset Environment Variables
To unset environment variables in the pod templates:
oc env <object-selection> KEY_1- ... KEY_N- [<common-options>]
$ oc env <object-selection> KEY_1- ... KEY_N- [<common-options>]
The trailing hyphen (-, U+2D) is required.
This example removes environment variables ENV1 and ENV2 from deployment config d1:
oc env dc/d1 ENV1- ENV2-
$ oc env dc/d1 ENV1- ENV2-
This removes environment variable ENV from all replication controllers:
oc env rc --all ENV-
$ oc env rc --all ENV-
This removes environment variable ENV from container c1 for replication controller r1:
oc env rc r1 --containers='c1' ENV-
$ oc env rc r1 --containers='c1' ENV-23.5. List Environment Variables
To list environment variables in pods or pod templates:
oc env <object-selection> --list [<common-options>]
$ oc env <object-selection> --list [<common-options>]
This example lists all environment variables for pod p1:
oc env pod/p1 --list
$ oc env pod/p1 --list
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}