This documentation is for WSO2 Stratos 2.0.0. View the latest Apache Stratos documentation.

||
Skip to end of metadata
Go to start of metadata

Icon

The difference between a Cartridge XML file for a Carbon and non-carbon XML file is the fact that non-carbon XML files have an additional section that defines port mapping.

 

Carbon Cartridge XML

 

Non-Carbon Cartridge XML

 

Element Definitions

Click the respective element link for in-depth information. 

cartridge

CriteriaDescription
XML Syntax
<cartridge>   
DescriptionDefines the various Cartridge elements available. There can be 1..n Cartridge elements.
Mandatory/OptionalMandatory
Attribute
type         
TypeString
Mandatory/OptionalMandatory
Attributehost
TypeString
Mandatory/Optional Mandatory
Attribute

provider

TypeString
Mandatory/OptionalMandatory
Attribute version
TypeString
Mandatory/OptionalMandatory
Elements

 

property
CriteriaDescription
XML Syntax
<property/>
DescriptionDefines the various Cartridge properties available.
Mandatory/OptionalOptional
Attribute
name        
TypeString
Mandatory/OptionalMandatory
Attributevalue
TypeString
Mandatory/OptionalMandatory

 

displayName
CriteriaDescription
XML Syntax
<displayName>
DescriptionCartridge name.
TypeString
Mandatory/OptionalOptional

 

description
CriteriaDescription
XML Syntax<description>
DescriptionCartridge description.
TypeString
Mandatory/OptionalOptional

 

iaasProvider
CriteriaDescription
XML Syntax<iaasProvider>
Description

A Cartridge element should add a reference to an existing IaaS provider or a completely new IaaS Provider needs to be created. This section is used to create a new IaaS Provider.

Mandatory/OptionalMandatory
Attributetype
DescriptionUnique attribute used when creating a new IaaS Provider.
TypeString
Mandatory/OptionalMandatory
ElementsimageId | property

 

imageId
CriteriaDescription
XML Syntax<imageId>
DescriptionUnique ID of the image.
TypeString
Mandatory/OptionalOptional  


property
CriteriaDescription
XML Syntax<property/>
DescriptionIn this case the property sub-element defines the properties of the IaaS provider. A Cartridge element can have 0..n properties. The properties specified under the matching iaasProvider child elements in the Cloud Controller XML will be overwritten by the properties specified under the matching iaasProvider child elements in the Cartridge XML.
Mandatory/OptionalOptional
Attributename
TypeString
Mandatory/OptionalMandatory
Attributevalue
TypeString
Mandatory/OptionalOptional

 

deployment
CriteriaDescription
XML Syntax

<deployment>

DescriptionThis is required for the GIT repo creation.
AttributebaseDir
DescriptionThis attribute should point to a valid path in the service instance, as it is the location from where a GIT repo is cloned.
TypeString
Mandatory/OptionalOptional
Elementsdir

 

dir
CriteriaDescription
XML Syntax<dir>
DescriptionAll directories that have to be created newly in the GIT repo can be added individually in this manner.
TypeString
Mandatory/OptionalOptional

 

portMapping
CriteriaDescription
XML Syntax<portMapping>
DescriptionThis element is required if the Cartridge is a non-carbon Cartridge.
Type

complex

Mandatory/OptionalOptional
Elementshttp | https


http
CriteriaDescription
XML Syntax<http/>
DescriptionPort mapping for http.
Mandatory/OptionalMandatory
Attributeport
Descriptionhttp port of the non-carbon Cartridge instance.
TypeString 
Mandatory/OptionalMandatory
AttributeproxyPort
Descriptionhttp port of the ELB
TypeString
Mandatory/OptionalMandatory

 

https
CriteriaDescription
XML Syntax<https/>
DescriptionPort mapping for https.
Mandatory/OptionalOptional
Attributeport
Descriptionhttps port of the non-carbon Cartridge instance.
TypeString 
Mandatory/OptionalMandatory
AttributeproxyPort
Descriptionhttp port of the ELB
TypeString
Mandatory/OptionalMandatory
  • No labels