Skip to content

Commit 5749b2e

Browse files
authored
Merge branch 'v1.13' into issue_3869
2 parents 3018bad + 7c09f2c commit 5749b2e

File tree

16 files changed

+272
-191
lines changed

16 files changed

+272
-191
lines changed

daprdocs/config.toml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -209,18 +209,6 @@ url_latest_version = "https://docs.dapr.io"
209209
[[params.versions]]
210210
version = "v1.7"
211211
url = "https://v1-7.docs.dapr.io"
212-
[[params.versions]]
213-
version = "v1.6"
214-
url = "https://v1-6.docs.dapr.io"
215-
[[params.versions]]
216-
version = "v1.5"
217-
url = "https://v1-5.docs.dapr.io"
218-
[[params.versions]]
219-
version = "v1.4"
220-
url = "https://v1-4.docs.dapr.io"
221-
[[params.versions]]
222-
version = "v1.3"
223-
url = "https://v1-3.docs.dapr.io"
224212

225213
# UI Customization
226214
[params.ui]

daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,13 @@ The diagram below shows an example of how this works. If you have 1 instance of
9090

9191
**Note**: App ID is unique per _application_, not application instance. Regardless how many instances of that application exist (due to scaling), all of them will share the same app ID.
9292

93-
### Pluggable service discovery
93+
### Swappable service discovery
9494

95-
Dapr can run on a variety of [hosting platforms]({{< ref hosting >}}). To enable service discovery and service invocation, Dapr uses pluggable [name resolution components]({{< ref supported-name-resolution >}}). For example, the Kubernetes name resolution component uses the Kubernetes DNS service to resolve the location of other applications running in the cluster. Self-hosted machines can use the mDNS name resolution component. The Consul name resolution component can be used in any hosting environment, including Kubernetes or self-hosted.
95+
Dapr can run on a variety of [hosting platforms]({{< ref hosting >}}). To enable swappable service discovery with service invocation, Dapr uses [name resolution components]({{< ref supported-name-resolution >}}). For example, the Kubernetes name resolution component uses the Kubernetes DNS service to resolve the location of other applications running in the cluster.
96+
97+
Self-hosted machines can use the mDNS name resolution component. As an alternative, you can use the SQLite name resolution component to run Dapr on single-node environments and for local development scenarios. Dapr sidecars that are part of the cluster store their information in a SQLite database on the local machine.
98+
99+
The Consul name resolution component is particularly suited to multi-machine deployments and can be used in any hosting environment, including Kubernetes, multiple VMs, or self-hosted.
96100

97101
### Streaming for HTTP service invocation
98102

