Merge branch 'v1.5' into patch-1

This commit is contained in:
greenie-msft 2021-12-01 09:13:54 -08:00 committed by GitHub
commit b9ac9727a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 762 additions and 456 deletions

View File

@ -1,18 +0,0 @@
---
type: docs
title: "Configuration overview"
linkTitle: "Configuration overview"
weight: 1000
description: "Use Dapr to get and watch application configuration"
---
Consuming application configuration is a common task when writing applications and frequently configuration stores are used to manage this configuration data. A configuration item is often dynamic in nature and is tightly coupled to the needs of the application that consumes it. For example, common uses for application configuration include names of secrets that need to be retrieved, different identifiers, partition or consumer IDs, names of databased to connect to etc. These configuration items are typically stored as key-value items in a database.
Dapr provides a [State Management API]({{<ref "state-management-overview.md">}}) that is based on key-value stores. However, application configuration can be changed by either developers or operators at runtime and the developer needs to be notified of these changes in order to take the required action and load the new configuration. Also the configuration data may want to be read only. Dapr's Configuration API allows developers to consume configuration items that are returned as key/value pair and subscribe to changes whenever a configuration item changes.
*This API is currently in `Alpha state` and only available on gRPC. An HTTP1.1 supported version with this URL `/v1.0/configuration` will be available before the API becomes stable.*
## References
- [How-To: Manage application configuration]({{< ref howto-manage-configuration.md >}})

View File

