Application Manifest

Let’s have a closer look at the code of the package with all required configurations.

JPS manifest is a file with .json extension which contains an appropriate code written in JSON format (JSON Formatter & Validator). This manifest file includes the links to the web only dependencies. This file can be named as you require.

The code should contain a set of strings needed for successful installation of application. The basis of the code is represented by the following strings:

1
2
3
4
5

{
 "jpsVersion":"0.2"
 "jpsType": "install",
 "application": { }
}

This is a mandatory body part of the application package which includes the information about JPS version and the type of the application installation (“install” mode initiates a new environment creation required for deploy).

These basic strings should be extended with the settings required by the application you are packing. The following configuration details are included to the “application”: { } parameter:

• Application Description
• Environment Configurations

Application Description

First of all you need to provide some general information about the application such as its title, version, type of programming language and so on.

Sample of code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

{
   application: {
      "id":"opencms",
      "name":"OpenCMS",
      "version":"8.5",
      "logo":"",
      "type":"java",
      "categories":["apps/cms","apps/popular"],
      "homepage": "",
      "description": {
          "en": "OpenCMS from Alkacon Software is a professional, easy to use website content management system. OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.",
          "ru": "Russian description"
      },
     "startPage" : "/install.jsp",
     "success": {
    "text": "Dashboard success text",
    "email": "Email success text"
     }

}}

In the categories parameter you can use the following values due to the Marketplace category you would like your application belong to:

Environment configurations

You need to specify the details about the environment your application requires for a proper performance. The settings stated in this part of the code will be used for creating and configuring the appropriate environment while package installation.

• TOPOLOGY section
• UPLOAD section
• DEPLOYMENTS section
• CONFIGS section

TOPOLOGY Section

The “topology”:{ } section includes the data on the programming language of the environment, the required nodes with their settings and the necessity to enable such extra functions as High Availability and SSL.

Sample of code:

1
2
3
4
5
6

"topology":{
             "ha":value,
             "engine":"value",
             "ssl":value,
             "nodes":[ ]
          },

NODES Subsection

This is the “nodes”:[ ] subsection of the above mentioned “topology”:{ } where you can specify the amount of nodes and their main settings.

Sample of code:

1
2
3
4
5
6
7
8

"nodes":[
           {
              "extip":value,
              "count":value,
              "cloudlets":value,
              "nodeType":"value"
           }
        ]

In the nodeType parameter you can use the following node type values due to the stack you want to use:

UPLOAD Section

Add the “upload”:[ ] section to the code if your application requires any additional files (e.g. any library or module) to be uploaded and set:

Sample of code:

1
2
3
4
5
6
7

"upload":[
             {
                "nodeType":"value",
                "sourcePath":"value",
                "destPath":"value"
             }
                       ],

DEPLOYMENTS Section

The “deployments”:[ ] section is responsible for setting the deploy process of the application archive to the configured environment.

Sample of code:

1
2
3
4
5
6
7

"deployments":[
     {
        "archive":"value",
        "name":"value",
        "context":"value"
     }
  ]

CONFIGS Section

Using the “configs”:[ ] section you are able to modify any configuration file at any node (application server, database, etc.) to configure application settings (e.g. configure connection setting between application server and database) and also perform database related operations: apply initial database dump, apply database patch, etc.

Sample of code:

1
2
3
4
5
6
7
8
9

"configs":[
 {
    "nodeType":"value",
    "restart":value,
    "replacements":[]
    "path":"value",
    "database":{},
    }
]

REPLACEMENTS Subsection

This is the “replacements”:[ ] subsection of the above mentioned “configs”:{ }. You can use as replacement any string value including any combination of placeholders.

Sample of code:

1
2
3
4
5
6

"replacements":[
    {
       "pattern":"value",
       "replacement":"value"
    },
]

DATABASE Subsection

This is the “database”:[ ] subsection of the above mentioned “configs”:{ } where you can specify the main db settings.

Sample of code:

1
2
3
4
5
6

"database":{
   "name":"value",
   "user":"value",
   "dump":"value",
   "patch" : "value"
}

What’s next?

• Packaging Overview
• Application Marketplace
• Application Manifest Example
• Packaging Placeholders