daprdocs/content/en/operations/configuration/configuration-overview.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ The following configuration settings can be applied to Dapr application sidecars
5050
- [Metrics](#metrics)
5151
- [Logging](#logging)
5252
- [Middleware](#middleware)
53+
- [Name resolution](#name-resolution)
5354
- [Scope secret store access](#scope-secret-store-access)
5455
- [Access Control allow lists for building block APIs](#access-control-allow-lists-for-building-block-apis)
5556
- [Access Control allow lists for service invocation API](#access-control-allow-lists-for-service-invocation-api)
@@ -189,6 +190,29 @@ The following table lists the properties for HTTP handlers:
189190

190191
See [Middleware pipelines]({{< ref "middleware.md" >}}) for more information
191192

193+
#### Name resolution component
194+
195+
You can set name resolution component to use within the configuration YAML. For example, to set the `spec.nameResolution.component` property to `"sqlite"`, pass configuration options in the `spec.nameResolution.configuration` dictionary as shown below.
196+
197+
This is the basic example of a configuration resource:
198+
199+
```yaml
200+
apiVersion: dapr.io/v1alpha1
201+
kind: Configuration
202+
metadata:
203+
name: appconfig
204+
spec:
205+
nameResolution:
206+
component: "sqlite"
207+
version: "v1"
208+
configuration:
209+
connectionString: "/home/user/.dapr/nr.db"
210+
```
211+
212+
For more information, see:
213+
- [The name resolution component documentation]({{< ref supported-name-resolution >}}) for more examples.
214+
- - [The Configuration YAML documentation]({{< ref configuration-schema.md >}}) to learn more about how to configure name resolution per component.
215+
192216
#### Scope secret store access
193217

194218
See the [Scoping secrets]({{< ref "secret-scope.md" >}}) guide for information and examples on how to scope secrets to an application.

daprdocs/content/en/reference/components-reference/supported-name-resolution/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ no_list: true
99

1010
The following components provide name resolution for the service invocation building block.
1111

12+
Name resolution components are configured via the [configuration]({{< ref configuration-overview.md >}}).
13+
1214
{{< partial "components/description.html" >}}
1315

1416
{{< partial "components/name-resolution.html" >}}

daprdocs/content/en/reference/components-reference/supported-name-resolution/nr-kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
type: docs
3-
title: "Kubernetes DNS name resolution provider spec"
3+
title: "Kubernetes DNS"
44
linkTitle: "Kubernetes DNS"
55
description: Detailed information on the Kubernetes DNS name resolution component
66
---

daprdocs/content/en/reference/components-reference/supported-name-resolution/nr-mdns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
type: docs
3-
title: "mDNS name resolution provider spec"
3+
title: "mDNS"
44
linkTitle: "mDNS"
55
description: Detailed information on the mDNS name resolution component
66
---

daprdocs/content/en/reference/components-reference/supported-name-resolution/nr-sqlite.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
type: docs
3-
title: "SQLite name resolution provider"
3+
title: "SQLite"
44
linkTitle: "SQLite"
55
description: Detailed information on the SQLite name resolution component
66
---

daprdocs/content/en/reference/components-reference/supported-name-resolution/setup-nr-consul.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
type: docs
3-
title: "HashiCorp Consul name resolution provider spec"
3+
title: "HashiCorp Consul"
44
linkTitle: "HashiCorp Consul"
55
description: Detailed information on the HashiCorp Consul name resolution component
66
---

daprdocs/content/en/reference/components-reference/supported-pubsub/setup-nats-streaming.md

Lines changed: 0 additions & 133 deletions
This file was deleted.

daprdocs/content/en/reference/components-reference/supported-state-stores/setup-azure-blobstorage.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ metadata:
1818
name: <NAME>
1919
spec:
2020
type: state.azure.blobstorage
21-
version: v1
21+
# Supports v1 and v2. Users should always use v2 by default. There is no
22+
# migration path from v1 to v2, see `versioning` below.
23+
version: v2
2224
metadata:
2325
- name: accountName
2426
value: "[your_account_name]"
@@ -32,21 +34,32 @@ spec:
3234
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 >}}).
3335
{{% /alert %}}
3436
37+
## Versioning
38+
39+
Dapr has 2 versions of the Azure Blob Storage state store component: `v1` and `v2`. It is recommended to use `v2` for all new applications. `v1` is considered legacy and is preserved for compatibility with existing applications only.
40+
41+
In `v1`, a longstanding implementation issue was identified, where the [key prefix]({{< ref howto-share-state.md >}}) was incorrectly stripped by the component, essentially behaving as if `keyPrefix` was always set to `none`.
42+
The updated `v2` of the component fixes the incorrect behavior and makes the state store correctly respect the `keyPrefix` property.
43+
44+
While `v1` and `v2` have the same metadata fields, they are otherwise incompatible, with no automatic data migration path for `v1` to `v2`.
45+
46+
If you are using `v1` of this component, you should continue to use `v1` until you create a new state store.
47+
3548
## Spec metadata fields
3649

37-
| Field | Required | Details | Example |
50+
| Field | Required | Details | Example |
3851
|--------------------|:--------:|---------|---------|
39-
| `accountName` | Y | The storage account name | `"mystorageaccount"`.
40-
| `accountKey` | Y (unless using Microsoft Entra ID) | Primary or secondary storage key | `"key"`
41-
| `containerName` | Y | The name of the container to be used for Dapr state. The container will be created for you if it doesn't exist | `"container"`
42-
| `azureEnvironment` | N | Optional name for the Azure environment if using a different Azure cloud | `"AZUREPUBLICCLOUD"` (default value), `"AZURECHINACLOUD"`, `"AZUREUSGOVERNMENTCLOUD"`, `"AZUREGERMANCLOUD"`
52+
| `accountName` | Y | The storage account name | `"mystorageaccount"`. |
53+
| `accountKey` | Y (unless using Microsoft Entra ID) | Primary or secondary storage key | `"key"` |
54+
| `containerName` | Y | The name of the container to be used for Dapr state. The container will be created for you if it doesn't exist | `"container"` |
55+
| `azureEnvironment` | N | Optional name for the Azure environment if using a different Azure cloud | `"AZUREPUBLICCLOUD"` (default value), `"AZURECHINACLOUD"`, `"AZUREUSGOVERNMENTCLOUD"` |
4356
| `endpoint` | N | Optional custom endpoint URL. This is useful when using the [Azurite emulator](https://github.com/Azure/azurite) or when using custom domains for Azure Storage (although this is not officially supported). The endpoint must be the full base URL, including the protocol (`http://` or `https://`), the IP or FQDN, and optional port. | `"http://127.0.0.1:10000"`
44-
| `ContentType` | N | The blob's content type | `"text/plain"`
45-
| `ContentMD5` | N | The blob's MD5 hash | `"vZGKbMRDAnMs4BIwlXaRvQ=="`
46-
| `ContentEncoding` | N | The blob's content encoding | `"UTF-8"`
47-
| `ContentLanguage` | N | The blob's content language | `"en-us"`
48-
| `ContentDisposition` | N | The blob's content disposition. Conveys additional information about how to process the response payload | `"attachment"`
49-
| `CacheControl` | N | The blob's cache control | `"no-cache"`
57+
| `ContentType` | N | The blob's content type | `"text/plain"` |
58+
| `ContentMD5` | N | The blob's MD5 hash | `"vZGKbMRDAnMs4BIwlXaRvQ=="` |
59+
| `ContentEncoding` | N | The blob's content encoding | `"UTF-8"` |
60+
| `ContentLanguage` | N | The blob's content language | `"en-us"` |
61+
| `ContentDisposition` | N | The blob's content disposition. Conveys additional information about how to process the response payload | `"attachment"` |
62+
| `CacheControl`| N | The blob's cache control | `"no-cache"` |
5063

5164
## Setup Azure Blob Storage
5265

0 commit comments

Comments
 (0)