Environment Module

Availability of functionality depends on the license and may not be available in all deployments.

The module is used to manage application templates. It enables:

• previewing the version of the selected application in the available environments,
• migrating the application template (together with its dependencies) between environments,
• withdrawing the last application migration on a specific environment (rollback),
• running the selected application in the selected environment in the simulator (see Application Simulator),
• downloading the business package (application template together with dependencies required to run it in the environment).

Displaying application information in environments

After entering the module, the button is displayed APPLICATION.

Figure 1. "Environments" tab

After selecting an application from the list, the published and highest version of the application will be displayed on each of the available environments:

Figure 2. Application status on individual environments

Running the application

Clicking the button next to the published version redirects to the application simulator module, automatically selecting the environment from which the redirection occurred.

Template migration

To migrate the application together with dependencies to a higher environment, click the arrow between the tiles:

Figure 3. Arrow migrating the application to a higher environment

This will cause the migration and publishing of the template in the highest version to the indicated environment. Additionally, files necessary for proper operation of the application will be imported into the appropriate directories on the environment.

Template migration is performed only on the first environment, due to the shared database for all LAN instances. Dependencies for the application, however, are delivered to all instances.

Validation during template migration

Before migrating the template together with dependencies, environment consistency validation is performed. The validator checks whether dependencies imposed on the target environment will not introduce inconsistencies. If the validator encounters any problems, it will display a list and the content of warnings to the user. At this point, the user can decide whether they still want to force the migration to the target environment.

Figure 4. Migration error message

Environment action menu

To open the environment action menu, press the button Open action menu located in the upper right corner of the environment tile.

Figure 5. Environment action menu

Template export

Clicking in the action menu option Export package will build a zip file containing the application template in the latest version on the given environment along with the dependencies needed to run it.

Figure 6. Menu containing the package export command

The file will be saved in the Nexus repository. In response, a popup with a link to the package in Nexus will appear in the browser.

Figure 7. Window with link to the package

• Exporting the template from the repository is performed from the first environment, due to the shared database for all LAN instances.
• Visibility of the export option is controlled by the flag from the environment configuration (bundleExporter).

Environment rollback

The option Rollback serves to restore on a given environment the last backup copy of the application dependencies directories. Backups are created at the moment of migrating any application with dependencies to the environment. Each environment has its own backup for each application previously migrated.

• Template rollback is performed only on the first environment, due to the shared database for all LAN instances.
• Visibility of this option is controlled by the flag from the environment configuration (migrationTarget).

If no migration has been finalized previously, the option will be grayed out, because there is no available package that could be restored.

Environment configuration

The list of available environment "tiles" should be configured in a file whose path should be provided in the package installation parameters (EXIMEE_CONSOLE_ENVIRONMENTS_CONFIGURATION_PATH). The order of the listed environments also determines the direction of migration.

[
  {
    "name": "Environment1",
    "lanHosts": [
      "lan.adres.test"
    ],
    "migrationTarget": false,
    "bundleExporter": false
  },
  {
    "name": "Environment2",
    "lanHosts": [
      "lan.test.eximee",
      "lan2.test.eximee"
    ],
    "migrationTarget": true,
    "bundleExporter": true
  }
]

Meaning of individual attributes:

• name – environment name displayed on the tile.
• lanHosts – array of LAN instances in a given environment (it is important that these are only hosts – without e.g. protocol http:// or port).
• migrationTarget – flag indicating whether applications can be migrated to the given environment.
• bundleExporter – flag indicating whether the application package with dependencies can be exported from the given environment.