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 #2373

Merged
merged 2 commits into from
Jan 29, 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
20 changes: 20 additions & 0 deletions docs/modules/ROOT/partials/aws-sqs-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS SQS 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]
20 changes: 20 additions & 0 deletions docs/modules/ROOT/partials/aws-sqs-source-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS SQS Source 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]
7 changes: 1 addition & 6 deletions kamelets/aws-sqs-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: AWS SQS Sink
description: |-
Send messages to an Amazon Simple Queue Service (SQS) queue.

The basic authentication method for the SQS 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 SQS client loads the credentials through this provider and doesn't use the basic authentication method.
description: Send messages to an Amazon Simple Queue Service (SQS) queue.
required:
- queueNameOrArn
- region
Expand Down
9 changes: 1 addition & 8 deletions kamelets/aws-sqs-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,7 @@ metadata:
spec:
definition:
title: "AWS SQS Source"
description: |-
Receive data from AWS SQS.

Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the SQS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet.

Two headers will be duplicated with different names for clarity at sink level, CamelAwsSqsMessageId will be duplicated into aws.sqs.message.id and CamelAwsSqsReceiptHandle will be duplicated in aws.sqs.receipt.handle
description: Receive data from AWS SQS.
required:
- queueNameOrArn
- region
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: AWS SQS Sink
description: |-
Send messages to an Amazon Simple Queue Service (SQS) queue.

The basic authentication method for the SQS 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 SQS client loads the credentials through this provider and doesn't use the basic authentication method.
description: Send messages to an Amazon Simple Queue Service (SQS) queue.
required:
- queueNameOrArn
- region
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,7 @@ metadata:
spec:
definition:
title: "AWS SQS Source"
description: |-
Receive data from AWS SQS.

Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the SQS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet.

Two headers will be duplicated with different names for clarity at sink level, CamelAwsSqsMessageId will be duplicated into aws.sqs.message.id and CamelAwsSqsReceiptHandle will be duplicated in aws.sqs.receipt.handle
description: Receive data from AWS SQS.
required:
- queueNameOrArn
- region
Expand Down
Loading