Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kamelets Catalog - Make the description a one liner #2358

Merged
merged 2 commits into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
== AWS S3 Event based Source Kamelet Description

=== Authentication methods

Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service.

=== Required Setup

To use this Kamelet you'll need to set up Eventbridge on your bucket and subscribe Eventbridge bus to an SQS Queue.

For doing this you'll need to enable Evenbridge notification on your bucket and creating a rule on Eventbridge console related to all the events on S3 bucket and pointing to the SQS Queue specified as parameter in this Kamelet.
26 changes: 26 additions & 0 deletions docs/modules/ROOT/partials/aws-s3-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
== AWS S3 Sink Kamelet Description

=== Authentication methods

In this Kamelet you have the possibility of avoiding the usage of explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.

The order of evaluation for Default Credentials Provider is the following:

- Java system properties - `aws.accessKeyId` and `aws.secretKey`.
- Environment variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
- Web Identity Token from AWS STS.
- The shared credentials and config files.
- Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` is set.
- Amazon EC2 Instance profile credentials.

You have also the possibility of using Profile Credentials Provider, by specifying the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.

Only one of access key/secret key or default credentials provider could be used

For more information about this you can look at https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html[AWS credentials documentation]

=== Optional Headers

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.
10 changes: 1 addition & 9 deletions kamelets/aws-s3-event-based-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,7 @@ metadata:
spec:
definition:
title: AWS S3 Event Based Source
description: >-
Receive data from AWS SQS subscribed to Eventbridge Bus reporting events related to an S3 bucket or multiple buckets.

Access Key/Secret Key are the basic method for authenticating to the AWS
SQS Service.

To use this Kamelet you'll need to set up Eventbridge on your bucket and subscribe Eventbridge bus to an SQS Queue.

For doing this you'll need to enable Evenbridge notification on your bucket and creating a rule on Eventbridge console related to all the events on S3 bucket and pointing to the SQS Queue specified as parameter in this Kamelet.
description: Receive data from AWS SQS subscribed to Eventbridge Bus reporting events related to an S3 bucket or multiple buckets.
required:
- accessKey
- secretKey
Expand Down
11 changes: 1 addition & 10 deletions kamelets/aws-s3-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ metadata:
spec:
definition:
title: "AWS S3 Sink"
description: |-
Upload data to an Amazon S3 Bucket.

The basic authentication method for the S3 service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider.

If you use the default credentials provider, the S3 client loads the credentials through this provider and doesn't use the basic authentication method.

In the header, you can optionally set the `file` / `ce-partition` 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.
description: Upload data to an Amazon S3 Bucket.
required:
- bucketNameOrArn
- region
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,7 @@ metadata:
spec:
definition:
title: AWS S3 Event Based Source
description: >-
Receive data from AWS SQS subscribed to Eventbridge Bus reporting events related to an S3 bucket or multiple buckets.

Access Key/Secret Key are the basic method for authenticating to the AWS
SQS Service.

To use this Kamelet you'll need to set up Eventbridge on your bucket and subscribe Eventbridge bus to an SQS Queue.

For doing this you'll need to enable Evenbridge notification on your bucket and creating a rule on Eventbridge console related to all the events on S3 bucket and pointing to the SQS Queue specified as parameter in this Kamelet.
description: Receive data from AWS SQS subscribed to Eventbridge Bus reporting events related to an S3 bucket or multiple buckets.
required:
- accessKey
- secretKey
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ metadata:
spec:
definition:
title: "AWS S3 Sink"
description: |-
Upload data to an Amazon S3 Bucket.

The basic authentication method for the S3 service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider.

If you use the default credentials provider, the S3 client loads the credentials through this provider and doesn't use the basic authentication method.

In the header, you can optionally set the `file` / `ce-partition` 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.
description: Upload data to an Amazon S3 Bucket.
required:
- bucketNameOrArn
- region
Expand Down
Loading