SFTP copy allows copying of the files from the specified directory on SFTP servers and write them to HDFS as the destination. The files that are copied can be optionally uncompressed before storing. The files are copied directly to HDFS without needing any additional staging area.
In order perform SFTP copy, we require host and port on which the SFTP server is running. SFTP implements secure file
transfer over SSH. Typically port number 22 is used for SFTP(which is also default port for SSH). We also require valid
credentials in the form of user name and password. Please make sure that you are able to SSH to the SFTP server using
specified user and password. SSH connection to SFTP server can be customized by providing additional configurations
such as enable host key checking by setting configuration property 'StrictHostKeyChecking' to 'yes'. These additional
configurations can be specified using Properties for SSH section.
Directory on the SFTP server which needs to be copied can be specified using Source directory property. The specified
directory should exist and absolute path to the directory must be provided. If directory is empty then execution will
continue without any error. Destination directory is the absolute path of the directory on HDFS where the files will be copied.
If destination directory does not exists, then it will be created first. If file with the same name already exists in
the destination directory, it will be overwritten.
Files from the SFTP server can optionally be uncompressed while copying to HDFS. Currently uncompress option is only supported for the zip files.
Typically SFTP server acts as a temporary storage for the files and once processed the files can be deleted. Comma
separated list of file names on the SFTP server which were copied to HDFS during the current run, is stored in a
variable named sftp.copied.file.names. SFTP Delete action can be configured to run at the end of the pipeline,
which uses this variable to determine the files to be deleted from SFTP server.
| Configuration | Required | Default | Description |
|---|---|---|---|
| Host | Y | N/A | Specifies the host name of the SFTP server. |
| Port | N | 22 | Specifies the port on which SFTP server is running. |
| User Name | Y | N/A | Specifies the name of the user which will be used to connect to the SFTP server. |
| Authentication | Y | PrivateKey | Specifies the type of Authentication that will be used to connect to the SFTP Server. |
| Private Key | N | N/A | Private RSA Key to be used to connect to the SFTP Server. This key is recommended to be stored in the Secure Key Store, and macro called into the Configuration. Must be a RSA key starting with -----BEGIN RSA PRIVATE KEY----- |
| Private Key Passphrase | N | N/A | Passphrase to be used with RSA Private Key if a Passphrase was specified when key was generated. |
| Password | N | N/A | Specifies the password of the user. Only Required if Private Key is not being used. |
| Source Directory | Y | N/A | Absolute path of the directory on the SFTP server which is to be copied. If the directory is empty, the execution of the plugin will be no-op. |
| Destination Directory | Y | N/A | Destination directory on the file system, where files need to be copied. If directory does not exist, it will lbe created. |
| Uncompress | N | true | Boolean flag to determine whether to uncompress the .zip files while copying. |
| File Name Regex | N | .* | Regex to choose only the files that are of interest. All files will be copied by default. |
| Variable name to hold list of copied file names | N | sftp.copied.file.names | Name of the variable which holds comma separated list of file names on the SFTP server which were copied during this run of the plugin. Usually this variable is used as Macro in the SFTP Delete action to delete the files from SFTP server once their processing is successful. |
| Properties for SSH | N | N/A | Specifies the properties that are used to configure SSH connection to the FTP server. For example to enable verbose logging add property 'LogLevel' with value 'VERBOSE'. To enable host key checking set 'StrictHostKeyChecking' to 'yes'. SSH can be configured with the properties described here 'https://linux.die.net/man/5/ssh_config'. |
| Properties for FileSystem | N | N/A | Specifies the properties that are used to configure Destination File system for example: HDFS, ADLS |
To build this plugin:
mvn clean package
The build will create a .jar and .json file under the target directory.
These files can be used to deploy your plugins.
You can deploy your plugins using the CDAP CLI:
> load artifact <target/sftp-actions-<version>.jar config-file <target/sftp-actions-<version>.json>
For example, if your artifact is named 'sftp-actions-1.0.0':
> load artifact target/sftp-actions-1.0.0.jar config-file target/sftp-actions-1.0.0.json
CDAP User Group and Development Discussions:
[email protected] <https://groups.google.com/d/forum/cdap-user>
The cdap-user mailing list is primarily for users using the product to develop applications or building plugins for appplications. You can expect questions from users, release announcements, and any other discussions that we think will be helpful to the users.
CDAP Slack Channel: http://cdap-users.herokuapp.com/
Copyright © 2017 Cask Data, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Cask is a trademark of Cask Data, Inc. All rights reserved.
Apache, Apache HBase, and HBase are trademarks of The Apache Software Foundation. Used with permission. No endorsement by The Apache Software Foundation is implied by the use of these marks.