OpenShift Online

User Guide

Managing Applications in the Cloud with OpenShift Online

Edition 1.0

Red Hat OpenShift Documentation Team

Legal Notice

Copyright © 2014 Red Hat.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, OpenShift, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
All other trademarks are the property of their respective owners.


This guide provides an introduction to OpenShift Online and documents its application management functions.
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. Getting Help
2.1. Do You Need Help?
2.2. We Need Feedback!
I. Introduction
1. Introduction to OpenShift Online
1.1. Basic Architecture
1.2. Subscription Plans
1.3. User Interfaces
1.3.1. Management Console
1.3.2. Client Tools
1.4. What's New in Current Release
2. Getting Started
2.1. OpenShift Account
2.2. Client Tools
2.3. Basic Administration
2.3.1. Viewing Account Information
2.3.2. Ending Current Session
3. Authentication
3.1. Authorization Tokens
3.1.1. Introduction to Authorization Tokens
3.1.2. Creating Authorization Tokens
3.1.3. Viewing Authorization Tokens
3.1.4. Deleting Authorization Tokens
3.2. SSH Keys
3.2.1. Introduction to SSH Keys
3.2.2. Generating Keys Manually
3.2.3. Adding a Key
3.2.4. Viewing All Public Keys
3.2.5. Viewing a Specific Public Key
3.2.6. Deleting a Key
3.2.7. Resolving Authentication Issues
II. Domains and SSL Certificates
4. Domains
4.1. Introduction to Domains
4.2. Domain Management
4.2.1. Creating a Domain
4.2.2. Listing Available Domains
4.2.3. Viewing a Domain
4.2.4. Renaming a Domain
4.2.5. Deleting a Domain
5. Domain Membership
5.1. Introduction to Domain Membership
5.2. Managing Domain Membership
5.2.1. Adding a Member
5.2.2. Changing Member Role
5.2.3. Listing Members of a Domain
5.2.4. Listing Members of an Application
5.2.5. Removing a Member
6. Custom Domains and SSL Certificates
6.1. Introduction to Custom Domains and SSL Certificates
6.2. Managing Custom Domain Names
6.3. Managing Custom SSL Certificates
III. Cartridges and Applications
7. Cartridges
7.1. Introduction to Cartridges
7.1.1. Web Framework Cartridges
7.1.2. Add-on Cartridges
7.1.3. Downloadable Cartridges
8. Applications
8.1. Introduction to Applications
8.1.1. Application Life Cycle
8.1.2. Scalable and Non-Scalable Applications
9. Application Management
9.1. General Information
9.2. Creating an Application
9.3. Cloning an Existing Application
9.4. Cloning the Remote Application Repository
9.5. Viewing Applications for a User
9.6. Scaling an Application Manually
9.7. Application Management Commands
9.8. Managing Applications in a Secure Shell Environment
9.8.1. Introduction to Secure Shell Environment
9.8.2. Accessing an Application
9.8.3. Accessing a Specific Gear
9.8.4. Accessing a Database Cartridge
9.9. Monitoring Gear and Cartridge Status with Watchman
9.10. Scheduling Cron Jobs
9.11. Binding Applications to Ports
9.11.1. Configuring WebSocket Ports
9.11.2. Configuring Email Ports
9.12. Port Forwarding
9.12.1. Introduction to Port Forwarding
9.12.2. Application Port Forwarding
9.12.3. Gear Port Forwarding
9.12.4. Port Forwarding on Mac OS X
9.13. Deleting an Application
10. Cartridge Management
10.1. Viewing Available Cartridges
10.2. Adding a Cartridge to an Application
10.3. Viewing Cartridges for an Application
10.4. Cartridge Management Commands
11. Build and Deployment
11.1. Introduction to Deployment
11.2. Preparing an Application for Deployment
11.3. Deployment Mechanisms
11.3.1. Automatic Deployment
11.3.2. Manual Deployment
11.4. Action Hooks
11.4.1. Introduction to Action Hooks
11.4.2. Cartridge Action Hooks
11.4.3. Build and Deployment Action Hooks
11.4.4. Scaling Action Hooks
11.5. Environment Variables
11.5.1. Introduction to Environment Variables
11.5.2. Informational Environment Variables
11.5.3. Directory Environment Variables
11.5.4. Database Environment Variables
11.5.5. Library Environment Variables
11.5.6. Jenkins Environment Variables
11.5.7. Gear Environment Variables
11.5.8. JBoss Environment Variables
11.5.9. Ruby Environment Variables
11.5.10. Python Environment Variables
11.5.11. Custom Environment Variables
11.6. Hot Deployment
11.6.1. Introduction to Hot Deployment
11.6.2. Hot Deployment Build Details
11.6.3. Enabling and Disabling Hot Deployment
11.7. Jenkins Continuous Integration
11.7.1. Introduction to Jenkins
11.7.2. Configuring Jenkins
11.7.3. Building Applications with Jenkins
12. Gear Storage and Disk Space Management
12.1. Introduction to Gear Storage and Disk Space
12.2. Viewing Gear Storage
12.3. Adding Gear Storage
12.4. Setting Gear Storage
12.5. Removing Gear Storage
12.6. Tidying an Application
13. Application Backup and Restoration with Snapshots
13.1. Introduction to Snapshots
13.2. Creating an Application Snapshot
13.3. Restoring from an Application Snapshot
13.4. Migrating an Application to Another Gear
A. Revision History