Skip to content

Commit 7dc401d

Browse files
matzewmatzew
committed
adding first draft of IntegrationSource doc
Signed-off-by: Matthias Wessendorf <[email protected]>
1 parent 6ff4a73 commit 7dc401d

File tree

6 files changed

+169
-0
lines changed

6 files changed

+169
-0
lines changed

‎config/nav.yml

+6
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,12 @@ nav:
230230
- PingSource:
231231
- Creating a PingSource object: eventing/sources/ping-source/README.md
232232
- PingSource reference: eventing/sources/ping-source/reference.md
233+
- IntegrationSource
234+
- About: eventing/sources/integration-source/README.md
235+
- AWS DDB Streams: eventing/sources/integration-source/aws_ddbstreams.md
236+
- AWS S3: eventing/sources/integration-source/aws_s3.md
237+
- AWS SQS: eventing/sources/integration-source/aws_sqs.md
238+
- Generic Timer: eventing/sources/integration-source/timer.md
233239
- RabbitMQSource: eventing/sources/rabbitmq-source/README.md
234240
- RedisStreamSource:
235241
- About RedisStreamSource: eventing/sources/redis/README.md

‎docs/eventing/sources/integration-source/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Knative Source for Apache Camel Kamelet integrations
2+
3+
![stage](https://img.shields.io/badge/Stage-alpah-red?style=flat-square)
4+
![version](https://img.shields.io/badge/API_Version-v1alpha1-red?style=flat-square)
5+
6+
The `IntegrationSource` is a Knative Eventing custom resource supporting selected [_Kamelets_](https://camel.apache.org/camel-k/latest/kamelets/kamelets.html) from the [Apache Camel](https://camel.apache.org/) project. Kamelets allow users to connect to 3rd party system for improved connectivity, they can act as "sources" or as "sinks". Therefore the `IntegrationSource` allows to consume data from external systems and forward them into Knative Eventing. The integration source is part of the Knative Eventing core installation.
7+
8+
## Supported Kamelet sources
9+
10+
* [AWS DDB Streams](./aws_ddbstreams.md)
11+
* [AWS S3](./aws_s3.md)
12+
* [AWS SQS](./aws_sqs.md)
13+
* [Generic timer](./timer.md)

‎docs/eventing/sources/integration-source/aws_ddbstreams.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# AWS DynamoDB Streams
2+
3+
The `IntegrationSource` supports the Amazon Web Services (AWS) DynamoDB Streams service, through its `aws.ddbStreams` property.
4+
5+
## Amazon credentials
6+
7+
For connecting to AWS the `IntegrationSource` uses Kubernetes `Secret`, present in the namespace of the resource. The `Secret` can be created like:
8+
9+
```bash
10+
kubectl -n <namespace> create secret generic my-secret --from-literal=aws.accessKey=<accessKey> --from-literal=aws.secretKey=<secretKey>
11+
```
12+
13+
## AWS DynamoDB Streams Example
14+
15+
Below is an `IntegrationSource` to receive events from Amazon DynamoDB Streams.
16+
17+
```yaml
18+
apiVersion: sources.knative.dev/v1alpha1
19+
kind: IntegrationSource
20+
metadata:
21+
name: integration-source-aws-ddb
22+
namespace: knative-samples
23+
spec:
24+
aws:
25+
ddbStreams:
26+
table: "my-table"
27+
region: "eu-north-1"
28+
auth:
29+
secret:
30+
ref:
31+
name: "my-secret"
32+
sink:
33+
ref:
34+
apiVersion: eventing.knative.dev/v1
35+
kind: Broker
36+
name: default
37+
```
38+
39+
Inside of the `aws.ddbStreams` object we define the name of the table and its region. The credentials for the AWS service are referenced from the `my-secret` Kubernetes `Secret`
40+
41+
More details about the Apache Camel Kamelet [aws-ddb-streams-source](https://camel.apache.org/camel-kamelets/latest/aws-ddb-streams-source.html).

‎docs/eventing/sources/integration-source/aws_s3.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# AWS S3 Source
2+
3+
The `IntegrationSource` supports the Amazon Web Services (AWS) S3 service, through its `aws.s3` property.
4+
5+
## Amazon credentials
6+
7+
For connecting to AWS the `IntegrationSource` uses Kubernetes `Secret`, present in the namespace of the resource. The `Secret` can be created like:
8+
9+
```bash
10+
kubectl -n <namespace> create secret generic my-secret --from-literal=aws.accessKey=<accessKey> --from-literal=aws.secretKey=<secretKey>
11+
```
12+
13+
## AWS S3 Source Example
14+
15+
Below is an `IntegrationSource` to receive data from an Amazon S3 Bucket.
16+
17+
```yaml
18+
apiVersion: sources.knative.dev/v1alpha1
19+
kind: IntegrationSource
20+
metadata:
21+
name: integration-source-aws-s3
22+
namespace: knative-samples
23+
spec:
24+
aws:
25+
s3:
26+
arn: "arn:aws:s3:::my-bucket"
27+
region: "eu-north-1"
28+
auth:
29+
secret:
30+
ref:
31+
name: "my-secret"
32+
sink:
33+
ref:
34+
apiVersion: eventing.knative.dev/v1
35+
kind: Broker
36+
name: default
37+
```
38+
39+
Inside of the `aws.s3` object we define the name of the bucket (or _arn_) and its region. The credentials for the AWS service are referenced from the `my-secret` Kubernetes `Secret`
40+
41+
More details about the Apache Camel Kamelet [aws-s3-source](https://camel.apache.org/camel-kamelets/latest/aws-s3-source.html).

‎docs/eventing/sources/integration-source/aws_sqs.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# AWS Simple Queue Service Source
2+
3+
The `IntegrationSource` supports the Amazon Web Services (AWS) Simple Queue Service (SQS) service, through its `aws.sqs` property.
4+
5+
## Amazon credentials
6+
7+
For connecting to AWS the `IntegrationSource` uses Kubernetes `Secret`, present in the namespace of the resource. The `Secret` can be created like:
8+
9+
```bash
10+
kubectl -n <namespace> create secret generic my-secret --from-literal=aws.accessKey=<accessKey> --from-literal=aws.secretKey=<secretKey>
11+
```
12+
13+
## AWS SQS Source Example
14+
15+
Below is an `IntegrationSource` to receive data from AWS SQS.
16+
17+
```yaml
18+
apiVersion: sources.knative.dev/v1alpha1
19+
kind: IntegrationSource
20+
metadata:
21+
name: integration-source-aws-sqs
22+
namespace: knative-samples
23+
spec:
24+
aws:
25+
sqs:
26+
arn: "arn:aws:s3:::my-queue"
27+
region: "eu-north-1"
28+
auth:
29+
secret:
30+
ref:
31+
name: "my-secret"
32+
sink:
33+
ref:
34+
apiVersion: eventing.knative.dev/v1
35+
kind: Broker
36+
name: default
37+
```
38+
Inside of the `aws.sqs` object we define the name of the queue (or _arn_) and its region. The credentials for the AWS service are referenced from the `my-secret` Kubernetes `Secret`
39+
40+
More details about the Apache Camel Kamelet [aws-sqs-source](https://camel.apache.org/camel-kamelets/latest/aws-sqs-source.html).

‎docs/eventing/sources/integration-source/timer.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Timer Source
2+
3+
The `IntegrationSource` supports the _Timer Kamelet_ for producing periodic messages with a custom payload, through its `timer` property.
4+
5+
## Timer Source Example
6+
7+
Produces periodic messages with a custom payload.
8+
9+
```yaml
10+
apiVersion: sources.knative.dev/v1alpha1
11+
kind: IntegrationSource
12+
metadata:
13+
name: integration-source-timer
14+
namespace: knative-samples
15+
spec:
16+
timer:
17+
period: 2000
18+
message: "Hello, Eventing Core"
19+
sink:
20+
ref:
21+
apiVersion: eventing.knative.dev/v1
22+
kind: Broker
23+
name: default
24+
```
25+
26+
Inside of the `timer` object we define the `period` and the message that is send to the referenced `sink`.
27+
28+
More details about the Apache Camel Kamelet [timer-source](https://camel.apache.org/camel-kamelets/latest/timer-source.html).

0 commit comments

Comments
 (0)