Skip to main content Skip to complementary content

Pairing a Remote Engine

Obtain the pairing key from Talend Management Console and apply it to your engine using either the web configuration interface or a configuration file.

This task covers initial pairing. If you have already paired an engine and need to re-establish the connection, see Troubleshooting: Re-pairing a Remote Engine.

If you installed the engine using the graphical installer and provided the pairing key during installation, pairing was already completed. You can skip this task and proceed to deploying tasks.

Before you begin

  • You have installed the Remote Engine.
  • You have created a Remote Engine logical entity in Talend Management Console by following Creating Remote Engines.
  • You have the Infrastructure Administrator role in Talend Management Console.

Procedure

Obtain the preauthorization key

  1. Retrieve the key (preauthorization key) from Talend Management Console Web UI or API.
    • Talend Management Console Web UI:
      1. Open Talend Management Console.
      2. Open the Processing page, then click the Engines tab.
      3. Select the environment of your engine from the Environment drop-down list.

        You can also use the search box and the filter options to filter the list.

      4. On the engine list, click the engine for which you need to pair.
      5. In the Engine details blade, click the Manage tab.
        Screenshot of Remote Engine key in Engine details window.
      6. Copy the key from the Remote Engine key field.
    • Talend Management Console API:

      You can create a Remote Engine entity and retrieve its preauthorization key programmatically. See Creating and pairing a Remote Engine programmatically.

Pair the engine

  1. Choose one of the following methods to pair your engine.
    • Using the web configuration interface:

      Use this method for interactive setup. The engine must be running to access the configuration interface.

      1. Launch the Talend Remote Engine console on your machine (trun).
      2. In a browser, open http://localhost:8043/configuration.
      3. Paste the preauthorization key in the key field.
      4. Click Pair Remote Engine.
      5. In the engine console, type list then press Enter.

        All bundles display as Active when pairing is successful.

    • Using the configuration file:

      Use this method for command-line-only environments. The engine must be stopped while you edit the file.

      1. If the engine is running, stop it by executing the stop file in the <RemoteEngineInstallationDirectory>/bin folder.
      2. Open <RemoteEngineInstallationDirectory>/etc/preauthorized.key.cfg.
      3. Set the following parameters:
        remote.engine.pre.authorized.key
        Paste the preauthorization key.
        remote.engine.name
        Enter the name of the Remote Engine.
        remote.engine.description
        Enter the description of the Remote Engine.
      4. Save the file.
      5. Launch the Talend Remote Engine console on your machine (trun).
      6. Type list then press Enter.

        All bundles display as Active when pairing is successful.

Results

Your Remote Engine is now paired. The status updates to Paired in Talend Management Console.

To run tasks with this engine, ensure you have the Operator (Execute) right on the space where the engine is located.

If you need to know the Java version used by the engine, click the Configuration tab in the Engine details blade. There you can see the version Talend Remote Engine is using for start and also the Java version it uses to run tasks and plans. Note that by default, Talend Remote Engine uses the Java it starts with to run tasks and plans.

Troubleshooting:
If you encounter the error message below in your engine's Karaf logs, it means that engine pairing has failed:
Error setting property: PropertyDescriptor <name: cleanInterval, getter: null, setter: [class org.talend.ipaas.rt.deployment.agent.impl.KarafDataMavenCleaner.setCleanInterval(long)]
This error is caused by trailing spaces at the end of the local.maven.clean.interval.days parameter line in the <RemoteEngineInstallationDirectory>/etc/org.talend.ipaas.rt.deployment.agent.cfg file.
  • The local.maven.clean.interval.days parameter controls automatic cleanup of unused artifacts in your engine. For further information about your Remote Engine's resilience settings, see Automatic artifact cleanup.

To resolve the issue, remove the trailing spaces from the local.maven.clean.interval.days parameter line.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!