6.2. setup Script

Synopsis

setup [ --version <version> ]

Options

--version <version>: selects which version of the cartridge to install. If you do not supply a version, OpenShift Enterprise installs the version given in the Version element of the $cartridge_name/metadata/manifest.yml file.

Description

The setup script creates and configures files that OpenShift Enterprise copies from the cartridge repository to the gear's directory. The setup script must be re-entrant. OpenShift Enterprise runs the script for every upgrade that is not backward compatible. Add logic you want to run only once to the install script, not the setup script.

Add files created during setup to the setup_rewritten section of the $cartridge_name/metadata/managed_files.yml file. During an upgrade, OpenShift Enterprise deletes these files prior to running the setup script.
If you use ERB templates to configure software, OpenShift Enterprise processes these files for environment variable substitution after running the setup script.
Lock context: unlocked.