Versions Compared

Old Version 3

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

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

You can add a deployment policy using the CLI the CLI tool or , REST API , or the PPaaS Console as shown below:

 

Sample Network Partition JSON
Localtabgroup
Panel
title
Localtab
activetrue
titleCLI
Add

Adding a deployment policy via the CLI

Overview
CLI command
add-deployment-policy
DescriptionAdd a deployment policy definition.
Command format
Code Block
add-deployment-policy -p <JSON_FILE_PATH>
Info

The path to the JSON file that defines the deployment policy needs to be defined as the <JSON_FILE_PATH> value.

Parameter definition
SAMPLES>/common
Short optionLong optionDescriptionRequiredExample value
-p
--resource-pathFolder path where the JSON file that defines the deployment policy is stored.Yes
Code Block
                  <PRIVATE_PAAS_
CARTRIDGES>/wso2am/1.9.0/samples/
deployment-policies/mock/deployment-policy-1.json
Example

Add the deployment policy that is defined in the <PRIVATE_PAAS_SAMPLES>/commonCARTRIDGES>/wso2am/1.9.0/samples/deployment-policies/mock/deployment-policy-1.json file.

Code Block
add-deployment-policy -p <PRIVATE_PAAS_SAMPLES>/commonCARTRIDGES>/wso2am/1.9.0/samples/deployment-policies/mock/deployment-policy-1.json
Sample output
Code Block
Deployment policy added successfully: [deployment-policy-id] deployment-policy-1
Localtab
titleREST API
Add

Adding a deployment policy via the REST API

Overview
DescriptionAdd a deployment policy definition.
Resource Path

/deploymentPolicies

HTTP MethodPOST
Request/Response Format

application/json

Command format
Code Block
curl -X POST -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/deploymentPolicies
Info
  • The path to the JSON file that defines the deployment policy needs to be defined as the  <JSON_PAYLOAD> value.
  • By default, <USERNAME>:<PASSWORD> is admin:admin.
  • By default, <PRIVATE_PAAS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <PRIVATE_PAAS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.
Example

Add the deployment policy that is defined in the <PRIVATE_PAAS_SAMPLES>/commonCARTRIDGES>/wso2am/1.9.0/samples/deployment-policies/mock/deployment-policy-1.json file.

Code Block
cd <PRIVATE_PAAS_SAMPLES>/common/samples

curl -X POST -H "Content-Type: application/json" -d @'deployment-policies/deployment-policy-1.json' -k -v -u admin:admin https://localhost:9443/api/deploymentPolicies
Sample output
Code Block
> POST /api/deploymentPolicies HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Content-Length: 432
> 
< HTTP/1.1 201 Created
< Date: Mon, 05 Oct 2015 04:34:35 GMT
< Location: https://localhost:9443/api/deploymentPolicies/deployment-policy-1
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"status":"success","message":"Deployment policy added successfully: [deployment-policy-id] deployment-policy-1"}

You will come across the following HTTP status codes while adding a deployment policy:

HTTP status code

201, 400, 409, 500

See the descriptions of the HTTP status codes here.

Location header URLhttps://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/deploymentPolicies/<DEPLOYMENT_POLICY_ID>

 

 

Localtab
titlePPaaS Console

Adding a deployment policy via the PPaaS Console

Adding a deployment policy via the UI editor

Follow the instructions below to add a deployment policy:

  1. Click Configurations on the home page.
    Image Added
  2. Click Deployment Policies.
    Image Added
  3. Click Add New Deployment Policy.
    Image Added
  4. Enter the required details. For property definitions, see Deployment policy property definitions.
    Image Added
  5. Click SAVE DEPLOYMENT POLICY DEFINITION.

Adding a deployment policy via the JSON editor

Follow the instructions below to add a deployment policy:

  1. Click Configurations on the home page.
    Image Added
  2. Click Deployment Policies.
    Image Added
  3. Click ADD DEPLOYMENT POLICY.
    Image Added
  4. Click on the editor control to switch to the JSON editor. The JSON code format to add a deployment policy will appear.
    Image Added
  5. Optionally, check the Auto correct with schema option to ensure that you do not accidentally delete any mandatory fields from the deployment policy definition JSON code.
    Image Added
  6. Code the deployment policy definition using JSON. For property definitions, see Deployment Policy Resource Definition.
  7. Click SAVE DEPLOYMENT POLICY DEFINITION.

 

...

Sample deployment policy JSON

Excerpt
Code Block
{
  "id": "deployment-policy-1",
  "networkPartitions": [
    {
      "id": "network-partition-mock",
      "partitionAlgo": "round-robin",
      "partitions": [
        {
          "id": "partition-1",
          "partitionMax": 2
        }
      ]
    }
  ]
}