diff --git a/docs/modules/ROOT/assets/images/kamelets/ftps-sink.svg b/docs/modules/ROOT/assets/images/kamelets/ftps-sink.svg new file mode 100644 index 000000000..2faddf298 --- /dev/null +++ b/docs/modules/ROOT/assets/images/kamelets/ftps-sink.svg @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + ftp + + diff --git a/docs/modules/ROOT/pages/ftps-sink.adoc b/docs/modules/ROOT/pages/ftps-sink.adoc new file mode 100644 index 000000000..9799e2173 --- /dev/null +++ b/docs/modules/ROOT/pages/ftps-sink.adoc @@ -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