Page Comparison

Note

• When the application is able to identify the Load Balancer details, the inputs will be auto-populated and non-editable. However, if the application is unable to identify Load Balancer details, you must add the details manually, which is a one-time activity.

• For the GCP MPMarketplace, even if LB a Load Balancer was not created during deployment, however, if Load Balancer is already configured manually then Kyvos Manager will prompt for Load Balancer details so that rest automation can continueif one has already been configured manually, to facilitate further automation.

1. Open the AWS console.

2. Locate the target group associated with the load balancer used with the cluster. This can be done in two ways, depending on the scenario.

   1. Case 1: When the stack is used for deployment, and the Load Balancer is created as a part of it, In this case, perform the following steps.

      1. Navigate to CloudFormation > Stacks > <STACK-NAME>

      2. Click the Resources tab.

      3. Search for target group with the name starting with KyvosTG-<STACK-NAME> or KyvosWebServer-<STACK-NAME> and then click it.

      4. In the Resources section, do the following:

         1. Click the link in the Physical ID column. It will open a new tab.

         2. Click the link in the Name column.

            

   2. Case 2 : Go to EC2 > Target groups.
      On the Target groups page, perform the following steps.

      1. Locate your target group by name and click the target group.

      2. This will open the Target Group details page.

      3. On the page, verify it by checking the value displays for Load balancer.

         

3. Click the Health checks tab in the Target group details section.

4. Click Edit.

5. Under Health check path, change the health check path to /kyvos/

6. Click Save changes. The Health check changes are saved now.

7. Click on the Targets tab in the Target group details section.

   

8. Click Register targets.

9. Select the newly added Kyvos Manager instance ID from Instance ID column under Available instances.

10. Enter the required port under Ports for the selected instances.

11. Click Include as pending below. It will show the added instance under the Review targets section.

12. Click Register pending targets. It will register the pending targets to the Target group.

1. Open Azure console.

2. Go to Deployment in the Settings section.

3. Click the deployment.

4. Expand the Deployment details section.

5. Search for Application gateway.

   

6. Click Application gateway resource link.

7. Select Backend pools display in the left pane under Settings.

8. Click WebPortalLoadBalancerBackEndPool.

9. Under Backend targets Select Target type as Virtual Machine and Select newly added Kyvos Manager Virtual machine in Target.

10. Click Save. The virtual Machine is added to the backend pool targets.

11. Go to Health probe in the Settings section.

12. Click WebPortalLoadBalancerHealthProbe.

13. Change the path to /kyvos/.

14. Click Test

15. After successful test, click Save.

    

1. Open AWS console.

2. Locate the target group associated with the load balancer used. This can be done in two ways, depending on the scenario.

   1. Case1: When stack is used for deployment and Load Balancer is created as a part of it.

      1. Navigate to CloudFormation > Stacks > <STACK-NAME>

      2. Click on the Resources tab.

      3. Search for KyvosManagerAlbTargetGroup.

      4. Click the link in the Physical ID column.

      5. Click the link in Name column.

   2. Case2 : Go to EC2 > Target groups.

      1. Locate your target group by name and verify it by checking the value displays for Load balancer in the Target group details page.

      2. Click the Targets tab in Target group details section.

      3. Select the instance ID to be deregistered under the Registered targets list.

         

      4. Click Deregister.

1. Open Azure console.

2. Go to deployment.

3. Go to the deployment details.

4. Search for the type Application gateway.

5. Click Application gateway in the resource link.

6. Go to Backend pools display in the left menu under Settings.

7. Click KyvosManagerLoadBalancerBackEndPool.

8. Under Backend targets, click the Delete button against the Kyvos Manager virtual machine to be removed.

9. Click Save.

1. Go the Instance Group used in Load Balancer.

2. Edit the Instance Group.

3. Using the minus icon in the VM Instances list, you can remove the VMs that you no longer require for this backend service.
   

   Image RemovedImage Added

