Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 3.02 KB

OS-README.md

File metadata and controls

71 lines (49 loc) · 3.02 KB
Raw

OpenShift Project Information

This file copied from an OpenShift layout and then formatted for Markdown.

Repo layout

  • node_modules/ - Any Node modules packaged with the app
  • deplist.txt - Deprecated.
  • package.json - npm package descriptor.
  • .openshift/ - Location for openshift specific files
  • .openshift/action_hooks/pre_build - Script that gets run every git push before the build
  • .openshift/action_hooks/build - Script that gets run every git push as part of the build process (on the CI system if available)
  • .openshift/action_hooks/deploy - Script that gets run every git push after build but before the app is restarted
  • .openshift/action_hooks/post_deploy - Script that gets run every git push after the app is restarted

Notes about layout

Please leave the node_modules and .openshift directories but feel free to create additional directories if needed.

Note: Every time you push, everything in your remote repo dir gets recreated please store long term items (like an sqlite database) in the OpenShift data directory, which will persist between pushes of your repo. The OpenShift data directory is accessible relative to the remote repo directory (../data) or via an environment variable OPENSHIFT_DATA_DIR.

Environment Variables

OpenShift provides several environment variables to reference for ease of use. The following list are some common variables but far from exhaustive:

  • process.env.OPENSHIFT_GEAR_NAME - Application name
  • process.env.OPENSHIFT_DATA_DIR - For persistent storage (between pushes)
  • process.env.OPENSHIFT_TMP_DIR - Temp storage (unmodified files deleted after 10 days)

When embedding a database using 'rhc app cartridge add', you can reference environment variables for username, host and password:

  • process.env.OPENSHIFT_MYSQL_DB_HOST - DB Host
  • process.env.OPENSHIFT_MYSQL_DB_PORT - DB Port
  • process.env.OPENSHIFT_MYSQL_DB_USERNAME - DB Username
  • process.env.OPENSHIFT_MYSQL_DB_PASSWORD - DB Password

When embedding a NoSQL database using 'rhc app cartridge add', you can reference environment variables for username, host and password:

  • process.env.OPENSHIFT_MONGODB_DB_HOST - NoSQL DB Host
  • process.env.OPENSHIFT_MONGODB_DB_PORT - NoSQL DB Port
  • process.env.OPENSHIFT_MONGODB_DB_USERNAME - NoSQL DB Username
  • process.env.OPENSHIFT_MONGODB_DB_PASSWORD - NoSQL DB Password

To get a full list of environment variables, simply add a line in your .openshift/action_hooks/build script that says "export" and push.

deplist.txt

A list of node modules to install, line by line on the server. This will happen when the user does a git push.

Additional information

Link to additional information will be here, when we have it :)