Show Table of Contents
7.3. Custom Cartridge Environment Variables
You can add custom environment variables to a cartridge by adding them to the cartridge's
$cartridge_name/env/ directory or creating them with the cartridge's setup and install scripts.
Entries in a cartridge's
$cartridge_name/env/ directory do not override system-provided environment variables. Using system-provided environment variable names in the $cartridge_name/env/ directory prevents the cartridge from installing correctly.
Prefix custom environment variables with
OPENSHIFT_{cartridge short name}_ to prevent overwriting other cartridge variables in the packaged software's process environment space.
Suffix directory environment variables with
_DIR and the value with a backslash (/).
You can provide Embedded Ruby (ERB) templates for environment variables in the
$cartridge_name/env/ directory. OpenShift Enterprise processes ERB templates in this directory before calling the cartridge's setup script.
OpenShift Enterprise sets the
PATH variable using the path /etc/openshift/env/PATH. If you provide an OPENSHIFT_{Cartridge-Short-Name}_PATH_ELEMENT, OpenShift Enterprise uses the value to build the PATH when your scripts run or an application developer performs an interactive log on.
Important
OpenShift Enterprise does not validate cartridge-provided environment variables. A cartridge can fail to function if its environment variable files contain invalid data.
Packaged Software Environment Variables
If your cartridge packages software with its own environment variables, add these variables to the cartridge's $cartridge_name/env/ directory or include them in the shim code of the scripts in the $cartridge_name/bin/ directory.
Example 7.1. Jenkins Environment Variables
JENKINS_URLJENKINS_USERNAMEJENKINS_PASSWORD
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.