Skip to content

Commit

Permalink
Added FTP Source Kamelet
Browse files Browse the repository at this point in the history
  • Loading branch information
oscerd authored and nicolaferraro committed Mar 5, 2021
1 parent 5788de0 commit 9721c3c
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
67 changes: 67 additions & 0 deletions docs/modules/ROOT/pages/ftp-source.adoc
Original file line number Diff line number Diff line change
@@ -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
2 changes: 0 additions & 2 deletions ftp-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,4 @@ spec:
parameters:
password: "{{password}}"
steps:
- marshal:
json: {}
- to: "kamelet:sink"

0 comments on commit 9721c3c

Please sign in to comment.