scp sink SCP Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send file to an FTP Server through Secure Copy Protocol

Configuration Options

The following table summarizes the configuration options available for the scp-sink Kamelet:

Property Name Description Type Default Example

serverName

Hostname

Required The hostname of the FTP server.

string

serverPort

Port

Required The port of the FTP server.

string

password

Password

Password for accessing FTP Server.

string

privateKeyFile

Private Key File

Set the private key file so that the SFTP endpoint can do private key verification.

string

privateKeyPassphrase

Private Key Passphrase

Set the private key file passphrase so that the SFTP endpoint can do private key verification.

string

strictHostKeyChecking

Strict Host Checking

Sets whether to use strict host key checking.

string

no

useUserKnownHostsFile

Use User Known Hosts File

If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts.

boolean

true

username

Username

Username for accessing FTP Server.

string

Dependencies

At runtime, the scp-sink Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • camel:jsch

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the scp-sink.

Knative sink

You can use the scp-sink Kamelet as a Knative sink by binding it to a Knative object.

scp-sink-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: scp-sink-pipe
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: scp-sink
    properties:
      serverName: The Hostname
      serverPort: The Port

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the scp-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f scp-sink-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind scp-sink -p "sink.serverName=The Hostname" -p "sink.serverPort=The Port" channel:mychannel

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka sink

You can use the scp-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

scp-sink-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: scp-sink-pipe
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: scp-sink
    properties:
      serverName: The Hostname
      serverPort: The Port

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the scp-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f scp-sink-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind scp-sink -p "sink.serverName=The Hostname" -p "sink.serverPort=The Port" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the Kamelet Pipe in the current namespace on the cluster.