Kamelets Catalog - Make the description a one liner - Azure CosmosDB …

…Sink Signed-off-by: Andrea Cosentino <[email protected]>
apache · Jan 31, 2025 · 97dede4 · 97dede4
1 parent dcc2f1b
commit 97dede4
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 20 deletions.
diff --git a/docs/modules/ROOT/partials/azure-cosmosdb-sink-description.adoc b/docs/modules/ROOT/partials/azure-cosmosdb-sink-description.adoc
@@ -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.
diff --git a/kamelets/azure-cosmosdb-sink.kamelet.yaml b/kamelets/azure-cosmosdb-sink.kamelet.yaml
@@ -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

diff --git a/library/camel-kamelets/src/main/resources/kamelets/azure-cosmosdb-sink.kamelet.yaml b/library/camel-kamelets/src/main/resources/kamelets/azure-cosmosdb-sink.kamelet.yaml
@@ -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