Deploy to the OL Hub Runtime

Overview

An OL Hub Admin can deploy a Project to an OL Hub Managed Service on AWS Cloud.

The Project Deployment Wizard takes a project created by the user and runs it through the steps to deploy it. The user has the option of selecting the deployment environment, profile, connection profile and project variables to be used.

After the project is successfully deployed, the user can view and manage the project in Runtime (OpenLegacy Managed Services Runtime in AWS Cloud).

Procedure

  1. On the Projects page, select the project to be deployed.

  2. Click on the Deploy button. The Deploy Project page displays.

    ❗️

    Note: The Deploy button is enabled only if there is at least one published method in the project.

  3. Select the deployment environment from the list. Currently, there are two environments: TEST and PROD. The TEST env limitations are displayed in red.

  4. Select the active profile for deployment. You can select more one than one profile. It will behave as in the test flow.

  5. Select the Connection Profile. You can check its validity by clicking Test Connection:

  6. You can view the Project Configuration to display project variables. If you created project variables when creating the project, you can assign them values here. For example, if one of parameters is a file name, you can deploy it with the file name value.

    1. To add/edit/delete project variables, go back to the project page and select Project Configuration from the menu:

    2. The Project Configuration Variables page displays:

    3. Add/edit project variables as needed.

  7. Press the Deploy button. A progress bar displays at the top of the page:

  8. When the deployment completes, a success message displays:

  9. You can view the project APIs by clicking on Service Swagger Page on the right-hand side of the success message. This opens the api yaml file in Swagger in a new browser tab.

Runtime

After successfully deploying the project, you can navigate to the Runtime page. On this page, you can view the:

  • Dashboard - displays basic information about the application and allows managing the application
  • Monitoring - displays application metrics

Dashboard

The Dashboard page displays:

  • Application - the name of the service
  • Version - version number
  • Status - current status (Running, etc.)
  • Deployment Date
  • Specification - a link to the application’s Swagger Page
  • A submenu - select whether to:
    • Start Application - if not running, start the application
    • Stop Application - if running, stop the application
    • Delete Application
    • Manage Application - display the Application Overview

Selecting Manage Application displays the Application Overview window:

  • Selecting Logs displays the Monitoring/Logs page:

  • Selecting Metrics displays the Project Dashboard:

  • Selecting Endpoints displays:

  • Selecting Advanced displays:



Monitoring

The Monitoring page displays: