Skip to end of metadata
Go to start of metadata

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:

Sample cartridge definition JSON

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

In Stratos 4.1.1, you can specify the kubernetesPortType as NodePort or ClusterIP in Port Mapping.

Access URLs are generated only for the NodePort service type.


Property definitions

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

property definitions

PropertyDescriptionData
Type 
Example
JSONUI
typeType Type of the cartridge.YesN/AStringphp, tomcat

category

Category 

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

For more information, see Customizing Cartridges.

YesN/A

String

framework, application, data, lb

provider

Provider Provider of the cartridge.YesN/A

String

apache, php.net, wso2

host

Host Domain where the cartridge will be hosted.YesN/A

String

stratos.org

displayName

Display Name The name in which the cartridge will be displayed.YesN/A

String

PHP

description

Description A short description about the cartridge.NoN/A

String

PHP Cartridge

version

Version The version of the cartridge application.YesN/A

String

7
loadBalancingIPTypeLoad 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.

  Stringpublic, private

multiTenant

Multi Tenant 

Whether the cartridge supports multi tenancy.

For more information, see Customizing Cartridges.

YesfalseBooleantrue/false

portMapping

Port Mapping 

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

 Add parameter definitions on multiple port mappings if required.

YesN/AportMapping arrayN/A

deployment

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

iaasProvider

iaas Provider 

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

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 <apache-stratos-version-SNAPSHOT>/repository/conf/ directory. Where <apache-stratos-version-SNAPSHOT> is the location of the unzipped Stratos binary package.

YesN/AiaasProvider arrayN/A

persistence

Persistence 

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

For more information, see Customizing Cartridges.

NoN/ApersistenceN/A
metadataKeys       

String

 
property       property array 

Sub-property definitions

portMapping
PropertyDescriptionData
Type 
Example
JSONUI
protocolProtocol The protocol that is used to map the portsYesN/AString

http

portPort The port to which the cartridge is mappedYesN/AInt80
proxyPortProxy Port The proxy port to which the cartridge is mappedYesN/AInt8280

kubernetesPortType

Kubernetes Port Type 

The Kubernetes port type to which the cartridge is mapped

The following can be assigned for the Kubernetes port type:

  • NodePort
  • ClusterIP

Access URLs are generated only for the NodePort service type.

NoN/AStringNodePort
deployment
PropertyDescriptionData
Type 
Example
JSONUI
baseDir- Base directory of the cartridge where artifacts should be deployed. The Cartridge Agent will deploy the artifacts that are checked out from the Git repository to this location. It is recommended to only set the base directory when working with Kubernetes, as it generally needs to be set in the Puppet Master configurations when working with VM scenarios (i.e., EC2, OpenStack)NoN/AString/var/www

dir

-    dir array 
iaasProvider
PropertyDescriptionData
Type 
Example
JSONUI
typeType Type of the IaaS providerYesN/AStringec2, mock, openstack, kubernetes

name

-   Name of the IaaS provider.NoN/AString 

className

-    No String 
imageIdImage ID The unique ID of the IaaS image.YesN/AString

ap-southeast-1/ami-2e0d5a7c

provider

-   The name of the IaaS provider.  String 

identity

-      String 

credential

-      String 
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 Stratos, see Multiple Network Interfaces. For more information on the sub-properties, see networkInterfaces.

NoN/AnetworkInterfaces array

fb9c21f4-0672-48b2-8279-77334bb63a53

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.

YesN/Aproperty arrayN/A
networkInterfaces
PropertyDescriptionData
Type 
Example
JSONUI
networkUuid            
Network UUID The universal unique identifier (UUID) that corresponds to the network.  Stringba667f72-7ba8-4b24-b360-b74a0211c83c
fixedIp        
-   The fixed IP that corresponds to the network.  String 
portUuid            
-   The universal unique identifier (UUID) that corresponds to the port.  String 

floatingNetworks

-   For more information on the sub-properties, see floatingNetworks.No floatingNetworks
array
 
floatingNetworks
PropertyDescriptionData
Type 
Example
JSONUI

name

- The name assigned to the floating network.NoN/AStringexternalThree

networkUuid

- The universal unique identifier (UUID) that corresponds to the floating network.NoN/AStringba667f72-7ba8-4b24-b360-b74a0211c83c

floatingIP

- The IP that corresponds to the floating network.NoN/AString192.168.17.227
property

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

Property NameRelevant IaaS DescriptionDefault ValueExample Values
associatePublicIpAddressXWhen using virtual private cloud (VPC) this property needs to be assigned to true, so that your cartridge instance will be assigned a public IP.truetrue, false
autoAssignIpThis 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. truetrue, false
availabilityZone

The name of the availability zone.

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/Aap-southeast-1a
blockUntilRunningX

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.

falsetrue, false
defaultFloatingIpPool 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/APublicPool1

instanceType

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

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

IaaSValue Format
EC2N/A
OpenStack<REGION>/<ID>
N/A

EC2

m1.small

OpenStack

RegionOne/2

keyPairThe name of the private key that corresponds to the key pair used to connect to the instance.N/Aapache-stratos-key1
securityGroupIds When defining a security group in a VPC scenario, this property should be used instead of the securityGroups property.N/Asg-c999f7a6
securityGroupsThe name of the security group that is used to define the IP filter rules for the instance.N/Asg-c999f7a6
shellType 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/Abash, sh, cmd
subnetId X ID used to identify the virtual private cloud (VPC). For more information, go to Amazon VPC.N/Asubnet-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/Aa
tags X Defines the names of multiple tags. For example: <property name="tags" value="a,b,c,d" /> N/Aa,b,c,d

persistence
PropertyDescriptionData
Type 
Example
JSONUI
isRequiredIs
Required
 Whether an extra volume is required is required to be attached to the cartridge to store contentNoN/ABooleantrue
volumes Volume Details of the persistence volume that should be attached to the cartridge. For more information on the sub-properties, see volumes. NoN/Avolumes arrayN/A
volumes
PropertyDescriptionData
Type 
Example
JSONUI

id

-    String 
deviceDevice Linux device of the volume that will be mounted to the mapping path.NoN/AString/dev/sdc
mappingPathMapping Path Folder path of the directory onto which the Linux device will be mounted.NoN/AString/home/ubuntu/sdc
sizeSize 

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

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

YesN/AString11
removeOnTerminationRemove on Termination   

Whether the volume should be removed after termination of the instance

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.

NoN/ABooleanfalse
snapshotId -      String 
volumeId
-      String 
  • No labels