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.
Name | Description |
name | Name of the cartridge. |
version | Version of the packaged software in the cartridge. |
license | License of the packaged software in the cartridge. |
license_url | URL of the license file for the packaged software in the cartridge. |
website | Website URL for the packaged software in the cartridge. |
help_topics | Map of topics and associated URLs that can provide help on how to use and configure the cartridge. |
display_name | Formatted name of the cartridge for user interfaces. |
description | Description of the cartridge for user interfaces. |
current_scale | Current number of gears used to run the cartridge. |
scales_from | Minimum 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_to | Maximum 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_with | Names 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_from | Minimum number of gears supported by the cartridge; the scales_from value cannot be less than this number. |
supported_scales_to | Maximum number of gears supported by the cartridge; the scales_to value cannot be greater than this number. |
tags | Array of tags associated with the cartridge. |
usage_rates | Plan usage costs. |
status_messages | Status messages returned back by the cartridge. |