Skip to content

Deploying the Streaming Integrator as a Minimum HA Cluster in AWS ECS

Introduction

This section explains how to run WSO2 Streaming Integrator as a minimum HA (High Availability) cluster in AWS (Amazon Web Services) ECS(Elastic Container Service).

The minimum HA cluster typically has two nodes where one node operates as the active node and the other as the passive node. Each node maintains a communication link with the other node as well as with the database.

Assigning the Active and Passive statuses to nodes

Assign Node Active or Passive Status

When a node is started in the minimum HA cluster mode, it checks the tables in the WSO2_CLUSTER_DB database. This check covers checking whether there are existing members in the cluster. If other nodes already exist as members of the cluster, it checks whether there are heartbeats from the existing member(s) for the last time interval that is of the same length as the specified heartbeat interval. If no heartbeat exists for the specified time interval, the node is added to the cluster as the active node. If not, it is added as the passive node.

Once a node becomes the active node, it performs the following:

  • Inserts its own details in the WSO2_CLUSTER_DB database or updates them if they already exist. The details include nodeId, clusterGroup, propertyMap, and heartbeatTimestamp.
  • Periodically updates the appropriate table of the WSO2_CLUSTER_DB database with its heartbeat (timestamp).
  • Starts the Siddhi applications in runtime and opens all the ports mentioned in the Siddhi applications.
  • Starts the binary and thrift transports.
  • Starts the REST endpoints.
  • Once a new member (i.e., passive node) joins the cluster, the active node checks the WSO2_CLUSTER_DB database for the host and port of ther other member's event syncing server. Once this information is retrieved, it sends the input events received by the cluster to that event syncing server.

Operating the nodes

When the cluster is running with both the nodes, the active node sends each event received by the cluster to the passive node's event sync server with the event timestamp. It also persists the state (windows, sequences, patterns, aggregations, etc.,) in the database named PERSISTENSE_DB. Each time the state is persisted, the active node sends a control message to the passive node.

The passive node saves the events sent to its event sync server in a queue. When it receives the control message from the active node, it trims the queue to keep only the latest events that were not used by the active node to build the state of Siddhi applications at the time of persisting the state.

Handling the failure of the active node

The passive node continuously monitors the heartbeat of the active node. If the active node fails, the passive node follows the process shown below to start functioning as the active node so that data is not lost due to node failure.

Passive Node Becomes Active

The following table explains the above steps.

Step Description
1. Start Siddhi Application Runtime This is done without opening any ports mentioned in Siddhi applications. This is because the Siddhi application statuses need to be restored to what they were before the node failure so that unprocessed events before the failure are not lost.
2. Restore State This is done by retrieving the states persisted in the PERSISTENSE_DB database.
3. Direct Events in Queue to Streams The unprocessed events that are currently in the queue of the event sync server are directed into the relevant streams of the Siddhi applications.
4. Open Ports, Binary & Thrift Transports,
and REST Endpoints
Once the above steps are completed, the previously passive and now active node opens the ports, starts the thrift and binary transports, and opens the REST endpoints.

Setting up the SI cluster in AWS ECS

Before you begin:

In order to deploy WSO2 Streaming Integrator in AWS ECS, you need to complete the following requisites:
- create an account in AWS. - Download and install AWS CLI Version 2. - Download and install Docker. For instructions, see Docker Documentation.

