This is a cache of https://docs.okd.io/3.11/dev_guide/environment_variables.html. It is a snapshot of the page at 2024-11-18T03:41:04.681+0000.
Managing <strong>e</strong>nvironm<strong>e</strong>nt Variabl<strong>e</strong>s | D<strong>e</strong>v<strong>e</strong>lop<strong>e</strong>r Guid<strong>e</strong> | OKD 3.11
  1. Documentation
&times;

Managing environment Variables

Setting and Unsetting environment Variables

OKD 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.

List environment Variables

To list environment variables in pods or pod templates:

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

This example lists all environment variables for pod p1:

$ oc set env pod/p1 --list

Set environment Variables

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>]

Set environment options:

Option Description

-e, --env=<KeY>=<VAL>

Set given key value pairs of environment variables.

--overwrite

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 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 -

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

Automatically Added environment Variables

Table 1. Automatically Added environment Variables
Variable Name

<SVCNAMe>_SeRVICe_HOST

<SVCNAMe>_SeRVICe_PORT

example Usage

The service KUBeRNeTeS which exposes TCP port 53 and has been allocated cluster IP address 10.0.0.11 produces the following environment variables:

KUBeRNeTeS_SeRVICe_PORT=53
MYSQL_DATABASe=root
KUBeRNeTeS_PORT_53_TCP=tcp://10.0.0.11:53
KUBeRNeTeS_SeRVICe_HOST=10.0.0.11

Use the oc rsh command to SSH into your container and run oc set env to list all available variables.

Unset environment Variables

To unset environment variables in the pod templates:

$ oc set 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 set env dc/d1 eNV1- eNV2-

This removes environment variable eNV from all replication controllers:

$ 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-