Versions Compared

Old Version 3

changes.mady.by.user Former user

Saved on

compared with

New Version 4

changes.mady.by.user Former user

Saved on

Key

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

You can add a cartridge group using the CLI tool, REST API or the management Private PaaS console (UI) as shown below:

...

Localtabgroup
Localtab
activetrue
titleCLI

Add a cartridge group via the CLI

Overview
CLI commandadd-cartridge-group
DescriptionAdd a cartridge group.
Command format
Code Block
add-cartrdige-group -p <JSON_FILE_PATH>
Info

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

Parameter definition
Short optionLong optionDescriptionRequiredExample value
-p
--resource-pathFolder path where the JSON file defining the cartridge group is stored.yes

<PRIVATE_PAAS_SAMPLES>CARTRIDGES>/wso2am/1.9.0/samples/cartridge-groups/wso2am-190/wso2am-190-group1.json

Example

Add a cartridge group that has been defined in the <PRIVATE_PAAS_SAMPLES>CARTRIDGES>/wso2am/1.9.0/samples/cartridge-groups/wso2am-190/wso2am-190-group1.json file.

Code Block
add-cartridge-group -p <PRIVATE_PAAS_SAMPLES>CARTRIDGES>/wso2am/1.9.0/samples/cartridge-groups/wso2am-190/wso2am-190-group1.json
Sample output
Code Block
Cartridge Group added successfully: [cartridge-group] keymanager-gw-manager-gw-worker
Localtab
titleREST API

Add a cartridge group via the REST API

Overview
DescriptionAdd a cartridge group.
Resource Path/cartridgeGroups
HTTP MethodPOST
Request/Response Formatapplication/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/cartridgeGroups
Info
  • The path to the JSON file that defines the cartridge group 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 a cartridge group that has been defined in the <PRIVATE_PAAS_SAMPLES>CARTRIDGES>/wso2am/1.9.0/samples/cartridge-groups/wso2am-190/wso2am-190-group1.json file.

Code Block
cd <PRIVATE_PAAS_SAMPLES>CARTRIDGES>/wso2am/1.9.0/samples
curl -X POST -H "Content-Type: application/json" -d @'cartridge-groups/wso2am-190/wso2am-190-group1.json' -k -v -u admin:admin https://localhost:9443/api/cartridgeGroups
Sample output
Code Block
> POST /api/cartridgeGroups HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Content-Length: 233
>
< HTTP/1.1 201 Created
< Date: Tue, 06 Oct 2015 11:28:13 GMT
< Location: https://localhost:9443/api/cartridgeGroups/keymanager-gw-manager-gw-worker
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"status":"success","message":"Cartridge Group added successfully: [cartridge-group] keymanager-gw-manager-gw-worker"}

You will come across the following HTTP status codes while adding a cartridge group:

HTTP status code

201, 400, 409, 500

See the descriptions of the HTTP status codes here.

Location header URLhttps://<STRATOS<SPRIVATE_PAAS_HOST>:<STRATOS<PRIVATE_PAAS_HTTPS_PORT>/api/cartridgeGroups/<CARTRIDGE_GROUP_NAME>
Localtab
titleManagement Private PaaS console

Add a cartridge group via the

management

Private PaaS console

 

...

 

Panel
titleSample cartridge group JSON
Code Block
{
  "name": "keymanager-gw-manager-gw-worker",
  "cartridges": [
    "wso2am-190-gw-manager",
    "wso2am-190-gw-worker",
    "wso2am-190-km"
  ],
  "dependencies": {
    "terminationBehaviour": "terminate-none"
  }
}