Chapter 16. Gear Groups

Gear groups are of the same size and share scaling limit in terms of maximum number of gears. A gear group is automatically created when a scaled application is created, or when a cartridge is added to a scaled application. For an application that is not scalable, only one gear group gets created. All cartridges in a gear group scale together.

16.1. Get Application Gear Groups

Description

Get a list of gear groups where each group represents a list of gears that share scaling and storage policies.

Note

Section 13.2.2, “List Embedded Cartridges” provides information on how to view scaling and storage policies for scaled cartridges.
Method and URL Structure

Method URL Structure
GET /broker/rest/application/:id/gear_groups

Request Parameters

Not applicable

cURL Command Example

$ curl -X GET https://openshift.redhat.com/broker/rest/application/5213190e2587c8817a000121/gear_groups --user user@example.com

JSON Response

The API returns a list of all gear groups for the specified application. See Chapter 13, Cartridges for more information on all cartridge parameters. 

"api_version": 1.7,
  "data": [
    {
      "additional_gear_storage": 0,
      "base_gear_storage": 1,
      "cartridges": [
        {
          "name": "haproxy-1.4",
          "display_name": "Web Load Balancer",
          "tags": [
            "web_proxy",
            "scales",
            "embedded"
          ]
        },
        {
          "name": "ruby-1.9",
          "display_name": "Ruby 1.9",
          "tags": [
            "service",
            "ruby",
            "web_framework"
          ]
        }
      ],
      "gear_profile": "small",
      "gears": [
        {
          "id": "53bdbd95e19923514a0000c1",
          "state": "started",
          "ssh_url": "ssh://53bdbd95e19923514a0000c1@myapp-mydomain.rhcloud.com",
          "region": null,
          "zone": null
        }
      ],
      "id": "53bdbd95e19923514a0000c3",
      "name": "53bdbd95e19923514a0000c3",
      "scales_from": 1,
      "scales_to": -1
    }
  ],
  "messages": [
    {
      "exit_code": 0,
      "field": null,
      "index": null,
      "severity": "info",
      "text": "Showing gear groups for application 'myapp' with domain 'mydomain'"
    },
    {
      "exit_code": 0,
      "field": null,
      "index": null,
      "severity": "result",
      "text": "started\n"
    }
  ],
  "status": "ok",
  "supported_api_versions": [
    1.0,
    1.1,
    1.2,
    1.3,
    1.4,
    1.5,
    1.6,
    1.7
  ],
  "type": "gear_groups",
  "version": "1.7"