Cloud Controller Configuration Files
- Former user (Deleted)
A new Cloud Controller pack contains only the main configuration file that is namely cloud-controller.xml and it resides in the ${WSO2-CC}/repository/conf/ directory. The main configuration file mainly consists 3 sections that are namely,
To see an entire sample cloud-controller.xml file see Stratos IaaS configuration file.
BAM data publisher section
The BAM server URL should be specified in the carbon.xml file
This section contains the information related to the BAM data publisher of the Cloud Controller (such as BAM server information, Data publishing task interval and so on). To disable the BAM data publisher set the Enable attribute to False.
<dataPublisher enable="true">
<bamServer>
<adminUserName>admin</adminUserName>
<adminPassword svns:secretAlias="cloud.controller.bam.server.admin.password">admin</adminPassword>
</bamServer>
<cron>1 * * * * ? *</cron>
</dataPublisher>
Element Definitions
Click the respective parameter link for in-depth information.
dataPublisher
| Criteria | Description |
|---|---|
| Syntax | <dataPublisher> |
| Attribute | enable |
| Description | Used to enable or disable the BAM data publisher. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Mandatory |
adminUserName
| Criteria | Description |
|---|---|
| Syntax | <adminUserName> |
| Description | BAM server Username |
| Type | String |
| Default Value | admin |
| Mandatory/Optional | Optional |
adminPassword
| Criteria | Description |
|---|---|
| Syntax | <adminPassword> |
| Description | BAM server password. |
| Type | String |
| Default Value | admin |
| Mandatory/Optional | Optional |
cron
| Criteria | Description |
|---|---|
| Syntax | <cron> |
| Description | For more information go to http://en.wikipedia.org/wiki/Cron |
| Type | String. (Valid cron expression) |
| Default Value | 1 * * * * ? * This means the first second of every minute. |
| Mandatory/Optional | Optional |
Topology sync section
This section contains information related to topology synchronization that mainly relates to WSO2 Message Broker server information.
<topologySync enable="true">
<mbServerUrl>localhost:5673</mbServerUrl>
<cron>1 * * * * ? *</cron>
</topologySync>
Element Definitions
Click the respective parameter link for in-depth information.
topologySync
| Criteria | Description |
|---|---|
| Syntax | <topologySync> |
| Description | Section to configure topology synchronization. The elements in this section define the topology synchronization. |
| Attribute | enable |
| Description | Used to enable or disable the Topology sync. Disabling this section is not recommended as it will result in not syncing up the topology. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Mandatory |
mbServerUrl
| Criteria | Description |
|---|---|
| Syntax | <mbServerUrl> |
| Description | URL of the Message broker |
| Type | String |
| Default Value | localhost:5672 |
| Mandatory/Optional | Optional |
cron
| Criteria | Description |
|---|---|
| Syntax | <cron> |
| Description | For more information please go to http://en.wikipedia.org/wiki/Cron |
| Type | String |
| Default Value | 1 * * * * ? * This means the first second of every minute. |
| Mandatory/Optional | Optional |
IaaS providers section
This section specifies the properties that are common to an IaaS here. Users can use this section to avoid repeatedly specifying the same property. If users wish they can remove this section; however, we recommend that this section be maintained.
<iaasProviders>
<iaasProvider type="ec2" name="ec2 specific details">
<className>org.wso2.carbon.stratos.cloud.controller.iaases.AWSEC2Iaas</className>
<provider>aws-ec2</provider>
<identity svns:secretAlias="cloud.controller.ec2.identity"></identity>
<credential svns:secretAlias="cloud.controller.ec2.credential"></credential>
<scaleUpOrder>1</scaleUpOrder>
<scaleDownOrder>2</scaleDownOrder>
<property name="jclouds.ec2.ami-query" value="owner-id=XXXX-XXX;state=available;image-type=machine"/>
<property name="availabilityZone" value="us-east-1c"/>
<property name="securityGroups" value="default"/>
<property name="instanceType" value="m1.large"/>
<property name="keyPair" value="nirmal-key"/>
<imageId>us-east-1/ami-XXXXX</imageId>
</iaasProvider>
<iaasProvider type="openstack" name="openstack specific details">
<className>org.wso2.carbon.stratos.cloud.controller.iaases.OpenstackNovaIaas</className>
<provider>openstack-nova</provider>
<identity svns:secretAlias="cloud.controller.openstack.identity"></identity>
<credential svns:secretAlias="cloud.controller.openstack.credential"></credential>
<property name="jclouds.endpoint" value="http://192.168.16.20:5000/" />
<property name="jclouds.openstack-nova.auto-create-floating-ips" value="false"/>
<property name="jclouds.api-version" value="2.0/" />
<scaleUpOrder>2</scaleUpOrder>
<scaleDownOrder>3</scaleDownOrder>
<property name="X" value="x" />
<property name="Y" value="y" />
<imageId>nova/dab37f0e-cf6f-4812-86fc-XXXXXXXXXXXX</imageId>
</iaasProvider>
</iaasProviders>
Element Definitions
Click the respective parameter link for in-depth information.
iaasProvider
| Criteria | Description |
|---|---|
| Syntax | <iaasProvider type="ec2" name="ec2 specific details"> |
| Attribute | type |
| Description | Type of the IaaS provider. The type mentioned should be unique. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Mandatory |
| Attribute | name |
| Description | Name of the IaaS provider. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Optional |
className
| Criteria | Description |
|---|---|
| Syntax | <className> |
| Description | The full qualified name of the IaaS implementation. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Mandatory |
provider
| Criteria | Description |
|---|---|
| Syntax | <provider> |
| Description | Name of the IaaS provider. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Mandatory |
identity
| Criteria | Description |
|---|---|
| Syntax | <identity> |
| Description | Identity of the user's IaaS acccount. If a value for this element can not be found via secure vault the text value will be used. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Mandatory |
credential
| Criteria | Description |
|---|---|
| Syntax | <credential> |
| Description | Credentials of the user's IaaS account. If a value for this element can not be found via secure vault the text value will be used. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Mandatory |
scaleUpOrder
| Criteria | Description |
|---|---|
| Syntax | <scaleUpOrder> |
| Description | The order in which scaling up should take place against the other IaaS providers. 1 has the highest precedence. |
| Type | Positive Integer |
| Default Value | N/A |
| Mandatory/Optional | Mandatory |
scaleDownOrder
| Criteria | Description |
|---|---|
| Syntax | <scaleDownOrder> |
| Description | The order in which scaling down should take place against the other IaaS providers. 1 has the highest precedence. |
| Type | Positive Integer |
| Default Value | N/A |
| Mandatory/Optional | Mandatory |
property
| Criteria | Description |
|---|---|
| Syntax | <property name="abc" value="dfe"/>
|
| Description | Used to define any property that is required for that respective IaaS provider. |
| Attribute | name |
| Description | Unique name that defines the property. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Optional |
| Attribute | value
|
| Description | Value corresponding to the property. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Optional |
imageId
| Criteria | Description |
|---|---|
| Syntax | <imageId> |
| Description | ID of the Cartridge image that resides in your IaaS. |
| Type | String |
| Default Value | N/A |
| Mandatory/Optional | Please see the note below. |
The imageId has to be specified in either the Cloud Controller XML or the Cartridge XML. If the imageId is specified in the Cartridge XML the imageId value in the Cartridge XML will override the value specified in the Cloud Controller XML. As a result if the imageId is not specified in the Cartridge XML it will be mandatory to specify it in the Cloud Controller XML.