6.3. install Script

Synopsis

install [ --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 install script creates and configures files that OpenShift Enterprise copies from the cartridge repository to the gear's directory. OpenShift Enterprise runs the install script only on the first installation of a cartridge.

Put logic for one-time operations, for example generating passwords, creating ssh keys, and adding environment variables, in the install script.
Report client results and messages with the install script, not the setup script.
The install script may substitute a version dependent of the template or template.git directories.
Lock context: unlocked.