Configuring the Management service

IBM® API Connect automatically detects the host name, user name, and password combination to use to log on to the first Management server.

Before you begin

You must complete the following task:

Ensure that the Management server is running and available on your network.

About this task

Your initial Management server is automatically added to your cloud, so that you can manage the overall operations of the various servers in the API Connect cloud.

The Management service consists of the first Management server that you defined during the API Connect installation.

Within the API Connect cloud, Management servers store all of the cloud configuration and control communication between the other servers.

One Management server is automatically defined in the cloud console when you install API Connect. If required, you can add further Management servers to your cloud.

In the Cloud Manager, each server is added as a member of a service.

If you plan to use more than one Management server in your on-premises cloud, you must complete the following steps:

Procedure

  1. Set up an external load balancer with only one Management server in the load balancer group.
    You use an external load balancer to provide load balancing for the user interfaces.
  2. Enter the load balancer FQDN in to the Management service configuration (see Defining the Management service).
  3. Add the second Management server to the Management service by using the API Connect cloud console (see Adding more Management servers).
  4. Add the second Management server to the load balancer.
  5. Repeat the previous steps for all other Management servers that you want to add to your on-premises cloud.

Defining the Management service

Procedure

The Management service is a cluster of one or more of the Management servers. To configure your Management service, complete the following steps:

  1. In the Cloud Manager, click Services.
  2. In the Management Services pane, click the Service Settings icon The Service Settings icon.
  3. If you are using only one Management server in your Management service, check that the Address field contains the FQDN (fully qualified domain name) of the server, for example, mgmt01.acme.com. If you plan to add additional servers, change the value of this field to the FQDN of the external load balancer.

  4. Optional: Define an internal load balancer by completing the following steps:
    1. Select Use a different hostname for internal communication..
    2. Enter the load balancer FQDN in the Hostname for internal communication field, and click Save Service.
      For more information on using an internal load balancer, see Using a load balancer to optimize internal communications.
  5. Optional: To change the name of the Management service, enter a new value in the Display Name field.
  6. When you are finished, click Save Service.

Results

The Management service cloud settings are configured.

What to do next

Complete the following task: