Show TOC

Deploying an Adapter to a ClusterLocate this document in the navigation structure

You can start, stop, and remove an adapter from a cluster using the SAP ESP Cockpit, SAP Event Stream Processor Studio, or the streamingclusteradmin command line utility.

Context

To manage an adapter using a cluster, add the adapter to the cluster using the streamingclusteradmin command line utility. You can only do this for adapters developed using the adapter toolkit (either preconfigured or custom), so ensure that you have a toolkit adapter ready to deploy. For a complete list of adapters developed using the adapter toolkit, see Preconfigured Adapters Included with the Adapter Toolkit in the SAP Event Stream Processor: Building Custom Adapters guide.

Procedure

  1. Add the adapter to the cluster by executing:
    streamingclusteradmin --uri=esp[s]://localhost:19011 --username=<username> --password=<password> --add_adapter --workspace-name=<workspace-name> --adapter-name=<adapter-name> --adapter-type=toolkit_adapter --arc=/config/adapter_config.xml
    Note If you omit the password parameter when you call the streamingclusteradmin tool, Event Stream Processor prompts you for the password and hides it as you type, which improves security.
  2. (Optional) Start the adapter by executing:
    streamingclusteradmin --uri=esp[s]://localhost:19011 --username=<username> --password=<password> --start_adapter --workspace-name=<workspace-name> --adapter-name=<adapter-name>

In this section:
    Application Deployment Parameters
    Application deployment parameters specify whether failover or affinity are enabled on the application being deployed to the cluster. Manually create an application deployment (XML) configuration file to set these options. Each application to be deployed to the cluster, such as an adapter, requires its own configuration file.
    Sample Application Deployment Configuration File
    Example content of an application deployment configuration file.
    Adapter Cold Failover
    An adapter fails when it does not run properly or stops running properly. If failover is enabled, the cluster restarts the adapter if it is killed or stopped abnormally.
    Adapter Affinity
    Adapters in cluster-managed mode support controller affinities, which lets you set which controller node the adapter can run on. Each adapter allows a single controller affinity.