This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch 2345-2 in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit 756e74fce326a1b42a1e008d0463c53ef4b388f2 Author: Andrea Cosentino <anco...@gmail.com> AuthorDate: Mon Jan 13 12:56:45 2025 +0100 Kamelets Catalog - Make the description a one liner - AWS EC2 Sink Signed-off-by: Andrea Cosentino <anco...@gmail.com> --- .../ROOT/partials/aws-ec2-sink-description.adoc | 26 ++++++++++++++++++++++ kamelets/aws-ec2-sink.kamelet.yaml | 11 +-------- .../resources/kamelets/aws-ec2-sink.kamelet.yaml | 11 +-------- 3 files changed, 28 insertions(+), 20 deletions(-) diff --git a/docs/modules/ROOT/partials/aws-ec2-sink-description.adoc b/docs/modules/ROOT/partials/aws-ec2-sink-description.adoc new file mode 100644 index 00000000..11bc3842 --- /dev/null +++ b/docs/modules/ROOT/partials/aws-ec2-sink-description.adoc @@ -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. diff --git a/kamelets/aws-ec2-sink.kamelet.yaml b/kamelets/aws-ec2-sink.kamelet.yaml index 08caaaf1..ba280c22 100644 --- a/kamelets/aws-ec2-sink.kamelet.yaml +++ b/kamelets/aws-ec2-sink.kamelet.yaml @@ -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 diff --git a/library/camel-kamelets/src/main/resources/kamelets/aws-ec2-sink.kamelet.yaml b/library/camel-kamelets/src/main/resources/kamelets/aws-ec2-sink.kamelet.yaml index 08caaaf1..ba280c22 100644 --- a/library/camel-kamelets/src/main/resources/kamelets/aws-ec2-sink.kamelet.yaml +++ b/library/camel-kamelets/src/main/resources/kamelets/aws-ec2-sink.kamelet.yaml @@ -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