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

Merged
merged 6 commits into from
Jan 31, 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
20 changes: 20 additions & 0 deletions docs/modules/ROOT/partials/aws-sqs-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS SQS 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-sqs-source-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS SQS 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]
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
== AWS STS Assume Role Action 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

In this Kamelet you have to specify the following headers:

- `role-arn` / `ce-role-arn` property to specify the role ARN you want to assume.
- `role-session-name` / `ce-role-session-name` property to specify the role Session name you want to use.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
== AWS Timestream Query 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

In this Kamelet you have to specify the following headers:

- `query` / `ce-query`: as a Timestream Query
20 changes: 20 additions & 0 deletions docs/modules/ROOT/partials/aws-translate-action-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== AWS Translate Action 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]
23 changes: 23 additions & 0 deletions docs/modules/ROOT/partials/azure-cosmosdb-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
== Azure CosmosDB Sink Kamelet Description

=== Authentication methods

In this Kamelet you have the possibility of using the Azure Identity mechanism or the plain Shared Account Key. Respectively the parameters are `AZURE_IDENTITY` and `SHARED_ACCOUNT_KEY`

The order of evaluation for `AZURE_IDENTITY` is the following:

- Enviroment
- Workload Identity
- Managed Identity
- Azure Developer CLI
- IntelliJ
- Azure CLI
- Azure Powershell

For more information about this you can look at https://learn.microsoft.com/en-us/java/api/overview/azure/identity-readme[Azure Identity documentation]

=== Optional Headers

In the headers, you can optionally set the `itemPartitionKey` / `ce-itemPartitionKey` property to specify the partition key for a specific item.

If you do not set the property in the header, you'll need to use the static property itemPartitonKey.
7 changes: 1 addition & 6 deletions kamelets/aws-sqs-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: AWS SQS Sink
description: |-
Send messages to an Amazon Simple Queue Service (SQS) queue.

The basic authentication method for the SQS 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 SQS client loads the credentials through this provider and doesn't use the basic authentication method.
description: Send messages to an Amazon Simple Queue Service (SQS) queue.
required:
- queueNameOrArn
- region
Expand Down
9 changes: 1 addition & 8 deletions kamelets/aws-sqs-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,7 @@ metadata:
spec:
definition:
title: "AWS SQS Source"
description: |-
Receive data from AWS SQS.

Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the SQS 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.

Two headers will be duplicated with different names for clarity at sink level, CamelAwsSqsMessageId will be duplicated into aws.sqs.message.id and CamelAwsSqsReceiptHandle will be duplicated in aws.sqs.receipt.handle
description: Receive data from AWS SQS.
required:
- queueNameOrArn
- region
Expand Down
11 changes: 1 addition & 10 deletions kamelets/aws-sts-assume-role-action.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ metadata:
spec:
definition:
title: "AWS STS Assume Role Action"
description: |-
Assume a role through STS

Access Key/Secret Key are the basic method for authenticating to the AWS STS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the Translate 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.

In the headers, you have to specify the `role-arn` / `ce-role-arn` property to specify the role ARN you want to assume.

In the headers, you have to specify the `role-session-name` / `ce-role-session-name` property to specify the role Session name you want to use.
description: Assume a role through STS
required:
- region
type: object
Expand Down
11 changes: 1 addition & 10 deletions kamelets/aws-timestream-query-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ metadata:
spec:
definition:
title: AWS Timestream Query Sink
description: |-
Query an AWS Timestream Database

Access Key/Secret Key are the basic method for authenticating to the AWS Timestream Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the Timestream 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:

- `query` / `ce-query`: as a Timestream Query
description: Query an AWS Timestream Database
required:
- region
type: object
Expand Down
7 changes: 1 addition & 6 deletions kamelets/aws-translate-action.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS Translate Action"
description: |-
Translate a text in a specific language.

Access Key/Secret Key are the basic method for authenticating to the AWS Translate Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the Translate 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.
description: Translate a text in a specific language.
required:
- region
- sourceLanguage
Expand Down
11 changes: 1 addition & 10 deletions kamelets/azure-cosmosdb-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ metadata:
spec:
definition:
title: "Azure CosmosDB Sink"
description: |-
Send Data to an Azure CosmosDB instance

In the headers, you can optionally set the `itemPartitionKey` / `ce-itemPartitionKey` property to specify the partition key for a specific item.

If you do not set the property in the header, you'll need to use the static property itemPartitonKey.

There are two different mechanism of authentication `SHARED_ACCOUNT_KEY` and `AZURE_IDENTITY`, you could specify with credentialType property. If you're using `SHARED_ACCOUNT_KEY` accountKey property will be needed.

In case of `AZURE_IDENTITY` selection, the DefaultAzureCredential will attempt to authenticate via the following mechanisms in the following order enviroment, Workload Identity, Managed Identity, Azure Developer CLI, IntelliJ, Azure CLI and Azure Powershell.
description: Send Data to an Azure CosmosDB instance
required:
- databaseName
- containerName
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: AWS SQS Sink
description: |-
Send messages to an Amazon Simple Queue Service (SQS) queue.

The basic authentication method for the SQS 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 SQS client loads the credentials through this provider and doesn't use the basic authentication method.
description: Send messages to an Amazon Simple Queue Service (SQS) queue.
required:
- queueNameOrArn
- region
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,7 @@ metadata:
spec:
definition:
title: "AWS SQS Source"
description: |-
Receive data from AWS SQS.

Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the SQS 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.

Two headers will be duplicated with different names for clarity at sink level, CamelAwsSqsMessageId will be duplicated into aws.sqs.message.id and CamelAwsSqsReceiptHandle will be duplicated in aws.sqs.receipt.handle
description: Receive data from AWS SQS.
required:
- queueNameOrArn
- region
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ metadata:
spec:
definition:
title: "AWS STS Assume Role Action"
description: |-
Assume a role through STS

Access Key/Secret Key are the basic method for authenticating to the AWS STS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the Translate 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.

In the headers, you have to specify the `role-arn` / `ce-role-arn` property to specify the role ARN you want to assume.

In the headers, you have to specify the `role-session-name` / `ce-role-session-name` property to specify the role Session name you want to use.
description: Assume a role through STS
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 Timestream Query Sink
description: |-
Query an AWS Timestream Database

Access Key/Secret Key are the basic method for authenticating to the AWS Timestream Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the Timestream 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:

- `query` / `ce-query`: as a Timestream Query
description: Query an AWS Timestream Database
required:
- region
type: object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS Translate Action"
description: |-
Translate a text in a specific language.

Access Key/Secret Key are the basic method for authenticating to the AWS Translate Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the Translate 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.
description: Translate a text in a specific language.
required:
- region
- sourceLanguage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,7 @@ metadata:
spec:
definition:
title: "Azure CosmosDB Sink"
description: |-
Send Data to an Azure CosmosDB instance

In the headers, you can optionally set the `itemPartitionKey` / `ce-itemPartitionKey` property to specify the partition key for a specific item.

If you do not set the property in the header, you'll need to use the static property itemPartitonKey.

There are two different mechanism of authentication `SHARED_ACCOUNT_KEY` and `AZURE_IDENTITY`, you could specify with credentialType property. If you're using `SHARED_ACCOUNT_KEY` accountKey property will be needed.

In case of `AZURE_IDENTITY` selection, the DefaultAzureCredential will attempt to authenticate via the following mechanisms in the following order enviroment, Workload Identity, Managed Identity, Azure Developer CLI, IntelliJ, Azure CLI and Azure Powershell.
description: Send Data to an Azure CosmosDB instance
required:
- databaseName
- containerName
Expand Down
Loading