Pipeline wizard

Agent

Choose the agent that runs a new pipeline, approve a pending agent, or add one without leaving the wizard.

The agent runs the pipeline: it tests your connections, discovers tables, loads the initial data, captures changes and applies them. You choose it on the Source step, under the capture mode. The control plane never connects to your databases itself.

This page covers the Runs on control. To install an agent, see Agents.

Choose an agent

The Runs on control lists the agents that are online and can capture the source engine.

  • One eligible agent: the wizard selects it and shows Runs on <name> (<host>), the only online agent.
  • Several eligible agents: choose one from Agent that runs this pipeline. Each entry shows the agent's name, host and status.

A pipeline needs an agent when you choose:

  • DirectLog on SQL Server, Oracle or Sybase;
  • Reconstruction on Sybase;
  • any SQL Server mode except Native CDC.

For every other mode you can select No agent (manual entry) and create the pipeline unassigned. An unassigned pipeline has no connection test and no table discovery, so you type the tables by hand, and it doesn't run until you assign an agent from Actions > Assign agent… on its page.

When no agent is available

If no agent is online and eligible, an amber card appears:

  • No online agent, when no agent is online.
  • No online agent can capture <engine>, when agents are online but none can capture this source. The card names them: Online but without this capability: <names>.

To add an agent without leaving the wizard:

  1. Select Add agent.
  2. In the Add agent dialog, follow the install steps from Agents. Your draft is kept.
  3. Approve the new agent (see below). Select Refresh now if it doesn't appear, then Done.

Approve a pending agent

A newly installed agent is Pending and runs nothing until you approve it. When a pending agent exists, the step shows Agent approval required.

Check that the agent's name and host match the machine you installed on, then select Approve. The step confirms with Approved <name>. If the row says Cannot capture <engine>; approval will not add that capability., that agent can't run this source.

If the agent goes offline

If the agent you chose goes offline or is removed, an amber bar appears on every step:

  • This pipeline's agent '<name>' is <status>. It tests connections and runs the pipeline, so nothing will start until it reconnects.
  • Agent '<id>' is no longer registered with the control plane. Go back and choose another agent.
  • <name> cannot capture <engine>. Choose an eligible agent on Source.

While a required agent is offline, Next is disabled on the Source and Target steps, and Create and start isn't offered. See Review and create.

One agent or two

By default the agent you choose here captures changes and also applies them to the target. On the Target step you can name a different agent, close to the target, to apply over a relay. See Relay.

See also

Previous
Source
Next
Broker

If this was useful,
our newsletter will be too.

Get monthly insights on data engineering, AI, and building critical infrastructure - direct from the Spectral Core team and CEO Damir Bulic.