OpenShift Cartridge Tools

This is a set of tools that makes the OpenShift cartridge/quickstart developers life easier.

The OpenShift Cartridge Lint is an utility which helps developers to test the validity and syntax of the cartridge metadata.

In future this command will be expanded to provide more functionality, but for now you can use it to validate the cartridge 'manifest.yml' file to make sure you haven't missed some required attribute or you not made the syntax error.

To check your current cartridge, you can run the following command:

$ cd cartridge-dir/
$ oo-cartridge-lint manifest

The output should tell you if your manifest.yml has correct syntax or not. The sample output might look like this:

 ~/code/openshift-origin-cartridge-ruby → oo-cartridge-lint manifest --file metadata/manifest.yml.rhel
[openshift-origin-cartridge-ruby/metadata/manifest.yml.rhel] INVALID
  [/] - key 'Description:' is required.
  [/Architecture] - 'arm': invalid Architecture value.

(Note: The --file option is optional, by default the command will check the metadata/manifest.yml path.

This command will create and prepare directory with DIY cartridge. It is basically a bootstrap script for the new cartridge.

$ oo-cartridge-create diy --name openshift-sidekiq-cartridge
Cartridge-Short-Name (eg. "redis"): sidekiq
Version: 1.0
The './openshift-sidekiq-cartridge/' cartridge was succesfully created...

The 'openshift-sidekiq-cartridge' directory will then contain a DIY cartridge bootstrap and you could start adding your code into it.

• kwalify
• commander

(Don't worry, these dependencies are installed automatically for you)

$ gem install oo-cartridge-tools