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

Merged
merged 6 commits into from
Jan 13, 2025
Merged
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS Bedrock Agent Runtime 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-bedrock-text-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS Bedrock Text 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-cloudtrail-source-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS Cloudtrail 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]
31 changes: 31 additions & 0 deletions docs/modules/ROOT/partials/aws-cloudwatch-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
== AWS Cloudwatch 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]

=== Metric Headers

In this Kamelet you could use the following headers for metrics:

- `metric-name` / `ce-metricname` for the metric name.
- `metric-value` / `ce-metricvalue` for the metric value.
- `metric-unit` / `ce-metricunit` for the metric unit.
- `metric-timestamp` / `ce-metrictimestamp` for the metric timestamp.
- `metric-dimension-name` / `ce-metricdimensionname` for the dimension name.
- `metric-dimension-value` / `ce-metricdimensionvalue` for the dimension value.
7 changes: 1 addition & 6 deletions kamelets/aws-bedrock-agent-runtime-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS Bedrock Agent Runtime Sink"
description: |-
Send data for invoking a knowledge base from AWS Bedrock.

The basic authentication method for the Bedrock 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 Bedrock client loads the credentials through this provider and doesn't use the basic authentication method.
description: Send data for invoking a knowledge base from AWS Bedrock.
required:
- modelId
- knowledgeBaseId
Expand Down
7 changes: 1 addition & 6 deletions kamelets/aws-bedrock-text-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS Bedrock Text Sink"
description: |-
Send data for invoking a text model of Amazon Bedrock.

The basic authentication method for the Bedrock 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 Bedrock client loads the credentials through this provider and doesn't use the basic authentication method.
description: Send data for invoking a text model of Amazon Bedrock.
required:
- modelId
- region
Expand Down
5 changes: 1 addition & 4 deletions kamelets/aws-cloudtrail-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,7 @@ metadata:
spec:
definition:
title: "AWS Cloudtrail Source"
description: |-
Receive data from an AWS Cloudtrail.

The basic authentication method for the Cloudtrail service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider.
description: Receive data from an AWS Cloudtrail.
required:
- region
type: object
Expand Down
16 changes: 1 addition & 15 deletions kamelets/aws-cloudwatch-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,7 @@ metadata:
spec:
definition:
title: "AWS CloudWatch Metrics Sink"
description: |-
Send data to Amazon CloudWatch metrics.

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

You can set the following properties in the header:

`metric-name` / `ce-metricname` for the metric name.
`metric-value` / `ce-metricvalue` for the metric value.
`metric-unit` / `ce-metricunit` for the metric unit.
`metric-timestamp` / `ce-metrictimestamp` for the metric timestamp.
`metric-dimension-name` / `ce-metricdimensionname` for the dimension name.
`metric-dimension-value` / `ce-metricdimensionvalue` for the dimension value.
description: Send data to Amazon CloudWatch metrics.
required:
- cwNamespace
- region
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS Bedrock Agent Runtime Sink"
description: |-
Send data for invoking a knowledge base from AWS Bedrock.

The basic authentication method for the Bedrock 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 Bedrock client loads the credentials through this provider and doesn't use the basic authentication method.
description: Send data for invoking a knowledge base from AWS Bedrock.
required:
- modelId
- knowledgeBaseId
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS Bedrock Text Sink"
description: |-
Send data for invoking a text model of Amazon Bedrock.

The basic authentication method for the Bedrock 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 Bedrock client loads the credentials through this provider and doesn't use the basic authentication method.
description: Send data for invoking a text model of Amazon Bedrock.
required:
- modelId
- region
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,7 @@ metadata:
spec:
definition:
title: "AWS Cloudtrail Source"
description: |-
Receive data from an AWS Cloudtrail.

The basic authentication method for the Cloudtrail service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider.
description: Receive data from an AWS Cloudtrail.
required:
- region
type: object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,7 @@ metadata:
spec:
definition:
title: "AWS CloudWatch Metrics Sink"
description: |-
Send data to Amazon CloudWatch metrics.

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

You can set the following properties in the header:

`metric-name` / `ce-metricname` for the metric name.
`metric-value` / `ce-metricvalue` for the metric value.
`metric-unit` / `ce-metricunit` for the metric unit.
`metric-timestamp` / `ce-metrictimestamp` for the metric timestamp.
`metric-dimension-name` / `ce-metricdimensionname` for the dimension name.
`metric-dimension-value` / `ce-metricdimensionvalue` for the dimension value.
description: Send data to Amazon CloudWatch metrics.
required:
- cwNamespace
- region
Expand Down
Loading