OpenShift Online

User Guide

Managing Applications in the Cloud with OpenShift Online

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, 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.
The OpenStack® Word Mark and OpenStack Logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.


The OpenShift Online User Guide helps developers set up and configure a workstation to develop and deploy applications in an OpenShift Online cloud environment with a command-line interface (CLI), more commonly known as the client tools. This guide provides detailed instructions and examples to help developers:
  • Create and manage domains and SSL certificates
  • Create, build, and deploy applications
  • Manage applications and cartridges
  • Monitor and manage application storage and resources
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. Getting Help and Giving Feedback
2.1. Do You Need Help?
2.2. We Need Feedback!
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 User 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
4. Multiple OpenShift Servers
4.1. Server Management
4.1.1. Adding a Server
4.1.2. Switching Between Servers
4.1.3. Configuring Server Settings
4.1.4. Listing Servers
4.1.5. Viewing a Server
4.1.6. Removing a Server
5. Domains
5.1. Introduction to Domains
5.2. Domain Management
5.2.1. Creating a Domain
5.2.2. Listing Available Domains
5.2.3. Viewing a Domain
5.2.4. Renaming a Domain
5.2.5. Deleting a Domain
5.2.6. Configuring Domain Gear Size
6. Teams
6.1. Introduction to Teams
6.2. Team Management
6.2.1. Creating a Team
6.2.2. Adding Members to a Team
6.2.3. Listing Your Teams
6.2.4. Viewing Team Information
6.2.5. Leaving a Team
6.2.6. Deleting a Team
7. Domain Membership
7.1. Introduction to Domain Membership
7.2. Managing Domain Membership
7.2.1. Adding a Member
7.2.2. Changing Member Role
7.2.3. Listing Members of a Domain
7.2.4. Listing Members of an Application
7.2.5. Removing a Member
8. Regions
8.1. Introduction to Regions
8.2. Region Management
8.2.1. Listing Available Regions
9. Cartridges
9.1. Introduction to Cartridges
9.1.1. Web Framework Cartridges
9.1.2. Add-on Cartridges
9.1.3. Downloadable Cartridges
10. Applications
10.1. Introduction to Applications
10.1.1. Application Life Cycle
10.1.2. Scalable Applications
11. Application Management
11.1. General Information
11.2. Creating an Application
11.3. Cloning an Existing Application
11.4. Cloning the Remote Application Repository
11.5. Viewing Applications for a User
11.6. Scaling an Application Manually
11.7. Application Management Commands
11.8. Managing Applications in a Secure Shell Environment
11.8.1. Introduction to Secure Shell Environment
11.8.2. Accessing an Application
11.8.3. Accessing a Specific Gear
11.8.4. Accessing a Database Cartridge
11.9. Custom Domains and SSL Certificates
11.9.1. Managing Custom Domain Names
11.9.2. Managing Custom SSL Certificates
11.10. Embedding 10gen MMS Agent
11.11. Scheduling Cron Jobs
11.12. Binding Applications to Ports
11.12.1. Configuring WebSocket Ports
11.12.2. Configuring Email Ports
11.13. Port Forwarding
11.13.1. Introduction to Port Forwarding
11.13.2. Application Port Forwarding
11.13.3. Gear Port Forwarding
11.13.4. Port Forwarding on Mac OS X
11.14. Deleting an Application
12. Cartridge Management
12.1. Viewing Available Cartridges
12.2. Adding a Cartridge to an Application
12.3. Viewing Cartridges for an Application
12.4. Cartridge Management Commands
13. Build and Deployment
13.1. Introduction to Deployment
13.2. Preparing an Application for Deployment
13.3. Deployment Mechanisms
13.3.1. Automatic Deployment
13.3.2. Manual Deployment
13.4. Action Hooks
13.4.1. Introduction to Action Hooks
13.4.2. Cartridge Action Hooks
13.4.3. Build and Deployment Action Hooks
13.4.4. Scaling Action Hooks
13.5. Environment Variables
13.5.1. Introduction to Environment Variables
13.5.2. Informational Environment Variables
13.5.3. Directory Environment Variables
13.5.4. Logging Environment Variables
13.5.5. Database Environment Variables
13.5.6. Library Environment Variables
13.5.7. Jenkins Environment Variables
13.5.8. Gear Environment Variables
13.5.9. JBoss Environment Variables
13.5.10. Ruby Environment Variables
13.5.11. Python Environment Variables
13.5.12. Custom Environment Variables
13.6. Hot Deployment
13.6.1. Introduction to Hot Deployment
13.6.2. Hot Deployment Build Details
13.6.3. Enabling and Disabling Hot Deployment
13.7. Jenkins Continuous Integration
13.7.1. Introduction to Jenkins
13.7.2. Configuring Jenkins
13.7.3. Building Applications with Jenkins
14. Gear Storage and Disk Space Management
14.1. Introduction to Gear Storage and Disk Space
14.2. Viewing Gear Storage
14.3. Adding Gear Storage
14.4. Setting Gear Storage
14.5. Removing Gear Storage
14.6. Tidying an Application
15. Application Backup and Restoration with Snapshots
15.1. Introduction to Snapshots
15.2. Creating an Application Snapshot
15.3. Restoring from an Application Snapshot
15.4. Migrating an Application to Another Gear
A. Revision History