How to Discover Docker Swarm Topology by RESTful API

This task describes how to discover Docker Swarm components using HTTP Protocol. This discovery process enables you to discover information about Docker Swarm Cluster and the topology of Docker managed by this cluster.

This task contains the following steps:

1. Prerequisites – Set up protocol credentials

   Docker Swarm discovery uses the HTTP Protocol.

   1. Create a new HTTP protocol.

      In the HTTP Protocol Parameters dialog box, select https in the Protocol field.

   2. Right-click the protocol that you just created and select Edit using previous interface.

   3. Configure the Key Store Path, Key Store Password (if needed), and Key Password (if needed).

      • Key Store Path. Specify the full path of the Key Store file.
      • Key Store Password. Specify the password for the Key Store.
      • Key Password. Specify the password for the Key.

      For details, see How to Generate the Key Store File.

      Note: If you do not need the TLS verification in Docker Swarm, skip this step.

   For credential information, see Supported Protocols.

2. Configure the URI endpoint – Edit UriEndpointConfiguration.xml

   1. Go to Data Flow Management > Adapter Management > Resources pane.
   2. Click the Find resource button, enter UriEndpointConfiguration.xml in the Name field, and then click the Find Next button.

   3. In UriEndpointConfiguration.xml, set the proper Data Flow Probe name on which the trigger UriEndpoint runs and set the url and type as follows:

      <dataflowprobe name="<Data Flow Probe name>">
        <uri-endpoint>
          <url>https://<IP address>:<port>/</url>
          <type>docker swarm</type>
        </uri-endpoint>
      </dataflowprobe>

3. Run the discovery

   Run the following jobs in the following order:

   1. Manual UriEndpoint Discovery to discover Docker Swarm UriEndpoint.

   2. Docker Swarm Discovery by RESTful API to discover Docker Swarm Topology.

   For details on running jobs, refer to "Module/Job-Based Discovery" in the Universal CMDB Data Flow Management section of the UCMDB Online Help.