This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
The following commit(s) were added to refs/heads/main by this push:
new 56aabd5ce chore: describe the MinIO, Ceph, GitHub, Kubernetes and
webhook Kamelets for people and AI assistants (#3147)
56aabd5ce is described below
commit 56aabd5ceb42e5182f3bfdcf899cfff1a92c3984
Author: Claus Ibsen <[email protected]>
AuthorDate: Tue Nov 17 11:28:03 2026 +0100
chore: describe the MinIO, Ceph, GitHub, Kubernetes and webhook Kamelets
for people and AI assistants (#3147)
Rewrites the descriptions, options and partial pages of 14 Kamelets to the
standard of docs/modules/ROOT/pages/documenting.adoc (#3140): minio-source,
minio-sink, ceph-source, ceph-sink, ceph-event-based-source, the five
GitHub sources, the three Kubernetes sources and webhook-source.
The MinIO and Ceph Kamelets were run against MinIO, ceph-event-based-source
also against Kafka, the Kubernetes sources against a local stand-in of the
Kubernetes watch API, and webhook-source with curl; the GitHub sources were
checked against the template and the component.
These Kamelets declare their headers under spec.dataTypes, so the catalog
returns those instead of the headers of the component;
KameletsCatalogTest follows.
The Dropbox Kamelets are left out: they do not start, and will be
described with their fix.
Co-authored-by: Claude Opus 5.5 <[email protected]>
---
.../ceph-event-based-source-description.adoc | 5 +-
.../ROOT/partials/ceph-sink-description.adoc | 2 +-
.../partials/github-commit-source-description.adoc | 2 +-
.../partials/github-event-source-description.adoc | 2 +-
.../kubernetes-namespaces-source-description.adoc | 16 ++----
.../kubernetes-nodes-source-description.adoc | 16 ++----
.../kubernetes-pods-source-description.adoc | 16 ++----
.../ROOT/partials/minio-sink-description.adoc | 2 +-
.../ROOT/partials/minio-source-description.adoc | 2 +-
.../ROOT/partials/webhook-source-description.adoc | 11 ++--
kamelets/ceph-event-based-source.kamelet.yaml | 53 +++++++++++++++-----
kamelets/ceph-sink.kamelet.yaml | 41 +++++++++++----
kamelets/ceph-source.kamelet.yaml | 58 +++++++++++++++++-----
kamelets/github-commit-source.kamelet.yaml | 44 +++++++++++++---
kamelets/github-event-source.kamelet.yaml | 24 +++++++--
.../github-pullrequest-comment-source.kamelet.yaml | 24 +++++++--
kamelets/github-pullrequest-source.kamelet.yaml | 28 +++++++++--
kamelets/github-tag-source.kamelet.yaml | 17 +++++--
kamelets/kubernetes-namespaces-source.kamelet.yaml | 27 ++++++++--
kamelets/kubernetes-nodes-source.kamelet.yaml | 30 +++++++++--
kamelets/kubernetes-pods-source.kamelet.yaml | 30 +++++++++--
kamelets/minio-sink.kamelet.yaml | 36 +++++++++++---
kamelets/minio-source.kamelet.yaml | 45 ++++++++++++++---
kamelets/webhook-source.kamelet.yaml | 28 +++++++++--
.../kamelets/catalog/KameletsCatalogTest.java | 14 +++---
.../main/resources/META-INF/kamelets-index.json | 56 ++++++++++-----------
.../kamelets/ceph-event-based-source.kamelet.yaml | 53 +++++++++++++++-----
.../main/resources/kamelets/ceph-sink.kamelet.yaml | 41 +++++++++++----
.../resources/kamelets/ceph-source.kamelet.yaml | 58 +++++++++++++++++-----
.../kamelets/github-commit-source.kamelet.yaml | 44 +++++++++++++---
.../kamelets/github-event-source.kamelet.yaml | 24 +++++++--
.../github-pullrequest-comment-source.kamelet.yaml | 24 +++++++--
.../github-pullrequest-source.kamelet.yaml | 28 +++++++++--
.../kamelets/github-tag-source.kamelet.yaml | 17 +++++--
.../kubernetes-namespaces-source.kamelet.yaml | 27 ++++++++--
.../kamelets/kubernetes-nodes-source.kamelet.yaml | 30 +++++++++--
.../kamelets/kubernetes-pods-source.kamelet.yaml | 30 +++++++++--
.../resources/kamelets/minio-sink.kamelet.yaml | 36 +++++++++++---
.../resources/kamelets/minio-source.kamelet.yaml | 45 ++++++++++++++---
.../resources/kamelets/webhook-source.kamelet.yaml | 28 +++++++++--
40 files changed, 856 insertions(+), 258 deletions(-)
diff --git
a/docs/modules/ROOT/partials/ceph-event-based-source-description.adoc
b/docs/modules/ROOT/partials/ceph-event-based-source-description.adoc
index 3dc18c944..5d0ddaeaf 100644
--- a/docs/modules/ROOT/partials/ceph-event-based-source-description.adoc
+++ b/docs/modules/ROOT/partials/ceph-event-based-source-description.adoc
@@ -11,8 +11,9 @@ S3 and topic APIs, and is not something this Kamelet does.
=== Fetching the Object
Set `getObject` to true to fetch the object body from Ceph for `ObjectCreated`
events,
-using the same S3 compatible path that `ceph-source` and `ceph-sink` use. The
notification
-JSON is emitted unchanged otherwise.
+using the same S3 compatible path that `ceph-source` and `ceph-sink` use. With
`getObject`
+left false, the notification JSON is emitted unchanged, as text. With
`getObject` true, the
+other events are emitted as parsed JSON (a Jackson `JsonNode`) rather than as
text.
When `getObject` is enabled, `cephUrl`, `accessKey`, `secretKey` and
`zoneGroup` are
required so the object can be read back from the RGW endpoint.
diff --git a/docs/modules/ROOT/partials/ceph-sink-description.adoc
b/docs/modules/ROOT/partials/ceph-sink-description.adoc
index 3481d8619..f7c3477dd 100644
--- a/docs/modules/ROOT/partials/ceph-sink-description.adoc
+++ b/docs/modules/ROOT/partials/ceph-sink-description.adoc
@@ -8,4 +8,4 @@ In this Kamelet you need to use static credentials
In the header, you can optionally set the `file` / `ce-file` property to
specify the name of the file to upload.
-If you do not set the property in the header, the Kamelet uses the exchange ID
for the file name.
+If you do not set the property in the header, the Kamelet uses the `keyName`
option for the file name, or a generated unique name when `keyName` is not set.
diff --git a/docs/modules/ROOT/partials/github-commit-source-description.adoc
b/docs/modules/ROOT/partials/github-commit-source-description.adoc
index d32d80ed8..78163db53 100644
--- a/docs/modules/ROOT/partials/github-commit-source-description.adoc
+++ b/docs/modules/ROOT/partials/github-commit-source-description.adoc
@@ -9,7 +9,7 @@ This Kamelet uses OAuth token-based authentication to connect
to GitHub. You nee
=== Output format
-The Kamelet produces commit data in JSON format containing commit information
from the specified GitHub repository and branch.
+The Kamelet produces one message per new commit on the branch. The body is the
commit message as JSON text, that is a quoted JSON string, and the headers
`CamelGitHubCommitSha`, `CamelGitHubCommitUrl`, `CamelGitHubCommitAuthor` and
`CamelGitHubCommitCommitter` give the details of the commit.
=== Configuration
diff --git a/docs/modules/ROOT/partials/github-event-source-description.adoc
b/docs/modules/ROOT/partials/github-event-source-description.adoc
index b8b3b8200..7af772188 100644
--- a/docs/modules/ROOT/partials/github-event-source-description.adoc
+++ b/docs/modules/ROOT/partials/github-event-source-description.adoc
@@ -9,7 +9,7 @@ This Kamelet uses OAuth token-based authentication to connect
to GitHub. You nee
=== Output format
-The Kamelet produces event data in JSON format containing various GitHub
repository events such as pushes, issues, pull requests, and other repository
activities.
+The Kamelet produces one message per repository event, such as a push, an
issue or a pull request. The body is the type of the event as JSON text, that
is a quoted JSON string such as `"PUSH"`; the details of the event are in the
`CamelGitHubEventPayload` header, as a Java object.
=== Configuration
diff --git
a/docs/modules/ROOT/partials/kubernetes-namespaces-source-description.adoc
b/docs/modules/ROOT/partials/kubernetes-namespaces-source-description.adoc
index 22d80a099..8753fcdd8 100644
--- a/docs/modules/ROOT/partials/kubernetes-namespaces-source-description.adoc
+++ b/docs/modules/ROOT/partials/kubernetes-namespaces-source-description.adoc
@@ -2,22 +2,15 @@
=== Authentication methods
-This Kamelet connects to Kubernetes using:
-
-- Service account authentication (recommended in cluster)
-- Kubeconfig file authentication
-- Token-based authentication
+This Kamelet connects to the Kubernetes API server given by `masterUrl` with a
bearer token, the `token` option, such as the token of a service account
created with `kubectl create token <service-account>`. The token must be
allowed to list and watch namespaces.
=== Output format
-The Kamelet watches Kubernetes namespaces resources and produces event data in
JSON format when resources are created, updated, or deleted.
+The Kamelet watches Kubernetes namespaces resources and produces a message
when one is created, updated, or deleted. The body is the resource as JSON
text, and the `CamelKubernetesEventAction` header says what happened (`ADDED`,
`MODIFIED` or `DELETED`).
=== Configuration
-The Kamelet supports various Kubernetes connection parameters:
-
-- `namespace`: The Kubernetes namespace to watch (optional)
-- Authentication and connection configuration
+The Kamelet requires `masterUrl` and `token`, and watches all the namespaces
of the cluster.
=== Usage example
@@ -33,7 +26,8 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kubernetes-namespaces-source
properties:
- namespace: "default"
+ masterUrl: "https://my-cluster.example.com:6443"
+ token: "{{kubernetes-token}}"
sink:
ref:
kind: Service
diff --git
a/docs/modules/ROOT/partials/kubernetes-nodes-source-description.adoc
b/docs/modules/ROOT/partials/kubernetes-nodes-source-description.adoc
index 71c21d87c..924102a6b 100644
--- a/docs/modules/ROOT/partials/kubernetes-nodes-source-description.adoc
+++ b/docs/modules/ROOT/partials/kubernetes-nodes-source-description.adoc
@@ -2,22 +2,15 @@
=== Authentication methods
-This Kamelet connects to Kubernetes using:
-
-- Service account authentication (recommended in cluster)
-- Kubeconfig file authentication
-- Token-based authentication
+This Kamelet connects to the Kubernetes API server given by `masterUrl` with a
bearer token, the `token` option, such as the token of a service account
created with `kubectl create token <service-account>`. The token must be
allowed to list and watch nodes.
=== Output format
-The Kamelet watches Kubernetes nodes resources and produces event data in JSON
format when resources are created, updated, or deleted.
+The Kamelet watches Kubernetes nodes resources and produces a message when one
is created, updated, or deleted. The body is the resource as JSON text, and the
`CamelKubernetesEventAction` header says what happened (`ADDED`, `MODIFIED` or
`DELETED`).
=== Configuration
-The Kamelet supports various Kubernetes connection parameters:
-
-- `namespace`: The Kubernetes namespace to watch (optional)
-- Authentication and connection configuration
+The Kamelet requires `masterUrl` and `token`. Set `resourceName` to watch only
one node.
=== Usage example
@@ -33,7 +26,8 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kubernetes-nodes-source
properties:
- namespace: "default"
+ masterUrl: "https://my-cluster.example.com:6443"
+ token: "{{kubernetes-token}}"
sink:
ref:
kind: Service
diff --git a/docs/modules/ROOT/partials/kubernetes-pods-source-description.adoc
b/docs/modules/ROOT/partials/kubernetes-pods-source-description.adoc
index ad65e2137..d3eb40249 100644
--- a/docs/modules/ROOT/partials/kubernetes-pods-source-description.adoc
+++ b/docs/modules/ROOT/partials/kubernetes-pods-source-description.adoc
@@ -2,22 +2,15 @@
=== Authentication methods
-This Kamelet connects to Kubernetes using:
-
-- Service account authentication (recommended in cluster)
-- Kubeconfig file authentication
-- Token-based authentication
+This Kamelet connects to the Kubernetes API server given by `masterUrl` with a
bearer token, the `token` option, such as the token of a service account
created with `kubectl create token <service-account>`. The token must be
allowed to list and watch pods.
=== Output format
-The Kamelet watches Kubernetes pods resources and produces event data in JSON
format when resources are created, updated, or deleted.
+The Kamelet watches Kubernetes pods resources and produces a message when one
is created, updated, or deleted. The body is the resource as JSON text, and the
`CamelKubernetesEventAction` header says what happened (`ADDED`, `MODIFIED` or
`DELETED`).
=== Configuration
-The Kamelet supports various Kubernetes connection parameters:
-
-- `namespace`: The Kubernetes namespace to watch (optional)
-- Authentication and connection configuration
+The Kamelet requires `masterUrl` and `token`. It watches the pods of all
namespaces: it has no option to choose a namespace, and `resourceName` has no
effect.
=== Usage example
@@ -33,7 +26,8 @@ spec:
apiVersion: camel.apache.org/v1alpha1
name: kubernetes-pods-source
properties:
- namespace: "default"
+ masterUrl: "https://my-cluster.example.com:6443"
+ token: "{{kubernetes-token}}"
sink:
ref:
kind: Service
diff --git a/docs/modules/ROOT/partials/minio-sink-description.adoc
b/docs/modules/ROOT/partials/minio-sink-description.adoc
index bec8bd606..46a9e5b7d 100644
--- a/docs/modules/ROOT/partials/minio-sink-description.adoc
+++ b/docs/modules/ROOT/partials/minio-sink-description.adoc
@@ -18,7 +18,7 @@ The Kamelet can optionally auto-create buckets if they don't
exist, providing fl
=== Object Naming
-Object names can be specified through configuration or derived from message
headers (`file` or `ce-file`). If no name is provided, the exchange ID is used
as the object name.
+When the `keyName` option is set, every message is stored under that name, and
the `file` and `ce-file` headers are ignored. Otherwise the object name comes
from the `file` header, or the `ce-file` header, and is a generated unique name
when neither is set.
=== Deployment Flexibility
diff --git a/docs/modules/ROOT/partials/minio-source-description.adoc
b/docs/modules/ROOT/partials/minio-source-description.adoc
index 6f46ef559..8bbd1e08e 100644
--- a/docs/modules/ROOT/partials/minio-source-description.adoc
+++ b/docs/modules/ROOT/partials/minio-source-description.adoc
@@ -10,7 +10,7 @@ This Kamelet connects to Minio using appropriate
authentication mechanisms:
=== Output format
-The Kamelet consumes data from Minio and produces the data in JSON format.
+The Kamelet reads the files of a MinIO bucket, and produces one message per
file, with the content of the file as bytes. It reads only the files at the top
of the bucket, not the files in folders, and by default deletes each file after
it has been read.
=== Configuration
diff --git a/docs/modules/ROOT/partials/webhook-source-description.adoc
b/docs/modules/ROOT/partials/webhook-source-description.adoc
index ef67dbc00..b8a0ef3c4 100644
--- a/docs/modules/ROOT/partials/webhook-source-description.adoc
+++ b/docs/modules/ROOT/partials/webhook-source-description.adoc
@@ -66,11 +66,12 @@ Processing webhook data:
subpath: "github-webhook"
steps:
- filter:
- header:
- name: "X-GitHub-Event"
- value: "push"
- - to:
- uri: "kamelet:log-sink"
+ expression:
+ simple:
+ expression: "${header.X-GitHub-Event} == 'push'"
+ steps:
+ - to:
+ uri: "kamelet:log-sink"
----
This example filters for GitHub push events before processing.
diff --git a/kamelets/ceph-event-based-source.kamelet.yaml
b/kamelets/ceph-event-based-source.kamelet.yaml
index d115b6bd2..515655226 100644
--- a/kamelets/ceph-event-based-source.kamelet.yaml
+++ b/kamelets/ceph-event-based-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "Ceph Event Based Source"
- description: Receive Ceph RGW bucket notifications from a Kafka topic, and
optionally fetch the object each notification refers to.
+ description: |-
+ Receives the bucket notifications that a Ceph Object Gateway sends to a
Kafka topic, one message per event, such as a file added to or deleted from a
bucket.
+
+ Use it to react as soon as a file is uploaded to or removed from a Ceph
bucket, without reading the bucket over and over. Set `getObject` to true to
receive the content of each new file. To read and remove the files of a bucket
instead, use `ceph-source`.
+
+ Output: the body is the notification as JSON text, unchanged: a
`Records` array that gives the event name (such as `ObjectCreated:Put`), the
bucket name and the key of the file. The headers `ceph-event-id`,
`ceph-opaque-data`, `ceph-object-metadata` and `ceph-object-tags` give the
fields Ceph adds to the event; metadata and tags are a List of entries with a
`key` and a `val`. Each header is also set with a `ce-` name, such as
`ce-cepheventid`. With `getObject` true, the body of an [...]
+
+ Good to know: the notification and its Kafka topic are set up on the
Ceph side; this Kamelet only reads the topic. A record that is not a Ceph
notification (without a `Records` array) fails. It connects to Kafka with no
login and no TLS unless `saslAuthType` says otherwise. Without `consumerGroup`,
each start uses a new group, so with the default `autoOffsetReset` of `latest`
the events sent while it was stopped are not read.
required:
- topic
- bootstrapServers
@@ -38,72 +45,92 @@ spec:
properties:
topic:
title: Topic Name
- description: The Kafka topic Ceph pushes the bucket notifications to.
+ description: The Kafka topic that the Ceph Object Gateway sends the
bucket notifications to, as set in the push endpoint of the Ceph topic.
type: string
example: "ceph-bucket-notifications"
bootstrapServers:
title: Bootstrap Servers
- description: A comma separated list of Kafka brokers to connect to.
+ description: The address of one or more Kafka brokers to connect to
first, as `host:port`, separated by commas.
type: string
+ example: "broker1:9092,broker2:9092"
consumerGroup:
title: Consumer Group
- description: A string that uniquely identifies the group of consumers
this source belongs to.
+ description: The name of the Kafka consumer group. Kafka remembers how
far the group has read, so a restart continues where it stopped. When it is not
set, a new group is used at each start.
type: string
example: "my-group-id"
autoOffsetReset:
title: Auto Offset Reset
- description: What to do when there is no initial offset. There are 3
enums and the value can be latest, earliest or none.
+ description: Where to start when the consumer group has not read the
topic before. `latest` reads only the events sent from now on, `earliest` reads
the topic from its start, and `none` fails.
type: string
default: "latest"
enum: ["latest", "earliest", "none"]
saslAuthType:
title: Authentication Type
- description: Authentication type to use. Use NONE for no
authentication, PLAIN or SCRAM_SHA_256/SCRAM_SHA_512 for username/password, SSL
for certificate-based, OAUTH for OAuth 2.0, AWS_MSK_IAM for MSK, or KERBEROS
for Kerberos.
+ description: How to log in to Kafka. `NONE` connects with no login and
no TLS, as a local Kafka expects; `PLAIN`, `SCRAM_SHA_256` and `SCRAM_SHA_512`
log in with `saslUsername` and `saslPassword`.
type: string
default: NONE
enum: ["NONE", "PLAIN", "SCRAM_SHA_256", "SCRAM_SHA_512", "SSL",
"OAUTH", "AWS_MSK_IAM", "KERBEROS"]
saslUsername:
title: Username
- description: Username for SASL authentication. Required when
saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.
+ description: The user to log in to Kafka as. Required when
`saslAuthType` is `PLAIN`, `SCRAM_SHA_256` or `SCRAM_SHA_512`.
type: string
x-descriptors:
- urn:camel:group:credentials
saslPassword:
title: Password
- description: Password for SASL authentication. Required when
saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.
+ description: The password of `saslUsername`. Required when
`saslAuthType` is `PLAIN`, `SCRAM_SHA_256` or `SCRAM_SHA_512`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
getObject:
title: Get Object
- description: Fetch the object body from Ceph for ObjectCreated events,
instead of emitting only the notification.
+ description: If true, for each `ObjectCreated` event the file is read
from Ceph and becomes the body, instead of the notification. It needs
`cephUrl`, `accessKey`, `secretKey` and `zoneGroup`.
type: boolean
default: false
cephUrl:
title: Ceph URL
- description: The URL of the Ceph RGW endpoint to fetch objects from.
Required when getObject is true.
+ description: The address of the Ceph Object Gateway (RGW) to read the
files from, as a URL with the scheme and the port. Required when `getObject` is
true.
type: string
example: "http://ceph-rgw:8080"
accessKey:
title: Access Key
- description: The access key to read objects from Ceph. Required when
getObject is true.
+ description: The S3 access key of a Ceph Object Gateway user that can
read the bucket. Required when `getObject` is true.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key to read objects from Ceph. Required when
getObject is true.
+ description: The S3 secret key that goes with `accessKey`. Required
when `getObject` is true.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
zoneGroup:
title: Ceph Zone Group
- description: The zone group the bucket belongs to, passed to the S3
client as its region.
+ description: The name of the zone group of the Ceph Object Gateway,
used as the region of the requests. Required when `getObject` is true.
type: string
example: "zonegroup1"
+ dataTypes:
+ out:
+ headers:
+ ceph-event-id:
+ title: Event ID
+ description: The ID of the event, unique for each event, to spot
duplicates. Also set as `ce-cepheventid`.
+ type: string
+ ceph-opaque-data:
+ title: Opaque Data
+ description: The free-form text attached to the Ceph topic by
whoever set it up, empty when none. Also set as `ce-cephopaquedata`.
+ type: string
+ ceph-object-metadata:
+ title: Object Metadata
+ description: The user metadata of the file (the `x-amz-meta-`
attributes), as a List of entries with a `key` and a `val`. Also set as
`ce-cephobjectmetadata`.
+ type: array
+ ceph-object-tags:
+ title: Object Tags
+ description: The tags of the file, as a List of entries with a `key`
and a `val`. Also set as `ce-cephobjecttags`.
+ type: array
dependencies:
- "camel:kafka"
- "camel:jsonpath"
diff --git a/kamelets/ceph-sink.kamelet.yaml b/kamelets/ceph-sink.kamelet.yaml
index 772246876..d35597fcd 100644
--- a/kamelets/ceph-sink.kamelet.yaml
+++ b/kamelets/ceph-sink.kamelet.yaml
@@ -31,7 +31,16 @@ metadata:
spec:
definition:
title: "Ceph Sink"
- description: Upload data to an Ceph Bucket managed by a Object Storage
Gateway.
+ description: |-
+ Uploads each message as a file (object) to a bucket of a Ceph Object
Gateway, the S3-compatible storage of Ceph.
+
+ Use it to store data in Ceph, such as reports, exports, images or
received messages to keep as an archive. For MinIO use `minio-sink`, and for
Amazon S3 use `aws-s3-sink`.
+
+ Input: the body is the content of the file, as text, bytes or a stream.
The key (the name of the file in the bucket) comes from the optional `file`
header, or the `ce-file` header; when neither is set it is `keyName`, or a
generated unique name when `keyName` is not set either.
+
+ Output: the body is unchanged.
+
+ Good to know: a file with the same key is overwritten, so with `keyName`
set and no `file` header each message replaces the previous one. The bucket is
addressed as part of the host name (such as `my-bucket.ceph.example.com`)
unless `cephUrl` uses an IP address, so the gateway must accept that style of
address.
required:
- cephUrl
- accessKey
@@ -42,40 +51,54 @@ spec:
properties:
bucketName:
title: Bucket Name
- description: The Ceph Bucket name.
+ description: The name of the bucket to store the files in.
type: string
+ example: my-bucket
accessKey:
title: Access Key
- description: The access key.
+ description: The S3 access key of a Ceph Object Gateway user, as shown
by `radosgw-admin user info`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key.
+ description: The S3 secret key that goes with `accessKey`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
zoneGroup:
title: Bucket Zone Group
- description: The bucket zone group.
+ description: The name of the zone group of the Ceph Object Gateway,
used as the region of the requests. A Ceph cluster that was not set up with
several zone groups uses `default`.
type: string
+ example: default
autoCreateBucket:
title: Autocreate Bucket
- description: Specifies to automatically create the bucket.
+ description: If true, the bucket is created when it does not exist
yet. If false, the bucket must already exist.
type: boolean
default: false
cephUrl:
title: Ceph Url Address
- description: Set the Ceph Object Storage Address Url.
+ description: The address of the Ceph Object Gateway (RGW), as a URL
with the scheme and the port.
type: string
- example: "http://ceph-storage-address.com"
+ example: "http://ceph-rgw.example.com:7480"
keyName:
title: Key Name
- description: The key name for saving an element in the bucket.
+ description: The key to store the files under, with its folder if any,
used when a message has no `file` or `ce-file` header. When it is not set
either, each file gets a generated unique name.
type: string
+ example: reports/latest.csv
+ dataTypes:
+ in:
+ headers:
+ file:
+ title: File Name
+ description: The key to store the file under, such as
`reports/january.csv`. It takes precedence over `keyName`.
+ type: string
+ ce-file:
+ title: File Name
+ description: The key to store the file under, used when the `file`
header is not set. It takes precedence over `keyName`.
+ type: string
dependencies:
- "camel:aws2-s3"
- "camel:kamelet"
diff --git a/kamelets/ceph-source.kamelet.yaml
b/kamelets/ceph-source.kamelet.yaml
index 6a6e4ed3b..bfec49ff1 100644
--- a/kamelets/ceph-source.kamelet.yaml
+++ b/kamelets/ceph-source.kamelet.yaml
@@ -31,7 +31,14 @@ metadata:
spec:
definition:
title: "Ceph Source"
- description: Receive data from an Ceph Bucket, managed by a Object Storage
Gateway.
+ description: |-
+ Reads the files (objects) in a bucket of a Ceph Object Gateway, one
message per file, and by default deletes each file once it has been read.
+
+ Use it to process files that another system drops into a Ceph bucket,
such as uploaded documents, exported reports or log files. To react to the
bucket notifications of Ceph instead of reading the bucket over and over, use
`ceph-event-based-source`.
+
+ Output: the body is the content of the file, as bytes. The headers give
the bucket name, the key (the path of the file in the bucket, `CamelAwsS3Key`),
the content type and the ETag of the file.
+
+ Good to know: files are deleted from the bucket after they are read,
unless `deleteAfterRead` is set to false; then the same files are read again on
every poll. Files in folders are read too. The bucket is addressed as part of
the host name (such as `my-bucket.ceph.example.com`) unless `cephUrl` uses an
IP address, so the gateway must accept that style of address.
required:
- cephUrl
- accessKey
@@ -42,61 +49,86 @@ spec:
properties:
bucketName:
title: Bucket Name
- description: The Ceph Bucket name.
+ description: The name of the bucket to read the files from.
type: string
+ example: my-bucket
deleteAfterRead:
title: Auto-delete Objects
- description: Specifies to delete objects after consuming them.
+ description: If true, each file is deleted from the bucket after it
has been read. Set it to false to keep the files; they are then read again on
every poll.
type: boolean
default: true
accessKey:
title: Access Key
- description: The access key.
+ description: The S3 access key of a Ceph Object Gateway user, as shown
by `radosgw-admin user info`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key.
+ description: The S3 secret key that goes with `accessKey`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
zoneGroup:
title: Bucket Zone Group
- description: The bucket zone group.
+ description: The name of the zone group of the Ceph Object Gateway,
used as the region of the requests. A Ceph cluster that was not set up with
several zone groups uses `default`.
type: string
+ example: default
autoCreateBucket:
title: Autocreate Bucket
- description: Specifies to automatically create the bucket.
+ description: If true, the bucket is created when it does not exist
yet. If false, every poll fails while the bucket does not exist.
type: boolean
default: false
includeBody:
title: Include Body
- description: If true, the exchange is consumed and put into the body
and closed. If false, the Object stream is put raw into the body and the
headers are set with the object metadata.
+ description: If true, the body is the content of the file, as bytes.
If false, the body is a stream of the content, which suits large files.
type: boolean
default: true
prefix:
title: Prefix
- description: The bucket prefix to consider while searching.
+ description: Read only the files whose key starts with this text, such
as a folder name followed by `/`. When it is not set, all the files of the
bucket are read.
type: string
example: 'folder/'
ignoreBody:
title: Ignore Body
- description: If true, the Object body is ignored. Setting this to true
overrides any behavior defined by the `includeBody` option. If false, the
object is put in the body.
+ description: If true, the content of the file is not read, and the
body is empty; only the headers describe the file. It takes precedence over
`includeBody`.
type: boolean
default: false
cephUrl:
title: Ceph Url Address
- description: Set the Ceph Object Storage Address Url.
+ description: The address of the Ceph Object Gateway (RGW), as a URL
with the scheme and the port.
type: string
- example: "http://ceph-storage-address.com"
+ example: "http://ceph-rgw.example.com:7480"
delay:
title: Delay
- description: The number of milliseconds before the next poll of the
selected bucket.
+ description: How long to wait between two polls of the bucket, in
milliseconds.
type: integer
default: 500
+ dataTypes:
+ out:
+ headers:
+ CamelAwsS3BucketName:
+ title: Bucket Name
+ description: The name of the bucket the file was read from.
+ type: string
+ CamelAwsS3Key:
+ title: Key
+ description: The key of the file, its path in the bucket, such as
`reports/january.csv`.
+ type: string
+ CamelAwsS3ContentType:
+ title: Content Type
+ description: The content type the file was stored with, such as
`application/octet-stream`.
+ type: string
+ CamelAwsS3ContentLength:
+ title: Content Length
+ description: The size of the file, in bytes.
+ type: integer
+ CamelAwsS3ETag:
+ title: ETag
+ description: The ETag of the file, which changes when its content
changes.
+ type: string
dependencies:
- "camel:aws2-s3"
- "camel:kamelet"
diff --git a/kamelets/github-commit-source.kamelet.yaml
b/kamelets/github-commit-source.kamelet.yaml
index 7243fa95d..8cd920a77 100644
--- a/kamelets/github-commit-source.kamelet.yaml
+++ b/kamelets/github-commit-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Commit Source"
- description: Receive commit From GitHub.
+ description: |-
+ Receives each new commit on a branch of a GitHub repository, one message
per commit, oldest first, by asking the GitHub API for new commits.
+
+ Use it to start a flow when code is pushed, for example to post the
commit message to a chat channel or to trigger a build or a deployment.
+
+ Output: the body is the commit message as JSON text, that is a quoted
JSON string such as `"Fix the login page"`. The `CamelGitHubCommitSha` header
gives the SHA of the commit, `CamelGitHubCommitUrl` its web address, and
`CamelGitHubCommitAuthor` and `CamelGitHubCommitCommitter` the names of its
author and committer.
+
+ Good to know: with the default `startingSha` of `last`, only the commits
made after the start are sent. It works with github.com, not with GitHub
Enterprise Server. It asks GitHub for new commits about twice a second, and
every request counts against the API rate limit of the token.
required:
- repoName
- repoOwner
@@ -41,33 +48,56 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
startingSha:
title: Starting SHA
- description: The SHA from which we want to consume, possible values
beginning, last or a specific SHA
+ description: Where to start. `last` sends only the commits made after
the start, `beginning` also sends the commits already on the branch, and the
SHA of a commit sends the commits made after that one.
type: string
default: last
+ example: 8aed4eb7f8fa1877d215a331a2a682edc4e26932
branch:
- title: Branch
- description: The branch we want to consume commit from
+ title: Branch
+ description: The name of the branch to watch for new commits.
type: string
+ example: main
delay:
title: Delay
description: The number of milliseconds before the next poll
type: integer
default: 60000
+ dataTypes:
+ out:
+ headers:
+ CamelGitHubCommitSha:
+ title: Commit SHA
+ description: The SHA of the commit.
+ type: string
+ CamelGitHubCommitUrl:
+ title: Commit URL
+ description: The address of the commit on github.com.
+ type: string
+ CamelGitHubCommitAuthor:
+ title: Author
+ description: The name of the author of the commit.
+ type: string
+ CamelGitHubCommitCommitter:
+ title: Committer
+ description: The name of the committer of the commit.
+ type: string
types:
out:
mediaType: application/json
diff --git a/kamelets/github-event-source.kamelet.yaml
b/kamelets/github-event-source.kamelet.yaml
index 09d0e18f0..e9c3c7c58 100644
--- a/kamelets/github-event-source.kamelet.yaml
+++ b/kamelets/github-event-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Event Source"
- description: Receive Events From a GitHub Repository.
+ description: |-
+ Receives the activity of a GitHub repository, such as pushes, issues,
pull requests and stars, one message per event, by asking the GitHub API for
new events.
+
+ Use it to follow everything that happens in a repository in one flow,
for example to log it or to count it. To receive only commits, pull requests,
comments on pull requests or tags, use `github-commit-source`,
`github-pullrequest-source`, `github-pullrequest-comment-source` or
`github-tag-source`.
+
+ Output: the body is the type of the event as JSON text, that is a quoted
JSON string such as `"PUSH"`, `"PULL_REQUEST"` or `"ISSUES"`. The details of
the event are only in the `CamelGitHubEventPayload` header, as a Java object.
+
+ Good to know: when it starts, it first sends the recent events that
GitHub still lists for the repository, not only the new ones. It works with
github.com, not with GitHub Enterprise Server. It asks GitHub for new events
about twice a second, and every request counts against the API rate limit of
the token.
required:
- repoName
- repoOwner
@@ -39,15 +46,17 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name.
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner.
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token.
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository.
type: string
format: password
x-descriptors:
@@ -57,6 +66,13 @@ spec:
description: The number of milliseconds before the next poll
type: integer
default: 60000
+ dataTypes:
+ out:
+ headers:
+ CamelGitHubEventPayload:
+ title: Event Payload
+ description: The event, with who did it, when and its details, as a
Java object of the GitHub library (`GHEventInfo`).
+ type: object
types:
out:
mediaType: application/json
diff --git a/kamelets/github-pullrequest-comment-source.kamelet.yaml
b/kamelets/github-pullrequest-comment-source.kamelet.yaml
index 811620278..7822a4603 100644
--- a/kamelets/github-pullrequest-comment-source.kamelet.yaml
+++ b/kamelets/github-pullrequest-comment-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Pull Request Comments Source"
- description: Receive pull request Comments From GitHub.
+ description: |-
+ Receives each new comment written on the open pull requests of a GitHub
repository, one message per comment, by asking the GitHub API for new comments.
+
+ Use it to react to the discussion on pull requests, for example to
answer a command written in a comment, such as `/retest`, or to forward the
comments to a chat channel. To receive the pull requests themselves, use
`github-pullrequest-source`.
+
+ Output: the body is the comment as JSON text. The
`CamelGitHubPullRequest` header gives the number of the pull request it was
written on.
+
+ Good to know: only the comments written after the start are sent, and
only on pull requests that are still open. These are the comments of the
conversation of a pull request, not the review comments on lines of code. It
works with github.com, not with GitHub Enterprise Server. About twice a second
it asks GitHub for the open pull requests and for the comments of each of them,
and every request counts against the API rate limit of the token.
required:
- repoName
- repoOwner
@@ -39,15 +46,17 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository and its pull requests.
type: string
format: password
x-descriptors:
@@ -57,6 +66,13 @@ spec:
description: The number of milliseconds before the next poll
type: integer
default: 60000
+ dataTypes:
+ out:
+ headers:
+ CamelGitHubPullRequest:
+ title: Pull Request Number
+ description: The number of the pull request the comment was written
on.
+ type: integer
types:
out:
mediaType: application/json
diff --git a/kamelets/github-pullrequest-source.kamelet.yaml
b/kamelets/github-pullrequest-source.kamelet.yaml
index 0b75f01ce..ee55d40f8 100644
--- a/kamelets/github-pullrequest-source.kamelet.yaml
+++ b/kamelets/github-pullrequest-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Pull Request Source"
- description: Receive pull request From GitHub.
+ description: |-
+ Receives each new pull request opened in a GitHub repository, one
message per pull request, by asking the GitHub API for new open pull requests.
+
+ Use it to react when someone proposes a change, for example to announce
the pull request in a chat channel, open a review ticket or start a check. To
receive the comments on pull requests, use `github-pullrequest-comment-source`.
+
+ Output: the body is the pull request as JSON text. The
`CamelGitHubPullRequest` header gives its number, and
`CamelGitHubPullRequestHeadCommitSha` the SHA of its latest commit.
+
+ Good to know: only the pull requests opened after the start are sent,
once each; updates, merges and closes are not. It works with github.com, not
with GitHub Enterprise Server. It asks GitHub for new pull requests about twice
a second, and every request counts against the API rate limit of the token.
required:
- repoName
- repoOwner
@@ -39,15 +46,17 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository and its pull requests.
type: string
format: password
x-descriptors:
@@ -57,6 +66,17 @@ spec:
description: The number of milliseconds before the next poll
type: integer
default: 60000
+ dataTypes:
+ out:
+ headers:
+ CamelGitHubPullRequest:
+ title: Pull Request Number
+ description: The number of the pull request, as in
`https://github.com/apache/camel/pull/42`.
+ type: integer
+ CamelGitHubPullRequestHeadCommitSha:
+ title: Head Commit SHA
+ description: The SHA of the latest commit of the pull request.
+ type: string
types:
out:
mediaType: application/json
diff --git a/kamelets/github-tag-source.kamelet.yaml
b/kamelets/github-tag-source.kamelet.yaml
index 4cf816f13..e67cf3b10 100644
--- a/kamelets/github-tag-source.kamelet.yaml
+++ b/kamelets/github-tag-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Tag Source"
- description: Receive Tags From a GitHub Repository.
+ description: |-
+ Receives each new tag created in a GitHub repository, one message per
tag, by asking the GitHub API for the tags of the repository.
+
+ Use it to react to a new version, for example to announce a release,
update a changelog or start a deployment. To receive every commit instead, use
`github-commit-source`.
+
+ Output: the body is the tag as JSON text.
+
+ Good to know: only the tags created after the start are sent; the tags
that exist when it starts are skipped. It works with github.com, not with
GitHub Enterprise Server. It asks GitHub for the tags about twice a second, and
every request counts against the API rate limit of the token.
required:
- repoName
- repoOwner
@@ -39,15 +46,17 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository.
type: string
format: password
x-descriptors:
diff --git a/kamelets/kubernetes-namespaces-source.kamelet.yaml
b/kamelets/kubernetes-namespaces-source.kamelet.yaml
index 73e19f85b..d24e8b0e6 100644
--- a/kamelets/kubernetes-namespaces-source.kamelet.yaml
+++ b/kamelets/kubernetes-namespaces-source.kamelet.yaml
@@ -30,23 +30,42 @@ metadata:
spec:
definition:
title: "Kubernetes Namespaces Source"
- description: Consume Events from Kubernetes Namespaces
+ description: |-
+ Watches the namespaces of a Kubernetes cluster and sends a message each
time a namespace is created, changed or deleted.
+
+ Use it to react when teams or applications are added to or removed from
a cluster, for example to set up monitoring, quotas or access for each new
namespace. For pods or nodes, use `kubernetes-pods-source` or
`kubernetes-nodes-source`.
+
+ Output: the body is the namespace as JSON text, in the same shape as
`kubectl get namespace <name> -o json`. The `CamelKubernetesEventAction` header
says what happened: `ADDED`, `MODIFIED` or `DELETED`.
+
+ Good to know: when it starts, it first sends an `ADDED` message for
every namespace that already exists. The token must be allowed to list and
watch namespaces, which is a cluster-wide permission.
required:
- token
- masterUrl
type: object
properties:
token:
- title: Oauth Token
- description: The Auth Token to connect to Kubernetes Cluster
+ title: Token
+ description: A bearer token to log in to the Kubernetes API with, such
as the token of a service account created with `kubectl create token
<service-account>`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
masterUrl:
title: Kubernetes Master URL
- description: The Kubernetes Cluster Master URL
+ description: The address of the Kubernetes API server, as a URL that
starts with `https://`, such as the `server` of the cluster in your kubeconfig
file.
type: string
+ example: https://my-cluster.example.com:6443
+ dataTypes:
+ out:
+ headers:
+ CamelKubernetesEventAction:
+ title: Event Action
+ description: What happened to the namespace, such as `ADDED`,
`MODIFIED` or `DELETED`.
+ type: string
+ CamelKubernetesEventTimestamp:
+ title: Event Timestamp
+ description: When the event was received, in milliseconds since 1
January 1970.
+ type: integer
types:
out:
mediaType: application/json
diff --git a/kamelets/kubernetes-nodes-source.kamelet.yaml
b/kamelets/kubernetes-nodes-source.kamelet.yaml
index 52af7bd58..a8cc908c3 100644
--- a/kamelets/kubernetes-nodes-source.kamelet.yaml
+++ b/kamelets/kubernetes-nodes-source.kamelet.yaml
@@ -30,27 +30,47 @@ metadata:
spec:
definition:
title: "Kubernetes Nodes Source"
- description: Consume Events from Kubernetes Nodes
+ description: |-
+ Watches the nodes (the machines) of a Kubernetes cluster and sends a
message each time a node is added, changed or removed.
+
+ Use it to react to changes in the capacity or the health of a cluster,
for example to alert when a node is not ready or when a node joins or leaves.
For pods or namespaces, use `kubernetes-pods-source` or
`kubernetes-namespaces-source`.
+
+ Output: the body is the node as JSON text, in the same shape as `kubectl
get node <name> -o json`. The `CamelKubernetesEventAction` header says what
happened: `ADDED`, `MODIFIED` or `DELETED`.
+
+ Good to know: when it starts, it first sends an `ADDED` message for
every node that already exists. The status of a node is updated often, so
expect many `MODIFIED` messages. The token must be allowed to list and watch
nodes, which is a cluster-wide permission.
required:
- token
- masterUrl
type: object
properties:
token:
- title: Oauth Token
- description: The Auth Token to connect to Kubernetes Cluster
+ title: Token
+ description: A bearer token to log in to the Kubernetes API with, such
as the token of a service account created with `kubectl create token
<service-account>`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
masterUrl:
title: Kubernetes Master URL
- description: The Kubernetes Cluster Master URL
+ description: The address of the Kubernetes API server, as a URL that
starts with `https://`, such as the `server` of the cluster in your kubeconfig
file.
type: string
+ example: https://my-cluster.example.com:6443
resourceName:
title: Resource Name
- description: The Resource Name we want to watch
+ description: The name of the one node to watch. When it is not set,
all the nodes are watched.
type: string
+ example: worker-1
+ dataTypes:
+ out:
+ headers:
+ CamelKubernetesEventAction:
+ title: Event Action
+ description: What happened to the node, such as `ADDED`, `MODIFIED`
or `DELETED`.
+ type: string
+ CamelKubernetesEventTimestamp:
+ title: Event Timestamp
+ description: When the event was received, in milliseconds since 1
January 1970.
+ type: integer
types:
out:
mediaType: application/json
diff --git a/kamelets/kubernetes-pods-source.kamelet.yaml
b/kamelets/kubernetes-pods-source.kamelet.yaml
index 6a60df7db..59c6d0afd 100644
--- a/kamelets/kubernetes-pods-source.kamelet.yaml
+++ b/kamelets/kubernetes-pods-source.kamelet.yaml
@@ -30,27 +30,47 @@ metadata:
spec:
definition:
title: "Kubernetes Pods Source"
- description: Consume Events from Kubernetes Pods
+ description: |-
+ Watches the pods of a Kubernetes cluster and sends a message each time a
pod is added, changed or deleted, in any namespace.
+
+ Use it to react to what happens to workloads, for example to alert when
a pod fails or restarts, or to keep an inventory of running pods. For nodes or
namespaces, use `kubernetes-nodes-source` or `kubernetes-namespaces-source`.
+
+ Output: the body is the pod as JSON text, in the same shape as `kubectl
get pod <name> -o json`. The `CamelKubernetesEventAction` header says what
happened: `ADDED`, `MODIFIED` or `DELETED`.
+
+ Good to know: when it starts, it first sends an `ADDED` message for
every pod that already exists. A pod changes often, so expect many `MODIFIED`
messages. It watches the pods of all namespaces: `resourceName` has no effect.
The token must be allowed to list and watch pods in all namespaces.
required:
- token
- masterUrl
type: object
properties:
token:
- title: Oauth Token
- description: The Auth Token to connect to Kubernetes Cluster
+ title: Token
+ description: A bearer token to log in to the Kubernetes API with, such
as the token of a service account created with `kubectl create token
<service-account>`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
masterUrl:
title: Kubernetes Master URL
- description: The Kubernetes Cluster Master URL
+ description: The address of the Kubernetes API server, as a URL that
starts with `https://`, such as the `server` of the cluster in your kubeconfig
file.
type: string
+ example: https://my-cluster.example.com:6443
resourceName:
title: Resource Name
- description: The Resource Name we want to watch
+ description: Meant to watch only the pod with this name, but it has no
effect, as this Kamelet watches the pods of all namespaces.
type: string
+ example: web-1
+ dataTypes:
+ out:
+ headers:
+ CamelKubernetesEventAction:
+ title: Event Action
+ description: What happened to the pod, such as `ADDED`, `MODIFIED`
or `DELETED`.
+ type: string
+ CamelKubernetesEventTimestamp:
+ title: Event Timestamp
+ description: When the event was received, in milliseconds since 1
January 1970.
+ type: integer
types:
out:
mediaType: application/json
diff --git a/kamelets/minio-sink.kamelet.yaml b/kamelets/minio-sink.kamelet.yaml
index 8c506b891..9a977d473 100644
--- a/kamelets/minio-sink.kamelet.yaml
+++ b/kamelets/minio-sink.kamelet.yaml
@@ -30,7 +30,16 @@ metadata:
spec:
definition:
title: "Minio Sink"
- description: Upload data to MinIO.
+ description: |-
+ Uploads each message as a file (object) to a bucket in MinIO, the
S3-compatible object storage.
+
+ Use it to store data in MinIO, such as reports, exports, images or
received messages to keep as an archive. For Amazon S3 use `aws-s3-sink`, and
for the S3 gateway of Ceph use `ceph-sink`.
+
+ Input: the body is the content of the file, as text, bytes or a stream.
When `keyName` is set, every message is stored under that name. Otherwise the
name of the file comes from the optional `file` header, or the `ce-file`
header, and is a generated unique name when neither is set.
+
+ Output: the body is unchanged. The `CamelMinioObjectName` header holds
the name the file was stored under, unless `keyName` is set.
+
+ Good to know: a file with the same name is overwritten, so with
`keyName` set each message replaces the previous one. When `keyName` is set,
the `file` and `ce-file` headers are ignored.
required:
- bucketName
- accessKey
@@ -40,36 +49,49 @@ spec:
properties:
bucketName:
title: Bucket Name
- description: The Minio Bucket name.
+ description: The name of the bucket to store the files in.
type: string
+ example: my-bucket
accessKey:
title: Access Key
- description: The access key obtained from MinIO.
+ description: The access key to log in to MinIO with, such as the
access key of a key pair created in the MinIO Console, or the name of a MinIO
user.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key obtained from MinIO.
+ description: The secret key that goes with `accessKey`, or the
password of the MinIO user.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
endpoint:
title: Endpoint
- description: The MinIO Endpoint. You can specify an URL, domain name,
IPv4 address, or IPv6 address.
+ description: The address of the MinIO server, as a URL with the port,
such as `http://localhost:9000`. Use `https://` when the server has TLS.
type: string
example: http://localhost:9000
autoCreateBucket:
title: Autocreate Bucket
- description: Specify to automatically create the MinIO bucket.
+ description: If true, the bucket is created when it does not exist
yet. If false, the bucket must already exist.
type: boolean
default: false
keyName:
title: Key Name
- description: The key name for saving an element in the bucket.
+ description: The name to store every file under, with its folder if
any. When it is not set, the name comes from the `file` or `ce-file` header of
each message, or is generated.
type: string
+ example: reports/latest.csv
+ dataTypes:
+ in:
+ headers:
+ file:
+ title: File Name
+ description: The name to store the file under, such as
`reports/january.csv`. Ignored when `keyName` is set.
+ type: string
+ ce-file:
+ title: File Name
+ description: The name to store the file under, used when the `file`
header is not set. Ignored when `keyName` is set.
+ type: string
dependencies:
- "camel:minio"
- "camel:kamelet"
diff --git a/kamelets/minio-source.kamelet.yaml
b/kamelets/minio-source.kamelet.yaml
index b4c5f8145..bb7a417f1 100644
--- a/kamelets/minio-source.kamelet.yaml
+++ b/kamelets/minio-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "Minio Source"
- description: Receive data from MinIO.
+ description: |-
+ Reads the files (objects) in a MinIO bucket, one message per file, and
by default deletes each file once it has been read.
+
+ Use it to process files that another system drops into a MinIO bucket,
such as uploaded documents, exported reports or log files. For Amazon S3 use
`aws-s3-source`, and for the S3 gateway of Ceph use `ceph-source`.
+
+ Output: the body is the content of the file, as bytes. The headers give
the bucket name, the name of the file (`CamelMinioObjectName`), and its content
type, size, ETag and last modified date.
+
+ Good to know: files are deleted from the bucket after they are read,
unless `deleteAfterRead` is set to false; then the same files are read again on
every poll, about twice a second. Only the files at the top of the bucket are
read: a file in a folder, such as `reports/january.csv`, is not.
required:
- bucketName
- accessKey
@@ -40,37 +47,61 @@ spec:
properties:
bucketName:
title: Bucket Name
- description: The MinIO Bucket name.
+ description: The name of the bucket to read the files from.
type: string
+ example: my-bucket
deleteAfterRead:
title: Auto-delete Objects
- description: Delete objects after consuming them.
+ description: If true, each file is deleted from the bucket after it
has been read. Set it to false to keep the files; they are then read again on
every poll.
type: boolean
default: true
accessKey:
title: Access Key
- description: The access key obtained from MinIO.
+ description: The access key to log in to MinIO with, such as the
access key of a key pair created in the MinIO Console, or the name of a MinIO
user.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key obtained from MinIO.
+ description: The secret key that goes with `accessKey`, or the
password of the MinIO user.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
endpoint:
title: Endpoint
- description: The MinIO Endpoint. You can specify an URL, domain name,
IPv4 address, or IPv6 address.
+ description: The address of the MinIO server, as a URL with the port,
such as `http://localhost:9000`. Use `https://` when the server has TLS.
type: string
example: http://localhost:9000
autoCreateBucket:
title: Autocreate Bucket
- description: Specifies to automatically create the MinIO bucket.
+ description: If true, the bucket is created when it does not exist
yet. If false, every poll fails while the bucket does not exist.
type: boolean
default: false
+ dataTypes:
+ out:
+ headers:
+ CamelMinioBucketName:
+ title: Bucket Name
+ description: The name of the bucket the file was read from.
+ type: string
+ CamelMinioObjectName:
+ title: Object Name
+ description: The name of the file in the bucket, such as
`invoice-42.pdf`.
+ type: string
+ CamelMinioContentType:
+ title: Content Type
+ description: The content type the file was stored with, such as
`application/octet-stream`.
+ type: string
+ CamelMinioContentLength:
+ title: Content Length
+ description: The size of the file, in bytes.
+ type: integer
+ CamelMinioETag:
+ title: ETag
+ description: The ETag of the file, which changes when its content
changes.
+ type: string
dependencies:
- "camel:minio"
- "camel:kamelet"
diff --git a/kamelets/webhook-source.kamelet.yaml
b/kamelets/webhook-source.kamelet.yaml
index 7ae8e6538..b916a45ab 100644
--- a/kamelets/webhook-source.kamelet.yaml
+++ b/kamelets/webhook-source.kamelet.yaml
@@ -30,15 +30,37 @@ metadata:
spec:
definition:
title: "Webhook Source"
- description: Creates an HTTP endpoint that can be used as a bridge to
forward data to the Kamelet sink.
+ description: |-
+ Receives HTTP requests on a path of its own, such as `/webhook`, and
sends each request on as a message, with its body and headers.
+
+ Use it to receive the webhook calls of an online service, such as a
payment, form or code hosting service, or to let another system push data with
a simple HTTP POST. To fetch a URL at a regular interval instead, use
`http-source`.
+
+ Output: the body is the body of the request, as a stream, and is empty
for a request without a body, such as a GET. The HTTP headers of the request
become headers of the message, and so does each query parameter.
`CamelHttpMethod` gives the method (such as `POST`), `CamelHttpPath` the path
and `CamelHttpQuery` the query string. A form
(`application/x-www-form-urlencoded`) arrives as a Map of its fields instead.
+
+ Good to know: there is no login, so anyone who can reach the address can
send messages; protect it with network rules or a gateway in front, and treat
the content as untrusted. It accepts every HTTP method, on the exact path only.
It listens on the HTTP port of the application, 8080 by default with Camel
JBang. The caller gets back the message as it is at the end of the flow: by
default the body it sent, with status 200, or status 204 when there is no body.
type: object
properties:
subpath:
title: Subpath
- description: |
- The subpath where the webhook is registered
+ description: The path to receive the requests on, without a leading
`/`. For example, `hooks/orders` receives the requests sent to
`http://<host>:<port>/hooks/orders`.
type: string
default: "webhook"
+ example: hooks/orders
+ dataTypes:
+ out:
+ headers:
+ CamelHttpMethod:
+ title: HTTP Method
+ description: The method of the request, such as `POST` or `GET`.
+ type: string
+ CamelHttpPath:
+ title: HTTP Path
+ description: The path of the request, such as `/webhook`.
+ type: string
+ CamelHttpQuery:
+ title: HTTP Query
+ description: The query string of the request, without the `?`, such
as `source=shop`. Each query parameter is also a header of its own.
+ type: string
dependencies:
- "camel:platform-http"
- "camel:kamelet"
diff --git
a/library/camel-kamelets-catalog/src/test/java/org/apache/camel/kamelets/catalog/KameletsCatalogTest.java
b/library/camel-kamelets-catalog/src/test/java/org/apache/camel/kamelets/catalog/KameletsCatalogTest.java
index 0723ee6fa..cc3c1d822 100644
---
a/library/camel-kamelets-catalog/src/test/java/org/apache/camel/kamelets/catalog/KameletsCatalogTest.java
+++
b/library/camel-kamelets-catalog/src/test/java/org/apache/camel/kamelets/catalog/KameletsCatalogTest.java
@@ -226,10 +226,10 @@ public class KameletsCatalogTest {
verifyHeaders("ftp-sink", 6);
verifyHeaders("ftps-source", 15);
verifyHeaders("ftps-sink", 6);
- verifyHeaders("github-commit-source", 7);
- verifyHeaders("github-event-source", 7);
- verifyHeaders("github-pullrequest-comment-source", 7);
- verifyHeaders("github-pullrequest-source", 7);
+ verifyHeaders("github-commit-source", 4);
+ verifyHeaders("github-event-source", 1);
+ verifyHeaders("github-pullrequest-comment-source", 1);
+ verifyHeaders("github-pullrequest-source", 2);
verifyHeaders("github-tag-source", 7);
verifyHeaders("google-bigquery-sink", 4);
verifyHeaders("google-calendar-source", 1);
@@ -266,8 +266,8 @@ public class KameletsCatalogTest {
verifyHeaders("mail-sink", 8);
verifyHeaders("mariadb-source", 0);
verifyHeaders("mariadb-sink", 9);
- verifyHeaders("minio-source", 15);
- verifyHeaders("minio-sink", 23);
+ verifyHeaders("minio-source", 5);
+ verifyHeaders("minio-sink", 2);
verifyHeaders("mongodb-changes-stream-source", 3);
verifyHeaders("mongodb-sink", 12);
verifyHeaders("mongodb-source", 3);
@@ -314,7 +314,7 @@ public class KameletsCatalogTest {
verifyHeaders("twitter-directmessage-source", 1);
verifyHeaders("twitter-timeline-source", 1);
verifyHeaders("twitter-search-source", 1);
- verifyHeaders("webhook-source", 0);
+ verifyHeaders("webhook-source", 3);
verifyHeaders("wttrin-source", 5);
}
diff --git
a/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
b/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
index 3987b251f..198130e0f 100644
--- a/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
+++ b/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
@@ -564,8 +564,8 @@
"type" : "source",
"supportLevel" : "Preview",
"title" : "Ceph Event Based Source",
- "summary" : "Receive Ceph RGW bucket notifications from a Kafka topic, and
optionally fetch the object each notification refers to.",
- "description" : "Receive Ceph RGW bucket notifications from a Kafka topic,
and optionally fetch the object each notification refers to.",
+ "summary" : "Receives the bucket notifications that a Ceph Object Gateway
sends to a Kafka topic, one message per event, such as a file added to or
deleted from a bucket.",
+ "description" : "Receives the bucket notifications that a Ceph Object
Gateway sends to a Kafka topic, one message per event, such as a file added to
or deleted from a bucket.\n\nUse it to react as soon as a file is uploaded to
or removed from a Ceph bucket, without reading the bucket over and over. Set
`getObject` to true to receive the content of each new file. To read and remove
the files of a bucket instead, use `ceph-source`.\n\nOutput: the body is the
notification as JSON text, [...]
"group" : "Ceph",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -574,8 +574,8 @@
"type" : "sink",
"supportLevel" : "Stable",
"title" : "Ceph Sink",
- "summary" : "Upload data to an Ceph Bucket managed by a Object Storage
Gateway.",
- "description" : "Upload data to an Ceph Bucket managed by a Object Storage
Gateway.",
+ "summary" : "Uploads each message as a file (object) to a bucket of a Ceph
Object Gateway, the S3-compatible storage of Ceph.",
+ "description" : "Uploads each message as a file (object) to a bucket of a
Ceph Object Gateway, the S3-compatible storage of Ceph.\n\nUse it to store data
in Ceph, such as reports, exports, images or received messages to keep as an
archive. For MinIO use `minio-sink`, and for Amazon S3 use
`aws-s3-sink`.\n\nInput: the body is the content of the file, as text, bytes or
a stream. The key (the name of the file in the bucket) comes from the optional
`file` header, or the `ce-file` header; [...]
"group" : "Ceph",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -584,8 +584,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "Ceph Source",
- "summary" : "Receive data from an Ceph Bucket, managed by a Object Storage
Gateway.",
- "description" : "Receive data from an Ceph Bucket, managed by a Object
Storage Gateway.",
+ "summary" : "Reads the files (objects) in a bucket of a Ceph Object
Gateway, one message per file, and by default deletes each file once it has
been read.",
+ "description" : "Reads the files (objects) in a bucket of a Ceph Object
Gateway, one message per file, and by default deletes each file once it has
been read.\n\nUse it to process files that another system drops into a Ceph
bucket, such as uploaded documents, exported reports or log files. To react to
the bucket notifications of Ceph instead of reading the bucket over and over,
use `ceph-event-based-source`.\n\nOutput: the body is the content of the file,
as bytes. The headers give t [...]
"group" : "Ceph",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -944,8 +944,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "GitHub Commit Source",
- "summary" : "Receive commit From GitHub.",
- "description" : "Receive commit From GitHub.",
+ "summary" : "Receives each new commit on a branch of a GitHub repository,
one message per commit, oldest first, by asking the GitHub API for new
commits.",
+ "description" : "Receives each new commit on a branch of a GitHub
repository, one message per commit, oldest first, by asking the GitHub API for
new commits.\n\nUse it to start a flow when code is pushed, for example to post
the commit message to a chat channel or to trigger a build or a
deployment.\n\nOutput: the body is the commit message as JSON text, that is a
quoted JSON string such as `\"Fix the login page\"`. The `CamelGitHubCommitSha`
header gives the SHA of the commit, `Came [...]
"group" : "GitHub",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -954,8 +954,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "GitHub Event Source",
- "summary" : "Receive Events From a GitHub Repository.",
- "description" : "Receive Events From a GitHub Repository.",
+ "summary" : "Receives the activity of a GitHub repository, such as pushes,
issues, pull requests and stars, one message per event, by asking the GitHub
API for new events.",
+ "description" : "Receives the activity of a GitHub repository, such as
pushes, issues, pull requests and stars, one message per event, by asking the
GitHub API for new events.\n\nUse it to follow everything that happens in a
repository in one flow, for example to log it or to count it. To receive only
commits, pull requests, comments on pull requests or tags, use
`github-commit-source`, `github-pullrequest-source`,
`github-pullrequest-comment-source` or `github-tag-source`.\n\nOutput [...]
"group" : "GitHub",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -964,8 +964,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "GitHub Pull Request Comments Source",
- "summary" : "Receive pull request Comments From GitHub.",
- "description" : "Receive pull request Comments From GitHub.",
+ "summary" : "Receives each new comment written on the open pull requests
of a GitHub repository, one message per comment, by asking the GitHub API for
new comments.",
+ "description" : "Receives each new comment written on the open pull
requests of a GitHub repository, one message per comment, by asking the GitHub
API for new comments.\n\nUse it to react to the discussion on pull requests,
for example to answer a command written in a comment, such as `/retest`, or to
forward the comments to a chat channel. To receive the pull requests
themselves, use `github-pullrequest-source`.\n\nOutput: the body is the comment
as JSON text. The `CamelGitHubPullRe [...]
"group" : "GitHub",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -974,8 +974,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "GitHub Pull Request Source",
- "summary" : "Receive pull request From GitHub.",
- "description" : "Receive pull request From GitHub.",
+ "summary" : "Receives each new pull request opened in a GitHub repository,
one message per pull request, by asking the GitHub API for new open pull
requests.",
+ "description" : "Receives each new pull request opened in a GitHub
repository, one message per pull request, by asking the GitHub API for new open
pull requests.\n\nUse it to react when someone proposes a change, for example
to announce the pull request in a chat channel, open a review ticket or start a
check. To receive the comments on pull requests, use
`github-pullrequest-comment-source`.\n\nOutput: the body is the pull request as
JSON text. The `CamelGitHubPullRequest` header giv [...]
"group" : "GitHub",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -984,8 +984,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "GitHub Tag Source",
- "summary" : "Receive Tags From a GitHub Repository.",
- "description" : "Receive Tags From a GitHub Repository.",
+ "summary" : "Receives each new tag created in a GitHub repository, one
message per tag, by asking the GitHub API for the tags of the repository.",
+ "description" : "Receives each new tag created in a GitHub repository, one
message per tag, by asking the GitHub API for the tags of the
repository.\n\nUse it to react to a new version, for example to announce a
release, update a changelog or start a deployment. To receive every commit
instead, use `github-commit-source`.\n\nOutput: the body is the tag as JSON
text.\n\nGood to know: only the tags created after the start are sent; the tags
that exist when it starts are skipped. It wor [...]
"group" : "GitHub",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -1624,8 +1624,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "Kubernetes Namespaces Source",
- "summary" : "Consume Events from Kubernetes Namespaces",
- "description" : "Consume Events from Kubernetes Namespaces",
+ "summary" : "Watches the namespaces of a Kubernetes cluster and sends a
message each time a namespace is created, changed or deleted.",
+ "description" : "Watches the namespaces of a Kubernetes cluster and sends
a message each time a namespace is created, changed or deleted.\n\nUse it to
react when teams or applications are added to or removed from a cluster, for
example to set up monitoring, quotas or access for each new namespace. For pods
or nodes, use `kubernetes-pods-source` or `kubernetes-nodes-source`.\n\nOutput:
the body is the namespace as JSON text, in the same shape as `kubectl get
namespace <name> -o json`. [...]
"group" : "Kubernetes",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -1634,8 +1634,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "Kubernetes Nodes Source",
- "summary" : "Consume Events from Kubernetes Nodes",
- "description" : "Consume Events from Kubernetes Nodes",
+ "summary" : "Watches the nodes (the machines) of a Kubernetes cluster and
sends a message each time a node is added, changed or removed.",
+ "description" : "Watches the nodes (the machines) of a Kubernetes cluster
and sends a message each time a node is added, changed or removed.\n\nUse it to
react to changes in the capacity or the health of a cluster, for example to
alert when a node is not ready or when a node joins or leaves. For pods or
namespaces, use `kubernetes-pods-source` or
`kubernetes-namespaces-source`.\n\nOutput: the body is the node as JSON text,
in the same shape as `kubectl get node <name> -o json`. The ` [...]
"group" : "Kubernetes",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -1644,8 +1644,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "Kubernetes Pods Source",
- "summary" : "Consume Events from Kubernetes Pods",
- "description" : "Consume Events from Kubernetes Pods",
+ "summary" : "Watches the pods of a Kubernetes cluster and sends a message
each time a pod is added, changed or deleted, in any namespace.",
+ "description" : "Watches the pods of a Kubernetes cluster and sends a
message each time a pod is added, changed or deleted, in any namespace.\n\nUse
it to react to what happens to workloads, for example to alert when a pod fails
or restarts, or to keep an inventory of running pods. For nodes or namespaces,
use `kubernetes-nodes-source` or `kubernetes-namespaces-source`.\n\nOutput: the
body is the pod as JSON text, in the same shape as `kubectl get pod <name> -o
json`. The `CamelKuber [...]
"group" : "Kubernetes",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -1754,8 +1754,8 @@
"type" : "sink",
"supportLevel" : "Stable",
"title" : "Minio Sink",
- "summary" : "Upload data to MinIO.",
- "description" : "Upload data to MinIO.",
+ "summary" : "Uploads each message as a file (object) to a bucket in MinIO,
the S3-compatible object storage.",
+ "description" : "Uploads each message as a file (object) to a bucket in
MinIO, the S3-compatible object storage.\n\nUse it to store data in MinIO, such
as reports, exports, images or received messages to keep as an archive. For
Amazon S3 use `aws-s3-sink`, and for the S3 gateway of Ceph use
`ceph-sink`.\n\nInput: the body is the content of the file, as text, bytes or a
stream. When `keyName` is set, every message is stored under that name.
Otherwise the name of the file comes from th [...]
"group" : "Minio",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -1764,8 +1764,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "Minio Source",
- "summary" : "Receive data from MinIO.",
- "description" : "Receive data from MinIO.",
+ "summary" : "Reads the files (objects) in a MinIO bucket, one message per
file, and by default deletes each file once it has been read.",
+ "description" : "Reads the files (objects) in a MinIO bucket, one message
per file, and by default deletes each file once it has been read.\n\nUse it to
process files that another system drops into a MinIO bucket, such as uploaded
documents, exported reports or log files. For Amazon S3 use `aws-s3-source`,
and for the S3 gateway of Ceph use `ceph-source`.\n\nOutput: the body is the
content of the file, as bytes. The headers give the bucket name, the name of
the file (`CamelMinioObjec [...]
"group" : "Minio",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
@@ -2554,8 +2554,8 @@
"type" : "source",
"supportLevel" : "Stable",
"title" : "Webhook Source",
- "summary" : "Creates an HTTP endpoint that can be used as a bridge to
forward data to the Kamelet sink.",
- "description" : "Creates an HTTP endpoint that can be used as a bridge to
forward data to the Kamelet sink.",
+ "summary" : "Receives HTTP requests on a path of its own, such as
`/webhook`, and sends each request on as a message, with its body and headers.",
+ "description" : "Receives HTTP requests on a path of its own, such as
`/webhook`, and sends each request on as a message, with its body and
headers.\n\nUse it to receive the webhook calls of an online service, such as a
payment, form or code hosting service, or to let another system push data with
a simple HTTP POST. To fetch a URL at a regular interval instead, use
`http-source`.\n\nOutput: the body is the body of the request, as a stream, and
is empty for a request without a body, [...]
"group" : "Webhook",
"namespace" : "Cloud",
"provider" : "Apache Software Foundation"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/ceph-event-based-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/ceph-event-based-source.kamelet.yaml
index d115b6bd2..515655226 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/ceph-event-based-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/ceph-event-based-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "Ceph Event Based Source"
- description: Receive Ceph RGW bucket notifications from a Kafka topic, and
optionally fetch the object each notification refers to.
+ description: |-
+ Receives the bucket notifications that a Ceph Object Gateway sends to a
Kafka topic, one message per event, such as a file added to or deleted from a
bucket.
+
+ Use it to react as soon as a file is uploaded to or removed from a Ceph
bucket, without reading the bucket over and over. Set `getObject` to true to
receive the content of each new file. To read and remove the files of a bucket
instead, use `ceph-source`.
+
+ Output: the body is the notification as JSON text, unchanged: a
`Records` array that gives the event name (such as `ObjectCreated:Put`), the
bucket name and the key of the file. The headers `ceph-event-id`,
`ceph-opaque-data`, `ceph-object-metadata` and `ceph-object-tags` give the
fields Ceph adds to the event; metadata and tags are a List of entries with a
`key` and a `val`. Each header is also set with a `ce-` name, such as
`ce-cepheventid`. With `getObject` true, the body of an [...]
+
+ Good to know: the notification and its Kafka topic are set up on the
Ceph side; this Kamelet only reads the topic. A record that is not a Ceph
notification (without a `Records` array) fails. It connects to Kafka with no
login and no TLS unless `saslAuthType` says otherwise. Without `consumerGroup`,
each start uses a new group, so with the default `autoOffsetReset` of `latest`
the events sent while it was stopped are not read.
required:
- topic
- bootstrapServers
@@ -38,72 +45,92 @@ spec:
properties:
topic:
title: Topic Name
- description: The Kafka topic Ceph pushes the bucket notifications to.
+ description: The Kafka topic that the Ceph Object Gateway sends the
bucket notifications to, as set in the push endpoint of the Ceph topic.
type: string
example: "ceph-bucket-notifications"
bootstrapServers:
title: Bootstrap Servers
- description: A comma separated list of Kafka brokers to connect to.
+ description: The address of one or more Kafka brokers to connect to
first, as `host:port`, separated by commas.
type: string
+ example: "broker1:9092,broker2:9092"
consumerGroup:
title: Consumer Group
- description: A string that uniquely identifies the group of consumers
this source belongs to.
+ description: The name of the Kafka consumer group. Kafka remembers how
far the group has read, so a restart continues where it stopped. When it is not
set, a new group is used at each start.
type: string
example: "my-group-id"
autoOffsetReset:
title: Auto Offset Reset
- description: What to do when there is no initial offset. There are 3
enums and the value can be latest, earliest or none.
+ description: Where to start when the consumer group has not read the
topic before. `latest` reads only the events sent from now on, `earliest` reads
the topic from its start, and `none` fails.
type: string
default: "latest"
enum: ["latest", "earliest", "none"]
saslAuthType:
title: Authentication Type
- description: Authentication type to use. Use NONE for no
authentication, PLAIN or SCRAM_SHA_256/SCRAM_SHA_512 for username/password, SSL
for certificate-based, OAUTH for OAuth 2.0, AWS_MSK_IAM for MSK, or KERBEROS
for Kerberos.
+ description: How to log in to Kafka. `NONE` connects with no login and
no TLS, as a local Kafka expects; `PLAIN`, `SCRAM_SHA_256` and `SCRAM_SHA_512`
log in with `saslUsername` and `saslPassword`.
type: string
default: NONE
enum: ["NONE", "PLAIN", "SCRAM_SHA_256", "SCRAM_SHA_512", "SSL",
"OAUTH", "AWS_MSK_IAM", "KERBEROS"]
saslUsername:
title: Username
- description: Username for SASL authentication. Required when
saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.
+ description: The user to log in to Kafka as. Required when
`saslAuthType` is `PLAIN`, `SCRAM_SHA_256` or `SCRAM_SHA_512`.
type: string
x-descriptors:
- urn:camel:group:credentials
saslPassword:
title: Password
- description: Password for SASL authentication. Required when
saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.
+ description: The password of `saslUsername`. Required when
`saslAuthType` is `PLAIN`, `SCRAM_SHA_256` or `SCRAM_SHA_512`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
getObject:
title: Get Object
- description: Fetch the object body from Ceph for ObjectCreated events,
instead of emitting only the notification.
+ description: If true, for each `ObjectCreated` event the file is read
from Ceph and becomes the body, instead of the notification. It needs
`cephUrl`, `accessKey`, `secretKey` and `zoneGroup`.
type: boolean
default: false
cephUrl:
title: Ceph URL
- description: The URL of the Ceph RGW endpoint to fetch objects from.
Required when getObject is true.
+ description: The address of the Ceph Object Gateway (RGW) to read the
files from, as a URL with the scheme and the port. Required when `getObject` is
true.
type: string
example: "http://ceph-rgw:8080"
accessKey:
title: Access Key
- description: The access key to read objects from Ceph. Required when
getObject is true.
+ description: The S3 access key of a Ceph Object Gateway user that can
read the bucket. Required when `getObject` is true.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key to read objects from Ceph. Required when
getObject is true.
+ description: The S3 secret key that goes with `accessKey`. Required
when `getObject` is true.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
zoneGroup:
title: Ceph Zone Group
- description: The zone group the bucket belongs to, passed to the S3
client as its region.
+ description: The name of the zone group of the Ceph Object Gateway,
used as the region of the requests. Required when `getObject` is true.
type: string
example: "zonegroup1"
+ dataTypes:
+ out:
+ headers:
+ ceph-event-id:
+ title: Event ID
+ description: The ID of the event, unique for each event, to spot
duplicates. Also set as `ce-cepheventid`.
+ type: string
+ ceph-opaque-data:
+ title: Opaque Data
+ description: The free-form text attached to the Ceph topic by
whoever set it up, empty when none. Also set as `ce-cephopaquedata`.
+ type: string
+ ceph-object-metadata:
+ title: Object Metadata
+ description: The user metadata of the file (the `x-amz-meta-`
attributes), as a List of entries with a `key` and a `val`. Also set as
`ce-cephobjectmetadata`.
+ type: array
+ ceph-object-tags:
+ title: Object Tags
+ description: The tags of the file, as a List of entries with a `key`
and a `val`. Also set as `ce-cephobjecttags`.
+ type: array
dependencies:
- "camel:kafka"
- "camel:jsonpath"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/ceph-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/ceph-sink.kamelet.yaml
index 772246876..d35597fcd 100644
--- a/library/camel-kamelets/src/main/resources/kamelets/ceph-sink.kamelet.yaml
+++ b/library/camel-kamelets/src/main/resources/kamelets/ceph-sink.kamelet.yaml
@@ -31,7 +31,16 @@ metadata:
spec:
definition:
title: "Ceph Sink"
- description: Upload data to an Ceph Bucket managed by a Object Storage
Gateway.
+ description: |-
+ Uploads each message as a file (object) to a bucket of a Ceph Object
Gateway, the S3-compatible storage of Ceph.
+
+ Use it to store data in Ceph, such as reports, exports, images or
received messages to keep as an archive. For MinIO use `minio-sink`, and for
Amazon S3 use `aws-s3-sink`.
+
+ Input: the body is the content of the file, as text, bytes or a stream.
The key (the name of the file in the bucket) comes from the optional `file`
header, or the `ce-file` header; when neither is set it is `keyName`, or a
generated unique name when `keyName` is not set either.
+
+ Output: the body is unchanged.
+
+ Good to know: a file with the same key is overwritten, so with `keyName`
set and no `file` header each message replaces the previous one. The bucket is
addressed as part of the host name (such as `my-bucket.ceph.example.com`)
unless `cephUrl` uses an IP address, so the gateway must accept that style of
address.
required:
- cephUrl
- accessKey
@@ -42,40 +51,54 @@ spec:
properties:
bucketName:
title: Bucket Name
- description: The Ceph Bucket name.
+ description: The name of the bucket to store the files in.
type: string
+ example: my-bucket
accessKey:
title: Access Key
- description: The access key.
+ description: The S3 access key of a Ceph Object Gateway user, as shown
by `radosgw-admin user info`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key.
+ description: The S3 secret key that goes with `accessKey`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
zoneGroup:
title: Bucket Zone Group
- description: The bucket zone group.
+ description: The name of the zone group of the Ceph Object Gateway,
used as the region of the requests. A Ceph cluster that was not set up with
several zone groups uses `default`.
type: string
+ example: default
autoCreateBucket:
title: Autocreate Bucket
- description: Specifies to automatically create the bucket.
+ description: If true, the bucket is created when it does not exist
yet. If false, the bucket must already exist.
type: boolean
default: false
cephUrl:
title: Ceph Url Address
- description: Set the Ceph Object Storage Address Url.
+ description: The address of the Ceph Object Gateway (RGW), as a URL
with the scheme and the port.
type: string
- example: "http://ceph-storage-address.com"
+ example: "http://ceph-rgw.example.com:7480"
keyName:
title: Key Name
- description: The key name for saving an element in the bucket.
+ description: The key to store the files under, with its folder if any,
used when a message has no `file` or `ce-file` header. When it is not set
either, each file gets a generated unique name.
type: string
+ example: reports/latest.csv
+ dataTypes:
+ in:
+ headers:
+ file:
+ title: File Name
+ description: The key to store the file under, such as
`reports/january.csv`. It takes precedence over `keyName`.
+ type: string
+ ce-file:
+ title: File Name
+ description: The key to store the file under, used when the `file`
header is not set. It takes precedence over `keyName`.
+ type: string
dependencies:
- "camel:aws2-s3"
- "camel:kamelet"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/ceph-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/ceph-source.kamelet.yaml
index 6a6e4ed3b..bfec49ff1 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/ceph-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/ceph-source.kamelet.yaml
@@ -31,7 +31,14 @@ metadata:
spec:
definition:
title: "Ceph Source"
- description: Receive data from an Ceph Bucket, managed by a Object Storage
Gateway.
+ description: |-
+ Reads the files (objects) in a bucket of a Ceph Object Gateway, one
message per file, and by default deletes each file once it has been read.
+
+ Use it to process files that another system drops into a Ceph bucket,
such as uploaded documents, exported reports or log files. To react to the
bucket notifications of Ceph instead of reading the bucket over and over, use
`ceph-event-based-source`.
+
+ Output: the body is the content of the file, as bytes. The headers give
the bucket name, the key (the path of the file in the bucket, `CamelAwsS3Key`),
the content type and the ETag of the file.
+
+ Good to know: files are deleted from the bucket after they are read,
unless `deleteAfterRead` is set to false; then the same files are read again on
every poll. Files in folders are read too. The bucket is addressed as part of
the host name (such as `my-bucket.ceph.example.com`) unless `cephUrl` uses an
IP address, so the gateway must accept that style of address.
required:
- cephUrl
- accessKey
@@ -42,61 +49,86 @@ spec:
properties:
bucketName:
title: Bucket Name
- description: The Ceph Bucket name.
+ description: The name of the bucket to read the files from.
type: string
+ example: my-bucket
deleteAfterRead:
title: Auto-delete Objects
- description: Specifies to delete objects after consuming them.
+ description: If true, each file is deleted from the bucket after it
has been read. Set it to false to keep the files; they are then read again on
every poll.
type: boolean
default: true
accessKey:
title: Access Key
- description: The access key.
+ description: The S3 access key of a Ceph Object Gateway user, as shown
by `radosgw-admin user info`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key.
+ description: The S3 secret key that goes with `accessKey`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
zoneGroup:
title: Bucket Zone Group
- description: The bucket zone group.
+ description: The name of the zone group of the Ceph Object Gateway,
used as the region of the requests. A Ceph cluster that was not set up with
several zone groups uses `default`.
type: string
+ example: default
autoCreateBucket:
title: Autocreate Bucket
- description: Specifies to automatically create the bucket.
+ description: If true, the bucket is created when it does not exist
yet. If false, every poll fails while the bucket does not exist.
type: boolean
default: false
includeBody:
title: Include Body
- description: If true, the exchange is consumed and put into the body
and closed. If false, the Object stream is put raw into the body and the
headers are set with the object metadata.
+ description: If true, the body is the content of the file, as bytes.
If false, the body is a stream of the content, which suits large files.
type: boolean
default: true
prefix:
title: Prefix
- description: The bucket prefix to consider while searching.
+ description: Read only the files whose key starts with this text, such
as a folder name followed by `/`. When it is not set, all the files of the
bucket are read.
type: string
example: 'folder/'
ignoreBody:
title: Ignore Body
- description: If true, the Object body is ignored. Setting this to true
overrides any behavior defined by the `includeBody` option. If false, the
object is put in the body.
+ description: If true, the content of the file is not read, and the
body is empty; only the headers describe the file. It takes precedence over
`includeBody`.
type: boolean
default: false
cephUrl:
title: Ceph Url Address
- description: Set the Ceph Object Storage Address Url.
+ description: The address of the Ceph Object Gateway (RGW), as a URL
with the scheme and the port.
type: string
- example: "http://ceph-storage-address.com"
+ example: "http://ceph-rgw.example.com:7480"
delay:
title: Delay
- description: The number of milliseconds before the next poll of the
selected bucket.
+ description: How long to wait between two polls of the bucket, in
milliseconds.
type: integer
default: 500
+ dataTypes:
+ out:
+ headers:
+ CamelAwsS3BucketName:
+ title: Bucket Name
+ description: The name of the bucket the file was read from.
+ type: string
+ CamelAwsS3Key:
+ title: Key
+ description: The key of the file, its path in the bucket, such as
`reports/january.csv`.
+ type: string
+ CamelAwsS3ContentType:
+ title: Content Type
+ description: The content type the file was stored with, such as
`application/octet-stream`.
+ type: string
+ CamelAwsS3ContentLength:
+ title: Content Length
+ description: The size of the file, in bytes.
+ type: integer
+ CamelAwsS3ETag:
+ title: ETag
+ description: The ETag of the file, which changes when its content
changes.
+ type: string
dependencies:
- "camel:aws2-s3"
- "camel:kamelet"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/github-commit-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/github-commit-source.kamelet.yaml
index 7243fa95d..8cd920a77 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/github-commit-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/github-commit-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Commit Source"
- description: Receive commit From GitHub.
+ description: |-
+ Receives each new commit on a branch of a GitHub repository, one message
per commit, oldest first, by asking the GitHub API for new commits.
+
+ Use it to start a flow when code is pushed, for example to post the
commit message to a chat channel or to trigger a build or a deployment.
+
+ Output: the body is the commit message as JSON text, that is a quoted
JSON string such as `"Fix the login page"`. The `CamelGitHubCommitSha` header
gives the SHA of the commit, `CamelGitHubCommitUrl` its web address, and
`CamelGitHubCommitAuthor` and `CamelGitHubCommitCommitter` the names of its
author and committer.
+
+ Good to know: with the default `startingSha` of `last`, only the commits
made after the start are sent. It works with github.com, not with GitHub
Enterprise Server. It asks GitHub for new commits about twice a second, and
every request counts against the API rate limit of the token.
required:
- repoName
- repoOwner
@@ -41,33 +48,56 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
startingSha:
title: Starting SHA
- description: The SHA from which we want to consume, possible values
beginning, last or a specific SHA
+ description: Where to start. `last` sends only the commits made after
the start, `beginning` also sends the commits already on the branch, and the
SHA of a commit sends the commits made after that one.
type: string
default: last
+ example: 8aed4eb7f8fa1877d215a331a2a682edc4e26932
branch:
- title: Branch
- description: The branch we want to consume commit from
+ title: Branch
+ description: The name of the branch to watch for new commits.
type: string
+ example: main
delay:
title: Delay
description: The number of milliseconds before the next poll
type: integer
default: 60000
+ dataTypes:
+ out:
+ headers:
+ CamelGitHubCommitSha:
+ title: Commit SHA
+ description: The SHA of the commit.
+ type: string
+ CamelGitHubCommitUrl:
+ title: Commit URL
+ description: The address of the commit on github.com.
+ type: string
+ CamelGitHubCommitAuthor:
+ title: Author
+ description: The name of the author of the commit.
+ type: string
+ CamelGitHubCommitCommitter:
+ title: Committer
+ description: The name of the committer of the commit.
+ type: string
types:
out:
mediaType: application/json
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/github-event-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/github-event-source.kamelet.yaml
index 09d0e18f0..e9c3c7c58 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/github-event-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/github-event-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Event Source"
- description: Receive Events From a GitHub Repository.
+ description: |-
+ Receives the activity of a GitHub repository, such as pushes, issues,
pull requests and stars, one message per event, by asking the GitHub API for
new events.
+
+ Use it to follow everything that happens in a repository in one flow,
for example to log it or to count it. To receive only commits, pull requests,
comments on pull requests or tags, use `github-commit-source`,
`github-pullrequest-source`, `github-pullrequest-comment-source` or
`github-tag-source`.
+
+ Output: the body is the type of the event as JSON text, that is a quoted
JSON string such as `"PUSH"`, `"PULL_REQUEST"` or `"ISSUES"`. The details of
the event are only in the `CamelGitHubEventPayload` header, as a Java object.
+
+ Good to know: when it starts, it first sends the recent events that
GitHub still lists for the repository, not only the new ones. It works with
github.com, not with GitHub Enterprise Server. It asks GitHub for new events
about twice a second, and every request counts against the API rate limit of
the token.
required:
- repoName
- repoOwner
@@ -39,15 +46,17 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name.
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner.
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token.
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository.
type: string
format: password
x-descriptors:
@@ -57,6 +66,13 @@ spec:
description: The number of milliseconds before the next poll
type: integer
default: 60000
+ dataTypes:
+ out:
+ headers:
+ CamelGitHubEventPayload:
+ title: Event Payload
+ description: The event, with who did it, when and its details, as a
Java object of the GitHub library (`GHEventInfo`).
+ type: object
types:
out:
mediaType: application/json
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/github-pullrequest-comment-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/github-pullrequest-comment-source.kamelet.yaml
index 811620278..7822a4603 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/github-pullrequest-comment-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/github-pullrequest-comment-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Pull Request Comments Source"
- description: Receive pull request Comments From GitHub.
+ description: |-
+ Receives each new comment written on the open pull requests of a GitHub
repository, one message per comment, by asking the GitHub API for new comments.
+
+ Use it to react to the discussion on pull requests, for example to
answer a command written in a comment, such as `/retest`, or to forward the
comments to a chat channel. To receive the pull requests themselves, use
`github-pullrequest-source`.
+
+ Output: the body is the comment as JSON text. The
`CamelGitHubPullRequest` header gives the number of the pull request it was
written on.
+
+ Good to know: only the comments written after the start are sent, and
only on pull requests that are still open. These are the comments of the
conversation of a pull request, not the review comments on lines of code. It
works with github.com, not with GitHub Enterprise Server. About twice a second
it asks GitHub for the open pull requests and for the comments of each of them,
and every request counts against the API rate limit of the token.
required:
- repoName
- repoOwner
@@ -39,15 +46,17 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository and its pull requests.
type: string
format: password
x-descriptors:
@@ -57,6 +66,13 @@ spec:
description: The number of milliseconds before the next poll
type: integer
default: 60000
+ dataTypes:
+ out:
+ headers:
+ CamelGitHubPullRequest:
+ title: Pull Request Number
+ description: The number of the pull request the comment was written
on.
+ type: integer
types:
out:
mediaType: application/json
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/github-pullrequest-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/github-pullrequest-source.kamelet.yaml
index 0b75f01ce..ee55d40f8 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/github-pullrequest-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/github-pullrequest-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Pull Request Source"
- description: Receive pull request From GitHub.
+ description: |-
+ Receives each new pull request opened in a GitHub repository, one
message per pull request, by asking the GitHub API for new open pull requests.
+
+ Use it to react when someone proposes a change, for example to announce
the pull request in a chat channel, open a review ticket or start a check. To
receive the comments on pull requests, use `github-pullrequest-comment-source`.
+
+ Output: the body is the pull request as JSON text. The
`CamelGitHubPullRequest` header gives its number, and
`CamelGitHubPullRequestHeadCommitSha` the SHA of its latest commit.
+
+ Good to know: only the pull requests opened after the start are sent,
once each; updates, merges and closes are not. It works with github.com, not
with GitHub Enterprise Server. It asks GitHub for new pull requests about twice
a second, and every request counts against the API rate limit of the token.
required:
- repoName
- repoOwner
@@ -39,15 +46,17 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository and its pull requests.
type: string
format: password
x-descriptors:
@@ -57,6 +66,17 @@ spec:
description: The number of milliseconds before the next poll
type: integer
default: 60000
+ dataTypes:
+ out:
+ headers:
+ CamelGitHubPullRequest:
+ title: Pull Request Number
+ description: The number of the pull request, as in
`https://github.com/apache/camel/pull/42`.
+ type: integer
+ CamelGitHubPullRequestHeadCommitSha:
+ title: Head Commit SHA
+ description: The SHA of the latest commit of the pull request.
+ type: string
types:
out:
mediaType: application/json
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/github-tag-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/github-tag-source.kamelet.yaml
index 4cf816f13..e67cf3b10 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/github-tag-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/github-tag-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "GitHub Tag Source"
- description: Receive Tags From a GitHub Repository.
+ description: |-
+ Receives each new tag created in a GitHub repository, one message per
tag, by asking the GitHub API for the tags of the repository.
+
+ Use it to react to a new version, for example to announce a release,
update a changelog or start a deployment. To receive every commit instead, use
`github-commit-source`.
+
+ Output: the body is the tag as JSON text.
+
+ Good to know: only the tags created after the start are sent; the tags
that exist when it starts are skipped. It works with github.com, not with
GitHub Enterprise Server. It asks GitHub for the tags about twice a second, and
every request counts against the API rate limit of the token.
required:
- repoName
- repoOwner
@@ -39,15 +46,17 @@ spec:
properties:
repoName:
title: Repository Name
- description: The GitHub Repository name
+ description: The name of the repository, such as `camel` in
`https://github.com/apache/camel`.
type: string
+ example: camel
repoOwner:
title: Repository Owner
- description: The repository owner
+ description: The user or organization that owns the repository, such
as `apache` in `https://github.com/apache/camel`.
type: string
+ example: apache
oauthToken:
title: OAuth Token
- description: OAuth token
+ description: A GitHub personal access token, created on GitHub under
Settings, Developer settings, Personal access tokens. It needs read access to
the repository.
type: string
format: password
x-descriptors:
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/kubernetes-namespaces-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/kubernetes-namespaces-source.kamelet.yaml
index 73e19f85b..d24e8b0e6 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/kubernetes-namespaces-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/kubernetes-namespaces-source.kamelet.yaml
@@ -30,23 +30,42 @@ metadata:
spec:
definition:
title: "Kubernetes Namespaces Source"
- description: Consume Events from Kubernetes Namespaces
+ description: |-
+ Watches the namespaces of a Kubernetes cluster and sends a message each
time a namespace is created, changed or deleted.
+
+ Use it to react when teams or applications are added to or removed from
a cluster, for example to set up monitoring, quotas or access for each new
namespace. For pods or nodes, use `kubernetes-pods-source` or
`kubernetes-nodes-source`.
+
+ Output: the body is the namespace as JSON text, in the same shape as
`kubectl get namespace <name> -o json`. The `CamelKubernetesEventAction` header
says what happened: `ADDED`, `MODIFIED` or `DELETED`.
+
+ Good to know: when it starts, it first sends an `ADDED` message for
every namespace that already exists. The token must be allowed to list and
watch namespaces, which is a cluster-wide permission.
required:
- token
- masterUrl
type: object
properties:
token:
- title: Oauth Token
- description: The Auth Token to connect to Kubernetes Cluster
+ title: Token
+ description: A bearer token to log in to the Kubernetes API with, such
as the token of a service account created with `kubectl create token
<service-account>`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
masterUrl:
title: Kubernetes Master URL
- description: The Kubernetes Cluster Master URL
+ description: The address of the Kubernetes API server, as a URL that
starts with `https://`, such as the `server` of the cluster in your kubeconfig
file.
type: string
+ example: https://my-cluster.example.com:6443
+ dataTypes:
+ out:
+ headers:
+ CamelKubernetesEventAction:
+ title: Event Action
+ description: What happened to the namespace, such as `ADDED`,
`MODIFIED` or `DELETED`.
+ type: string
+ CamelKubernetesEventTimestamp:
+ title: Event Timestamp
+ description: When the event was received, in milliseconds since 1
January 1970.
+ type: integer
types:
out:
mediaType: application/json
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/kubernetes-nodes-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/kubernetes-nodes-source.kamelet.yaml
index 52af7bd58..a8cc908c3 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/kubernetes-nodes-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/kubernetes-nodes-source.kamelet.yaml
@@ -30,27 +30,47 @@ metadata:
spec:
definition:
title: "Kubernetes Nodes Source"
- description: Consume Events from Kubernetes Nodes
+ description: |-
+ Watches the nodes (the machines) of a Kubernetes cluster and sends a
message each time a node is added, changed or removed.
+
+ Use it to react to changes in the capacity or the health of a cluster,
for example to alert when a node is not ready or when a node joins or leaves.
For pods or namespaces, use `kubernetes-pods-source` or
`kubernetes-namespaces-source`.
+
+ Output: the body is the node as JSON text, in the same shape as `kubectl
get node <name> -o json`. The `CamelKubernetesEventAction` header says what
happened: `ADDED`, `MODIFIED` or `DELETED`.
+
+ Good to know: when it starts, it first sends an `ADDED` message for
every node that already exists. The status of a node is updated often, so
expect many `MODIFIED` messages. The token must be allowed to list and watch
nodes, which is a cluster-wide permission.
required:
- token
- masterUrl
type: object
properties:
token:
- title: Oauth Token
- description: The Auth Token to connect to Kubernetes Cluster
+ title: Token
+ description: A bearer token to log in to the Kubernetes API with, such
as the token of a service account created with `kubectl create token
<service-account>`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
masterUrl:
title: Kubernetes Master URL
- description: The Kubernetes Cluster Master URL
+ description: The address of the Kubernetes API server, as a URL that
starts with `https://`, such as the `server` of the cluster in your kubeconfig
file.
type: string
+ example: https://my-cluster.example.com:6443
resourceName:
title: Resource Name
- description: The Resource Name we want to watch
+ description: The name of the one node to watch. When it is not set,
all the nodes are watched.
type: string
+ example: worker-1
+ dataTypes:
+ out:
+ headers:
+ CamelKubernetesEventAction:
+ title: Event Action
+ description: What happened to the node, such as `ADDED`, `MODIFIED`
or `DELETED`.
+ type: string
+ CamelKubernetesEventTimestamp:
+ title: Event Timestamp
+ description: When the event was received, in milliseconds since 1
January 1970.
+ type: integer
types:
out:
mediaType: application/json
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/kubernetes-pods-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/kubernetes-pods-source.kamelet.yaml
index 6a60df7db..59c6d0afd 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/kubernetes-pods-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/kubernetes-pods-source.kamelet.yaml
@@ -30,27 +30,47 @@ metadata:
spec:
definition:
title: "Kubernetes Pods Source"
- description: Consume Events from Kubernetes Pods
+ description: |-
+ Watches the pods of a Kubernetes cluster and sends a message each time a
pod is added, changed or deleted, in any namespace.
+
+ Use it to react to what happens to workloads, for example to alert when
a pod fails or restarts, or to keep an inventory of running pods. For nodes or
namespaces, use `kubernetes-nodes-source` or `kubernetes-namespaces-source`.
+
+ Output: the body is the pod as JSON text, in the same shape as `kubectl
get pod <name> -o json`. The `CamelKubernetesEventAction` header says what
happened: `ADDED`, `MODIFIED` or `DELETED`.
+
+ Good to know: when it starts, it first sends an `ADDED` message for
every pod that already exists. A pod changes often, so expect many `MODIFIED`
messages. It watches the pods of all namespaces: `resourceName` has no effect.
The token must be allowed to list and watch pods in all namespaces.
required:
- token
- masterUrl
type: object
properties:
token:
- title: Oauth Token
- description: The Auth Token to connect to Kubernetes Cluster
+ title: Token
+ description: A bearer token to log in to the Kubernetes API with, such
as the token of a service account created with `kubectl create token
<service-account>`.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
masterUrl:
title: Kubernetes Master URL
- description: The Kubernetes Cluster Master URL
+ description: The address of the Kubernetes API server, as a URL that
starts with `https://`, such as the `server` of the cluster in your kubeconfig
file.
type: string
+ example: https://my-cluster.example.com:6443
resourceName:
title: Resource Name
- description: The Resource Name we want to watch
+ description: Meant to watch only the pod with this name, but it has no
effect, as this Kamelet watches the pods of all namespaces.
type: string
+ example: web-1
+ dataTypes:
+ out:
+ headers:
+ CamelKubernetesEventAction:
+ title: Event Action
+ description: What happened to the pod, such as `ADDED`, `MODIFIED`
or `DELETED`.
+ type: string
+ CamelKubernetesEventTimestamp:
+ title: Event Timestamp
+ description: When the event was received, in milliseconds since 1
January 1970.
+ type: integer
types:
out:
mediaType: application/json
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/minio-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/minio-sink.kamelet.yaml
index 8c506b891..9a977d473 100644
--- a/library/camel-kamelets/src/main/resources/kamelets/minio-sink.kamelet.yaml
+++ b/library/camel-kamelets/src/main/resources/kamelets/minio-sink.kamelet.yaml
@@ -30,7 +30,16 @@ metadata:
spec:
definition:
title: "Minio Sink"
- description: Upload data to MinIO.
+ description: |-
+ Uploads each message as a file (object) to a bucket in MinIO, the
S3-compatible object storage.
+
+ Use it to store data in MinIO, such as reports, exports, images or
received messages to keep as an archive. For Amazon S3 use `aws-s3-sink`, and
for the S3 gateway of Ceph use `ceph-sink`.
+
+ Input: the body is the content of the file, as text, bytes or a stream.
When `keyName` is set, every message is stored under that name. Otherwise the
name of the file comes from the optional `file` header, or the `ce-file`
header, and is a generated unique name when neither is set.
+
+ Output: the body is unchanged. The `CamelMinioObjectName` header holds
the name the file was stored under, unless `keyName` is set.
+
+ Good to know: a file with the same name is overwritten, so with
`keyName` set each message replaces the previous one. When `keyName` is set,
the `file` and `ce-file` headers are ignored.
required:
- bucketName
- accessKey
@@ -40,36 +49,49 @@ spec:
properties:
bucketName:
title: Bucket Name
- description: The Minio Bucket name.
+ description: The name of the bucket to store the files in.
type: string
+ example: my-bucket
accessKey:
title: Access Key
- description: The access key obtained from MinIO.
+ description: The access key to log in to MinIO with, such as the
access key of a key pair created in the MinIO Console, or the name of a MinIO
user.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key obtained from MinIO.
+ description: The secret key that goes with `accessKey`, or the
password of the MinIO user.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
endpoint:
title: Endpoint
- description: The MinIO Endpoint. You can specify an URL, domain name,
IPv4 address, or IPv6 address.
+ description: The address of the MinIO server, as a URL with the port,
such as `http://localhost:9000`. Use `https://` when the server has TLS.
type: string
example: http://localhost:9000
autoCreateBucket:
title: Autocreate Bucket
- description: Specify to automatically create the MinIO bucket.
+ description: If true, the bucket is created when it does not exist
yet. If false, the bucket must already exist.
type: boolean
default: false
keyName:
title: Key Name
- description: The key name for saving an element in the bucket.
+ description: The name to store every file under, with its folder if
any. When it is not set, the name comes from the `file` or `ce-file` header of
each message, or is generated.
type: string
+ example: reports/latest.csv
+ dataTypes:
+ in:
+ headers:
+ file:
+ title: File Name
+ description: The name to store the file under, such as
`reports/january.csv`. Ignored when `keyName` is set.
+ type: string
+ ce-file:
+ title: File Name
+ description: The name to store the file under, used when the `file`
header is not set. Ignored when `keyName` is set.
+ type: string
dependencies:
- "camel:minio"
- "camel:kamelet"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/minio-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/minio-source.kamelet.yaml
index b4c5f8145..bb7a417f1 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/minio-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/minio-source.kamelet.yaml
@@ -30,7 +30,14 @@ metadata:
spec:
definition:
title: "Minio Source"
- description: Receive data from MinIO.
+ description: |-
+ Reads the files (objects) in a MinIO bucket, one message per file, and
by default deletes each file once it has been read.
+
+ Use it to process files that another system drops into a MinIO bucket,
such as uploaded documents, exported reports or log files. For Amazon S3 use
`aws-s3-source`, and for the S3 gateway of Ceph use `ceph-source`.
+
+ Output: the body is the content of the file, as bytes. The headers give
the bucket name, the name of the file (`CamelMinioObjectName`), and its content
type, size, ETag and last modified date.
+
+ Good to know: files are deleted from the bucket after they are read,
unless `deleteAfterRead` is set to false; then the same files are read again on
every poll, about twice a second. Only the files at the top of the bucket are
read: a file in a folder, such as `reports/january.csv`, is not.
required:
- bucketName
- accessKey
@@ -40,37 +47,61 @@ spec:
properties:
bucketName:
title: Bucket Name
- description: The MinIO Bucket name.
+ description: The name of the bucket to read the files from.
type: string
+ example: my-bucket
deleteAfterRead:
title: Auto-delete Objects
- description: Delete objects after consuming them.
+ description: If true, each file is deleted from the bucket after it
has been read. Set it to false to keep the files; they are then read again on
every poll.
type: boolean
default: true
accessKey:
title: Access Key
- description: The access key obtained from MinIO.
+ description: The access key to log in to MinIO with, such as the
access key of a key pair created in the MinIO Console, or the name of a MinIO
user.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
secretKey:
title: Secret Key
- description: The secret key obtained from MinIO.
+ description: The secret key that goes with `accessKey`, or the
password of the MinIO user.
type: string
format: password
x-descriptors:
- urn:camel:group:credentials
endpoint:
title: Endpoint
- description: The MinIO Endpoint. You can specify an URL, domain name,
IPv4 address, or IPv6 address.
+ description: The address of the MinIO server, as a URL with the port,
such as `http://localhost:9000`. Use `https://` when the server has TLS.
type: string
example: http://localhost:9000
autoCreateBucket:
title: Autocreate Bucket
- description: Specifies to automatically create the MinIO bucket.
+ description: If true, the bucket is created when it does not exist
yet. If false, every poll fails while the bucket does not exist.
type: boolean
default: false
+ dataTypes:
+ out:
+ headers:
+ CamelMinioBucketName:
+ title: Bucket Name
+ description: The name of the bucket the file was read from.
+ type: string
+ CamelMinioObjectName:
+ title: Object Name
+ description: The name of the file in the bucket, such as
`invoice-42.pdf`.
+ type: string
+ CamelMinioContentType:
+ title: Content Type
+ description: The content type the file was stored with, such as
`application/octet-stream`.
+ type: string
+ CamelMinioContentLength:
+ title: Content Length
+ description: The size of the file, in bytes.
+ type: integer
+ CamelMinioETag:
+ title: ETag
+ description: The ETag of the file, which changes when its content
changes.
+ type: string
dependencies:
- "camel:minio"
- "camel:kamelet"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/webhook-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/webhook-source.kamelet.yaml
index 7ae8e6538..b916a45ab 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/webhook-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/webhook-source.kamelet.yaml
@@ -30,15 +30,37 @@ metadata:
spec:
definition:
title: "Webhook Source"
- description: Creates an HTTP endpoint that can be used as a bridge to
forward data to the Kamelet sink.
+ description: |-
+ Receives HTTP requests on a path of its own, such as `/webhook`, and
sends each request on as a message, with its body and headers.
+
+ Use it to receive the webhook calls of an online service, such as a
payment, form or code hosting service, or to let another system push data with
a simple HTTP POST. To fetch a URL at a regular interval instead, use
`http-source`.
+
+ Output: the body is the body of the request, as a stream, and is empty
for a request without a body, such as a GET. The HTTP headers of the request
become headers of the message, and so does each query parameter.
`CamelHttpMethod` gives the method (such as `POST`), `CamelHttpPath` the path
and `CamelHttpQuery` the query string. A form
(`application/x-www-form-urlencoded`) arrives as a Map of its fields instead.
+
+ Good to know: there is no login, so anyone who can reach the address can
send messages; protect it with network rules or a gateway in front, and treat
the content as untrusted. It accepts every HTTP method, on the exact path only.
It listens on the HTTP port of the application, 8080 by default with Camel
JBang. The caller gets back the message as it is at the end of the flow: by
default the body it sent, with status 200, or status 204 when there is no body.
type: object
properties:
subpath:
title: Subpath
- description: |
- The subpath where the webhook is registered
+ description: The path to receive the requests on, without a leading
`/`. For example, `hooks/orders` receives the requests sent to
`http://<host>:<port>/hooks/orders`.
type: string
default: "webhook"
+ example: hooks/orders
+ dataTypes:
+ out:
+ headers:
+ CamelHttpMethod:
+ title: HTTP Method
+ description: The method of the request, such as `POST` or `GET`.
+ type: string
+ CamelHttpPath:
+ title: HTTP Path
+ description: The path of the request, such as `/webhook`.
+ type: string
+ CamelHttpQuery:
+ title: HTTP Query
+ description: The query string of the request, without the `?`, such
as `source=shop`. Each query parameter is also a header of its own.
+ type: string
dependencies:
- "camel:platform-http"
- "camel:kamelet"