Application Manifest

An application manifest is a JSON-based JPS file that describes the information and configuration required to install an application successfully. It can define application metadata, environment topology, file uploads, deployments and post-deployment configuration.

Manifest Overview

Before packaging an application, deploy it manually first and verify all required settings. This helps identify every configuration value that should later be included in the package manifest.

The JPS manifest is a .json file containing the package definition in JSON format. It may also reference web-based dependencies needed during installation, and the manifest file can use any suitable filename.

Mandatory Manifest Body

The basic manifest body identifies the JPS version, installation type and application definition.

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

This part is mandatory. The install type indicates that a new environment should be created for application deployment. The application object is then extended with the application description and environment configuration.

Application Description

The application description contains the general information displayed to users during installation and in the Marketplace.

{
  "application": {
    "id": "myapp",
    "name": "My Application",
    "version": "1.0",
    "logo": "https://example.com/logo.png",
    "type": "java",
    "categories": ["apps/content-management"],
    "homepage": "https://example.com",
    "description": {
      "en": "Application description"
    },
    "startPage": "/",
    "success": {
      "text": "Application was deployed successfully.",
      "email": "Application installation has completed."
    }
  }
}

Marketplace Categories

Multiple categories can be assigned to the same package. If no category is specified, the application can be placed in the default miscellaneous category.

Environment Configuration

The environment configuration defines the infrastructure and application setup that should be created during package installation. The main sections are:

• TOPOLOGY — environment engine, nodes, High Availability and SSL.
• UPLOAD — additional libraries, modules or files.
• DEPLOYMENTS — application archives and deployment contexts.
• CONFIGS — configuration-file changes and database operations.

TOPOLOGY Section

The topology object defines the programming-language engine, High Availability, SSL and node configuration required by the application.

"topology": {
  "ha": false,
  "engine": "java7",
  "ssl": true,
  "nodes": [ ]
}

NODES Subsection

"nodes": [
  {
    "extip": false,
    "count": 1,
    "cloudlets": 16,
    "nodeType": "tomcat7"
  }
]

Typical node types include application servers, web servers, databases, load balancers, Maven and caching services. Additional custom templates can also be used when they are integrated into the platform.

UPLOAD Section

Use the upload array when the application requires extra files such as libraries, drivers or modules to be downloaded and placed on specific nodes.

"upload": [
  {
    "nodeType": "tomcat7",
    "sourcePath": "https://example.com/jdbc-connector.jar",
    "destPath": "${WEBAPPS}/jdbc-connector.jar"
  }
]

DEPLOYMENTS Section

The deployments array defines which application archive should be deployed and where it should be placed.

"deployments": [
  {
    "archive": "https://example.com/test.war",
    "name": "test.war",
    "context": "ROOT"
  }
]

CONFIGS Section

The configs array can modify configuration files on application servers, databases and other nodes. It can also restart nodes and perform database initialization or patching.

"configs": [
  {
    "nodeType": "tomcat7",
    "restart": true,
    "replacements": [ ],
    "path": "/path/to/config/file",
    "database": { }
  }
]

REPLACEMENTS Subsection

The replacements subsection searches for matching strings or regular expressions and replaces them with the required value. Platform placeholders can be used in the replacement text.

"replacements": [
  {
    "pattern": "app\\.host\\.url\\s*=\\s*.*",
    "replacement": "app.host.url = ${env.url}"
  }
]

DATABASE Subsection

The database subsection can create the application database, optionally specify the database user, import an initial dump and execute a patch.

"database": {
  "name": "appdb",
  "user": "root",
  "dump": "https://example.com/appdb.sql",
  "patch": "UPDATE settings SET value='${user.email}' WHERE name='admin_email';"
}

Important Notes

• Deploy and test the application manually before converting the installation into a package.
• Keep the mandatory JPS body at the root of the manifest.
• Use secure web URLs for logos, archives, libraries and database dumps.
• Use placeholders for environment-specific values rather than hard-coding them.
• Make sure the selected node types exist on the target platform.
• Validate configuration replacements and database patches in a non-production environment first.