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

Merged
merged 4 commits into from
Jan 28, 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
4 changes: 2 additions & 2 deletions docs/modules/ROOT/partials/aws-sns-fifo-sink-description.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ 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]

=== Required Headers
=== Optional Headers

The Kamelet expects the following headers to be set:
In the Kamelet you can optionally set the following header:

- `subject` / `ce-subject`: the subject of the message
26 changes: 26 additions & 0 deletions docs/modules/ROOT/partials/aws-sns-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
== AWS SNS 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 Kamelet you can optionally set the following header:

- `subject` / `ce-subject`: the subject of the message
20 changes: 20 additions & 0 deletions docs/modules/ROOT/partials/aws-sqs-batch-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS SQS Batch 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-fifo-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS SQS FIFO 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]
9 changes: 1 addition & 8 deletions kamelets/aws-sns-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,7 @@ metadata:
spec:
definition:
title: AWS SNS Sink
description: |-
Send message to an Amazon Simple Notification Service (SNS) topic.

The basic authentication method for the SNS 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 SNS client loads the credentials through this provider and doesn't use the basic authentication method.

In the header, you can optionally set the `subject` / `ce-subject` property to specify the subject of the message.
description: Send message to an Amazon Simple Notification Service (SNS) topic.
required:
- topicNameOrArn
- region
Expand Down
7 changes: 1 addition & 6 deletions kamelets/aws-sqs-batch-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 Batch Sink
description: |-
Send Batch message to an AWS SQS Queue.

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.
description: Send Batch message to an AWS SQS Queue.
required:
- queueNameOrArn
- region
Expand Down
7 changes: 1 addition & 6 deletions kamelets/aws-sqs-fifo-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 FIFO Sink
description: |-
Send message to an AWS SQS FIFO Queue.

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.
description: Send message to an AWS SQS FIFO Queue.
required:
- queueNameOrArn
- region
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,7 @@ metadata:
spec:
definition:
title: AWS SNS Sink
description: |-
Send message to an Amazon Simple Notification Service (SNS) topic.

The basic authentication method for the SNS 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 SNS client loads the credentials through this provider and doesn't use the basic authentication method.

In the header, you can optionally set the `subject` / `ce-subject` property to specify the subject of the message.
description: Send message to an Amazon Simple Notification Service (SNS) topic.
required:
- topicNameOrArn
- 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 Batch Sink
description: |-
Send Batch message to an AWS SQS Queue.

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.
description: Send Batch message to an AWS SQS Queue.
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 FIFO Sink
description: |-
Send message to an AWS SQS FIFO Queue.

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.
description: Send message to an AWS SQS FIFO Queue.
required:
- queueNameOrArn
- region
Expand Down
Loading