Plugin synchronization

Overview

The plugin synchronization process in Jackadi follows this workflow:

1. Plugins are placed in the manager’s plugin directory.
2. The manager maintains a configuration defining which agents should receive which plugins.
3. Agents request their plugin list from the manager.
4. The manager responds based on the agent’s identity and configured patterns.
5. Agents download, install, and load the required plugins.

Manager Configuration

Plugin directory

The manager looks for plugins in its configured plugin directory:

manager --plugin-dir=/path/to/plugins

All plugins binaries in this directory are available for distribution to agents.

Plugin configuration

The manager uses a YAML configuration file located at <config-dir>/plugins.yaml to determine which plugins to sync to which agents:

"*":
  - worker-tools
"db-*":
  - database-tools

The configuration uses agent name patterns (with glob syntax) as keys and lists of plugin names as values.

Agent plugin sync

Automatic sync

Manual sync

To manually trigger plugin synchronization on an agent:

jack run agent1 plugins:sync

This sync is using by default an exclusive lock.

Troubleshooting

If a plugin isn’t being loaded by an agent:

1. Check if the agent matches any patterns in the plugins.yaml file.
2. Verify the plugin binary exists in the manager’s plugin directory.
3. Check the agent logs for download or loading errors.
4. Execute the plugin binary manually with --describe and check for any errors.
5. Manually trigger a sync: jack run agent1 plugins:sync.