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

Merged
merged 4 commits into from
Jan 13, 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
39 changes: 39 additions & 0 deletions docs/modules/ROOT/partials/aws-ddb-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
== AWS DynamoDB 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]

=== Expected Data format for sink

This Kamelet expects a JSON-formatted body and it must include the primary key values that define the DynamoDB item. The mapping between the JSON fields and table attribute values is done by key. For example, for '{"username":"oscerd", "city":"Rome"}' input, the Kamelet inserts or update an item in the specified AWS DynamoDB table and sets the values for the 'username' and 'city' attributes.

For PutItem operation the Json body defines all item attributes.
For DeleteItem operation the Json body defines only the primary key attributes that identify the item to delete.
For UpdateItem operation the Json body defines both key attributes to identify the item to be updated and all item attributes tht get updated on the item.

The given Json body can use "operation", "key" and "item" as top level properties that will be mapped to respective attribute value maps.

[source,json]
----
{
"operation": "PutItem"
"key": {},
"item": {}
}
----
20 changes: 20 additions & 0 deletions docs/modules/ROOT/partials/aws-ddb-streams-source-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS DynamoDB Streams 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]
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.
20 changes: 1 addition & 19 deletions kamelets/aws-ddb-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,25 +31,7 @@ metadata:
spec:
definition:
title: "AWS DynamoDB Sink"
description: |-
Send data to Amazon DynamoDB. The sent data inserts, updates, or deletes an item on the specified AWS DynamoDB table.

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

This Kamelet expects a JSON-formatted body and it must include the primary key values that define the DynamoDB item. The mapping between the JSON fields and table attribute values is done by key. For example, for '{"username":"oscerd", "city":"Rome"}' input, the Kamelet inserts or update an item in the specified AWS DynamoDB table and sets the values for the 'username' and 'city' attributes.

For PutItem operation the Json body defines all item attributes.
For DeleteItem operation the Json body defines only the primary key attributes that identify the item to delete.
For UpdateItem operation the Json body defines both key attributes to identify the item to be updated and all item attributes tht get updated on the item.

The given Json body can use "operation", "key" and "item" as top level properties that will be mapped to respective attribute value maps.
{
"operation": "PutItem"
"key": {},
"item": {}
}
description: Send data to Amazon DynamoDB. The sent data inserts, updates, or deletes an item on the specified AWS DynamoDB table.
required:
- table
- region
Expand Down
7 changes: 1 addition & 6 deletions kamelets/aws-ddb-streams-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS DynamoDB Streams Source"
description: |-
Receive events from Amazon DynamoDB Streams.

The basic authentication method for the AWS DynamoDB Streams 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 DynamoDB Streams client loads the credentials through this provider and doesn't use the basic authentication method.
description: Receive events from Amazon DynamoDB Streams.
required:
- table
- region
Expand Down
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,25 +31,7 @@ metadata:
spec:
definition:
title: "AWS DynamoDB Sink"
description: |-
Send data to Amazon DynamoDB. The sent data inserts, updates, or deletes an item on the specified AWS DynamoDB table.

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

This Kamelet expects a JSON-formatted body and it must include the primary key values that define the DynamoDB item. The mapping between the JSON fields and table attribute values is done by key. For example, for '{"username":"oscerd", "city":"Rome"}' input, the Kamelet inserts or update an item in the specified AWS DynamoDB table and sets the values for the 'username' and 'city' attributes.

For PutItem operation the Json body defines all item attributes.
For DeleteItem operation the Json body defines only the primary key attributes that identify the item to delete.
For UpdateItem operation the Json body defines both key attributes to identify the item to be updated and all item attributes tht get updated on the item.

The given Json body can use "operation", "key" and "item" as top level properties that will be mapped to respective attribute value maps.
{
"operation": "PutItem"
"key": {},
"item": {}
}
description: Send data to Amazon DynamoDB. The sent data inserts, updates, or deletes an item on the specified AWS DynamoDB table.
required:
- table
- region
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS DynamoDB Streams Source"
description: |-
Receive events from Amazon DynamoDB Streams.

The basic authentication method for the AWS DynamoDB Streams 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 DynamoDB Streams client loads the credentials through this provider and doesn't use the basic authentication method.
description: Receive events from Amazon DynamoDB Streams.
required:
- table
- region
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
Loading