OpenShift Online

User Guide

Using OpenShift Online to manage your applications in the cloud

Edition 1.0

Legal Notice

Copyright © 2013 Red Hat, Inc.
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.

Abstract

This guide provides an introduction to OpenShift Online and documents its application management functions.
Preface
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!
1. Introduction
1.1. Platform Overview
2. OpenShift User Interfaces
2.1. Management Console
2.2. Client Tools
3. User Accounts
3.1. Basic Administration
3.1.1. Management Console
3.1.2. Client Tools
3.2. Authorization Tokens
3.2.1. Creating Authorization Tokens
3.2.2. Viewing Authorization Tokens
3.2.3. Deleting Authorization Tokens
4. Namespaces
4.1. Namespaces Overview
4.2. Creating a Namespace
4.3. Viewing a Namespace
4.4. Altering a Namespace
4.5. Deleting a Namespace
4.6. Custom Domains and SSL Certificates
4.6.1. Adding a custom domain name
4.6.2. Removing a custom domain name
4.6.3. Adding a custom SSL certificate
4.6.4. Removing a custom SSL certificate
5. Applications and Cartridges
5.1. Applications Overview
5.1.1. Scaled Applications
5.1.1.1. How Scaling Works
5.1.1.2. Automatic and Manual Scaling
5.1.2. Non-scaled Applications
5.1.3. WebSocket Connections
5.2. Cartridges Overview
5.2.1. Addon Cartridges
5.3. Creating an Application
5.3.1. Management Console
5.3.1.1. Creating Applications
5.3.1.2. Manually Scaling an Application
5.3.1.3. Cloning the Application Git Repository
5.3.2. Command Line Interface
5.3.2.1. Creating Single-Instance Applications
5.3.2.2. Creating Scaled Applications
5.3.2.3. Manually Scaling an Application
5.4. Adding and Managing Cartridges
5.4.1. Management Console
5.4.1.1. Adding Cartridges
5.4.2. Command Line Interface
5.4.2.1. Adding Cartridges
5.4.2.2. Managing Cartridges
5.5. Working With Database Cartridges
5.5.1. Adding a Database
5.5.2. Managing Databases in a Shell Environment
5.5.3. Managing a MongoDB Database with RockMongo
5.6. Deploying Applications
5.6.1. Preparing Your Application for Deployment
5.6.2. Deploying Your Application to the Cloud
5.6.3. Hot Deploying Applications
5.6.3.1. Hot Deployment Build Details
5.6.3.2. Enabling and Disabling Hot Deployment
5.6.4. Deploying JBoss Applications
5.6.4.1. Deploying on Java 6 or Java 7
5.6.4.2. Automatic Deployment
5.6.4.3. Types of Marker Files
5.6.4.4. Example JBoss Application Deployment Workflows
5.7. Jenkins Online Build System
5.7.1. Configuring Jenkins
5.7.1.1. Resource Requirements for Jenkins
5.7.2. Creating Jenkins-enabled Applications
5.7.2.1. Creating a Scaled Jenkins-enabled Application
5.7.2.2. Creating a Single-instance Jenkins-enabled application
5.7.2.3. Confirming Your Jenkins-enabled Application
5.7.3. Building Applications with Jenkins
5.7.3.1. Building Custom Applications
5.7.4. Building Applications Without Jenkins
5.8. Deleting an Application
5.8.1. Management Console
5.8.2. Command Line Interface
5.8.3. Deleting Local Application Data
5.9. Storage Management
5.9.1. Management Console
5.9.1.1. Changing Gear Storage
5.9.2. Command Line Interface
5.9.2.1. Viewing Gear Storage
5.9.2.2. Adding Gear Storage
5.9.2.3. Set Gear Storage
5.9.2.4. Removing Gear Storage
5.9.2.5. Managing Application Disk Space
6. Managing Applications
6.1. Application Management Commands
6.2. Managing Applications in a Secure Shell Environment
6.2.1. Linux and Mac
6.2.2. Windows
6.2.3. Accessing a Specific Gear
6.3. Environment Variables
6.3.1. Informational Environment Variables
6.3.2. Directory Environment Variables
6.3.3. Database Environment Variables
6.3.4. Jenkins Environment Variables
6.3.5. Gear Environment Variables
6.3.6. JBoss Environment Variables
6.4. Node.js
6.4.1. Repository Layout
6.4.2. Installing Node Modules
6.5. Scheduling Timed Jobs with Cron
6.6. Sending and Receiving Email
6.6.1. Email Port Configuration
7. SSH Authentication
7.1. SSH Authentication Overview
7.2. Resolving Authentication Issues
7.3. Using the Interactive Setup Wizard
7.4. Viewing All Public Keys
7.5. Viewing a Specific Public Key
7.6. Generating Keys Manually
7.7. Adding a Key
7.8. Removing a Key
8. Monitoring and Troubleshooting
8.1. Monitoring Application Resources
8.2. MongoDB Monitoring Service (MMS)
8.2.1. Configuring an Application with MMS
8.2.2. Monitoring Applications with MMS
8.2.2.1. Adding Hosts to MMS
8.2.2.2. MMS Monitoring with a Browser
8.3. Troubleshooting JBoss Applications
8.3.1. Using Thread Dumps
8.3.2. Inspecting Server, Boot and Other Log Files
8.4. Performing Application Maintenance from Your Workstation
8.4.1. Port Forwarding
8.4.1.1. Port Forwarding on Mac OS X
9. Backing Up and Restoring Application Data
9.1. Creating Application Snapshots
9.2. Restoring Application Snapshots
A. Revision History