Contents

Popular
 Contents

What is a Server Group and Why is it needed ?

Server Groups play a central role in API deployment as they provide

  • a way to define a cluster of gateway servers to deploy the projects. 
  • a mechanism to manage the API lifecycle.
  • possibility to have different levels of access to different types of clients.  

Many a times you would want to scale the API project to multiple proxies for ease of request handling and load balancing. For such activities, you may want to deploy the same API Project at multiple Gateways (Proxies) for ease of use. This is where a Server Group come into the picture; as a project is deployed on various environments, just adding the gateways to a server group will help you achieve the same.

How to Manage Server Groups ?

This view allows you to add/edit/remove Servers to the API Manager. 


Figure 1: Admin section with the Server Groups page displayed

To add a Server Group, click the button, and type the name of the new server group you want to add. Select the newly added server group name to get the Servers section on the right side of the Server Group section. 

Icon

Refer Creating a Server Group for Project Deployments section for a step by step instruction to add a Server Group.


Figure 2: Server Groups page with the Servers section that appears after clicking Add  button

Click the Editicon to add servers to the environment. This displays the following table that shows the available gateway servers, one or more of which can be added to/removed from the environment by using the and buttons:


Figure 3: Server Groups page with Available Servers section that appears after clicking Edit button

Click the Save button to save the changes made to the Server Groups.

Icon
  • For the changes to be saved successfully, every sever group must have at least one server added to it.
  • When a server is added to a group, the projects deployed on the particular group/environment will be automatically deployed on the server.
  • The server that is being used by an existing server group can be moved to Available Servers section and then used for the new server group by moving it to the Servers section. 
    • Use the left and right arrow buttons effectively to move the servers.

Click the Cancel button to revert the changes made in the Server Groups view.

To remove a server group, select the particular group name and click the Remove  button.

Adaptavist ThemeBuilder EngineAtlassian Confluence