Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Eagle Data Services has a facility to define distribution profiles to distribute data to multiple destinations.

Table of Contents

Distribution Profiles

The distribution profiles are JSON files stored in eagle/estar/tpe/dynamic/metadata/distributions/profilename_profile.json

...

For example, if eagle/estar/tpe/dynamic/metadata/distributions/client_destinations_profile.json is defined, you can reference it in the RTR by using the DistributionProfileName=client_destinations parameter.

Encrypted Credentials

You can embed the credentials in the distribution profile as shown in the example above or the credentials may point to an encrypted configuration file.

...

The above RTR creates a credentials configuration which may be referred with the "credentials":  "clientcredentials/sftpcrendentials" element in the distribution profile file.

Data Encryption

The data to be distributed may be encrypted. Only GPG is currently supported. The encryption is enabled using the encryption_policy element in the distribution profile as shown in the example below.

...

  • "armor" - the armor for GPG - please refer to GPG documentation for description.
  • "credentials"/"client_id" - the recipient, for which should have a certificate imported in GPG.

Include Sink Definitions

In the Distribution Profile, you can include other sink definitions and redefine their parameters. For example, if the file is named "test_sinks.json" in the eagle/estar/tpe/dynamic/metadata/distributions/ path with the following content:

...

Code Block
languagejs
themeConfluence
titleDistribution Profile With Include
{
	"include": ["test_sinks.json"],
	
	"data_sinks": [{
				"sink" : "sftp_sink"
	}
}

Data Compression

You can compress the distributed data by adding the "compression_codec": "GZIP" parameter to the "cfg" section of the sink definition. Only GZIP is supported presently.

SFTP Distribution Sink Parameters

The SFTP sink is designated with a "type": "SFTP" sink parameter.

...

  • "credentials"/"user_id" - the login user id on the SFTP server
  • "credentials"/"password" - the password to login to the SFTP server
  • "credentials"/"private_key" - the name to the private key file, if necessary. The private key file should be in the estar/tpe/dynamic/dataservices/certificates folder.
  • "credentials"/"passphrase" - the passphrase for the private key
  • "credentials"/"private_key_type"  - the private key type, for example RSA or DSA, defaults to RSA
  • "cfg"/"host" - the host name or IP address of the SFTP server
  • "cfg"/"port" - the port number of the SFTP server, usually set to 22
  • "cfg"/"make_dir" - values of true or false.  Set to true to create missing directories in the distribution path on the SFTP server and false to fail if the directory is missing. The default is true.
  • "cfg"/"location" a path on the SFTP server to distribute the files to.


AZURE Publishing Configuration (Starting December 2019 release)

The Azure publishing configuration profile sample is below:

...