Page Comparison

A cartridge is a container for a framework, load balancer or data management system. You can add a cartridge in a platform as a service (PaaS) for scalability. A sample cartridge definition, together with information on all the properties that can be added in a cartridge definition JSON are as follows:

...

The following are sample configurations that can be used in a JSON to define a cartridge:

Excerpt

...

Code Block

 {
  "type": "php",
  "provider": "apache",
  "category": "data",
  "host": "php.stratos.org",
  "displayName": "php",
  "description": "php Cartridge",
  "version": "7",
  "multiTenant": "false",
  "portMapping": [
    {
	  "name": "http-80",
      "protocol": "http",
      "port": "80",
      "proxyPort": "8280"
	  "kubernetesPortType": "NodePort"
    },
    {
      "name": "http-22",
      "protocol": "tcp",
      "port": "22",
      "proxyPort": "8222"
	  "kubernetesPortType": "NodePort"
    }
  ],
  "deployment": {
    
  },
  "iaasProvider": [
    {
      "type": "mock",
      "imageId": "RegionOne/b4ca55e3-58ab-4937-82ce-817ebd10240e",
      "networkInterfaces": [
        {
          "name": "network-non-routable",
          "networkUuid": "b55f009a-1cc6-4b17-924f-4ae0ee18db5e"
        },
      ],
      "property": [
        {
          "name": "instanceType",
          "value": "RegionOne/aa5f45a2-c6d6-419d-917a-9dd2e3888594"
        },
        {
          "name": "keyPair",
          "value": "reka"
        },
        {
          "name": "securityGroups",
          "value": "default"
        }
      ]
    },
	{
			"type": "kubernetes",
			"imageId": "ap-southeast-1/ami-70326522",
			"property": [],
			"networkInterfaces": []
	}
  ]
}

Property definitions

All

-include

	Adding a Cartridge
	Adding a Cartridge
nopanel	true

Property definitions

All the properties that correspond to the cartridge parameter resource are explained as follows:

...

property

Property W R U Description M DV Data
Type Example

JSON UI

 Anchor
type
type
type

Type

√

Type of the cartridge.

Yes

N/A

String

php, tomcat

Anchor

	category
	category

category

Category

√

Category that the cartridge belong to. The possible categorizes are as follows: data, lb and framework

Info

icon	false

For more information, see Customizing Cartridges.

Yes

N/A

String

framework, application, data, lb

Anchor

	provider1
	provider1

provider

Provider

√

Provider of the cartridge.

Yes

N/A

String

apache, php.net, wso2

Anchor

	host
	host

host

Host

√

Domain where the cartridge will be hosted.

Yes

N/A

String

stratos.org

Anchor

	displayName
	displayName

displayName

Display Name

√

The name in which the cartridge will be displayed.

Yes

N/A

String

PHP

Anchor

	description
	description

description

Description

√

A short description about the cartridge.

No

N/A

String

PHP Cartridge

Anchor

	version
	version

version

Version

√

The version of the cartridge application.

Yes

N/A

String

7

 Anchor
loadBalancingIPType
loadBalancingIPType
loadBalancingIPType

Load Balancing IP Type

√

Determines whether the members IP is private or public. If this property is set to 'private', the load balancer delegates requests to member's private IP address. If it is set to 'public', requests are delegated to the member's public IP address.

String

public, private

Anchor

	multiTenant
	multiTenant

multiTenant

Multi Tenant

√

Whether the cartridge supports multi tenancy.

Info

icon	false

For more information, see Customizing Cartridges.

Yes

false

Boolean

true/false

Anchor

	portMapping1
	portMapping1

portMapping

Port Mapping

√

Details of the port mapped to the cartridge. For more information on the sub-properties, see portMapping.

Info
Add parameter definitions on multiple port mappings if required.

Yes

N/A

portMapping array

N/A

Anchor

	deployment1
	deployment1

deployment

-

√

The deployment details need to be specified when working with Kubernetes. For more information on the sub-properties, see deployment.

No

N/A

deployment

Anchor

	iaasProvider1
	iaasProvider1

iaasProvider

iaas Provider

√

Details of the IaaS provider that is used for the cartridge. For more information on the sub-properties, see iaasProvider.

Info
If required, add parameter definitions on multiple IaaS providers. These values will override the values in the cloud-controller.xml file, which is in the `<PRIVATE_PAAS_HOME>/repository/conf/` directory. Where `<PRIVATE_PAAS_HOME>` is the location of the unzipped PPaaS binary package.

Yes

N/A

iaasProvider array

N/A

Anchor

	persistence1
	persistence1

persistence

Persistence

√

Details of the persistence volume that should be attached to the cartridge. For more information on the sub-properties, see persistence.