Step 1: Store SI Docker images in ECR

  1. Generate an access key and a secret key.

    1. Sign in to the IAM console via the AWS console. Under Access Management, click Users.

      AWS IAM console

      Then click Add User in the page that appears, and enter information as follows.

      1. In the User name field, enter a valid email address. Under Access Type, select the Programmatic Access check box. Then click Next:Permissions.

        Create Group

      2. Add the user you are creating to a relevant group. In this example, let's create a new group. To do this, click Create Group and open the CreateGroup dialog box. Then enter a name for the group, select the AdministratorAccess check box, and then click Create Group. Create Group

        Click Next:Tags, and in the next page click Next:Review.

      3. Review the information you have entered for the user. If you want to change anything, go back to the relevant previous page. If not, click Create User to save the information and create the user.

        Once you create the user, you can get the access key and the secret key as shown below.

        Get access keys and secret key

  2. Issue the following command in the terminal to configure AWS.

    aws configure

    You are prompted for the AWS Access Key ID, AWS Secret Access Key, Default region name, and Default output format. For this example, you can enter the following values.

    Requested Information Value
    AWS Access Key ID Enter the access key that you generated when you created the AWS user.
    AWS Secret Access Key [None] Enter the secret key that you generated when you created the AWS user.
    Default region name us-east-2.
    Default output format json
  3. Create a repository in the ECR (Elastic Container Registry).

    1. Access AWS ECR (Elastic Container Registry) via the AWS Console.

    2. To create a new repository, click Create a repository -> Get Started. The Create Repository page opens.

    3. For this example, enter wso2 as the repository name and click Create repository to create the repository.

      The repository is created as shown below.

      Repository Created

    4. To retrieve an authentication token and authenticate your Docker client to your registry, do the following:

      1. In the Repositories page, click View push commands.

      2. Copy the command given under Retrieve an authentication token and authenticate your Docker client to your registry.. This command is similar to the following example. aws ecr get-login-password --region us-east-2 | docker login --username AWS --password-stdin 627334729308.dkr.ecr.us-east-2.amazonaws.com/wso2

      3. Issue the command you copied in the AWS CLI. The following message appears in the CLI.

        Login Succeeded

  4. Build Docker images with SI configurations as follows:

    1. Edit the <SI_HOME>/conf/server/deployment.yaml file as follows.

      1. In the state.persistence section, update the following parameters.

        Parameter Value
        enabled true
        persistenceStore org.wso2.carbon.streaming.integrator.core.persistence.DBPersistenceStore
        datasource PERSISTENCE_DB
        table PERSISTENCE_TABLE
        Click here to view the updated state.persistence section.
        state.persistence:
          enabled: true
          intervalInMin: 1
          revisionsToKeep: 2
          persistenceStore: org.wso2.carbon.streaming.integrator.core.persistence.DBPersistenceStore
          config:
            datasource: PERSISTENCE_DB
            table: PERSISTENCE_TABLE
      2. In the wso2.datasources: section, add two data sources named PERSISTENCE_DB and WSO2_CLUSTER_DB as follows.

            - name: PERSISTENCE_DB
              description: The MySQL datasource used for persistence
              jndiConfig:
                name: jdbc/PERSISTENCE_DB
              definition:
                type: RDBMS
                configuration:
                  jdbcUrl: 'jdbc:mysql://wso2db.cxtsxcdgcayr.ap-south-1.rds.amazonaws.com:3306/persistencedb?useSSL=false'
                  username: root
                  password: rootroot
                  driverClassName: com.mysql.jdbc.Driver
                  maxPoolSize: 50
                  idleTimeout: 60000
                  connectionTestQuery: SELECT 1
                  validationTimeout: 30000
                  isAutoCommit: false
            - name: WSO2_CLUSTER_DB
              description: The MySQL datasource used for persistence
              jndiConfig:
                name: jdbc/WSO2_CLUSTER_DB
              definition:
                type: RDBMS
                configuration:
                  jdbcUrl: 'jdbc:mysql://wso2db.cxtsxcdgcayr.ap-south-1.rds.amazonaws.com:3306/clusterdb?useSSL=false'
                  username: root
                  password: rootroot
                  driverClassName: com.mysql.jdbc.Driver
                  maxPoolSize: 50
                  idleTimeout: 60000
                  connectionTestQuery: SELECT 1
                  validationTimeout: 30000
                  isAutoCommit: false
      3. To enable clustering and update strategy configuration values, update the cluster.config section as follows:

        Parameter Value
        enabled true
        groupId si
        coordinationStrategyClass org.wso2.carbon.cluster.coordinator.rdbms.RDBMSCoordinationStrategy
        datasource WSO2_CLUSTER_DB
        heartbeatInterval 5000
        heartbeatMaxRetry 5
        eventPollingInterval 5000
        Click here to view the updated cluster.config: section.
            cluster.config:
              enabled: true
              groupId:  si
              coordinationStrategyClass: org.wso2.carbon.cluster.coordinator.rdbms.RDBMSCoordinationStrategy
              strategyConfig:
                datasource: WSO2_CLUSTER_DB
                heartbeatInterval: 5000
                heartbeatMaxRetry: 5
                eventPollingInterval: 5000
      4. Uncomment the deployment.config: section and edit the parameters as follows:

      Parameter Value
      type ha
      host localhost
      advertisedHost localhost
    2. Clone the docker-ei repository by issuing the following command.

      git clone https://github.com/wso2/docker-ei

    3. In the docker-ei/alpine/streaming-integrator/docker-entrypoint.sh file, enter the following code before the # start WSO2 server comment.

      Info

      In this example, it is assumed that you are using alpine. You can also use centos or ubuntu.

      IP=$(ifconfig eth0 | grep "inet addr" | cut -d ':' -f 2 | cut -d ' ' -f 1)
      DEPLOYMENT_YAML=${WSO2_SERVER_HOME}/conf/server/deployment.yaml
      echo "$IP"
      sed -i "s/localhost/$IP/" "$DEPLOYMENT_YAML"

      This gets the IP address of the host machine and replaces it in the HA configuration in the <SI_HOME>/conf/server/deployment.yaml file.

    4. Make a copy of the <SI_HOME>/conf/server/deployment.yaml file you edited and paste it in docker-ei/dockerfiles/alpine/streaming-integrator directory.

    5. In the docker-ei/dockerfiles/alpine/streaming-integrator/deployment.yaml file, under wso2.carbon:, change value for the id parameter to wso2-si-1.

      id: wso2-si-1

    6. To build the Docker image for node 1, navigate to the docker-ei/dockerfiles/alpine/streaming-integrator directory and issue the following command.

      docker build -t wso2si:1.0.0-alpine-ha1 .

      Once the build is successfully executed, a message similar to the following appears in the CLI.

      build 1 successfully executed

    7. In the docker-ei/dockerfiles/alpine/streaming-integrator/deployment.yaml file, under wso2.carbon, change value for the id parameter to wso2-si-2.

      id: wso2-si-2

      This is because, now you are using the same repository to build the Docker image for node 2.

    8. To build the Docker image for node 2, navigate to the docker-ei/dockerfiles/alpine/streaming-integrator directory and issue the following command.

      docker build -t wso2si:1.0.0-alpine-ha2 .

      Once the build is successfully executed, a message similar to the following appears in the CLI.

      build 2 successfully executed

    9. To tag the built images, issue the following commands.

      docker tag wso2si:1.0.0-alpine-ha2 <AWS_ACCOUNT_NUMBER>.dkr.ecr.us-east-2.amazonaws.com/wso2:ha1

      docker tag wso2si:1.0.0-alpine-ha1 <AWS_ACCOUNT_NUMBER>.dkr.ecr.us-east-2.amazonaws.com/wso2:ha2

    10. To push the images, issue the following commands.

      docker push <AWS_ACCOUNT_NUMBER>.dkr.ecr.us-east-2.amazonaws.com/wso2:ha1

      docker push <AWS_ACCOUNT_NUMBER>.dkr.ecr.us-east-2.amazonaws.com/wso2:ha2

