Skip to content

Commit d8a5628

Browse files
authored
Merge branch 'v1.12' into perf-1
2 parents af8dc61 + 42c2b50 commit d8a5628

File tree

10 files changed

+49
-44
lines changed

10 files changed

+49
-44
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Contributing to Dapr docs
22

3-
Please see [this docs section](https://docs.dapr.io/contributing/) for general guidance on contributions to the Dapr project as well as specific guidelines on contributions to the docs repo.
3+
Please see [this docs section](https://docs.dapr.io/contributing/) for general guidance on contributions to the Dapr project as well as specific guidelines on contributions to the docs repo. Learn more about [Dapr bot commands and labels](https://docs.dapr.io/contributing/daprbot/) to improve your docs contributing experience.

daprdocs/config.toml

-12
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/contributing/daprbot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Dapr bot is triggered by a list of commands that helps with common tasks in the
1212

1313
| Command | Target | Description | Who can use | Repository |
1414
| ---------------- | --------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -------------------------------------- |
15-
| `/assign` | Issue | Assigns an issue to a user or group of users | Anyone | `dapr`, `components-contrib`, `go-sdk` |
15+
| `/assign` | Issue | Assigns an issue to a user or group of users | Anyone | `dapr`, `docs`, `quickstarts`, `cli`, `components-contrib`, `go-sdk`, `js-sdk`, `java-sdk`, `python-sdk`, `dotnet-sdk` |
1616
| `/ok-to-test` | Pull request | `dapr`: trigger end to end tests <br/> `components-contrib`: trigger conformance and certification tests | Users listed in the [bot](https://github.com/dapr/dapr/blob/master/.github/scripts/dapr_bot.js) | `dapr`, `components-contrib` |
1717
| `/ok-to-perf` | Pull request | Trigger performance tests. | Users listed in the [bot](https://github.com/dapr/dapr/blob/master/.github/scripts/dapr_bot.js) | `dapr` |
1818
| `/make-me-laugh` | Issue or pull request | Posts a random joke | Users listed in the [bot](https://github.com/dapr/dapr/blob/master/.github/scripts/dapr_bot.js) | `dapr`, `components-contrib` |

daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-architecture.md

+2
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@ Different state store implementations may implicitly put restrictions on the typ
145145

146146
Similarly, if a state store imposes restrictions on the size of a batch transaction, that may limit the number of parallel actions that can be scheduled by a workflow.
147147

148+
Workflow state can be purged from a state store, including all its history. Each Dapr SDK exposes APIs for purging all metadata related to specific workflow instances.
149+
148150
## Workflow scalability
149151

150152
Because Dapr Workflows are internally implemented using actors, Dapr Workflows have the same scalability characteristics as actors. The placement service:

daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md

+8
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ You can use the following two techniques to write workflows that may need to sch
6363

6464
1. **Use the _continue-as-new_ API**:
6565
Each workflow SDK exposes a _continue-as-new_ API that workflows can invoke to restart themselves with a new input and history. The _continue-as-new_ API is especially ideal for implementing "eternal workflows", like monitoring agents, which would otherwise be implemented using a `while (true)`-like construct. Using _continue-as-new_ is a great way to keep the workflow history size small.
66+
67+
> The _continue-as-new_ API truncates the existing history, replacing it with a new history.
6668
6769
1. **Use child workflows**:
6870
Each workflow SDK exposes an API for creating child workflows. A child workflow behaves like any other workflow, except that it's scheduled by a parent workflow. Child workflows have:
@@ -149,6 +151,12 @@ Workflows can also wait for multiple external event signals of the same name, in
149151

150152
Learn more about [external system interaction.]({{< ref "workflow-patterns.md#external-system-interaction" >}})
151153

154+
## Purging
155+
156+
Workflow state can be purged from a state store, purging all its history and removing all metadata related to a specific workflow instance. The purge capability is used for workflows that have run to a `COMPLETED`, `FAILED`, or `TERMINATED` state.
157+
158+
Learn more in [the workflow API reference guide]({{< ref workflow_api.md >}}).
159+
152160
## Limitations
153161

154162
### Workflow determinism and code restraints

daprdocs/content/en/reference/api/workflow_api.md

+4
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,10 @@ Purge the workflow state from your state store with the workflow's instance ID.
174174
POST http://localhost:3500/v1.0-beta1/workflows/<workflowComponentName>/<instanceId>/purge
175175
```
176176

177+
{{% alert title="Note" color="primary" %}}
178+
Only `COMPLETED`, `FAILED`, or `TERMINATED` workflows can be purged.
179+
{{% /alert %}}
180+
177181
### URL parameters
178182

179183
Parameter | Description

daprdocs/content/en/reference/components-reference/supported-bindings/openai.md

+5
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,11 @@ The response body contains the following JSON:
276276
[0.018574921,-0.00023652936,-0.0057790717,.... (1536 floats total for ada)]
277277
```
278278

279+
## Learn more about the Azure OpenAI output binding
280+
281+
Watch [the following Community Call presentation](https://youtu.be/rTovKpG0rhY?si=g7hZTQSpSEXz4pV1&t=80) to learn more about the Azure OpenAI output binding.
282+
283+
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/rTovKpG0rhY?si=XP1S-80SIg1ptJuG&amp;start=80" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
279284

280285
## Related links
281286

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

+18-24
Original file line numberDiff line numberDiff line change
@@ -47,67 +47,60 @@ spec:
4747
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 >}}).
4848
{{% /alert %}}
4949
50-
If you wish to use MongoDB as an actor store, append the following to the yaml.
50+
### Actor state store and transactions support
51+
52+
When using as an actor state store or to leverage transactions, MongoDB must be running in a [Replica Set](https://www.mongodb.com/docs/manual/replication/).
53+
54+
If you wish to use MongoDB as an actor store, add this metadata option to your Component YAML:
5155
5256
```yaml
5357
- name: actorStateStore
5458
value: "true"
5559
```
5660
57-
5861
## Spec metadata fields
5962
6063
| Field | Required | Details | Example |
6164
|--------------------|:--------:|---------|---------|
62-
| server | Y<sup>*</sup> | The server to connect to, when using DNS SRV record | `"server.example.com"`
63-
| host | Y<sup>*</sup> | The host to connect to | `"mongo-mongodb.default.svc.cluster.local:27017"`
65+
| server | Y<sup>1</sup> | The server to connect to, when using DNS SRV record | `"server.example.com"`
66+
| host | Y<sup>1</sup> | The host to connect to | `"mongo-mongodb.default.svc.cluster.local:27017"`
6467
| username | N | The username of the user to connect with (applicable in conjunction with `host`) | `"admin"`
6568
| password | N | The password of the user (applicable in conjunction with `host`) | `"password"`
6669
| databaseName | N | The name of the database to use. Defaults to `"daprStore"` | `"daprStore"`
6770
| collectionName | N | The name of the collection to use. Defaults to `"daprCollection"` | `"daprCollection"`
6871
| writeConcern | N | The write concern to use | `"majority"`
6972
| readConcern | N | The read concern to use | `"majority"`, `"local"`,`"available"`, `"linearizable"`, `"snapshot"`
7073
| operationTimeout | N | The timeout for the operation. Defaults to `"5s"` | `"5s"`
71-
| params | N<sup>**</sup> | Additional parameters to use | `"?authSource=daprStore&ssl=true"`
74+
| params | N<sup>2</sup> | Additional parameters to use | `"?authSource=daprStore&ssl=true"`
7275

73-
> <sup>[*]</sup> The `server` and `host` fields are mutually exclusive. If neither or both are set, Dapr will return an error.
76+
> <sup>[1]</sup> The `server` and `host` fields are mutually exclusive. If neither or both are set, Dapr returns an error.
7477

75-
> <sup>[**]</sup> The `params` field accepts a query string that specifies connection specific options as `<name>=<value>` pairs, separated by `"&"` and prefixed with `"?"`. e.g. to use "daprStore" db as authentication database and enabling SSL/TLS in connection, specify params as `"?authSource=daprStore&ssl=true"`. See [the mongodb manual](https://docs.mongodb.com/manual/reference/connection-string/#std-label-connections-connection-options) for the list of available options and their use cases.
78+
> <sup>[2]</sup> The `params` field accepts a query string that specifies connection specific options as `<name>=<value>` pairs, separated by `&` and prefixed with `?`. e.g. to use "daprStore" db as authentication database and enabling SSL/TLS in connection, specify params as `?authSource=daprStore&ssl=true`. See [the mongodb manual](https://docs.mongodb.com/manual/reference/connection-string/#std-label-connections-connection-options) for the list of available options and their use cases.
7679

7780
## Setup MongoDB
7881

7982
{{< tabs "Self-Hosted" "Kubernetes" >}}
8083

8184
{{% codetab %}}
82-
You can run MongoDB locally using Docker:
85+
You can run a single MongoDB instance locally using Docker:
8386

84-
```
87+
```sh
8588
docker run --name some-mongo -d mongo
8689
```
8790

88-
You can then interact with the server using `localhost:27017`.
89-
90-
If you do not specify a `databaseName` value in your component definition, make sure to create a database named `daprStore`.
91+
You can then interact with the server at `localhost:27017`. If you do not specify a `databaseName` value in your component definition, make sure to create a database named `daprStore`.
9192

93+
In order to use the MongoDB state store for transactions and as an actor state store, you need to run MongoDB as a Replica Set. Refer to [the official documentation](https://www.mongodb.com/compatibility/deploying-a-mongodb-cluster-with-docker) for how to create a 3-node Replica Set using Docker.
9294
{{% /codetab %}}
9395

9496
{{% codetab %}}
95-
The easiest way to install MongoDB on Kubernetes is by using the [Helm chart](https://github.com/helm/charts/tree/master/stable/mongodb):
96-
97-
```
98-
helm install mongo stable/mongodb
99-
```
100-
97+
You can conveniently install MongoDB on Kubernetes using the [Helm chart packaged by Bitnami](https://github.com/bitnami/charts/tree/main/bitnami/mongodb/). Refer to the documentation for the Helm chart for deploying MongoDB, both as a standalone server, and with a Replica Set (required for using transactions and actors).
10198
This installs MongoDB into the `default` namespace.
10299
To interact with MongoDB, find the service with: `kubectl get svc mongo-mongodb`.
103-
104-
For example, if installing using the example above, the MongoDB host address would be:
105-
100+
For example, if installing using the Helm defaults above, the MongoDB host address would be:
106101
`mongo-mongodb.default.svc.cluster.local:27017`
107-
108-
109102
Follow the on-screen instructions to get the root password for MongoDB.
110-
The username is `admin` by default.
103+
The username is typically `admin` by default.
111104
{{% /codetab %}}
112105

113106
{{< /tabs >}}
@@ -117,6 +110,7 @@ The username is `admin` by default.
117110
This state store supports [Time-To-Live (TTL)]({{< ref state-store-ttl.md >}}) for records stored with Dapr. When storing data using Dapr, you can set the `ttlInSeconds` metadata property to indicate when the data should be considered "expired".
118111

119112
## Related links
113+
120114
- [Basic schema for a Dapr component]({{< ref component-schema >}})
121115
- Read [this guide]({{< ref "howto-get-save-state.md#step-2-save-and-retrieve-a-single-state" >}}) for instructions on configuring state store components
122116
- [State management building block]({{< ref state-management >}})

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

+2-6
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,14 @@ spec:
3030
value: <PASSWORD>
3131
- name: enableTLS
3232
value: <bool> # Optional. Allowed: true, false.
33-
- name: failover
34-
value: <bool> # Optional. Allowed: true, false.
35-
- name: sentinelMasterName
36-
value: <string> # Optional
3733
- name: maxRetries
3834
value: # Optional
3935
- name: maxRetryBackoff
4036
value: # Optional
4137
- name: failover
42-
value: # Optional
38+
value: <bool> # Optional. Allowed: true, false.
4339
- name: sentinelMasterName
44-
value: # Optional
40+
value: <string> # Optional
4541
- name: redeliverInterval
4642
value: # Optional
4743
- name: processingTimeout

daprdocs/data/components/bindings/azure.yaml

+8
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@
1414
features:
1515
input: true
1616
output: true
17+
- component: Azure OpenAI
18+
link: openai
19+
state: Alpha
20+
version: v1
21+
since: "1.11"
22+
features:
23+
input: true
24+
output: true
1725
- component: Azure SignalR
1826
link: signalr
1927
state: Alpha

0 commit comments

Comments
 (0)