Apiqcloud Environment Import option allows to upload .json, .jps, .cs, .yml, .yaml file and execute it on a Platform in order to install & configure a project according to the settings, declared within it. Being initially designed to deploy the previously exported environment copies (e.g. to transfer an application from another Apiqcloud installation), it can be also used to install your own solutions, declared via JSON, or integrate any ready-to-go package from Apiqcloud JPS Collection.
So let’s consider how to work with the Apiqcloud import functionality in more details on the example of environment package, that was previously exported from another Platform.
1. Click on the Import button at the top tools pane of the dashboard.
2. Within the opened Import frame, you’ll see three tabs with different options for specifying the required file:
-
Local File - to select the locally stored manifest (via the Browse button)
-
URL - to type in or paste a direct link to the required file
-
JSON - the in-built editor to either insert and edit your code on fly before uploading or to compose your own solution from the scratch manually
Once added into this editor, your code will be automatically parsed for errors. If such are detected, they will be marked with the red cross icon before the corresponding line (which displays some additional information on the found issue upon hovering over it).Tip: For the most comfortable work with the code, you can use the number of basic editing tools at the top pane:
Besides that, all of the code you specify in editor window is safely retained in 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.
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 previously exported environment, it will also show information on its source platform and date of export.
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 at (if several ones are available)
Click Import when ready.
04. Wait until the environment is created, deployed and configured.
Tip: You can minimize this window and continue working with Apiqcloud dashboard, whilst the importing process will be performed in the background.
5. Once the import is completed, you’ll be shown the appropriate information window.
Here, you can Open your new environment in a browser to check the result, or Close this frame to re-configure your environment and application according to the new platform’s settings first (e.g. due to changed hostnames, IP addresses, etc).
Also, some basic information on your imported environment (like its hostname, new administrator credentials for the nodes it contains, etc) will be sent to you via email.
Lastly, 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.
