Routing and sFTP Server Configuration

The ASN.1 sFTP Sink application connects to an sFTP server to upload files.

Routing Configuration Properties describes the available properties for routing from inbound Kafka topics to outbound paths on the sFTP server.

Table 1. Routing Configuration Properties
Property Description
sftp.routes An array of route. The default value is an empty array.
route.topic The inbound topic of the route.
route.path The directory on the remote server for the route.
route.isdefault When set to true, the route is default. The default value is false.

Helm-Configured SFTP Server Configuration Properties describes properties changed by the Helm chart configuration and not the application configuration. Setting these properties in asn1-sftp-sink.yaml is overridden by the Helm chart.

Table 2. Helm-Configured SFTP Server Configuration Properties
Property Description
sftp.remote.host The sFTP server host name. The default value is sftp. The default value is sftp.
sftp.remote.port The sFTP server port number. The default value is 22.
sftp.remote.user The username to use when connecting to the sFTP server. The default value is mtxuser.
sftp.remote.password The base64-encoded password to use when connecting to the sFTP server.
sftp.remote.privateKey The base64-encoded private key value to use when connecting to the sFTP server.
sftp.remote.privatePassphrase The base64-encoded private key password or passphrase to use when connecting to the sFTP server.

SFTP Server Configuration Properties describes the available sFTP configuration properties.

Table 3. SFTP Server Configuration Properties
Property Description
sftp.host The sFTP server host name. The default value is sftp.
sftp.port The sFTP server port number. The default value is 22.
sftp.uploadDirectory The directory on the sFTP server where files are uploaded.
sftp.credentials.username The username to use when connecting to the sFTP server.
sftp.credentials.password The base64-encoded password to use when connecting to the sFTP server.
sftp.credentials.privateKey The base64-encoded private key value to use when connecting to the sFTP server.
sftp.credentials.privateKeyPassword The base64-encoded private key password or passphrase to use when connecting to the sFTP server.
sftp.credentials.secret.name The name of the Kubernetes secret that has the password or private key (and optionally the private key password) to use when connecting to the sFTP server. If sftp.credentials.secret.create is set to true, then this secret is created by the Helm chart. If it is false then it is assumed that this is an existing secret containing the required values. The default value is asn1-sftp-sink-release_name-sftp-creds.
sftp.credentials.secret.create If set to true, a Kubernetes secret is created with the specified password or private key (and, optionally, the private key password) and using the supplied name. The default value is true.
Note: The ASN.1 sFTP Sink application requires that RSA keys be created in legacy format. They can be created with the following command:
ssh-keygen -t rsa -m PEM
The generated private key starts with the following line:
-----BEGIN RSA PRIVATE KEY-----