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:

...

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 the properties that correspond to the cartridge parameter resource are explained as follows:

type
provider
category
host
displayName
description
version
multiTenant
deployment
- baseDir
- dir
portMapping
- protocol
- port
- proxyPort
- kubernetesPortType
iaasProvider
- type
- name
- className
- imageId
- provider
- identity
- credential
- property
- networkInterfaces
  - networkUuid
  - fixedIp
  - portUuid
  - floatingNetworks
    - name
    - networkUuid
    - floatingIP
persistence
- isRequired
- volumes
  - id
  - size
  - device
  - removeOnTermination
  - mappingPath
  - snapshotId
  - volumeId
loadBalancingIPType
metadataKeys
property
- name
- value

...

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

...

The IaaS provider properties will override the cartridge level properties that are defined in the <PRIVATE_PAAS_HOME>/repository/conf/cloud-controller.xml.

...

Panel

These abbreviations are used in the following table to specify the names of the IaaS:

E = EC2

O = OpenStack

Kub = Kubernetes

Property Name Relevant IaaS Description Default Value Example Values

E Image RemovedOImage Removed 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 X √ 0

KUBERNETES_CONTAINER_MEMORY X X √ 0

KUBERNETES_SERVICE_SESSION_AFFINITY X X √ ClientIP

IaaS specific payload parameter

Property Name	Relevant IaaS			Description	Example Values
Property Name	E	O	K	Description	Example Values
`START_CMD`	`X`	`X`	√		PCA

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

...

Versions Compared

Old Version 12

New Version 13

Key

Property definitions

IaaS specific payload parameter

persistence