Skip to content

Commit

Permalink
Kamelets Catalog - Make the description a one liner - AWS EC2 Sink
Browse files Browse the repository at this point in the history
Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
  • Loading branch information
oscerd committed Jan 13, 2025
1 parent 0eb9dbb commit 756e74f
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 20 deletions.
26 changes: 26 additions & 0 deletions docs/modules/ROOT/partials/aws-ec2-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
== AWS EC2 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]

=== Required Headers

The Kamelet expects the following headers to be set:

- `instanceIds` / `ce-instanceids`: as a comma separated list of EC2 instance ids.
11 changes: 1 addition & 10 deletions kamelets/aws-ec2-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ metadata:
spec:
definition:
title: AWS EC2 Sink
description: |-
Check the status of EC2 instances
Access Key/Secret Key are the basic method for authenticating to the AWS EC2 Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.
When using a default Credentials Provider the EC2 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.
The Kamelet expects the following headers to be set:
- `instanceIds` / `ce-instanceids`: as a comma separated list of EC2 instance ids.
description: Check the status of EC2 instances
required:
- region
type: object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ metadata:
spec:
definition:
title: AWS EC2 Sink
description: |-
Check the status of EC2 instances
Access Key/Secret Key are the basic method for authenticating to the AWS EC2 Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.
When using a default Credentials Provider the EC2 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.
The Kamelet expects the following headers to be set:
- `instanceIds` / `ce-instanceids`: as a comma separated list of EC2 instance ids.
description: Check the status of EC2 instances
required:
- region
type: object
Expand Down

0 comments on commit 756e74f

Please sign in to comment.