Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DescriptionUsed to deploy a deployment policy definition
URL
admin/policy/deployment
HTTP MethodPOST
Request/Response Format
application/json

Sample request payload

Excerpt
Code Block
{
   "deploymentPolicy":{
      "id":"isuruh-ec2",
      "partitionGroup":{
         "id":"ec2",
         "partitionAlgo":"one-after-another",
         "partition":[
            {
               "id":"P1",
               "partitionMax":"3",
               "partitionMin":"1"
            }
         ]
      }
   }
}

Parameter definition

ParameterDescriptionRequiredDefault valueExample Value
id
Unique ID of the deployment policy.YesNoDep-policy1
partitionGroup

This defines one or more partitions that are network bound and where communication among the partitions take place very efficiently. For example, in EC2 a partition group can be defined with multiple partitions that belong to the same region.

---
partitionGroup -
id 
Unique ID of the partition group.YesNoEC2-Group1
partitionGroup -

...

partitionAlgo 
This defines the sequence used to spawn up instances when scaling up.YesNoround-robin, one-after-another
partitionGroup - 
partition

This defines the conditions that will be applied to the partitions that have already been deployed.

---
partition - id
This defines the ID of the already deployed partition.YesNoP1
partition - 
partitionMax
This defines the maximum number of instances that will be maintained for each subscription in this partition when scaling up.YesNo5
partition -

...

partitionMin 
This defines the minimum number of instances that will be maintained for each subscription in this partition when scaling down.YesNo1

Example

Use case: Enter a deployment policy definition. The example request is as follows:

...