Register Transformer
To register Transformer with Control Hub, you generate an authentication token and modify the Transformer configuration files.
- Tarball installation
- You can register Transformer from the Transformer UI, from the command line interface, or from Control Hub.
- RPM installation
- You must register Transformer from Control Hub.
A registered Transformer communicates with Control Hub at regular intervals. If Transformer cannot connect to Control Hub, due to a network or system outage, then Transformer uses the Control Hub disconnected mode.
Before you register Transformer, ensure that you have enabled HTTPS for Transformer.
Registering from Transformer
For a Transformer tarball installation, you can register Transformer with Control Hub using the Transformer UI.
When you register from the Transformer UI, Transformer generates the authentication token and modifies the configuration files for you. You can also create Control Hub user accounts and groups during the registration process.
- Log in to Transformer using the following default credentials: admin/admin.
- Click .
-
Enter the following information in the Enable StreamSets Control
Hub window:
Property Description Control Hub Base URL URL to access Control Hub: - For Control Hub cloud, set to
https://cloud.streamsets.com
. - For Control Hub on-premises, set to the Control Hub
URL provided by your system administrator. For
example,
https://<hostname>:18631
.
Control Hub User ID Enter your Control Hub user ID using the following format: <ID>@<organization ID>
Control Hub User Password Enter the password for your Control Hub user account. Labels for this Transformer Assign a label to this Transformer. Labels that you assign here are defined in the Control Hub configuration file, $TRANSFORMER_CONF/dpm.properties
. To remove these labels after you register the Transformer, you must modify the configuration file.Default is
all
, which you can use to run a job on any of the registered Transformers. - For Control Hub cloud, set to
- Click Enable Control Hub.
-
Optionally, you can choose to create a Control Hub user account and group for
each Transformer user account and group.
The Create Control Hub Groups and Users window maps all existing Transformer user accounts and groups to Control Hub user accounts and groups. You can remove users or groups and can edit the IDs, names, and email addresses as needed.
When you have finished reviewing the users and groups to create, click Create. Each new user is assigned a default set of Control Hub roles. Groups are not assigned any roles. After you log in to Control Hub, change those role assignments as needed to secure the integrity of your organization and data.
- Restart Transformer.
Registering from the Command Line Interface
For a Transformer tarball installation, you can register Transformer with Control Hub using the command line interface.
When you register Transformer from the command line interface, Transformer generates the authentication token and modifies the configuration files for you. Transformer must be running before you can use the command line interface.
Start Transformer, and then use the system enableDPM command to register the Transformer.
Use the command from the $TRANSFORMER_DIST
directory as follows:
bin/streamsets cli \
(-U <sdcURL> | --url <sdcURL>) \
[(-D <dpmURL> | --dpmURL <dpmURL>)] \
[(-a <sdcAuthType> | --auth-type <sdcAuthType>)] \
[(-u <sdcUser> | --user <sdcUser>)] \
[(-p <sdcPassword> | --password <sdcPassword>)] \
system enableDPM \
(--dpmUrl <dpmBaseURL>) \
(--dpmUser <dpmUserID>) \
(--dpmPassword <dpmUserPassword>) \
[(--labels <labels>)]
When using the system enableDPM command, the following basic options are required:
Basic Option | Description |
---|---|
-U <sdcURL> or --url <sdcURL> |
Required. URL of the Transformer. The default URL is
|
-D <dpmURL> or --dpmURL <dpmURL> |
Required. URL to access Control Hub:
|
The following table describes the enableDPM options:
Enable DPM Option | Description |
---|---|
--dpmUrl <dpmBaseURL> | URL to access Control Hub:
|
--dpmUser <dpmUserID> | Required. Enter your Control Hub user ID using the following
format:
|
--dpmPassword <dpmUserPassword> | Required. Enter the password for your Control Hub user account. |
--labels <labels> | Required. Assign a label to this Transformer. You can enter multiple labels separated by commas. Labels that
you assign here are defined in the Control Hub configuration file,
$TRANSFORMER_CONF/dpm.properties . To remove
these labels after you register the Transformer, you must modify the configuration file. |
bin/streamsets cli -U http://localhost:19630 -D https://cloud.streamsets.com system enableDPM --dpmUrl https://cloud.streamsets.com --dpmUser alison@MyOrg --dpmPassword MyPassword --labels Finance,Accounting,Development
Restart Transformer to apply the changes.
Using a Publicly Accessible URL
If you register Transformer when it is installed on a cloud computing platform such as Amazon Elastic Compute Cloud (EC2), configure Transformer to use a publicly accessible URL.
When you register Transformer with Control Hub, Transformer sends its URL to Control Hub in the format
http://<hostname>:<http.port>
, where
<hostname>
is the value defined in the
http.bindHost
property in the Transformer configuration file, $TRANSFORMER_CONF/transformer.properties
. If the
host name is not defined in http.bindHost
, Transformer runs the following command to determine the host name: hostname
-f
For most cloud computing platforms, the hostname -f
command returns the
private IP address of the machine on the cloud platform. Control Hub includes the
private IP address in the Transformer URL displayed in Control Hub. However, when you click the Transformer URL, you cannot access Transformer because you must use a public IP address to access a cloud machine.
To access Transformer installed on a cloud computing platform from Control Hub, uncomment the
transformer.base.http.url
property in the Transformer configuration file, $TRANSFORMER_CONF/transformer.properties
, and
then configure it to use the publicly accessible URL to that Transformer.
After modifying the configuration file, restart Transformer for the changes to take effect.
Using a Proxy Server
You can configure each registered Transformer to use an authenticated HTTP or HTTPS proxy server for outbound requests made to Control Hub. Define the proxy properties in the TRANSFORMER_JAVA_OPTS environment variable.
Modify environment variables using the method required by your installation type.
Add the following Java options to the TRANSFORMER_JAVA_OPTS environment variable:
https.proxyUser
https.proxyPassword
https.proxyHost
https.proxyPort
If the proxy server uses HTTP instead of HTTPS, use http.<property
name>
for each property.
For example, to configure a registered Transformer to use an HTTPS proxy server on host 138.0.0.1 and port 3138, define TRANSFORMER_JAVA_OPTS as follows:
export TRANSFORMER_JAVA_OPTS="${TRANSFORMER_JAVA_OPTS} -Xmx1024m -Xms1024m -Dhttps.proxyUser=MyName -Dhttps.proxyPassword=MyPsswrd -Dhttps.proxyHost=138.0.0.1 -Dhttps.proxyPort=3138 -server"
-Djdk.http.auth.tunneling.disabledSchemes=''
However, use this workaround with caution since it exposes credentials by sending them through an unencrypted proxy.