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:
All the properties that correspond to the cartridge parameter resource are explained as follows:
|Type||√||√||Type of the cartridge.||Yes||N/A||String||php, tomcat|
Category that the cartridge belong to. The possible categorizes are as follows: data, lb and framework
|framework, application, data, lb|
|Provider||√||√||Provider of the cartridge.||Yes||N/A|
|apache, php.net, wso2|
|Host||√||√||Domain where the cartridge will be hosted.||Yes||N/A|
|Display Name||√||√||The name in which the cartridge will be displayed.||Yes||N/A|
|Description||√||√||A short description about the cartridge.||No||N/A|
|Version||√||√||The version of the cartridge application.||Yes||N/A|
|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.
Whether the cartridge supports multi tenancy.
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.
|-||√||√||The deployment details need to be specified when working with Kubernetes. For more information on the sub-properties, see deployment.||No||N/A||deployment|
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
Details of the persistence volume that should be attached to the cartridge. For more information on the sub-properties, see persistence.
|Protocol||√||√||The protocol that is used to map the ports||Yes||N/A||String|
|Port||√||√||The port to which the cartridge is mapped||Yes||N/A||Int||80|
|Proxy Port||√||√||The proxy port to which the cartridge is mapped||Yes||N/A||Int||8280|
|Kubernetes Port Type||√||√|
The Kubernetes port type to which the cartridge is mapped
The following can be assigned for the Kubernetes port type:
Access URLs are generated only for the NodePort service type.
|-||√||√||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)||No||N/A||String||/var/www|
|Type||√||√||Type of the IaaS provider||Yes||N/A||String||ec2, mock, openstack, kubernetes|
|-||Name of the IaaS provider.||No||N/A||String|
|Image ID||√||√||The unique ID of the IaaS image.||Yes||N/A||String|
|-||The name of the IaaS provider.||String|
The list of network configuration tuples attached when launching cartridges. The possible values for networkInterfaces tuples are as follows:
The IaaS provider properties are listed as name value pairs. It is mandatory that IaaS provider definitions include the following property configurations:
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.
|Network UUID||√||√||The universal unique identifier (UUID) that corresponds to the network.||String||ba667f72-7ba8-4b24-b360-b74a0211c83c|
|-||The fixed IP that corresponds to the network.||String|
|-||The universal unique identifier (UUID) that corresponds to the port.||String|
|-||For more information on the sub-properties, see floatingNetworks.||No||floatingNetworks|
|-||√||√||The name assigned to the floating network.||No||N/A||String||externalThree|
|-||√||√||The universal unique identifier (UUID) that corresponds to the floating network.||No||N/A||String||ba667f72-7ba8-4b24-b360-b74a0211c83c|
|-||√||√||The IP that corresponds to the floating network.||No||N/A||String||192.168.17.227|
The IaaS provider properties will override the cartridge level properties that are defined in the
|Property Name||Relevant IaaS||Description||Default Value||Example Values|
|√||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|
|√||√||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|
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.
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.
|√||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|
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.
|√||√||The name of the private key that corresponds to the key pair used to connect to the instance.||N/A||apache-stratos-key1|
|√||√||When defining a security group in a VPC scenario, this property should be used instead of the ||N/A||sg-c999f7a6|
|√||√||The name of the security group that is used to define the IP filter rules for the instance.||N/A||sg-c999f7a6|
|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|
|√||ID used to identify the virtual private cloud (VPC). For more information, go to Amazon VPC.||N/A||subnet-3b8a7d2g|
A tag is a name value pair used to filter instances. For more information, go to Using Tags.
|√||Defines the names of multiple tags. For example: ||N/A||a,b,c,d|
|√||√||Whether an extra volume is required is required to be attached to the cartridge to store content||No||N/A||Boolean||true|
|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|
|Device||√||√||Linux device of the volume that will be mounted to the mapping path.||No||N/A||String||/dev/sdc|
|Mapping Path||√||√||Folder path of the directory onto which the Linux device will be mounted.||No||N/A||String||/home/ubuntu/sdc|
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.
|Remove 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.