Packaging Standard Overview
Packaging Standard for CI/CD Automation
Packaging Standard Overview
JPS packages describe the infrastructure, software, configuration, and automation steps needed to deploy or modify a platform solution. The same package can be reused to provide a consistent installation process across compatible platform environments.
Application and Add-On Packages
| Package Type | Purpose |
|---|---|
| Application Package | Creates a new environment and deploys a complete predefined solution. |
| Add-On Package | Applies additional software, configuration, or automation to an existing environment or node layer. |
| Update Package | Runs actions against an existing solution without necessarily creating a new environment. |
JPS Manifest
A JPS package is described through a manifest, commonly written in JSON or YAML. The manifest can define metadata, environment topology, user-selectable settings, installation actions, and other lifecycle logic.
type: install
name: Example Application
baseUrl: https://example.com/package/
nodes:
- nodeType: docker
nodeGroup: cp
image: example/application:latest
cloudlets: 8
onInstall:
- log: "Application installation started"
A manifest may include sections for:
- Package name, description, logo, and version information.
- Environment and node topology.
- Application settings entered by the user.
- Installation, configuration, validation, and update actions.
- External scripts, files, and reusable resources.
- Success messages, warnings, and error handling.
Automation Workflow
A typical package installation follows this sequence:
- The user starts the package from Marketplace, Import, CLI, or API.
- The platform reads and validates the manifest.
- Required installation settings are collected.
- The environment is created or the target environment is selected.
- Manifest actions install and configure the solution.
- The platform records the operation in the Cloud Scripting log.
- The completed application or add-on is made available to the user.
Package Installation
JPS packages can be started through several platform interfaces:
- Marketplace package installation.
- Import through a manifest URL or manifest content.
- Platform CLI.
- Marketplace JPS API methods.
A CLI installation can use the following method:
~/jelastic/marketplace/jps/install \
--jps {manifest_url_or_body} \
[--envName {environment_name}] \
[--settings {json_settings}] \
[--nodeGroup {node_group}]
Installation Logs
Cloud Scripting records the operations performed during package installation. Logs are useful for verifying completed actions and troubleshooting failed steps.
- Review logs through the Cloud Scripting Console or the platform interface.
- Use the optional
logsPathparameter to define a custom log path. - Use
loggerNameto define the label shown with log entries. - Retrieve installation logs through API file-reading methods when automation requires it.
Common Use Cases
- Prepare a complete application stack for one-click deployment.
- Install monitoring, security, backup, SSL, or administration add-ons.
- Standardise deployment across development, staging, and production environments.
- Automate repeatable configuration and maintenance procedures.
- Distribute packaged solutions through Marketplace.
- Integrate platform deployments into CI/CD pipelines.