Info

icon	false

For more information, see Customizing Cartridges.

No

N/A

persistence

N/A

 Anchor
metadataKeys
metadataKeys
metadataKeys

√

List down the meta data keys used by the cartridge.

String

Anchor property1 property1 property

√

String√

Anchor

property1

Cartridge related properties are listed as name value pairs. Payload parameters and Iaas specific parameters can be defined as follows.

{"name":"payload_parameter.CONFIG_PARAM_CLUSTERING","value":"true"}, {"name":"KUBERNETES_CONTAINER_CPU","value":"0"}

Administrators can use this property parameter to define other dynamic parameters and their corresponding values that need to be set when an instance is spawned.

property array

Sub-property definitions

...

Property W R U Description M DV Data
Type Example

JSON UI

 Anchor
protocol
protocol
protocol

Protocol

√

The protocol that is used to map the ports

Yes

N/A

String

http

 Anchor
port
port
port

Port

√

The port to which the cartridge is mapped

Yes

N/A

Int

80

 Anchor
proxyPort
proxyPort
proxyPort

Proxy Port

√

The proxy port to which the cartridge is mapped

Yes

N/A

Int

8280

Anchor

	kubernetesPortType
	kubernetesPortType

kubernetesPortType

Kubernetes Port Type

√

The Kubernetes port type to which the cartridge is mapped

Info

The following can be assigned for the Kubernetes port type:

NodePort - If this value is used, it will create a service which can be accessed from the outside with port range of 30,000 to 32,767.
ClusterIP - If this value is used, the service that gets created will not be exposed to the outside. This is useful if you don't want to expose a service to outside, but need to maintain internal communication within Docker containers.

Access URLs are generated only for the NodePort service type.

No

N/A

String

NodePort

...

Property W R U Description M DV Data
Type Example

JSON UI

 Anchor
type2
type2
type

Type

√

Type of the IaaS provider

Yes

N/A

String

ec2, mock, openstack, kubernetes

Anchor

	name
	name

name

-

√

Name of the IaaS provider.

No

N/A

String

Anchor

	className
	className

className

-

√

Class name of the Iaas Provider

No

String

 Anchor
imageId
imageId
imageId

Image ID

√

The unique ID of the IaaS image.

Yes

N/A

String

ap-southeast-1/ami-2e0d5a7c

Anchor

	provider2
	provider2

provider

-

√

The name of the IaaS provider.

String

Anchor

	identity
	identity

identity

-

√

Identity key of the Iaas Provider

String

Anchor

	credential
	credential

credential

-

√

Secret key used of the Iaas Provider

String

 Anchor
networkInterfaces1
networkInterfaces1
networkInterfaces

Network Interfaces

√

The list of network configuration tuples attached when launching cartridges. The possible values for networkInterfaces tuples are as follows:

OpenStack:
{"networkUuid","fixedIp","portUuid"}
AWS EC2:
{"networkUuid"}

For more information on how multiple network interfaces are used in PPaaS, see Multiple Network Interfaces. For more information on the sub-properties, see networkInterfaces.

No

N/A

networkInterfaces array

fb9c21f4-0672-48b2-8279-77334bb63a53

 Anchor
property1property2property1
property2
property

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 use this property parameter to define other dynamic parameters and their corresponding values that need to be set when an instance is spawned. For more information, see IaaS provider properties. For more information on the sub-properties, see property.

Yes

N/A

property array

N/A

...

Property W R U Description M DV Data
Type Example

JSON UI

Anchor

	networkUuid
	networkUuid

networkUuid

Network UUID

√

The universal unique identifier (UUID) that corresponds to the network.

String

ba667f72-7ba8-4b24-b360-b74a0211c83c

Anchor

	fixedIp
	fixedIp

fixedIp

-

√

The fixed IP that corresponds to the network.

String

Anchor

	portUuid
	portUuid

portUuid

-

√

The universal unique identifier (UUID) that corresponds to the port.

String

Anchor

	floatingNetworks1
	floatingNetworks1

floatingNetworks

-

√

For more information on the sub-properties, see floatingNetworks.

No

floatingNetworks
array

...

Property Name Relevant IaaS Description Default Value Example Values

E O K

associatePublicIpAddress √ X X When using virtual private cloud (VPC) this property needs to be assigned to true, so that your cartridge instance will be assigned a public IP. true true, false

autoAssignIp √ √ X This is used to determine whether your cartridge will be assigned a public IP or private IP. If this property, is true a public IP will be assigned to your cartridge. If this property is false the IP will be assigned manually. true true, false

availabilityZone

√

X

The name of the availability zone.

Note
If you are using more than one partition, define the availability zone only in the cartridge definition and make sure not to define the availability zone in the cloud-controller.xml. This will enable the Autoscaler to dynamically select availability zone based on the partition.