@ -10,9 +10,9 @@ This article describe how to deploy services each with an unique application ID,
## Example: ## Example:
The below code examples loosely describe an application that processes orders. In the examples, there are two services - an order processing service and a checkout service. Both services have Dapr sidecars and the order processing service uses Dapr to invoke the checkout method in the checkout service. The below code examples loosely describes an application that processes orders. In the examples, there are two services - an order processing service and a checkout service. Both services have Dapr sidecars and the order processing service uses Dapr to invoke the checkout method in the checkout service.
<img src="/images/service_invocation_eg.png" width=1000 height=500 alt="Diagram showing service invocation of example service"> <img src="/images/building-block-service-invocation-example.png" width=1000 height=500 alt="Diagram showing service invocation of example service">
## Step 1: Choose an ID for your service ## Step 1: Choose an ID for your service
@ -184,18 +184,26 @@ Below are code examples that leverage Dapr SDKs for service invocation.
{{% codetab %}} {{% codetab %}}
```csharp ```csharp
//headers //dependencies
using Dapr.Client; using Dapr.Client;
using System.Net.Http;
//code //code
namespace EventService
CancellationTokenSource source = new CancellationTokenSource(); {
CancellationToken cancellationToken = source.Token; class Program
using var client = new DaprClientBuilder().Build(); {
var result = client.CreateInvokeMethodRequest(HttpMethod.Get, "checkout", "checkout/" + orderId, cancellationToken); static async Task Main(string[] args)
await client.InvokeMethodAsync(result); {
int orderId = 100;
CancellationTokenSource source = new CancellationTokenSource();
CancellationToken cancellationToken = source.Token;
//Using Dapr SDK to invoke a method
using var client = new DaprClientBuilder().Build();
var result = client.CreateInvokeMethodRequest(HttpMethod.Get, "checkout", "checkout/" + orderId, cancellationToken);
await client.InvokeMethodAsync(result);
}
}
}
``` ```
{{% /codetab %}} {{% /codetab %}}
@ -204,22 +212,27 @@ await client.InvokeMethodAsync(result);
{{% codetab %}} {{% codetab %}}
```java ```java
//headers //dependencies
import io.dapr.client.DaprClient; import io.dapr.client.DaprClient;
import io.dapr.client.DaprClientBuilder; import io.dapr.client.DaprClientBuilder;
import io.dapr.client.domain.HttpExtension; import io.dapr.client.domain.HttpExtension;
//code //code
@SpringBootApplication
DaprClient daprClient = new DaprClientBuilder().build(); public class OrderProcessingServiceApplication {
var result = daprClient.invokeMethod( public static void main(String[] args) throws InterruptedException {
"checkout", int orderId = 100;
"checkout/" + orderId, //Using Dapr SDK to invoke a method
null, DaprClient client = new DaprClientBuilder().build();
HttpExtension.GET, var result = client.invokeMethod(
String.class "checkout",
); "checkout/" + orderId,
null,
HttpExtension.GET,
String.class
);
}
}
``` ```
{{% /codetab %}} {{% /codetab %}}
@ -227,19 +240,19 @@ var result = daprClient.invokeMethod(
{{% codetab %}} {{% codetab %}}
```python ```python
//headers #dependencies
from dapr.clients import DaprClient from dapr.clients import DaprClient
//code #code
orderId = 100
with DaprClient() as daprClient: #Using Dapr SDK to invoke a method
result = daprClient.invoke_method( with DaprClient() as client:
"checkout", result = client.invoke_method(
f"checkout/{orderId}", "checkout",
data=b'', f"checkout/{orderId}",
http_verb="GET" data=b'',
) http_verb="GET"
)
``` ```
{{% /codetab %}} {{% /codetab %}}
@ -247,21 +260,25 @@ with DaprClient() as daprClient:
{{% codetab %}} {{% codetab %}}
```go ```go
//headers //dependencies
import ( import (
dapr "github.com/dapr/go-sdk/client" "strconv"
dapr "github.com/dapr/go-sdk/client"
) )
//code //code
func main() {
client, err := dapr.NewClient() orderId := 100
if err != nil { //Using Dapr SDK to invoke a method
panic(err) client, err := dapr.NewClient()
if err != nil {
panic(err)
}
defer client.Close()
ctx := context.Background()
result, err := client.InvokeMethod(ctx, "checkout", "checkout/" + strconv.Itoa(orderId), "get")
} }
defer client.Close()
ctx := context.Background()
result, err := client.InvokeMethod(ctx, "checkout", "checkout/" + strconv.Itoa(orderId), "get")
``` ```
{{% /codetab %}} {{% /codetab %}}
@ -269,15 +286,20 @@ result, err := client.InvokeMethod(ctx, "checkout", "checkout/" + strconv.Itoa(o
{{% codetab %}} {{% codetab %}}
```javascript ```javascript
//headers //dependencies
import { DaprClient, HttpMethod, CommunicationProtocolEnum } from 'dapr-client'; import { DaprClient, HttpMethod, CommunicationProtocolEnum } from 'dapr-client';
//code //code
const daprHost = "127.0.0.1";
const daprHost = "127.0.0.1"; var main = function() {
const client = new DaprClient(daprHost, process.env.DAPR_HTTP_PORT, CommunicationProtocolEnum.HTTP); var orderId = 100;
const result = await client.invoker.invoke('checkout' , "checkout/" + orderId , HttpMethod.GET); //Using Dapr SDK to invoke a method
const client = new DaprClient(daprHost, process.env.DAPR_HTTP_PORT, CommunicationProtocolEnum.HTTP);
const result = await client.invoker.invoke('checkout' , "checkout/" + orderId , HttpMethod.GET);
}
main();
``` ```
{{% /codetab %}} {{% /codetab %}}
@ -341,4 +363,4 @@ For more information on tracing and logs see the [observability]({{< ref observa
## Related Links ## Related Links
* [Service invocation overview]({{< ref service-invocation-overview.md >}}) * [Service invocation overview]({{< ref service-invocation-overview.md >}})
* [Service invocation API specification]({{< ref service_invocation_api.md >}}) * [Service invocation API specification]({{< ref service_invocation_api.md >}})

View File

@ -1,7 +1,7 @@
--- ---
type: docs type: docs
title: "State Time-to-Live (TTL)" title: "How-To: Set state Time-to-Live (TTL)"
linkTitle: "State TTL" linkTitle: "How-To: Set state TTL"
weight: 500 weight: 500
description: "Manage state with time-to-live." description: "Manage state with time-to-live."
--- ---
@ -31,12 +31,38 @@ Please refer to the TTL column in the tables at [state store components]({{< ref
State TTL can be set in the metadata as part of the state store set request: State TTL can be set in the metadata as part of the state store set request:
{{< tabs "HTTP API (Bash)" "HTTP API (PowerShell)" "Python SDK" "PHP SDK">}} {{< tabs Python "HTTP API (Bash)" "HTTP API (PowerShell)">}}
{{% codetab %}}
```python
#dependencies
from dapr.clients import DaprClient
#code
DAPR_STORE_NAME = "statestore"
with DaprClient() as client:
client.save_state(DAPR_STORE_NAME, "order_1", str(orderId), metadata=(
('ttlInSeconds', '120')
))
```
Navigate to the directory containing the above code, then run the following command to launch a Dapr sidecar and run the application:
```bash
dapr run --app-id orderprocessing --app-port 6001 --dapr-http-port 3601 --dapr-grpc-port 60001 -- python3 OrderProcessingService.py
```
{{% /codetab %}}
{{% codetab %}} {{% codetab %}}
```bash ```bash
curl -X POST -H "Content-Type: application/json" -d '[{ "key": "key1", "value": "value1", "metadata": { "ttlInSeconds": "120" } }]' http://localhost:3500/v1.0/state/statestore curl -X POST -H "Content-Type: application/json" -d '[{ "key": "order_1", "value": "250", "metadata": { "ttlInSeconds": "120" } }]' http://localhost:3601/v1.0/state/statestore
``` ```
{{% /codetab %}} {{% /codetab %}}
@ -44,48 +70,7 @@ curl -X POST -H "Content-Type: application/json" -d '[{ "key": "key1", "value":
{{% codetab %}} {{% codetab %}}
```powershell ```powershell
Invoke-RestMethod -Method Post -ContentType 'application/json' -Body '[{"key": "key1", "value": "value1", "metadata": {"ttlInSeconds": "120"}}]' -Uri 'http://localhost:3500/v1.0/state/statestore' Invoke-RestMethod -Method Post -ContentType 'application/json' -Body '[{"key": "order_1", "value": "250", "metadata": {"ttlInSeconds": "120"}}]' -Uri 'http://localhost:3601/v1.0/state/statestore'
```
{{% /codetab %}}
{{% codetab %}}
```python
from dapr.clients import DaprClient
with DaprClient() as d:
d.save_state(
store_name="statestore",
key="myFirstKey",
value="myFirstValue",
metadata=(
('ttlInSeconds', '120')
)
)
print("State has been stored")
```
{{% /codetab %}}
{{% codetab %}}
Save the following in `state-example.php`:
```php
<?php
require_once __DIR__.'/vendor/autoload.php';
$app = \Dapr\App::create();
$app->run(function(\Dapr\State\StateManager $stateManager, \Psr\Log\LoggerInterface $logger) {
$stateManager->save_state(store_name: 'statestore', item: new \Dapr\State\StateItem(
key: 'myFirstKey',
value: 'myFirstValue',
metadata: ['ttlInSeconds' => '120']
));
$logger->alert('State has been stored');
});
``` ```
{{% /codetab %}} {{% /codetab %}}
@ -98,4 +83,4 @@ See [this guide]({{< ref state_api.md >}}) for a reference on the state API.
- Learn [how to use key value pairs to persist a state]({{< ref howto-get-save-state.md >}}) - Learn [how to use key value pairs to persist a state]({{< ref howto-get-save-state.md >}})
- List of [state store components]({{< ref supported-state-stores >}}) - List of [state store components]({{< ref supported-state-stores >}})
- Read the [API reference]({{< ref state_api.md >}}) - Read the [API reference]({{< ref state_api.md >}})

View File

@ -16,7 +16,7 @@ In self hosted mode the Dapr configuration is a configuration file, for example
A Dapr sidecar can also apply a configuration by using a ```--config``` flag to the file path with ```dapr run``` CLI command. A Dapr sidecar can also apply a configuration by using a ```--config``` flag to the file path with ```dapr run``` CLI command.
#### Kubernetes sidecar #### Kubernetes sidecar
In Kubernetes mode the Dapr configuration is a Configuration CRD, that is applied to the cluster. For example; In Kubernetes mode the Dapr configuration is a Configuration CRD, that is applied to the cluster. For example:
```bash ```bash
kubectl apply -f myappconfig.yaml kubectl apply -f myappconfig.yaml
@ -41,7 +41,7 @@ Note: There are more [Kubernetes annotations]({{< ref "arguments-annotations-ove
### Sidecar configuration settings ### Sidecar configuration settings
The following configuration settings can be applied to Dapr application sidecars; The following configuration settings can be applied to Dapr application sidecars:
- [Tracing](#tracing) - [Tracing](#tracing)
- [Metrics](#metrics) - [Metrics](#metrics)
- [Middleware](#middleware) - [Middleware](#middleware)

View File

@ -46,7 +46,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
| masterKey | Y | Output | The CosmosDB account master key | `"master-key"` | | masterKey | Y | Output | The CosmosDB account master key | `"master-key"` |
| database | Y | Output | The name of the CosmosDB database | `"OrderDb"` | | database | Y | Output | The name of the CosmosDB database | `"OrderDb"` |
| collection | Y | Output | The name of the container inside the database. | `"Orders"` | | collection | Y | Output | The name of the container inside the database. | `"Orders"` |
| partitionKey | Y | Output | The name of the partitionKey to extract from the payload and is used in the container | `"OrderId"`, `"message"` | | partitionKey | Y | Output | The name of the key to extract from the payload (document to be created) that is used as the partition key. This name must match the partition key specified upon creation of the Cosmos DB container. | `"OrderId"`, `"message"` |
For more information see [Azure Cosmos DB resource model](https://docs.microsoft.com/azure/cosmos-db/account-databases-containers-items). For more information see [Azure Cosmos DB resource model](https://docs.microsoft.com/azure/cosmos-db/account-databases-containers-items).
@ -56,6 +56,31 @@ This component supports **output binding** with the following operations:
- `create` - `create`
## Best Practices for Production Use
Azure Cosmos DB shares a strict metadata request rate limit across all databases in a single Azure Cosmos DB account. New connections to Azure Cosmos DB assume a large percentage of the allowable request rate limit. (See the [CosmosDB documentation](https://docs.microsoft.com/azure/cosmos-db/sql/troubleshoot-request-rate-too-large#recommended-solution-3))
Therefore several strategies must be applied to avoid simultaneous new connections to Azure Cosmos DB:
- Ensure sidecars of applications only load the Azure Cosmos DB component when they require it to avoid unnecessary database connections. This can be done by [scoping your components to specific applications]({{< ref component-scopes.md >}}#application-access-to-components-with-scopes).
- Choose deployment strategies that sequentially deploy or start your applications to minimize bursts in new connections to your Azure Cosmos DB accounts.
- Avoid reusing the same Azure Cosmos DB account for unrelated databases or systems (even outside of Dapr). Distinct Azure Cosmos DB accounts have distinct rate limits.
- Increase the `initTimeout` value to allow the component to retry connecting to Azure Cosmos DB during side car initialization for up to 5 minutes. The default value is `5s` and should be increased. When using Kubernetes, increasing this value may also require an update to your [Readiness and Liveness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/).
```yaml
spec:
type: bindings.azure.cosmosdb
version: v1
initTimeout: 5m
metadata:
```
## Data format
The **output binding** `create` operation requires the following keys to exist in the payload of every document to be created:
- `id`: a unique ID for the document to be created
- `<partitionKey>`: the name of the partition key specified via the `spec.partitionKey` in the component definition. This must also match the partition key specified upon creation of the Cosmos DB container.
## Related links ## Related links
- [Basic schema for a Dapr component]({{< ref component-schema >}}) - [Basic schema for a Dapr component]({{< ref component-schema >}})

View File

@ -86,7 +86,7 @@ with NATS, find the service with: `kubectl get svc my-nats`.
- [Basic schema for a Dapr component]({{< ref component-schema >}}) - [Basic schema for a Dapr component]({{< ref component-schema >}})
- Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components - Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components
- [Pub/Sub building block]({{< ref pubsub >}}) - [Pub/Sub building block]({{< ref pubsub >}})
- [JetStream Documentation](https://docs.nats.io/jetstream/jetstream) - [JetStream Documentation](https://docs.nats.io/nats-concepts/jetstream)
- [NATS CLI](https://github.com/nats-io/natscli) - [NATS CLI](https://github.com/nats-io/natscli)

View File

@ -92,7 +92,7 @@ You can then interact with the server using the client port: `localhost:4222`.
{{% /codetab %}} {{% /codetab %}}
{{% codetab %}} {{% codetab %}}
Install NATS on Kubernetes by using the [kubectl](https://docs.nats.io/nats-on-kubernetes/minimal-setup): Install NATS on Kubernetes by using the [kubectl](https://docs.nats.io/running-a-nats-service/introduction/running/nats-kubernetes/minimal-setup#minimal-nats-setup):
```bash ```bash
# Single server NATS # Single server NATS

View File

@ -64,6 +64,25 @@ In order to setup CosmosDB as a state store, you need the following properties:
- **Database**: The name of the database - **Database**: The name of the database
- **Collection**: The name of the collection - **Collection**: The name of the collection
## Best Practices for Production Use
Azure Cosmos DB shares a strict metadata request rate limit across all databases in a single Azure Cosmos DB account. New connections to Azure Cosmos DB assume a large percentage of the allowable request rate limit. (See the [CosmosDB documentation](https://docs.microsoft.com/azure/cosmos-db/sql/troubleshoot-request-rate-too-large#recommended-solution-3))
Therefore several strategies must be applied to avoid simultaneous new connections to Azure Cosmos DB:
- Ensure sidecars of applications only load the Azure Cosmos DB component when they require it to avoid unnecessary database connections. This can be done by [scoping your components to specific applications]({{< ref component-scopes.md >}}#application-access-to-components-with-scopes).
- Choose deployment strategies that sequentially deploy or start your applications to minimize bursts in new connections to your Azure Cosmos DB accounts.
- Avoid reusing the same Azure Cosmos DB account for unrelated databases or systems (even outside of Dapr). Distinct Azure Cosmos DB accounts have distinct rate limits.
- Increase the `initTimeout` value to allow the component to retry connecting to Azure Cosmos DB during side car initialization for up to 5 minutes. The default value is `5s` and should be increased. When using Kubernetes, increasing this value may also require an update to your [Readiness and Liveness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/).
```yaml
spec:
type: state.azure.cosmosdb
version: v1
initTimeout: 5m
metadata:
```
## Data format ## Data format
To use the CosmosDB state store, your data must be sent to Dapr in JSON-serialized. Having it just JSON *serializable* will not work. To use the CosmosDB state store, your data must be sent to Dapr in JSON-serialized. Having it just JSON *serializable* will not work.

View File

@ -14,7 +14,7 @@
{{ end }} {{ end }}
{{ $url := urls.Parse .URL }} {{ $url := urls.Parse .URL }}
{{ $baseurl := urls.Parse $.Site.Params.Baseurl }} {{ $baseurl := urls.Parse $.Site.Params.Baseurl }}
<a class="nav-link{{if $active }} active{{end}}" href="{{ with .Page }}{{ .RelPermalink }}{{ else }}{{ .URL | relLangURL }}{{ end }}" {{ if ne $url.Host $baseurl.Host }}target="_blank" {{ end }}><span{{if $active }} class="active"{{end}}>{{ .Name }}</span></a> <a class="nav-link{{if $active }} active{{end}}" href="{{ with .Page }}{{ .RelPermalink }}{{ else }}{{ .URL | relLangURL }}{{ end }}" {{ if ne $url.Host $baseurl.Host }}target="_blank" rel="nofollow noopener noreferrer"{{ end }}><span{{if $active }} class="active"{{end}}>{{ .Name }}</span></a>
</li> </li>
{{ end }} {{ end }}
{{ if .Site.Params.versions }} {{ if .Site.Params.versions }}

View File

@ -21,8 +21,8 @@
{{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL }} {{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL }}
{{ $newPageURL := printf "%s/new/%s?%s" $gh_repo $gh_repo_path $newPageQS }} {{ $newPageURL := printf "%s/new/%s?%s" $gh_repo $gh_repo_path $newPageQS }}
<a href="{{ $editURL }}" target="_blank"><i class="fa fa-edit fa-fw"></i> {{ T "post_edit_this" }}</a> <a href="{{ $editURL }}" target="_blank" rel="nofollow noopener noreferrer"><i class="fa fa-edit fa-fw"></i> {{ T "post_edit_this" }}</a>
<a href="{{ $issuesURL }}" target="_blank"><i class="fab fa-github fa-fw"></i> {{ T "post_create_issue" }}</a> <a href="{{ $issuesURL }}" target="_blank" rel="nofollow noopener noreferrer"><i class="fab fa-github fa-fw"></i> {{ T "post_create_issue" }}</a>
</div> </div>
{{ end }} {{ end }}
{{ end }} {{ end }}

View File

@ -8,7 +8,7 @@
{{ with $current_version }}<p>The documentation you are viewing is for Dapr {{ . | markdownify }} {{ with $current_version }}<p>The documentation you are viewing is for Dapr {{ . | markdownify }}
which is an older version of Dapr. which is an older version of Dapr.
{{ with $latest_version }}For up-to-date documentation, see the {{ with $latest_version }}For up-to-date documentation, see the
<a href="{{ $latest_version | safeURL }}" target="_blank">latest version</a>.</p> <a href="{{ $latest_version | safeURL }}" target="_blank" rel="nofollow noopener noreferrer">latest version</a>.</p>
{{ end }} {{ end }}
{{ end }} {{ end }}
</div> </div>

View File

Before

Width:  |  Height:  |  Size: 181 KiB

After

Width:  |  Height:  |  Size: 181 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB