A downloadable cartridge which can be used to run Vert.x on OpenShift.
If you don't have an account, or aren't familiar with OpenShift you can go to Getting Started with OpenShift to help guide you through setting up your environment.
Once our environment is setup we can create our first application (we'll call it demo) using the rhc client tools.
rhc app create demo vertx
To create a scaled vertx application:
rhc app create demo vertx -s
This will create a directory named demo which will include the server.js application that this cartridge uses as the
default application. You should be able to access your application and see a OpenShift Vertx welcome page. From here you
now have the ability to run your favorite Vert.x application in the cloud. Enjoy !
The cartridge by default is configured to run the server.js as a raw verticle. To modify this value change the variable in the configuration/vertx.env file:
export vertx_app=server.js
To configure the cartridge to run a module just add the module name, i.e. org.example~my-mod~1.0.0 to the configuration/vertx.env file:
export vertx_module=org.example~my-mod~1.0.0
This tells Vert.x to look for the module org.example~my-mod~1.0.0 under the mods directory of your application. To deploy the module just add the module (under the mods directory) to the git repository and push.
To configure the cartridge to run a module zip just add the name, i.e. org.example~my-mod.zip to the configuration/vertx.env file:
export vertx_zip=org.example~my-mod.zip
This tells Vert.x to look for the org.example~my-mod.zip file in the root of your application. To deploy the module zip just add the zip module to the git repository and push.
All Vert.x run options are configured with the vertx_run_options variable in the configuration/vertx.env file. For example if you want to specify the number of instances to deploy:
export vertx_run_options="-instances 3"
See Running Vert.x for the options that are available depending on your type of application (raw, module, or zip).
To configure Vert.x in OpenShift you need to SSH into the application. This is explained in Remote Access to Your Application
Once you SSH into your application you will notice a vertx/conf directory. This is where Vert.x will look for it's configuration files, just as it looks in $VERTX_HOME/conf of your local installation. Here you can modify files like logging.properties and lang.properties.
Clustering is supported when the application is scaled through OpenShift when you create your application rhc app create <my-app> <url> -s. It's important to note that you do not need to add -cluster or modify the cluster.xml file of Vert.x. This will be handled automatically by the cartridge.
For more information on application scaling in OpenShift see Scaling on OpenShift.
The version of Vert.x that is installed by default is specified by the cartridge metadata/manifest.yml file. However it may be necessary to update the version manually w/out having to re-create the application:
rhc ssh demo 'echo 2.1.2 > vertx/env/OPENSHIFT_VERTX_VERSION'
rhc ssh demo 'vertx/bin/control restart'
The above commands will change the Vert.x version stored in form of $OPENSHIFT_VERTX_VERSION environment variable and restart the application. The new version will be downloaded and installed into vertx/usr directory during the cartridge startup phase. Once the application is restarted successfully, you should be running the new version.
The existing configuration in vertx/conf directory will be left unchanged. If you want to update the configuration as well, you might want to copy over the files from the vertx/usr/vert.x-$version/conf directory.
Note: The cartridge removes all unused versions from vertx/usr directory during the cartridge startup phase.
- Support maven project so module/zip is built when code is pushed to OpenShift.