CLI Tutorial: Install JPS

JPS packages can be installed through the platform CLI to create a new environment with predefined customisation or to apply an add-on and other actions to an existing environment.

On this page

Install Method and Parameters
Install the TimeZone Change Add-On
Check the Add-On Result
Install JPS with a Configuration File
Override Configuration Values
Verify the JPS Log
What’s next?

Install Method and Parameters

Use the following CLI method to execute a JPS package:

~/jelastic/marketplace/jps/install \
  --jps {jps} \
  [--envName {envName}] \
  [--settings {settings}] \
  [--nodeGroup {nodeGroup}] \
  [--displayName {displayName}] \
  [--region {region}] \
  [--envGroups {envGroups}] \
  [--ownerUid {ownerUid}] \
  [--logsPath {logsPath}] \
  [--loggerName {loggerName}] \
  [--skipNodeEmails {skipNodeEmails}]

Parameter	Description
`jps`	URL of the manifest file or the manifest body itself.
`envName`	Name of the newly created environment for an install manifest, or the target environment for an update/add-on manifest.
`settings`	Package settings supplied as a JSON object with key/value pairs.
`nodeGroup`	Target environment layer for an add-on, such as `bl`, `cp`, `cache`, `sqldb`, `nosqldb`, `storage`, `vps`, `build`, or a custom Docker node group.
`displayName`	Alias assigned to a newly created environment.
`region`	Unique name of the region where a new environment should be created.
`envGroups`	Environment groups for the created environment, supplied as a JSON array such as `["mygroup","group/subgroup"]`.
`ownerUid`	User ID of a shared account where the JPS package should be installed.
`logsPath`	Path to the JPS installation log file. The default is `cs.log`.
`loggerName`	Name shown beside the timestamp for each operation in the JPS installation log.
`skipNodeEmails`	Controls email notifications about newly created nodes. The documented default is `true`.

Parameters in square brackets are optional. The parameters required in practice depend on whether the manifest creates a new environment or updates an existing one.

Install the TimeZone Change Add-On

The TimeZone Change add-on can switch the timezone of the containers in an existing environment.

1Prepare CLI access

Install the platform CLI and sign in to the required account.

2Run the Install method

Provide the manifest URL, target environment, add-on settings, and target node layer:

~/jelastic/marketplace/jps/install \
  --jps {jps} \
  --envName {envName} \
  --settings {settings} \
  --nodeGroup {nodeGroup}

{jps} — URL of the TimeZone Change manifest.
{envName} — existing environment name, for example my-app.
{settings} — JSON object containing the timezone required by the manifest, for example {"dashoard_url":"America/New_York"}.
{nodeGroup} — target environment layer, for example cp.

Successful response: A CLI response containing "result": 0 indicates that the installation completed without errors.

Check the Add-On Result

For the TimeZone Change add-on, review the detailed result in /var/log/jpsaddon.log:

~/jelastic/environment/file/read \
  --envName {envName} \
  --path "/var/log/jpsaddon.log" \
  --nodeGroup {nodeGroup}

The log confirms whether the selected timezone was applied successfully to the target containers.

Install JPS with a Configuration File

Frequently used JPS calls can be simplified by storing all required parameters in one JSON configuration file.

1Create the JSON configuration

The following example runs an update-type JPS that writes a supplied parameter value to the Cloud Scripting log:

{
  "jps": {
    "type": "update",
    "name": "JPS Example",
    "onInstall": {
      "log": "${settings.param1}"
    }
  },
  "envName": "my-app",
  "settings": {
    "param1": "value1"
  },
  "nodeGroup": "cp"
}

Instead of embedding the manifest body in the jps property, you can provide a URL to the manifest file.

2Run Install with the configuration file

~/jelastic/marketplace/jps/install --myparams {myparams.json}

Override Configuration Values

A parameter supplied directly in the CLI command can override the corresponding value stored in the JSON file. For example, change the target environment without editing the configuration file:

~/jelastic/marketplace/jps/install \
  --myparams {myparams.json} \
  --envName {envName}

Reusable automation: Keep shared settings in the JSON file and override only the values that change between executions.

Verify the JPS Log

After installation, review the Cloud Scripting logs in the dashboard through Import > JPS > View Logs.

Confirm that the installation operation completed successfully.
Review the values written by the manifest.
Use the log to troubleshoot failed JPS steps.

Configuration files with predefined parameters are useful for simplifying and automating repeated JPS installation calls.