Remotely Launch a Plugin

Follow this configuration to use a remote connector in Fusion 5.6+.

A known issue is after idling for five minutes without any new connector start requests, the remote connector stops responding to server requests and must restart. This causes connector start requests to hang. A workaround is to schedule a connector to run every three minutes. It is recommended to use a connector instance that doesn’t fetch any documents to keep the remote connector functional without frequent restarts.

Execute the following command.

java -jar connector-plugin-client-standalone.jar [YAML_CONFIG_FILE]

Check that the YAML_CONFIG_FILE has the following format.

kafka-bridge:
  target: mynamespace-connectors-backend.lucidworkstest.com:443 # mandatory
  plain-text: false # optional
  proxy-server: # optional - needed when a forward proxy server is used to provide outbound access to the standalone connector
    host: host
    port: 111
    user: user
    password: password
  trust: # optional - needed when the client's system doesn't trust the server's certificate
    cert-collection-filepath: path1

proxy: # mandatory fusion-proxy
  user: admin
  password: password123
  url: https://fusiontest.com/ # needed only when the connector plugin requires blob store access

plugin: # mandatory
  path: ./fs.zip
  type:
    suffix: remote

Use this table for descriptions of the YAML properties.

Key Value description

Key	Value description
`kafka-bridge.target`	The Kafka-gRPC bridge host:port pair.
`kafka-bridge.plain-text`	Enable when TLS ingress is not used.
`kafka-bridge.proxy-server.host`	The Forward Proxy Server Host.
`kafka-bridge.proxy-server.port`	The Forward Proxy Server Port.
`kafka-bridge.proxy-server.user`	The Forward Proxy Server User.
`kafka-bridge.proxy-server.password`	The Forward Proxy Server Password.
`kafka-bridge.trust.cert-collection-filepath`	The Private Key file path.
`proxy.url`	Fusion proxy url.
`proxy.user`	Fusion proxy user.
`proxy.password`	Fusion proxy password.
`plugin.path`	The path of the plugin zip file.
`plugin.type`	Optional suffix added to the plugin `id`. For example, if the plugin `id` is `lucidworks.test` and the suffix is `remote`, the plugin will be launched with `lucidworks.test.remote`.

kafka-bridge.target

The Kafka-gRPC bridge host:port pair.

kafka-bridge.plain-text

Enable when TLS ingress is not used.

kafka-bridge.proxy-server.host

The Forward Proxy Server Host.

kafka-bridge.proxy-server.port

The Forward Proxy Server Port.

kafka-bridge.proxy-server.user

The Forward Proxy Server User.

kafka-bridge.proxy-server.password

The Forward Proxy Server Password.

kafka-bridge.trust.cert-collection-filepath

The Private Key file path.

proxy.url

Fusion proxy url.

proxy.user

Fusion proxy user.

proxy.password

Fusion proxy password.

plugin.path

The path of the plugin zip file.

plugin.type

Optional suffix added to the plugin id. For example, if the plugin id is lucidworks.test and the suffix is remote, the plugin will be launched with lucidworks.test.remote.

Example YAML_CONFIG_FILE:

kafka-bridge:
  target: mynamespace-connectors.example.com:443
  plain-text: false

proxy:
  user: admin
  password: "password123"

plugin:
  path: ./testplugin.zip