Microservices Creation Overview

Microservices Creation: (ECS – Container Cluster or EC2 – Server Cluster) under the Environment or Group.

You can create different microservices of type Container Cluster and Server Cluster under an Environment.

Step-by-Step Microservice Creation

  1. Expand the Environment/Group menu under which you want to create microservices.
    Placeholder: Environment tree view - Expand the environment in the navigation panel.

  2. Click + in the Infrastructure menu.

  3. Enter a name for your microservice. Select type = DeploymentNode.

  4. Click OK and then click Save. The detail screen of 'Deployment Node' (microservice) is displayed.

  5. Click on the microservice name to open the Property panel, or click Edit.

  6. Enter the following properties:

           

Property

Description

Node Type

Select ECS (Container Cluster) or EC2 (Server Cluster)

gRPC Checkbox

Select or clear as needed

Cloud/Infra account ID

Inherits from the group

Infrastructure creation

Inherits from the group

Infrastructure creation API key

Inherits from the group

Infra AMI ID Type

Select appropriate type

Base URL

  • Enter base URL for the service (Domain name must be pre-configured in AWS).


For example, https://orix.sample.com

  • If left blank, the frontend uses the AWS load balancer URL seen in Custom Properties.

Platform Repo Branch

Default: main

  1. Click Save to commit these changes.

  2. Click Neo-Pilot, then click CREATE ENVIRONMENT. A popup is displayed. (Server Cluster OR Container Cluster depending on Node Type).Placeholder: Environment creation popup properties are prefilled and disabled.

  3. Fill in the data in this popup:

    1. Select SSL Certificate

      Note:

      • If an SSL certificate is not created, create it first as per the section "Create SSL Certificate for Microservices or independent ECS/EC2"

      • SSL region must match environment region

      • Certificates in creation appears but is disabled

      • Wildcard certs (for example, *.domain.com) are supported

    2. Select CPU and Memory for your service.

    3. Select Maximum and Minimum cluster size.

    4. Click CREATE.

After Creation

  • Microservice creation and logging follow the same flow as Environment/Group.

  • Multiple microservices (ECS or EC2) can be created under an Environment/Group by repeating steps 1 to 8.

  • After completion, connection details (such as ecsProps or ec2Props) appear under Custom Properties of the deployment.

  • MQTT/RDS/Redis details are inherited from the Environment.

Specifying Microservice Deployment Types

You can assign microservices under an Environment with the following roles:

MAIN

  • App is deployed on that microservice.

  • All API requests from REMOTE services redirect here.

  • Only one microservice can be MAIN.

REMOTE

  • App is not deployed on this microservice.

  • API requests are redirected to the MAIN.

  • Multiple REMOTEs are allowed.

  • If all are REMOTE, they act as LOCAL.

LOCAL

  • App is deployed locally on this microservice.

  • API calls are executed here directly.

  • Multiple LOCALS are allowed.

NONE

  • App is not deployed on this microservice.

Configuring Application Deployment

Select the Environment where the app is deployed. Refer to the 'Application Box' in the Environment view.
Placeholder: Application box in Environment

  1. Click on Deploy To in the Application box to view all available microservices.

  2. By default, all are set as LOCAL.

  3. Change the deployment type by clicking the respective buttons: MAIN / REMOTE / LOCAL / NONE.

  4. Available buttons:

    • Deploy To All: Set all as LOCAL

    • Close: Close the popup

  5. After configuration:

    • MAIN is shown in Blue

    • REMOTE is shown in Green

    • If all are LOCAL, it shows All in Green

Running Applications from Designer

In the Web module, when clicking RUN, a list of URLs is shown:

  • Includes all microservices where the app is deployed.

  • Clicking any URL opens the Web Module homepage.

  • If a MAIN is defined, all REMOTEs redirect to MAIN.

  • If all are REMOTE (that is, LOCAL), the selected microservice URL is used.

Web Module Run View