Permalink
Browse files

refs #4, module documentation

  • Loading branch information...
1 parent 9236636 commit f5c279ea955d2ff938b30ca2fae6acf231b58f81 @opensas committed Jan 29, 2012
View
@@ -23,18 +23,16 @@ def import_module(module_name, file_path=""):
# Commands that are specific to your module
COMMANDS = [
- "rhc:test", "rhc:hello", "rhc:chk", "rhc:info", "rhc:app", "rhc:create", "rhc:open", "rhc:deploy", "rhc:destroy", "logs"
+ "rhc:test", "rhc:hello", "rhc:chk", "rhc:info", "rhc:open", "rhc:deploy", "rhc:destroy", "logs"
]
HELP = {
'rhc:chk': 'Check openshift prerequisites, application and git repo.',
'rhc:info': 'Displays information about user and configured applications.',
- 'rhc:app': 'Displays basic information about current application.',
- 'rhc:create': 'Creates application on openshift.',
'rhc:open': 'Opens the application deployed on openshift in web browser.',
'rhc:deploy': 'Deploys application on openshift.',
'rhc:destroy': 'Destroys application on openshift.',
- 'rhc:destroy': 'Show the logs of the application on openshift.'
+ 'rhc:logs': 'Show the logs of the application on openshift.'
}
class OpenshiftOptionParser(OptionParser):
@@ -67,10 +65,10 @@ def execute(**kargs):
if options.subdomain == '': options.subdomain = app.readConf('openshift.application.subdomain')
if options.rhlogin == '': options.rhlogin = app.readConf('openshift.rhlogin')
- if options.rhlogin == '': error_message("You must provide rhlogin parameter using the -l RHLOGIN command line option or setting openshift.rhlogin in application.conf file.")
+ if options.rhlogin == '': error_message("You must provide your red hat's login using the -l RHLOGIN command line option or setting openshift.rhlogin in application.conf file.")
if options.password == '': options.password = app.readConf('openshift.password')
- if options.password == '': error_message("You must your openshift password parameter using the -p PASSWORD command line option or setting openshift.password in application.conf file.")
+ if options.password == '': error_message("You must provide your openshift password using the -p PASSWORD command line option or setting openshift.password in application.conf file.")
if options.debug == '': options.debug = app.readConf('openshift.debug')
if options.debug == '': options.debug = False
@@ -87,7 +85,6 @@ def execute(**kargs):
if command == "chk": openshift_check(app, options)
if command == "info": openshift_info(options)
if command == "app": openshift_app(options)
- if command == "create": create_app(app, options)
if command == "open": open_app(options)
if command == "logs": openshift_logs(options)
if command == "deploy": deploy_app(args, app, env, options)
View
Binary file not shown.
View
@@ -1,4 +1,4 @@
-self: play -> openshift 0.1
+self: play -> openshift 1.0
require:
- - play
+ - play
Binary file not shown.
@@ -1,33 +1,115 @@
-h1. {module name}
+h1. Openshift module
-modified
+Openshift is Red Hat's free, auto-scaling, cloud-based platform-as-a-service for Java, Perl, PHP, Python, and Ruby applications.
-p(note). Write your module documentation in this file, possibly linking to other Textile files, and delete these notes when you are finished.
-p(note). Start with a clear statement of what the module is and what it is for. Link to any third-party libraries that the module is based on.
+With this module, you'll be able to easily deploy and manage your play application on Red Hat's cloud platform, with just a couple of simple commands from the command line.
-p(note). Briefly describe why you might want to use this module in a Play application.
+The module does not depend on any external Java libray. You'll just need an openshift account, git and openshift command line tools installed on your workstation.
+
+Source code is available at <a href="https://github.com/opensas/openshift">https://github.com/opensas/openshift</a>
+Written by Sebastián Scarano (<a href="http://www.twitter.com/develsas">@develsas</a>)
h2. Sample application
p(note). Your module should contain a sample app in the @sample@ directory that demonstrates the module. Describe how to run the demo here.
-h2. Getting started
+h2. <a name="getting_started">Prerequisites</a>
+
+Before being able to deploy your play application to openshift, you have to:
+
+* <a href="http://www.playframework.org/documentation/latest/install">install play</a>
+
+* <a href="https://openshift.redhat.com/app/user/new/express">sign up for openshift</a>
+
+* <a href="http://docs.redhat.com/docs/en-US/OpenShift_Express/2.0/html/User_Guide/sect-User_Guide-Working_With_Domains.html#sect-User_Guide-Working_With_Domains-Creating_a_Domain">create a domain</a>
+
+* <a href="https://www.redhat.com/openshift/community/kb/kb-e1000/installing-openshift-express-client-tools-on-non-rpm-based-systems">install openshift's command line tools</a>.
+
+h2. <a name="getting_started">Getting started</a>
+
+To install Openshift module add it as a dependency in your dependencies.yml file:
+
+bc. require:
+ -play -> openshift {version}
+
+Then execute:
+
+bc. play deps
-p(note). Describe any installation that is required, beyond adding and resolving the module dependency.
+p(note). Openshift hasn't been added to playframework's module repository so far. In the meantime, you can start using it right away with a dependencies.yml file like the following:
+
+bc.# Application dependencies
+
+require:
+ - play
+ - openshift -> openshift
+
+repositories:
+ - My local modules:
+ type: local
+ artifact: ${application.path}/../[module]
+ contains:
+ - openshift
+
+After that, deploying you play application to openshift is as easy as:
+
+bc. play rhc:deploy -l <your_openshift_email_acount> -p <your_openshift_password>
+
+And the module will create your app at openshift if it it's not already there, compile and package your app as a war folder, commit it in yout local git reposityr and then push it to openshift. Moreover, you can add the '-o' parameter to have the module automatically open you newly deployed app in a web browser.
h2. Configuration
+Openshift module allows you to define the following command line parameters directly on the application.conf file, so that you may avoid specifying them. You can always override them from the command line.
+
+h3. Your Red Hat login account
+
+Red Hat login (RHN or OpenShift login with OpenShift Express access) account is a mandatory parameter. It's the email address you used to register at openshift. You can specify it using the '-l' or '--rhlogin' command line parameter or adding an 'openshift.rhlogin' option in you application.conf file. If none of these are specified, openshift command line tools will use you git configured email account. For more info check [Set your user name, email and GitHub token]:"http://help.github.com/set-your-user-name-email-and-github-token/".
+
+h3. Your Red Hat login password
+
+Red Hat login password is a mandatory parameter. You can specify it using the '-p' or '--password' command line parameter or adding an 'openshift.rhlogin' option in you application.conf file.
+
+h3. Application name
+
+The application name is a mandatory parameter. You can specify it using the '-a' or '--app' command line parameter or adding an 'openshift.application.name' option in you application.conf file. If none of these are specified, openshift module will read the application's file from the 'application.name' entry in your application.conf file.
+
+h3. Application subdomain
+
+By default your play application will be deployed to openshift according to the following scheme:
+
+```
+http://<application name>-<domain-name>.rhcloud.com
+```
+
+You can have it deployed on a subdomain specifing it with the '-s' or '--subdomain' command line parameter or adding an 'openshift.application.subdomain' option in you application.conf file. In that case you'll be able to reach you application at:
+
+```
+http://<application name>-<domain-name>.rhcloud.com/<application subdomain>
+```
+
+h3. Timeout
+
+You can optionally specify a timeout, in seconds, for connection, using the '--timeout' command line parameter or adding an 'openshift.timeout' option in you application.conf file.
+
+h3. Debug
+
+You can tell Openshift module to print extra debug info, to help you troubleshoot and analyze any problem you encounter.
+
+You can optionally specify a timeout, in seconds, for connection, using the '--timeout' command line parameter or adding an 'openshift.timeout' option in you application.conf file.
+
+
+
+Timeout, in seconds, for connection
+
+
+
p(note). List any configuration options that the module uses, with an @h3.@ heading for each one.
h2. Usage
p(note). Explain how to use the module, and describe any routes, controllers, models or views that the module provides.
-h2. Tags
-
-p(note). List any tags the module provides, with an @h3.@ heading for each one. Include the tags’ arguments.
-
h2. Commands
p(note). List any commands the module provides, with an @h3.@ heading for each one. Include the commands’ options.
View
Binary file not shown.
View
@@ -1,8 +1,8 @@
h1. Openshift Module for Play! Framework Applications
-Openshift is Red Hat's free, cloud-based application platform for Java, Perl, PHP, Python, and Ruby applications.
+Openshift is Red Hat's free, auto-scaling, cloud-based platform-as-a-service for Java, Perl, PHP, Python, and Ruby applications.
-With the openshift module for Play Framework, you'll be able to deploy and manage your play application on Red Hat's cloud platform.
+With this module, you'll be able to easily deploy and manage your play application on Red Hat's cloud platform.
The module does not depend on any external Java libray. You'll just need an openshift account, git and openshift command line tools installed on your workstation.

0 comments on commit f5c279e

Please sign in to comment.