STEP 2: Create RDS for persisting and clustering requirements

To create a Amazon RDS (Relational Database Service) for the purpose of persisting data handled by the cluster, follow the procedure below:

  1. Access Amazon RDS via the AWS console.

  2. To add a parameter group and change the value for the max_connections parameter for it, follow the procedure below:

    1. In the left navigator, click Parameter groups. Then, in the Parameter Groups page, click Create Parameter Group to create a new parameter group.

      Create New Parameter Group

      The Create parameter group page opens.

    2. Enter details in the Create parameter group page to create a new parameter group.

      Create New Parameter Group

      Then click Create. The newly created parameter group appears in the Parameter groups page as follows.

      Created Parameter Group

    3. To edit the parameter group, click on it. Then search for the max_connections parameter, select it, and click Edit parameters. Change the value for the max_connections parameter to 300 and then click Save changes.

  3. Create an RDS instance as follows:

    1. In the left navigator, click Databases. Then in the Databases page, click Create database to open the Create Database page.

      Create New Database

    2. In the Create Database page, enter details as follows.

      1. Select Standard Create.

      2. Under Engine Type, select MySQL.

      3. Under Templates, select Free Tier.

      4. Under Settings, enter details as instructed within the user interface.

        RD Instance Settings

      5. Under Connectivity, expand the Additional connectivity configuration. Under Publicly accessible, select Yes. This allows you to connect and create the database, and then check on the database values later.

        Additional Connectivity

      6. Expand the Additional Configurations section. In the DB parameter group field, select the parameter group that you previously created.

        Additional Configurations

      7. Click Create database. The database you created appears in the Databases page.

    3. Enable public access to the database as follows:

      1. In the Databases page, click on the wso2 database you created to view details of it in a separate page.

      2. In the Security section, click the VPC.

        Security VPC

      3. In the Security Groups page that opens, click on the relevant security group to view details of it in a separate page.

        Security Group

      4. In the page with details of your security group, click Edit Inbound Rules.

        Edit Inbound Rules

        This opens the Edit inbound rules page.

      5. In the Edit inbound rules page, add two rules as follows.

        Type Source
        MYSQL/AURORA Select Custom for the Source field and then select 0.0.0.0/0 as the value.
        MYSQL/AURORA Select Custom for the Source field and then select ::/0 as the value.

        Then click Save rules.

