This chapter provides information on API resources that allow a client to manage OpenShift cartridges. Cartridges are the components of an OpenShift application, and include databases, build systems, and management capabilities. Adding a cartridge to an application provides the desired capability without requiring you to administer or update the included feature. T here are two types of cartridges available with OpenShift: standalone and embedded.

Standalone Cartridges

Standalone cartridges allow you to choose from a variety of programming languages and frameworks for developing your application. Every application requires a framework cartridge. Examples include PHP, JBoss, and Ruby. The table below describes each parameter associated with both standalone and embedded cartridges.
NameDescription
nameName of the cartridge.
versionVersion of the packaged software in the cartridge.
licenseLicense of the packaged software in the cartridge.
license_urlURL of the license file for the packaged software in the cartridge.
websiteWebsite URL for the packaged software in the cartridge.
help_topicsMap of topics and associated URLs that can provide help on how to use and configure the cartridge.
display_nameFormatted name of the cartridge for user interfaces.
descriptionDescription of the cartridge for user interfaces.
current_scaleCurrent number of gears used to run the cartridge.
scales_fromMinimum number of gears that a cartridge can scale to; once reached, scale_down requests are rejected. Cannot be less than the supported_scales_from value.
scales_toMaximum number of gears that a cartridge can scale to; once reached, scale_up requests are rejected. Cannot be greater than the supported_scales_to value.
scales_withNames of other cartridges that scale with this cartridge and run on the same set of gears; currently only HAProxy-1.4 is available.
supported_scales_fromMinimum number of gears supported by the cartridge; the scales_from value cannot be less than this number.
supported_scales_toMaximum number of gears supported by the cartridge; the scales_to value cannot be greater than this number.
tagsArray of tags associated with the cartridge.
usage_ratesPlan usage costs.
status_messagesStatus messages returned back by the cartridge.

Embedded Cartridges


Embedded cartridges provide extended functionality to OpenShift applications. Examples include MySQL, MongoDB, and phpMyAdmin. The table below describes each parameter associated with only embedded cartridges.
NameDescription
additional_gear_storageSet additional filesystem storage in gigabytes for the gear profile that the cartridge is running on.
base_gear_storageDefault basic storage in gigabytes associated with the gear profile that the cartridge is running on.
collocated_withArray of names of other cartridges that share the same gear(s) with the cartridge.
gear_profileSize of the gears grouped in this profile that the cartridge is running on; all gears in a group will have the same gear_profile.
propertiesList of environment variables and property values exposed by the cartridge and usable in application code.