Administration guide > Configure the deployment environment > Configuring catalog and container servers > Configuring WebSphere eXtreme Scale with WAS > Configuring the catalog service in WAS

Create catalog service domains in WAS

Catalog service domains define a group of catalog servers that manage the placement of shards and monitor the health of container servers in the data grid.

Before you begin

By creating a catalog service domain, you are defining a highly available collection of catalog servers.

These catalog servers can run in WAS within a single cell and core group. The catalog service domain can also define a remote group of servers that run in different Java™ SE processes or other WAS cells.

For catalog servers that run on existing application servers within the cell: When you define a catalog service domain that places catalog servers on the application servers within the cell, the core group mechanisms of WAS are used. The catalog service automatically starts on the application servers in the cell. As a result, the members of a single catalog service domain cannot span the boundaries of a core group, and a catalog service domain therefore cannot span cells. However, WebSphere eXtreme Scale container servers and clients can span cells by connecting to a catalog server across cell boundaries, such as a stand-alone catalog service domain or a catalog service domain embedded in another cell.

For remote catalog servers: You can connect WebSphere eXtreme Scale containers and clients to a catalog service domain that is running in another WAS cell or that are running as stand-alone processes. Because remotely configured catalog servers do not automatically start in the cell, manually start any remotely configured catalog servers. When you configure a remote catalog service domain, the domain name should match the domain name that you specified when you start the remote catalog servers. The default catalog service domain name for stand-alone catalog servers is DefaultDomain. Specify a catalog service domain name with the startOgServer command -domain parameter, a server properties file, or with the embedded server API. You must start each remote catalog server process in the remote domain with the same domain name. See Start a stand-alone catalog service for more information about starting catalog servers.

Attention: Do not collocate the catalog services with WebSphere eXtreme Scale container servers in a production environment. Include the catalog service in multiple node agent processes or in an application server that is not hosting a WebSphere eXtreme Scale application.


  1. Create the catalog service domain.

    1. In the WAS administrative console, click System administration > WebSphere eXtreme Scale > Catalog service domains > New.

    2. Define a name, default value, and JMX authentication credentials for the catalog service domain. If you are configuring remote endpoints for the catalog service domain, the name of the catalog service domain should match the name of the catalog service domain that you specify when you start the catalog servers.

    3. Add catalog server endpoints. You can either select existing application servers or add remote servers that are running a catalog service.

  2. Test the connection to the catalog servers within the catalog service domain. For existing application servers, catalog servers start when the associated application server is started. For remote application servers, start the servers manually using the startOgServer command or embedded server API.

    1. In the WAS administrative console, click System administration > WebSphere eXtreme Scale > Catalog service domains.

    2. Select the catalog service domain that to test and click Test connection. When you click this button, all of the defined catalog service domain end points are queried one by one, if any one end point is available, returns a message that indicates that the connection to the catalog service domain was successful.

Parent topic:

Configure the catalog service in WAS

Related concepts

Best practice: Clustering the catalog service

Catalog service

Related reference

Catalog service domain administrative tasks


Search Tips   |   Advanced Search