4. Click Save.

1. Open the AWS console.

2. In the search bar, type Target groups. A list is displayed. Click Target groups.

3. On the Target groups page, click Create target group.

4. On the Specify group details page, complete the following:

5. Click Next. The Register Targets page is displayed.

   

6. Select the instance from the list that is used for running Kyvos Reporting Service.

7. Enter the port 8080 for the selected instance that is used for running Kyvos Reporting Service.

8. Click Include as pending below. It will show the added instance under the Review targets section.

   

9. Click Create Target Group. The target group is created. After creating Target group, you need to configure Load Balancer for Listener.

   

10. Navigate EC2 > Load Balancer and then search for the Load Balancer that is being used for Kyvos Web Portal.

    

11. Click the Listeners and rules tab.

12. If using an existing protocol:port that is listener, select the Add Rule option.

    Anchor
    step13 step13

    

    1. From the Manage rules list, select Add Rule.
       While adding a rule on the Add Rule wizard, the following fields are mandatory.

    2. Select Protocol: Port checkbox. In the Port field, enter 80.

    3. Enter a unique name for the rule, and then click Next. For example, KyvosReportingRule.

       

    4. On the Details rule conditions section, click Add Condition, and then click Next. Select the Rule condition type as Path from the list and click Confirm.

       

    5. On the Add condition section, add the Path section as /kyvosreporting and /kyvosreporting/* with ‘or’ condition. Click Confirm.

       

    6. Verify the path and click Next.

    7. In the Action types section, select the Forward to target groups option.

       

    8. Select the target group that is used for configuring Kyvos Reporting from the list, and then click Next.
       Note: Keep the remaining settings unchanged.

    9. Enter Priority as 3.
       NOTE: For AWS Marketplace, it should be 3 and for AWS Managed Service, the Priority must be set as 2.

       

    10. Click Next. Confirm the Rule details and click Create. The rule is created.
        You can also delete the rule that you have created.

13. If you want to use a new protocol:port that is a listener, select Add listener. The Add Listener page is displayed.

    Anchor
    step14 step14

    
    NOTE: Ensure that the new LB port must be reachable. The target machine must be up and running.

    1. In the Listener Configuration section, enter the required Protocol and Port.

    2. In the Routing actions section, select Forward to target groups.

    3. Select the Target group from the list that you wan to use for forwarding to request to Kyvos Reporting Service.

    4. Click Add. The listener is added to the Load balancer.

1. Open Azure console.

2. In the Search bar, enter Managed application center.

3. Go to Marketplace application.

4. Select your Kyvos application.

5. Click Managed resource group and then search for application gateway.

   

6. In the Settings section of the left pane, click Backend Pool. On the Backend Pools page, click Add.

7. On the Add backend Pool dialog box,

   1. Enter a name for the backend pool. For Example, KyvosReportingbackendpool

   2. Select No to add backend pool without targets.

   3. Select the Virtual Machine option from Target Type list, and then select the Kyvos Reporting Service node from Target list that you have already added.

   4. Click Save. The backend pool is added.

      

8. After adding backend pool, click Listener in the Settings section display in the left pane of the page. The Listeners page is displayed. Click Add.

9. On the Listeners page, add Listener’s details such as,

   1. Enter name of the listener.

   2. Select Protocol as HTTP and Port as 8080.

   3. Select Listener type as Basic.

   4. Click Add. The Listener is added.

      

10. After adding a listener, you need to add Backend Settings display in the Settings section.

11. Click Backend settings, the Backend settings dialog is displayed.

12. On the Backend Settings dialog box, complete the fields as shown in the following page.

    

    NOTE: First you need to select the No display in the Use a custom probe section and save without it. You must update it after creating the Health probe.
    The Backend settings are now saved.

13. After saving the Backend settings, select the Frontend IP configurations from the Settings section display in the left pane.

14. On the Frontend IP configurations page, ensure that the frontend IP address has Public IP configured. This IP will be used for Kyvos Reporting URL.

    

15. After verifying Frontend IP configurations, click a Rule display in the Settings section. On the Rules page, click Add.

    

16. On the Rules page, complete the fields as shown in the following image.

    1. Enter a rule name.

    2. Enter Priority as 4.

    3. Click the Backend Targets tab, and then select the backend target and backend settings you have created.

    4. Click Save. The rule is created.

17. After creating a rule, click Health probes from the Settings section display in the left pane. On the Health Probes page, click Add.

    

18. On the Health probe dialog, complete the following fields.

    1. Enter a name for the health probe.

    2. Select protocol.

    3. Select the No option to pick host name from backend settings.

    4. Enter the Host name.

    5. Enter the Kyvos Reporting path as /kyvosreporting/

    6. Enter Interval (seconds), Timeout (seconds), Unhealthy threshold.

    7. Select the Yes option to use probe matching conditions.

    8. Enter the HTTP response status code match.

    9. Select backend settings from the list that you have created.

    10. Click Test to verify the backend health before adding the health probe.

    11. Click Test. After successful test, click Save.

1. If Load Balancer is not configured, first you You must configure the Load Balancer.
   To do this, refer to the Configuring External Load Balancer for GCP section.

2. Open GCP Console.

3. In the Search bar, enter Instance Groups. A list of Instance groups is displayed.

4. Create a new Instance Group.
   For Creating a Instance Group, See the Creating Instance Group section in the Configuring External Load Balancer for GCP page.

5. From the Select VMs Load Balancer as a prerequisite.

6. Go the Instance Group used in Load Balancer.

7. Edit the Instance Group.

8. From the VM Instances list, select the VMs on which you want to use this backend service and click Ok.

9. Click Save.

   Image Removed

10. .

11. In the Port Mapping area, click Add Port.

    • Port name as kyvosreporting-https and Port number as 8080.

    • Port name as kyvosreporting-http and Port number as 8080.

      Image Added

12. Click Save.

13. In the Search bar, enter Load Balancer. A list is displayed. Select the required load balancer.

14. In the Backends section, click the Health check link.

15. On the Health Checks pageCheck section, change the path to /kyvosreporting/.

    Image Added

16. Click Save.

Step:1 Removing a rule

1. Open AWS console.

2. Go to EC2 > Load balancers, and then navigate to the Load balancer you have created. The Load balancer page is displayed.

3. Navigate to the Listening and rules section, and then select the rule from the list that you want to delete.

4. From the Actions list, select Delete rule. On the confirmation message, click Delete. The rule is deleted.
   

   

Step:2 Removing Target group

1. Navigate EC2 > Load Balancer and then search for the Load Balancer that is being used for Kyvos Reporting Service.

2. Click the Listeners and rules tab.

3. If you use the existing listener, you must delete the rule associated with that listener that is forwarding request to the Kyvos Reporting Target group. If you are using a listener that is having a single rule, then the listener is itself deleted.

4. Go to EC2 > Target groups.

5. Search your target group that is being used for Kyvos Reporting.

6. Select the target group and then click Delete from the Actions list.

Step:3 Removing the listener

If you have added a new listener, in this case, you must remove the listener.

1. Open Azure console.

2. Go to Kyvos Application.

3. Click Managed resource group.

4. In overview tab, search for application gateway

5. Delete a rule that you have created.

6. Delete a backend pool that you have created.

7. Delete backend settings that you have created.

8. Delete listener that you have created.  

9. Delete health probe that you have created.

1. Open GCP Console.

2. In the Search bar, enter Instance Groups. A list of Instance groups is displayed.

3. Select the Instance Group which is used in backend Service of Load Balancer.

4. Edit the Instance Group.

5. Using the minus icon in the VM Instances list, you can remove the VMs that you no longer require for this backend service.

   Image RemovedImage Added

6. Click Save.