This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Updating a Deployment Policy - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
||
Skip to end of metadata
Go to start of metadata

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

 

Updating a deployment policy via the CLI

Overview
CLI command
update-deployment-policy          
DescriptionUpdate a deployment policy.
Command format
update-deployment-policy -p <JSON_FILE_PATH>

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

Parameter definition
Short optionLong optionDescriptionRequiredExample value
-p--resource-pathFolder path of the JSON file where the deployment policy definition is defined.Yes
<PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/
deployment-policies/mock/deployment-policy-1.json
Example

Update the deployment policy defined in the <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/deployment-policies/mock/deployment-policy-1.json file.

update-deployment-policy -p <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/deployment-policies/mock/deployment-policy-1.json
Sample output
Deployment policy updated successfully: [deployment-policy-id] deployment-policy-1

Updating a deployment policy via the REST API

Overview
Description

Update a deployment policy definition.

Resource Path

/deploymentPolicies

HTTP MethodPUT
Request/Response Format

application/json

Command format
curl -X PUT -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/deploymentPolicies
  • 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

Update the deployment policy defined in the <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/deployment-policies/mock/deployment-policy-1.json file.

cd <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples
curl -X PUT -H "Content-Type: application/json" -d @'deployment-policies/mock/deployment-policy-1.json' -k -v -u admin:admin https://localhost:9443/api/deploymentPolicies
Sample output
> PUT /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 200 OK
< Date: Mon, 05 Oct 2015 05:02:55 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"status":"success","message":"Deployment policy updated successfully: [deployment-policy-id] deployment-policy-1"}

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

HTTP status code

200, 500, 409
See the descriptions of the HTTP status codes  here .

Location header URL

https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/deploymentPolicies/<DEPLOYMENT_POLICY_ID>

Updating a deployment policy via the PPaaS Console

Updating a deployment policy via the UI editor

Follow the instructions below to update a deployment policy:

  1. Click Configurations on the home page.
  2. Click Deployment Policies.
  3. Hover your mouse pointer over the deployment policy definition you wish to update for the Edit button to appear and Click Edit.
  4. Update the deployment policy definition. For property definitions, see the Deployment Policy Resource Definition.
  5. Click SAVE.

Updating a deployment policy via the JSON editor

Follow the instructions below to update a deployment policy:

  1. Click Configurations on the home page.
  2. Click Deployment Policies.
  3. Hover your mouse pointer over the deployment policy definition you wish to update for the Edit button to appear and click EDIT.
  4. Click on the editor control to switch to the JSON editor. The JSON code format to update a deployment policy will appear.
  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.
  6. Update the deployment policy definition using JSON. For property definitions, see the Deployment Policy Resource Definition.
  7. Click SAVE.

 


Sample deployment policy JSON

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

  • No labels