N/A

ap-southeast-1a

blockUntilRunning

X

√

X

This will determine whether or not the instance spawning call to the IaaS will be blocked, in order to retrieve IP addresses. If you wish to auto assign IPs, the instance spawning call should be blocking, but if you wish to assign IPs manually, it can be non-blocking.

false

true, false

defaultFloatingIpPool X √ X If the floating IPs have not been pre-allocated for the respective tenant, when launching a cartridge, the floating IP allocation will fail. This property is used to specify the name of the floating IP pool that needs to be used. N/A PublicPool1

instanceType

√

X

The type of instance that determines the instance size, which needs to be used. In OpenStack this is referred to as flavor.

Note

The instance type value needs to be specified differently based on the IaaS.
For example:

IaaS	Value Format
EC2	N/A
OpenStack	`<REGION>/<ID>`

N/A

EC2

m1.small

OpenStack

RegionOne/2

keyPair √ √ X The name of the private key that corresponds to the key pair used to connect to the instance. N/A apache-stratos-key1

securityGroupIds √ √ X When defining a security group in a VPC scenario, this property should be used instead of the securityGroups property. N/A sg-c999f7a6

securityGroups √ √ X The name of the security group that is used to define the IP filter rules for the instance. N/A sg-c999f7a6

shellType X X X The type of shell scripting language being used in the cartridge. This property is used to identify the correct customization script to use when passing the payload to the cartridge. N/A bash, sh, cmd

subnetId √ X X ID used to identify the virtual private cloud (VPC). For more information, go to Amazon VPC. N/A subnet-3b8a7d2g

tag

√

X

A tag is a name value pair used to filter instances. For more information, go to Using Tags.
For example: <property name="tag.a" value="x" />

N/A

a

tags √ X X Defines the names of multiple tags. For example: <property name="tags" value="a,b,c,d" /> N/A a,b,c,d

KUBERNETES_CONTAINER_CPU

X

√

Number of CPU cores used in a pod. With the value following suffices (E, P, T, G, M, K, m) or their power-of-two equivalents (Ei, Pi, Ti, Gi, Mi, Ki) can be used. If value is defined as zero, it will allow to use indefinite resources in the Kubernetes node. For more information, go to Kubernetes resource model.

0

0, 0.3, 1, 300m

KUBERNETES_CONTAINER_MEMORY X X √ Memory usage of the pod. With the value following suffices (E, P, T, G, M, K, m) or their power-of-two equivalents (Ei, Pi, Ti, Gi, Mi, Ki) can be used. If value is defined as zero, it will allow to use indefinite resources in the Kubernetes node. For more information, go to Kubernetes resource model. 0 0, 40Mi

KUBERNETES_SERVICE_SESSION_AFFINITY X X √ Defines the session affinity that can be used with Kubernetes. None ClientIP

...

Include Page

	Cartridge Payload Property Definitions
	Cartridge Payload Property Definitions

...

persistence

Property W R U Description M DV Data
Type Example

JSON UI

 Anchor
isRequired
isRequired
isRequired

Is
Required

√

Whether an extra volume is required is required to be attached to the cartridge to store content

No

N/A

Boolean

true

 Anchor
volumes1
volumes1
 volumes

Volume

√

Details of the persistence volume that should be attached to the cartridge. For more information on the sub-properties, see volumes.

No

N/A

volumes array

N/A

...

Property W R U Description M DV Data
Type Example

JSON UI

Anchor

	id
	id

id

-

√

String

 Anchor
device
device
device

Device

√

Linux device of the volume that will be mounted to the mapping path.

No

N/A

String

/dev/sdc

 Anchor
mappingPath
mappingPath
mappingPath

Mapping Path

√

Folder path of the directory onto which the Linux device will be mounted.

No

N/A

String

/home/ubuntu/sdc

 Anchor
size
size
size

Size

√

Capacity of the persistence volume that should be attached to the cartridge

Info
If you provide different value during subscription, the value provided here is overridden.

Yes

N/A

String

11

 Anchor
removeOnTermination
removeOnTermination
removeOnTermination

Remove on Termination

√

Whether the volume should be removed after termination of the instance

Info
If the value is set to false, the volume and its data will exist even after the instance is terminated, so that the data will not be deleted.

No

N/A

Boolean

false

Anchor

	snapshotId
	snapshotId

snapshotId

-

√

The snapshot from which the volume was created, if applicable.

String

Anchor

	volumeId
	volumeId

volumeId

-

√

The ID of the volume.

String

Versions Compared

Old Version 18

New Version Current

Key

Property definitions

Property definitions

Sub-property definitions

persistence