Application Resource Definition

• applicationId
• multiTenant
• name
• description
• alias
• status
• components
  • groups
    • name
    • alias
    • groupMinInstances
    • groupMaxInstances
    • deploymentPolicy
    • cartridges
    • groups
  • dependencies
    • startupOrders
    • scalingDependents
    • terminationBehaviour
  • cartridges

    • type

    • cartridgeMin

    • cartridgeMax

    • subscribableInfo

      • alias

      • deploymentPolicy

      • autoscalingPolicy

      • maxMembers

      • minMembers

      • dependencyAliases

      • artifactRepository

        • alias

        • privateRepo

        • repoUrl

        • repoUsername

        • repoPassword

      • property

      • persistence

        • isRequired

        • volumes

          • id

          • size

          • device

          • removeOnTermination

          • mappingPath

          • snapshotId

          • volumeId

• property 

• name

• value

applicationId

test_app_3

multiTenant

name

description

status

alias

phpapp2

components  

The components section for the applications will comprise of groups and cartridges. While, each of the children groups can have nested groups. For more information on the sub-properties, see components.

property  

groups  

This section will have a list of groups that are referred in this application. The groups should have a reference to an already deployed cartridge group definitions using the group name. For more information on the sub-properties, see groups.

dependencies  

The dependencies define the order to instantiate and the groups and cartridges referred in the application definition. For more information on the sub-properties, see dependencies.

A sample rule for startup order is shown below:

"group.<GROUP_ALIAS>,cartridge.<CARTRIDGE_ALIAS>"

This would mean the group denoted by <GROUP_ALIAS> should be started before starting the cartridge denoted by <CARTRIDGE_ALIAS>. There can be multiple such rules. The rules should be applicable for only the top level groups and cartridges defined in the application. Startup orders for the elements in the groups will be defined in the group definition itself.

cartridges

name

deploymentPolicy

cartridges

Defines the nested groups (sub-groups). The groups should have a reference to an already deployed group definition using the group name. For more information on the sub-properties, see groups.

The order in which the applications’s children (sub-groups and sub-cartridges) need to started up.

If it is a group, it should use the format of "group.<GROUP_ALIAS>" and if it is a cartridge, it should be "cartridge.<CARTRIDGE_ALIAS>" when defining startupOrder. Multiple startupOrders can also be defined as String array. However, the startupOrder should not create a cyclic dependency. By defining multiple startupOrders, parallel dependencies can be identified to start them in parallel.

For example if the application startupOrder is as follows:

"startupOrders": [
  {
    "aliases": [
      "group.group2",
      "cartridge.tomcat"
    ]
  }
],

• Based on this WSO2 Private PaaS will identify that group2 will need to start before tomcat. Initially, WSO2 Private PaaS will check the startupOrder in the group2 cartridge group definition, which appears as follows:

  "startupOrders": [
    {
      "aliases": [
        "group.group1",
        "cartridge.tomcat"
      ]
    }
  ],

• Based on this Startos will identify that it needs to startup group1 before the tomcat cartridge. 

• This will in turn require WSO2 Private PaaS to check the startupOrder in the group1 cartridge group definition.

• If group1 does not have a startupOrder defined, WSO2 Private PaaS will start the tomcat and tomcat1 cartridges, which are in group1, in parallel to each other.
• Thereafter, it will start the tomcat cartridge in group2.
• Finally, it will start the tomcat cartridge, which has the mytomcat alias, defined in the application definition.

group.mygroup2

scalingDependents  

This determines how the instances need to be terminated. The terminationBehaviour has been explained provided the startupOrder is as follows:

"startupOrders": [
  {
    "aliases": [
      "group.group2",
      "cartridge.tomcat"
    ]
  },
  {
    "aliases": [
      "group.group3",
      "cartridge.mytomcat222"
    ]
  }
],

The available terminationBehaviours are as follows:

• terminate-none
  None of them will be terminated. For example, if something happens to mygroup1, it will not have an impact on the tomcat cartridge.
• terminate-all
  All the elements in that dependency tree are terminated. For example, if something happens to any of mygroup1, then all the children of the group that mygroup1 belongs to, are terminated regardless of the other dependency information.
• terminate-dependent
Only the dependents will be terminated.
  For example, if something happens to group2, then tomcat is terminated. However, if any other cartridge or group is found in the parent group that group2 belongs to, then that cartridge or group will remain as it is in WSO2 Private PaaS.

Contains the information about all the subscribables that is a part of the cartridge.

The fields under artifactRepository must be updated when a cartridge belonging to the Framework category is added (e.g., PHP cartridge, Tomcat cartridge). For more information on the sub-properties, see subscribableInfo.

mygroup2tomcat

deploymentPolicy

autoscaling_policy_1

The details of the remote Git repository that corresponds to the cartridge. The artifact repository details only need to be mentioned if the cartridge is a single tenant framework cartridge. For more information on the sub-properties, see artifactRepository.  

String

String

String

Whether the volume should be removed after termination of the instance.

String

String

String

www.mygit.com/php.git

mygroup2tomcat

repoUrl