diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 4ca8d633f..e512fe2bb 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -3,6 +3,7 @@ * xref:ROOT:aws-s3-source.adoc[image:kamelets/aws-s3-source.svg[] AWS S3 Source] * xref:ROOT:aws-sqs-source.adoc[image:kamelets/aws-sqs-source.svg[] AWS SQS Source] * xref:ROOT:bitcoin-source.adoc[image:kamelets/bitcoin-source.svg[] Bitcoin Source] +* xref:ROOT:ftp-source.adoc[image:kamelets/ftp-source.svg[] FTP Source] * xref:ROOT:http-source.adoc[image:kamelets/http-source.svg[] HTTP Source] * xref:ROOT:jira-source.adoc[image:kamelets/jira-source.svg[] Jira Source] * xref:ROOT:kafka-source.adoc[image:kamelets/kafka-source.svg[] Kafka Source] diff --git a/docs/modules/ROOT/pages/ftp-source.adoc b/docs/modules/ROOT/pages/ftp-source.adoc new file mode 100644 index 000000000..4b4e59f72 --- /dev/null +++ b/docs/modules/ROOT/pages/ftp-source.adoc @@ -0,0 +1,67 @@ +// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT += image:kamelets/ftp-source.svg[] FTP Source + +*Provided by: "Apache Software Foundation"* + +Receive data from an FTP Server. + +== Configuration Options + +The following table summarizes the configuration options available for the `ftp-source` Kamelet: +[width="100%",cols="2,^2,3,^2,^2,^3",options="header"] +|=== +| Property| Name| Description| Type| Default| Example +| *directoryName {empty}* *| directoryName| 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| | +|=== + +NOTE: Fields marked with ({empty}*) are mandatory. + +== Usage + +This section summarizes how the `ftp-source` can be used in various contexts. + +=== Knative Source + +The `ftp-source` Kamelet can be used as Knative source by binding it to a Knative object. + +.ftp-source-binding.yaml +[source,yaml] +---- +apiVersion: camel.apache.org/v1alpha1 +kind: KameletBinding +metadata: + name: ftp-source-binding +spec: + source: + ref: + kind: Kamelet + apiVersion: camel.apache.org/v1alpha1 + name: ftp-source + properties: + directoryName: "The directoryName" + host: "The Host" + password: "The Password" + username: "The Username" + sink: + ref: + kind: InMemoryChannel + apiVersion: messaging.knative.dev/v1 + name: mychannel + +---- + +Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to. + +Save the `ftp-source-binding.yaml` file into your hard drive, then configure it according to your needs. + +You can run the source using the following command: + +[source,shell] +---- +kubectl apply -f ftp-source-binding.yaml +---- +// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT diff --git a/ftp-source.kamelet.yaml b/ftp-source.kamelet.yaml index cf552defc..935b3d4b7 100644 --- a/ftp-source.kamelet.yaml +++ b/ftp-source.kamelet.yaml @@ -53,6 +53,4 @@ spec: parameters: password: "{{password}}" steps: - - marshal: - json: {} - to: "kamelet:sink"