Connecting Talend Remote Engine to Talend Runtime - Cloud

Talend Remote Engine User Guide for Linux

Version
Cloud
Language
English
Operating system
Linux
Product
Talend Cloud
Module
Talend Remote Engine
Content
Design and Development
Installation and Upgrade
Last publication date
2024-02-23

Configure Talend Remote Engine to securely connect to Talend Runtime using Talend Runtime access username and password.

By default, as Talend Remote Engine and Talend Runtime are installed on the same machine, they can automatically discover each other. To establish a secure connection between them, it is mandatory to specify how Talend Remote Engine can access the Talend Runtime credentials.

For this purpose, use the properties talendruntime.jmx.username and talendruntime.jmx.password, both located in the file: <RemoteEngineInstallationDirectory>/etc/org.talend.ipaas.rt.dsrunner.talendruntime.client.cfg.

The following procedure describes a simplified way to specify the credentials for a quick start. To create a security-strengthened access, see (Optional) Encrypting credentials for Talend Runtime access.

Before you begin

  • The Talend Runtime access username and password to be used by Talend Remote Engine must have been defined in <runtime_installation>/container/etc/user.properties on the Talend Runtime side.

Procedure

  1. Configure Talend Remote Engine to use the credentials.
    To do this, follow one of the three options below:
    • Option 1 - OS environment variables. This is also the recommended approach.

      Add the RUNTIME_JMX_USERNAME and the RUNTIME_JMX_PASSWORD variables to your OS environment variables.

      The value of RUNTIME_JMX_USERNAME is the Talend Runtime username; the value of RUNTIME_JMX_PASSWORD is the Talend Runtime password.

      Ensure not to modify the default expressions used by the talendruntime.jmx.username and the talendruntime.jmx.password properties in org.talend.ipaas.rt.dsrunner.talendruntime.client.cfg. This ensures that the environment variables are correctly used by these two properties.

      While technically not required to be added to the OS level, it is still recommended to include these variables in your OS environment for enhanced security and easy access by Talend Remote Engine when installed as system service.

    • Option 2 - Java system properties.

      Set the RUNTIME_JMX_USERNAME and RUNTIME_JMX_PASSWORD Java system properties.

      Ensure not to modify the default expressions used by the talendruntime.jmx.username and the talendruntime.jmx.password properties in org.talend.ipaas.rt.dsrunner.talendruntime.client.cfg. This ensures that the Java system properties are correctly used by talendruntime.jmx.username and talendruntime.jmx.password.
    • Option 3 - direct configuration.
      In <RemoteEngineInstallationDirectory>/etc/org.talend.ipaas.rt.dsrunner.talendruntime.client.cfg, directly replace the default expressions of talendruntime.jmx.username and talendruntime.jmx.password with the actual values you need to use. For example
      talendruntime.jmx.username=<runtime_username>
      talendruntime.jmx.password=<runtime_password>
    Tip: The mechanism behind the three options operates as follows:
    The properties in this file <RemoteEngineInstallationDirectory>/etc/org.talend.ipaas.rt.dsrunner.talendruntime.client.cfg default to resolving as references to environment variables. If the corresponding environment variables are absent, they resort to Java system properties. Consider the syntax example: talendruntime.jmx.username=${env:RUNTIME_JMX_USERNAME:-${RUNTIME_JMX_USERNAME}}. It means:
    1. The property talendruntime.jmx.username uses the value of the RUNTIME_JMX_USERNAME environment variable if available.
    2. In the absence of the environment variable, it uses the Java system property of the same name if available.

    This mechanism clarifies why it is crucial not to change the default expression in the syntax above when you declare the credentials as environment variables or Java system properties.

  2. If you do not need to encrypt your password, restart Talend Remote Engine and Talend Runtime. Otherwise, see (Optional) Encrypting credentials for Talend Runtime access before proceeding to the restart.
    To restart your engine, it is recommended to follow this procedure to gracefully shut down Talend Remote Engine.