Environment Import

The the platform’s Environment Import feature allows executing the .json, .jps, .yml, .yaml, or .cs files on the platform to automatically install and configure projects according to the declared settings. Being initially designed to deploy the previously exported environment copies (e.g. to transfer an application from another PaaS installation), it can also be used to install your own solutions, declared via JSON, or integrate any ready-to-go package from JPS Collection.

So, let’s consider how to work with the platform import functionality in detail on the example of the exported environment.

Note: For your exported environment to work correctly, it should be migrated to the PaaS installation of the same or higher version. You can compare the platform’s versions at Cloud Union.

1. Click on the Import button at the top of the dashboard.

package import button

2. Within the opened Import frame, you’ll see three tabs with different options for providing the required file:

  • Local File - to select a locally stored manifest (via the Browse button) import via local file

  • URL - to type in or paste a direct link to the required file import via URL

  • JPS - the built-in editor to either insert and edit code or to compose your own solution from scratch (refer to the JPS deployment and troubleshooting section below for more information) import via JPS

Tip: The Examples link next to these tabs redirects to the JPS Collection at GitHub, which stores multiple open-source samples of the ready-to-go packages. You can import any of them by fetching manifest.jps via the tabs above or examine files and scripts to create your own solution.

To proceed, click the Import button in the bottom-right corner of the needed import type tab.

3. After that, you’ll see the installation confirmation window with the corresponding package description. For the exported environment, it shows details on the source platform and export date.

confirm environment import

Within the fields inside, you need to specify the following parameters:

  • Environment - domain name for your new environment
  • Display Name - environment alias to be displayed at the dashboard instead of its domain (optional)
  • Region - environment region to host the solution (if several ones are available)

Click Import when ready.

4. Wait until the environment is created, deployed, and configured.

deploying imported environment

Tip: You can minimize this window and continue working with the dashboard without interrupting the importing process, which will proceed in the background.

5. In a few minutes, you’ll see the installation success window.

Here, you can click Open in Browser to immediately check the result or Close this frame to reconfigure your environment and application according to the new platform’s settings (e.g. due to changed hostnames, IP addresses, etc.).

environment successfully imported

Also, check your email for information (like hostname, new administrator credentials for the nodes, etc.) on your imported environment.

That’s all! This way, you can automatically install any required solution to the chosen platform just in a few clicks, without the necessity to set up all configurations manually.

JPS Deployment & Troubleshooting

The Import > JPS option is most frequently used by developers who create JPS packages (e.g. for automation of the common tasks or implementation of complex CI/CD flows). Also, it is an excellent tool for the quick tuning and testing of the packages.

1. Once added into this editor, your code will be automatically parsed for errors. If detected, they will be marked with the red cross icon before the corresponding line (hover over for some additional information on the issue). Besides, your code is safely retained in your browser’s local storage, so you can freely close the whole Import frame (e.g. to perform some other operations at the dashboard) and return to coding later on.

JPS editor for import

2. At the top of the frame, you can find several tools for a more comfortable work experience:

  • Format JSON - automatically sets proper indentation and line feeds (not available for YAML)
  • Wrap lines - brakes lines when they reach a frame border
  • Search - locates the needed information, with additional options to narrow the search results even further:
    • Match case - enables a case sensitive search
    • Regex - uses regular expressions for the search conditions specification
  • View Logs - opens a console to track your code execution

JPS editor tools bar

3. The Import logs provide essential information for troubleshooting. If you face issues during the JPS packages creation, refer to this Import > JPS > View Logs tab and search for errors.

import logs

Tip: On the platforms before the 5.9.7 release, you can access this JPS console in a separate browser tab by adding the /console suffix to your dashboard URL (must be logged in for authorization).

If you face any issues while importing a JPS package, feel free to appeal for our technical experts’ assistance at Stackoverflow.

What’s next?