Sample Load Balancer Cartridge Definition

The configurations included in a lb-cartridge.json file are as follows:

{
    "type":"lb",
    "provider":"lb",
    "host":"stratos.org",
    "displayName":"load balancer",
    "description":"LB Cartridge",
    "version":"4",
    "defaultAutoscalingPolicy":"economyPolicy",
    "multiTenant":"false",
    "portMapping":[
         {
            "protocol":"http",
            "port":"8280",
            "proxyPort":"8280"
         },
         {
            "protocol":"https",
            "port":"8243",
            "proxyPort":"8243"
         }
    ],
    "iaasProvider":[
         {
            "type":"ec2",
            "imageId":"apsoutheast1/ami70326522",
            "maxInstanceLimit":"5",
            "property":[
               {
                  "name":"instanceType",
                  "value":"m1.medium"
               },
               {
                  "name":"keyPair",
                  "value":"xxxxxx"
               }
            ]
         }
    ],
    
    "property":[
         {
            "name":"load.balancer",
            "value":"true"
         }
    ]
}

Parameter definitions

Cartridge definitions

Parameter	Description	Required	Default Value	Example Value
`type`	Type of the cartridge	Yes	N/A	lb
`provider`	Provider of the load balancer cartridge	Yes	N/A	lb
`host`	Domain where the load balancer cartridge will be hosted	Yes	N/A	stratos.org
`displayName`	The name in which the load balancer cartridge will be displayed	Yes	N/A	load balancer
`description`	A short description about the load balancer cartridge	No	N/A	LB Cartridge
`version`	The version of the load balancer cartridge application	Yes	N/A	4
`defaultAutoscalingPolicy`	The auto-scaling policy used by the load balancer cartridge	Yes	N/A	economyPolicy
`multiTenant`	Whether the load balancer cartridge supports multi tenancy	Yes	false	false
`portMapping`	Details of the ports mapped to the load balancer cartridge You can add parameter definitions on multiple port mappings if required.	Yes	N/A	N/A
`iaasProvider`	Details of the IaaS provider that is used for the load balancer cartridge You can add parameter definitions on multiple IaaS providers if required.	Yes	N/A	N/A
property	It is mandatory that LB cartridge definitions include the following property configurations: "name":"load.balancer", "value":"true" Administrators can define dynamic parameters together with its corresponding values, which need to be set when an instance is spawned, via the `property` parameter. The LB will directly send these dynamic parameters together with its corresponding values, as key value pairs to the Private PaaS instance. `"name":"payload_parameter.<PARAMETER-NAME>"` "value":"<PARAMETER-VALUE>" For example: `"name":"payload_parameter.AB_IP"` "value":"4500"

portMapping

Parameter	Description	Required	Default Value	Example Value
`protocol`	The protocol that is used to map the ports	Yes	N/A	http
`port`	The port to which the load balancer cartridge is mapped	Yes	N/A	80
`proxyPort`	The proxy port to which the cartridge is mapped	Yes	N/A	8280

iaasProvider

Parameter	Description	Required	Default Value	Example Value
type	Type of the IaaS provider	Yes	N/A	ec2
imageId	The unique ID of the IaaS image	Yes	N/A	apsoutheast1/ami70326522
maxInstanceLimit	The maximum instances that will be spawned in the IaaS	Yes	N/A	5
`property`	The IaaS provider properties are listed as name value pairs. It is mandatory that IaaS provider definitions include the following property configurations: { "name":"instanceType", "value":"m1.medium" }, { "name":"keyPair", "value":"xxxxxx" } Administrators can define other dynamic parameters together with its corresponding values appropriately, which need to be set when an instance is spawned, via this `property` parameter.	Yes	N/A	N/A

property

Parameter	Description	Required	Default Value	Example Value
`name`	Name of the property.	No	N/A	AB_IP
`value`	Value corresponding to the property.	No	N/A	4500