Installing Connect-Plugins

Installing plugins

  1. Copy the connect-plugin JARs files to the path defined by the CONNECT_PLUGINS_DIR_PATH config, each in its own directory.
    If a plugin is composed of multiple jars (e.g. a JDBC Connector jar with JDBC Driver jars), put them together in the same directory
    Example layout:

    [CONNECT_PLUGINS_DIR_PATH]
├── http-sink
│   └── http-sink-connector-1.0.0-jar-with-dependencies.jar
├── jdbc
│   ├── jdbc-connector.jar
│   └── mariadb-jdbc.jar
├── s3-sink
│   ├── ST4-4.0.4.jar
│   ├── activation-1.1.jar
│   ├── ant-1.9.1.jar
.   .
.   .
.   .
│   ├── zkclient-0.10.jar
│   └── zookeeper-3.4.13.jar
├── snowflake
│   ├── snowflake-connector.jar
│   └── bouncy-castle.jar
└─ [NEW PLUGIN NAME]
    ├── new-plugin.jar
    └── helper.jar

  2. Restart Connect

    axual.sh restart client $tenant-$instance axual-connect
    Restart Connect services in a rolling fashion to avoid downtime. Connect will re-balance the tasks on the remaining nodes when one goes down.

To share Java resources / configuration / certificates between connect-plugins, place the files in the directories configured as:

  • CONNECT_COMMON_CLASSES_PATH

  • CONNECT_CONFIG_DIR_PATH

  • CONNECT_CLIENT_CERTS_PATH

You need to restart Connect for these resources to become available.

Make the new Connect-Plugins available in the Self-Service portal

After Axual Connect has been restarted, confirm that the plugins are available by checking the /connector-plugins endpoint of any Connect-Node’s API.

Although the plugins are available in the Connect-Cluster, they may not yet available on the Self-Service portal.
You have two options to make the new Connect-Plugins available:

  1. Wait until the reconciliation.connect.plugin job has executed

    1. You can check how often the reconciliation connect plugin job runs by checking selfservice-api’s SCHEDULER_RECONCILIATION_CONNECT_PLUGINS_CRON config value.

    2. You can change the frequency by configuring the SCHEDULER_RECONCILIATION_CONNECT_PLUGINS_CRON value. see Configuring Connect Reconciliation Jobs

  2. Manually trigger a refresh of Connector Plugin by editing the Instance associated the Axual Connect in the Self-Service Portal

    1. Log in the Self-Service Portal as a TENANT_ADMIN

    2. Go to Instances page

    3. Select the Instance associated with the Axual Connect instance you updated the plugins for

    4. Press the edit button

    5. Save the Instance as-is, without changing anything. This will trigger the reconciliation plugin job to run immediately

When upgrading connect-plugin versions, existing connectors may start failing due to missing mandatory configurations.
We advise you to collect a list of Connect-Applications using a certain Connect-Plugin before performing any maintenance on it.
Make sure that the Connect-Application owners are aware of the implications of your maintenance operation.