Step 3: Set up ECS cluster, tasks and services

  1. To create a VPC (Virtual Private Cloud), a subnet, and a security group, follow the procedure below:

    1. Access the VPC Dashboard via the AWS Console.

    2. Click Launch VPC Wizard.

    3. In Step 1: Select a VPC Configuration, VPC with a Single Public Subnet is selected by default in the left pane. Click Select for it.

      Select VPC Type

    4. In Step 2: VPC with a Single Public Subnet, enter si-ha-vpc in the VPC name field. Then click Create VPC.

      Create VPC

    After successfully creating the VPC, you can view it in the Your VPCs page as follows:

    Created VPC

    To view the public subnet created, click Subnets in the left navigator. The subnet connected to the VPC is displayed as shown below.

    Created subnet

    To view the security group of the VPC, click Security Groups in the left navigator. The security group is displayed as follows.

    security group

    Info

    When you select the security group and view details for it at the bottom of the Security Groups page, note that all incoming traffic is currently enabled for now in the Inbound Rules tab.

    Inbound Rules

  2. Set up the cluster as follows:

    To set up the cluster, follow the procedure below:

    1. Access Amazon ECS via the AWS Console.

    2. In the left navigator, click Clusters. Then click Create Cluster in the Clusters page.

      clusters

    3. In the Create Cluster wizard that opens, select EC2 Linux + Networking and then click Next step. create cluster

    4. In Step 2: Configure Cluster of the Create Cluster wizard, enter information as follows:

      configure cluster

      1. In the Cluster name field, enter a name for your cluster. In this example, let's enter si-ha-cluster as the name.

      2. Select the Create an empty cluster check box.

      3. Click Create to create the cluster.

  3. Create a task for Streaming Integrator node 1 as follows:

    1. In the left navigator of Amazon ECS, click Task Definitions. Then in the Task Definitions window, click Create new Task Definition.

      Create New Task Definition

    2. In the Select launch type compatibility page, click FARGATE and then click Next step.

      Select Launch Type

    3. In Step 2: Configure task and container definitions, enter information in the Create new Task Definition wizard as follows:

      1. In the Task Definition Name field, enter ha-node-1-task as the name of the task definition.

      2. In the Task Size section, enter values as follows:

        Field Value
        Task memory (GB) 0.5GB
        Task CPU (vCPU) 0.25vCPU
      3. In the Container Definitions section, click Add container. Then enter information as follows:

        1. In the Container name field, enter node-1-ha-container as the name of the container.

        2. In the Image field, enter the image URI.

          Tip

          To get the image URI, follow the steps below:
          1. Access Amazon ECR via the AWS Console.
          2. In the left navigator, click Repositories to open the Repositories window.
          3. Click on your repository (which is wso2 in this example).
          The available docker images are displayed in the Images window.
          Docker Images
          3. In the Port Mappings section, add the following ports.

          Port Protocol
          9893 tcp
          9090 tcp
          9711 tcp
          9611 tcp
          7711 tcp
          7611 tcp
          7443 tcp
          7070 tcp
          9443 tcp
          8006 tcp

          To add each port, click Add Port Mapping.

        3. Click Add.

        4. Click Create in the Configure task and container definitions page to create the task.

  4. Create a task for Streaming Integrator node 2 as follows:

    1. In the left navigator of Amazon ECS, click Task Definitions. Then in the Task Definitions window, click Create new Task Definition.

      Create New Task Definition

    2. In the Select launch type compatibility page, click FARGATE and then click Next step.

      Select Launch Type

    3. In Step 2: Configure task and container definitions, enter information in the Create new Task Definition wizard as follows:

      1. In the Task Definition Name field, enter ha-node-2-task as the name of the task definition.

      2. In the Task Size section, enter values as follows:

        Field Value
        Task memory (GB) 0.5GB
        Task CPU (vCPU) 0.25vCPU
      3. In the Container Definitions section, click Add container. Then enter information as follows:

        1. In the Container name field, enter node-2-ha-container as the name of the container.

        2. In the Image field, enter the image URI.

        3. In the Port Mappings section, add the following ports.

        Port Protocol
        9893 tcp
        9090 tcp
        9711 tcp
        9611 tcp
        7711 tcp
        7611 tcp
        7443 tcp
        7070 tcp
        9443 tcp
        8006 tcp

        To add each port, click Add Port Mapping.

        1. Click Add.

        2. Click Create in the Configure task and container definitions page to create the task.

  5. Create a service for node 1 using the ha-node1-task task as follows:

    1. In Amazon ECS, click Clusters in the left navigator. Then click on your cluster.

      Create Task for Cluster

      This opens the Create Service wizard.

    2. In the Step 1: Configure service page, select/enter information as follows:

      Configure Service

      Field Value
      Launch Type FARGATE
      Task Definition ha-node-1-task
      Service Name ha-node1-service
      Number of tasks 1

      Then click Next step.

    3. In the Step 2: Configure network, select/enter information as follows:

      Configure Network

      1. In the Cluster VPC field, select the VPC that you previously created.

      2. In the Subnets field, select the subnet that you previously created for your VPC.

      3. Click Edit to select the security group.

        When you click Edit, the Configure security groups dialog box opens. Here, select the Select existing security group option and then select the security group that you previously created and connected to your VPC. Then click Save to save he information you entered in this dialog box.

        Select security groups

        Once you are back in the Step 2: Configure network page of the Create Service wizard, click Next step.

    4. Skip Step 3: Set Auto Scaling (optional) by clicking Next step in the page without making any changes. In Step 4: Review, check the information, and click Create Service.

      Once the service is successfully created, click View Service to view it. You can also access it by clicking Clusters in the left navigator, and then clicking si-ha-cluster -> Services tab -> ha-node1-service.

    5. To view the running service and node logs, follow substeps below:

      1. Click Clusters in the left navigator. Then click si-ha-cluster -> Services tab -> ha-node1-service to view the ha-node1-service service you created.

      2. Click on the Tasks tab. The task is displayed as shown below.

        View Task

      3. Click on the task to view it in a separate page. In that page, click on the View logs in CloudWatch. The following logs should be available to indicate that the node is started in the Active mode and it is persisting events.

            [2020-03-20 20:18:48,283]  INFO {org.wso2.carbon.streaming.integrator.core.ha.HAManager} - HA Deployment: Starting up as Active Node
            [2020-03-20 20:18:52,261]  INFO {org.wso2.carbon.kernel.internal.CarbonStartupHandler} - WSO2 Streaming Integrator started in 44.893 sec
            [2020-03-20 20:19:46,595]  INFO {org.wso2.carbon.streaming.integrator.core.persistence.PersistenceManager} - Siddhi apps persisted successfully
        
  6. Create a service for node 2 using the ha-node2-task task by following the same procedure you followed in the previous step (i.e., step 5) to create a service for node 1. However, make sure that the task definition is ha-node2-task. The service name can be ha-node2-service.

    Service for node 2

    When you view logs in CloudWatch for node 2, the following is displayed.

        [2020-03-20 20:38:14,390]  INFO {org.wso2.carbon.streaming.integrator.core.ha.HAManager} - HA Deployment: Starting up as Passive Node
        [2020-03-20 20:38:18,287]  INFO {org.wso2.carbon.kernel.internal.CarbonStartupHandler} - WSO2 Streaming Integrator started in 46.604 sec
    
  7. To check whether the cluster is working, check logs for node 1 as well as the error trace nodes.

    Logs similar to the following should be printed for node 1.

        [2020-03-20 20:38:15,409]  INFO {org.wso2.carbon.streaming.integrator.core.ha.HAEventListener} - memberAdded event received for node id : wso2-si-2
        [2020-03-20 20:38:15,455]  INFO {org.wso2.carbon.streaming.integrator.core.ha.HAEventListener} - Active node retrieved node details of passive node
    

Also, the following log should be printed without errors by the Error traces.

 [2020-03-20 20:38:46,587]  INFO {org.wso2.carbon.streaming.integrator.core.persistence.PersistenceManager} - Siddhi apps persisted successfully
Top