SFTP put allows uploading of file(s) from filesystem (local/HDFS) to FTP server. File Regex can also be used to filter only the files that are of interest.
In order perform SFTP Put, 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/File on the Filesystem which needs to be copied can be specified using Source Path property. The specified
path should exist. Destination directory is the absolute path of the directory on the FTP Server where the files
will be copied. If destination directory does not exists, then it will be created first.
| 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. |
| Files to be deleted | Y | ${sftp.copied.file.names} | Comma separated list of files on the SFTP server to be deleted. Default value for this field is a Macro which will be substituted by SFTP copy plugin when this plugin is used with it. |
| 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. |
| Continue execution on error | N | false | Boolean flag to determine whether to proceed with next files in case there is a failure in deletion of any particular file. |
| 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'. |
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.