From c06c757953fdfa034ad77b3bb62e9c6b610aa732 Mon Sep 17 00:00:00 2001 From: Hossam Kandil Date: Mon, 25 Oct 2021 16:40:59 +0400 Subject: [PATCH 1/5] Add content for Azure CosmosDB Graph dapr#1849 V1.5 --- .../supported-bindings/_index.md | 1 + .../supported-bindings/cosmosgrapdb.md | 59 +++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md b/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md index 50b314a16..12e6569ee 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md @@ -76,6 +76,7 @@ Table captions: |------|:----------------:|:-----------------:|--------| --------- | ---------- | | [Azure Blob Storage]({{< ref blobstorage.md >}}) | | ✅ | Alpha | v1 | 1.0 | | [Azure CosmosDB]({{< ref cosmosdb.md >}}) | | ✅ | Alpha | v1 | 1.0 | +| [Azure CosmosGraphDB]({{< ref cosmosgrapdb.md >}}) | | ✅ | Alpha | v1 | 1.5 | | [Azure Event Grid]({{< ref eventgrid.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | | [Azure Event Hubs]({{< ref eventhubs.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | | [Azure Service Bus Queues]({{< ref servicebusqueues.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md new file mode 100644 index 000000000..f51789b81 --- /dev/null +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md @@ -0,0 +1,59 @@ +--- +type: docs +title: "Azure CosmosGraphDB binding spec" +linkTitle: "Azure CosmosGraphDB" +description: "Detailed documentation on the Azure CosmosGraphDB binding component" +aliases: + - "/operations/components/setup-bindings/supported-bindings/cosmosgraphdb/" +--- + +## Component format + +To setup Azure CosmosGraphDB binding create a component of type `bindings.azure.cosmosgraphdb`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration. + + +```yaml +apiVersion: dapr.io/v1alpha1 +kind: Component +metadata: + name: + namespace: +spec: + type: bindings.azure.cosmosgraphdb + version: v1 + metadata: + - name: url + value: wss://******.gremlin.cosmos.azure.com:443/ + - name: masterKey + value: ***** + - name: username + value: ***** + ``` + +{{% alert title="Warning" color="warning" %}} +The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}). +{{% /alert %}} + +## Spec metadata fields + +| Field | Required | Binding support | Details | Example | +|--------------------|:--------:|--------|---------|---------| +| url | Y | Output | The CosmosGraphDB url | `"wss://******.gremlin.cosmos.azure.com:443/"` | +| masterKey | Y | Output | The CosmosGraphDB account master key | `"masterKey"` | +| database | Y | Output | The username of the CosmosGraphDB database | `"username"` | + +For more information see [Quickstart: Azure Cosmos Graph DB using Gremlin ](https://docs.microsoft.com/en-us/azure/cosmos-db/graph/create-graph-console). + +## Binding support + +This component supports **output binding** with the following operations: + +- `query` + +## Related links + +- [Basic schema for a Dapr component]({{< ref component-schema >}}) +- [Bindings building block]({{< ref bindings >}}) +- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}}) +- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}}) +- [Bindings API reference]({{< ref bindings_api.md >}}) From ff4ba2365aae6879c15e518b3a73e9159b973fd0 Mon Sep 17 00:00:00 2001 From: Hossam Kandil Date: Fri, 29 Oct 2021 01:15:48 +0400 Subject: [PATCH 2/5] removed unneeded alias --- .../components-reference/supported-bindings/cosmosgrapdb.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md index f51789b81..6de4c31b7 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md @@ -3,8 +3,6 @@ type: docs title: "Azure CosmosGraphDB binding spec" linkTitle: "Azure CosmosGraphDB" description: "Detailed documentation on the Azure CosmosGraphDB binding component" -aliases: - - "/operations/components/setup-bindings/supported-bindings/cosmosgraphdb/" --- ## Component format From cb070a1d6165b3bb732b42d7e24aadbad2e7a26e Mon Sep 17 00:00:00 2001 From: Hossam Kandil Date: Thu, 4 Nov 2021 19:17:21 +0400 Subject: [PATCH 3/5] cosmosdbgremlinapi ouput binding --- .../supported-bindings/_index.md | 2 +- .../{cosmosgrapdb.md => cosmosdbgremlinapi.md} | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) rename daprdocs/content/en/reference/components-reference/supported-bindings/{cosmosgrapdb.md => cosmosdbgremlinapi.md} (63%) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md b/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md index 12e6569ee..9f67360bf 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md @@ -76,7 +76,7 @@ Table captions: |------|:----------------:|:-----------------:|--------| --------- | ---------- | | [Azure Blob Storage]({{< ref blobstorage.md >}}) | | ✅ | Alpha | v1 | 1.0 | | [Azure CosmosDB]({{< ref cosmosdb.md >}}) | | ✅ | Alpha | v1 | 1.0 | -| [Azure CosmosGraphDB]({{< ref cosmosgrapdb.md >}}) | | ✅ | Alpha | v1 | 1.5 | +| [Azure CosmosDBGremlinAPI]({{< ref cosmosdbgremlinapi.md >}}) | | ✅ | Alpha | v1 | 1.5 | | [Azure Event Grid]({{< ref eventgrid.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | | [Azure Event Hubs]({{< ref eventhubs.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | | [Azure Service Bus Queues]({{< ref servicebusqueues.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md similarity index 63% rename from daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md rename to daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md index 6de4c31b7..15529cff8 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosgrapdb.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md @@ -1,13 +1,13 @@ --- type: docs -title: "Azure CosmosGraphDB binding spec" -linkTitle: "Azure CosmosGraphDB" -description: "Detailed documentation on the Azure CosmosGraphDB binding component" +title: "Azure CosmosDBGremlinAPI binding spec" +linkTitle: "Azure CosmosDBGremlinAPI" +description: "Detailed documentation on the Azure CosmosDBGremlinAPI binding component" --- ## Component format -To setup Azure CosmosGraphDB binding create a component of type `bindings.azure.cosmosgraphdb`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration. +To setup Azure CosmosDBGremlinAPI binding create a component of type `bindings.azure.cosmosdbgremlinapi`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration. ```yaml @@ -17,7 +17,7 @@ metadata: name: namespace: spec: - type: bindings.azure.cosmosgraphdb + type: bindings.azure.cosmosdbgremlinapi version: v1 metadata: - name: url @@ -36,9 +36,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Binding support | Details | Example | |--------------------|:--------:|--------|---------|---------| -| url | Y | Output | The CosmosGraphDB url | `"wss://******.gremlin.cosmos.azure.com:443/"` | -| masterKey | Y | Output | The CosmosGraphDB account master key | `"masterKey"` | -| database | Y | Output | The username of the CosmosGraphDB database | `"username"` | +| url | Y | Output | The CosmosDBGremlinAPI url | `"wss://******.gremlin.cosmos.azure.com:443/"` | +| masterKey | Y | Output | The CosmosDBGremlinAPI account master key | `"masterKey"` | +| database | Y | Output | The username of the CosmosDBGremlinAPI database | `"username"` | For more information see [Quickstart: Azure Cosmos Graph DB using Gremlin ](https://docs.microsoft.com/en-us/azure/cosmos-db/graph/create-graph-console). From 01c41c556c4983e7c2dfb94f1398893006784314 Mon Sep 17 00:00:00 2001 From: Artur Souza Date: Thu, 4 Nov 2021 14:27:40 -0700 Subject: [PATCH 4/5] Update cosmosdbgremlinapi.md --- .../supported-bindings/cosmosdbgremlinapi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md index 15529cff8..3993c2d3b 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md @@ -17,7 +17,7 @@ metadata: name: namespace: spec: - type: bindings.azure.cosmosdbgremlinapi + type: bindings.azure.cosmosdb.gremlinapi version: v1 metadata: - name: url From 81ed7cf5cb85919f36d85cc8a413670eda7bd5da Mon Sep 17 00:00:00 2001 From: greenie-msft <56556602+greenie-msft@users.noreply.github.com> Date: Thu, 4 Nov 2021 14:30:11 -0700 Subject: [PATCH 5/5] Update cosmosdbgremlinapi.md --- .../supported-bindings/cosmosdbgremlinapi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md index 3993c2d3b..f8f7e57d1 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/cosmosdbgremlinapi.md @@ -7,7 +7,7 @@ description: "Detailed documentation on the Azure CosmosDBGremlinAPI binding com ## Component format -To setup Azure CosmosDBGremlinAPI binding create a component of type `bindings.azure.cosmosdbgremlinapi`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration. +To setup Azure CosmosDBGremlinAPI binding create a component of type `bindings.azure.cosmosdb.gremlinapi`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration. ```yaml