Skip to content

Commit

Permalink
Added FTPS Sink Kamelet
Browse files Browse the repository at this point in the history
  • Loading branch information
oscerd committed May 26, 2021
1 parent d6f61f6 commit f4410fc
Show file tree
Hide file tree
Showing 2 changed files with 164 additions and 0 deletions.
89 changes: 89 additions & 0 deletions docs/modules/ROOT/assets/images/kamelets/ftps-sink.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
75 changes: 75 additions & 0 deletions docs/modules/ROOT/pages/ftps-sink.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/ftps-sink.svg[] FTPS Sink

*Provided by: "Apache Software Foundation"*

Send data to an FTPS Server.

The Kamelet expects the following headers to be set:

- `file` / `ce-file`: as the file name to upload

If the header won't be set the exchange ID will be used as file name.

== Configuration Options

The following table summarizes the configuration options available for the `ftps-sink` Kamelet:
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *directoryName {empty}* *| Directory Name| The starting directory| string| |
| *host {empty}* *| Host| Hostname of the FTP server| string| |
| *password {empty}* *| Password| The password to access the FTP server| string| |
| *port {empty}* *| Port| Port of the FTP server| string| `21`|
| *username {empty}* *| Username| The username to access the FTP server| string| |
| fileExist| File Existence| How to behave in case of file already existent. There are 4 enums and the value can be one of Override, Append, Fail or Ignore| string| `"Override"`|
| passiveMode| Passive Mode| Sets passive mode connection| boolean| `false`|
|===

NOTE: Fields marked with ({empty}*) are mandatory.

== Usage

This section summarizes how the `ftps-sink` can be used in various contexts.

=== Knative Sink

The `ftps-sink` Kamelet can be used as Knative sink by binding it to a Knative object.

.ftps-sink-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: ftps-sink-binding
spec:
source:
ref:
kind: InMemoryChannel
apiVersion: messaging.knative.dev/v1
name: mychannel
sink:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: ftps-sink
properties:
directoryName: "The Directory Name"
host: "The Host"
password: "The Password"
username: "The Username"
----

Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.

Save the `ftps-sink-binding.yaml` file into your hard drive, then configure it according to your needs.

You can run the sink using the following command:

[source,shell]
----
kubectl apply -f ftps-sink-binding.yaml
----
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT

0 comments on commit f4410fc

Please sign in to comment.