Adding a Service Registry

Edit online

You must have the Manage service registries functional privilege assigned to perform this task.

You have to add and configure a service registry in webMethods API Gateway before you reference it in an API. In cluster deployments of webMethods API Gateway, you can add a service registry on any webMethods API Gateway instance—other webMethods API Gateway instances are synchronized automatically.

To add and configure a service registry

  1. Expand the menu options icon menu_options, in the title bar, and select Administration.
  2. Select External accounts > Service Registry.
  3. Click Add service registry.
    Field Description
    Name Name used by webMethods API Gateway for the instance of service registry that you are adding.
    Description Description of the instance of service registry.
    Type Type of service registry. Available values are: SERVICE_CONSUL and EUREKA.
    Endpoint configuration
    Endpoint URI The base URI for the service registry. This should include the IP address or the FQDN and the port on which the service registry accepts requests.
    Service discovery path The relative path of the service registry discovery service. webMethods API Gateway appends this path (and the service ID) to the Endpoint URI to generate a service discovery request for the service registry.
    Note: A service registry discovery service returns the address (IP address or FQDN) of an application instance for the requested service ID.
    Service registration path The relative path of the service registry registration service. webMethods API Gateway appends this path (and the service ID) to the Endpoint URI to generate a service registration request for the service registry.
    Note: webMethods API Gateway uses this service to register (publish) a service with the service registry.
    Service de-registration path The relative path of the service registry de-registration service. webMethods API Gateway appends this path (and the service ID) to the Endpoint URI to generate a service de-registration request for the service registry.
    Note: webMethods API Gateway uses this service to de-register (unpublish) a service with the service registry.
    Connection timeout (seconds) Specifies the time (in seconds) after which a connection attempt times out while communicating with the service registry.

    The precedence of the Connection Timeout configuration is as follows:

    1. If you specify a value for the Connection timeout field in routing endpoint alias, then the Connection timeout value specified in the Endpoint alias section takes precedence over the timeout values defined at the API level and the global level.
    2. If you specify a value 0 for the Connection timeout field in routing endpoint alias, then webMethods API Gateway uses the value specified in the Connection timeout field in the routing protocol processing step of an API. The Read Timeout value specified at an API level takes precedence over the global configuration.
    3. If you specify a value 0 or do not specify a value for the Connection timeout field in the routing protocol processing step at the API level or specify a value 0 at an alias level, then webMethods API Gateway uses the value specified in this pg.endpoint.connectionTimeout property.
    4. If you do not specify any value for pg.endpoint.connectionTimeout, then webMethods API Gateway uses the default value of 30 seconds.
    Read timeout (seconds) Specifies the time (in seconds) after which a socket read attempt times out while communicating with the service registry.

    The precedence of the Read Timeout configuration is as follows:

    1. If you specify a value for the Read timeout field in routing endpoint alias, then the Read timeout value specified in the Endpoint alias section takes precedence over the timeout values defined at the API level and the global level.
    2. If you specify a value 0 for the Read timeout field in routing endpoint alias, then webMethods API Gateway uses the value specified in the Read Timeout field in the routing protocol processing step of an API. The Read Timeout value specified at an API level takes precedence over the global configuration.
    3. If you specify a value 0 or do not specify a value for the Read timeout field in the routing protocol processing step at the API level or specify a value 0 at an alias level, then webMethods API Gateway uses the value specified in this pg.endpoint.readTimeout property.
    4. If you do not specify any value for pg.endpoint.readTimeout, then webMethods API Gateway uses the default value of 30 seconds.
    SSL configuration
    Keystore alias List of keystores that are configured in webMethods API Gateway. This is used when the service registry is SSL enabled.

    Lists all available keystores. If you have not configured an Integration Server keystore the list is empty.

    Key alias Lists all the private keys that are present in the selected keystore alias. This is used when the service registry is SSL enabled.
    Truststore alias A truststore contains the certificates that are trusted by webMethods API Gateway. If the service registry is SSL enabled its certificate should be added to the selected truststore.
    Basic authentication details
    Username

    The basic authentication username.

    Password

    The basic authentication password.

    Other configuration
    Heartbeat interval (This setting is applicable only to Eureka service registries.) The interval at which the webMethods API Gateway sends a heartbeat message to the Eureka server to renew its leases. Eureka expects clients, such as webMethods API Gateway, to renew the lease by sending heartbeats as per the heartbeat interval configured in the Eureka server.
    Note: If the Eureka heartbeat interval is set to 0 and, as a result, some of the published APIs are removed from Eureka. Hence, if you modify any heartbeat value, you must republish the APIs for the changes to reflect in the Eureka server.
    Headers
    Key

    An HTTP header key that is included in all the HTTP requests sent to the service registry.

    Value

    A value for the given HTTP header key.

  4. Click Add.
The service registry is added to webMethods API Gateway.