Kamelets Catalog - Make the description a one liner - AWS Redshift So…

…urce Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
apache · Jan 14, 2025 · f0c4304 · f0c4304
1 parent f1a2f79
commit f0c4304
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 4 deletions.
diff --git a/docs/modules/ROOT/partials/aws-redshift-source-description.adoc b/docs/modules/ROOT/partials/aws-redshift-source-description.adoc
@@ -0,0 +1,20 @@
+== AWS Redshift 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]
diff --git a/kamelets/aws-redshift-source.kamelet.yaml b/kamelets/aws-redshift-source.kamelet.yaml
@@ -30,8 +30,7 @@ metadata:
 spec:
   definition:
     title: "AWS Redshift Source"
-    description: |-
-      Query data from an AWS RedShift Database.
+    description: Query data from an AWS RedShift Database.
     required:
       - serverName
       - username

diff --git a/library/camel-kamelets/src/main/resources/kamelets/aws-redshift-source.kamelet.yaml b/library/camel-kamelets/src/main/resources/kamelets/aws-redshift-source.kamelet.yaml
@@ -30,8 +30,7 @@ metadata:
 spec:
   definition:
     title: "AWS Redshift Source"
-    description: |-
-      Query data from an AWS RedShift Database.
+    description: Query data from an AWS RedShift Database.
     required:
       - serverName
       - username