Skip to content

Commit 2dd30f0

Browse files
committed
Merge upstream/v1.16 into add-clickhouse-state-store-docs-v1.16
2 parents 7dfc417 + 68f1be7 commit 2dd30f0

File tree

16 files changed

+230
-126
lines changed

16 files changed

+230
-126
lines changed

.github/workflows/website-root.yml

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

.github/workflows/website-v1-15.yml renamed to .github/workflows/website-v1-16.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
name: Azure Static Web App v1.15
1+
name: Azure Static Web App v1.16
22

33
on:
44
workflow_dispatch:
55
push:
66
branches:
7-
- v1.15
7+
- v1.16
88
pull_request:
99
types: [opened, synchronize, reopened, closed]
1010
branches:
11-
- v1.15
11+
- v1.16
1212

1313
jobs:
1414
build_and_deploy_job:
@@ -29,7 +29,7 @@ jobs:
2929
HUGO_ENV: production
3030
HUGO_VERSION: "0.100.2"
3131
with:
32-
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_V1_15 }}
32+
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_V1_16 }}
3333
repo_token: ${{ secrets.GITHUB_TOKEN }} # Used for Github integrations (i.e. PR comments)
3434
skip_deploy_on_missing_secrets: true
3535
action: "upload"
@@ -50,6 +50,6 @@ jobs:
5050
id: closepullrequest
5151
uses: Azure/static-web-apps-deploy@v1
5252
with:
53-
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_V1_15 }}
53+
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_V1_16 }}
5454
skip_deploy_on_missing_secrets: true
5555
action: "close"

daprdocs/config.toml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Site Configuration
2-
baseURL = "https://docs.dapr.io"
2+
baseURL = "https://v1-16.docs.dapr.io"
33
title = "Dapr Docs"
44
theme = "docsy"
55
disableFastRender = true
@@ -200,20 +200,20 @@ offlineSearch = false
200200
github_repo = "https://github.com/dapr/docs"
201201
github_project_repo = "https://github.com/dapr/dapr"
202202
github_subdir = "daprdocs"
203-
github_branch = "v1.15"
203+
github_branch = "v1.16"
204204

205205
# Versioning
206-
version_menu = "v1.15 (latest)"
207-
version = "v1.15"
206+
version_menu = "v1.16 (preview)"
207+
version = "v1.16"
208208
archived_version = false
209209
url_latest_version = "https://docs.dapr.io"
210210

211211
[[params.versions]]
212212
version = "v1.16 (preview)"
213-
url = "https://v1-16.docs.dapr.io"
213+
url = "#"
214214
[[params.versions]]
215215
version = "v1.15 (latest)"
216-
url = "#"
216+
url = "https://docs.dapr.io"
217217
[[params.versions]]
218218
version = "v1.14"
219219
url = "https://v1-14.docs.dapr.io"
@@ -281,4 +281,4 @@ no = '<b>Sorry to hear that.</b> Please <a href="https://github.com/dapr/docs/is
281281
name = "Zoom"
282282
url = "https://aka.ms/dapr-community-call"
283283
icon = "fas fa-video"
284-
desc = "Meetings happen here!"
284+
desc = "Meetings happen here!"

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Want to put the Dapr conversation API to the test? Walk through the following qu
5959

6060
| Quickstart/tutorial | Description |
6161
| ------------------- | ----------- |
62-
| [Conversation quickstart]({{< ref conversation-quickstart.md >}}) | Learn how to interact with Large Language Models (LLMs) using the conversation API. |
62+
| [Conversation quickstart]({{< ref conversation-quickstart.md >}}) | Learn how to interact with Large Language Models (LLMs) using the conversation API. |
6363

6464
### Start using the conversation API directly in your app
6565

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ All jobs are registered with a case-sensitive job name. These names are intended
1919
interfacing with the Dapr runtime. The name is used as an identifier when creating and modifying the job as well as
2020
to indicate which job a triggered invocation is associated with.
2121

22-
Only one job can be associated with a name at any given time. Any attempt to create a new job using the same name
23-
as an existing job will result in an overwrite of this existing job.
22+
Only one job can be associated with a name at any given time. By default, any attempt to create a new job using the same name as an existing job results in an error. However, if the `overwrite` flag is set to `true`, the new job overwrites the existing job with the same name.
2423

2524
## Scheduling Jobs
2625
A job can be scheduled using any of the following mechanisms:
@@ -115,6 +114,7 @@ POST request to the endpoint `/job/<job-name>`. The body includes the following
115114
or the not-before time from which the schedule should take effect
116115
- `Ttl`: An optional value indicating when the job should expire
117116
- `Payload`: A collection of bytes containing data originally stored when the job was scheduled
117+
- `Overwrite`: A flag to allow the requested job to overwrite an existing job with the same name, if it already exists.
118118

119119
The `DueTime` and `Ttl` fields will reflect an RC3339 timestamp value reflective of the time zone provided when the job was
120120
originally scheduled. If no time zone was provided, these values indicate the time zone used by the server running

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,11 @@ Dapr's jobs API ensures the tasks represented in these scenarios are performed c
5353

5454
## Features
5555

56-
The jobs API provides several features to make it easy for you to schedule jobs.
56+
The main functionality of the Jobs API allows you to create, retrieve, and delete scheduled jobs. By default, when you create a job with a name that already exists, the operation fails unless you explicitly set the `overwrite` flag to `true`. This ensures that existing jobs are not accidentally modified or overwritten.
5757

5858
### Schedule jobs across multiple replicas
5959

60-
When you create a job, it replaces any existing job with the same name. This means that every time a job is created, it resets the count and only keeps 1 record in the embedded etcd for that job. Therefore, you don't need to worry about multiple jobs being created and firing off — only the most recent job is recorded and executed, even if all your apps schedule the same job on startup.
60+
When you create a job, it does not replace an existing job with the same name, unless you explicitly set the `overwrite` flag. This means that every time a job is created, it resets the count and only keeps 1 record in the embedded etcd for that job. Therefore, you don't need to worry about multiple jobs being created and firing off — only the most recent job is recorded and executed, even if all your apps schedule the same job on startup.
6161

6262
The Scheduler service enables the scheduling of jobs to scale across multiple replicas, while guaranteeing that a job is only triggered by 1 Scheduler service instance.
6363

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Parameter | Description
3737
`dueTime` | An optional time at which the job should be active, or the "one shot" time, if other scheduling type fields are not provided. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from creation time), or non-repeating ISO8601.
3838
`repeats` | An optional number of times in which the job should be triggered. If not set, the job runs indefinitely or until expiration.
3939
`ttl` | An optional time to live or expiration of the job. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601.
40+
`overwrite` | A boolean value to specify if the job can overwrite an existing one with the same name. Default value is `false`
4041

4142
#### schedule
4243
`schedule` accepts both systemd timer-style cron expressions, as well as human readable '@' prefixed period strings, as defined below.

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,24 @@ The following metadata options are **required** to authenticate using a PostgreS
4141
|--------|:--------:|---------|---------|
4242
| `connectionString` | Y | The connection string for the PostgreSQL database. See the PostgreSQL [documentation on database connections](https://www.postgresql.org/docs/current/libpq-connect.html) for information on how to define a connection string. | `"host=localhost user=postgres password=example port=5432 connect_timeout=10 database=my_db"`
4343

44+
#### Authenticate using individual connection parameters
45+
46+
In addition to using a connection string, you can optionally specify individual connection parameters. These parameters are equivalent to the standard PostgreSQL connection parameters.
47+
48+
| Field | Required | Details | Example |
49+
|--------|:--------:|---------|---------|
50+
| `host` | Y | The host name or IP address of the PostgreSQL server | `"localhost"` |
51+
| `hostaddr` | N | The IP address of the PostgreSQL server (alternative to host) | `"127.0.0.1"` |
52+
| `port` | Y | The port number of the PostgreSQL server | `"5432"` |
53+
| `database` | Y | The name of the database to connect to | `"my_db"` |
54+
| `user` | Y | The PostgreSQL user to connect as | `"postgres"` |
55+
| `password` | Y | The password for the PostgreSQL user | `"example"` |
56+
| `sslRootCert` | N | Path to the SSL root certificate file | `"/path/to/ca.crt"` |
57+
58+
{{% alert title="Note" color="primary" %}}
59+
When using individual connection parameters, these will override the ones present in the `connectionString`.
60+
{{% /alert %}}
61+
4462
### Authenticate using Microsoft Entra ID
4563

4664
Authenticating with Microsoft Entra ID is supported with Azure Database for PostgreSQL. All authentication methods supported by Dapr can be used, including client credentials ("service principal") and Managed Identity.

daprdocs/content/en/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,21 @@ spec:
2727
# Name of the table which holds configuration information
2828
- name: table
2929
value: "[your_configuration_table_name]"
30+
# Individual connection parameters - can be used instead to override connectionString parameters
31+
#- name: host
32+
# value: "localhost"
33+
#- name: hostaddr
34+
# value: "127.0.0.1"
35+
#- name: port
36+
# value: "5432"
37+
#- name: database
38+
# value: "my_db"
39+
#- name: user
40+
# value: "postgres"
41+
#- name: password
42+
# value: "example"
43+
#- name: sslRootCert
44+
# value: "/path/to/ca.crt"
3045
# Timeout for database operations, in seconds (optional)
3146
#- name: timeoutInSeconds
3247
# value: 20
@@ -67,6 +82,24 @@ The following metadata options are **required** to authenticate using a PostgreS
6782
|--------|:--------:|---------|---------|
6883
| `connectionString` | Y | The connection string for the PostgreSQL database. See the PostgreSQL [documentation on database connections](https://www.postgresql.org/docs/current/libpq-connect.html) for information on how to define a connection string. | `"host=localhost user=postgres password=example port=5432 connect_timeout=10 database=my_db"`
6984

85+
#### Authenticate using individual connection parameters
86+
87+
In addition to using a connection string, you can optionally specify individual connection parameters. These parameters are equivalent to the standard PostgreSQL connection parameters.
88+
89+
| Field | Required | Details | Example |
90+
|--------|:--------:|---------|---------|
91+
| `host` | Y | The host name or IP address of the PostgreSQL server | `"localhost"` |
92+
| `hostaddr` | N | The IP address of the PostgreSQL server (alternative to host) | `"127.0.0.1"` |
93+
| `port` | Y | The port number of the PostgreSQL server | `"5432"` |
94+
| `database` | Y | The name of the database to connect to | `"my_db"` |
95+
| `user` | Y | The PostgreSQL user to connect as | `"postgres"` |
96+
| `password` | Y | The password for the PostgreSQL user | `"example"` |
97+
| `sslRootCert` | N | Path to the SSL root certificate file | `"/path/to/ca.crt"` |
98+
99+
{{% alert title="Note" color="primary" %}}
100+
When using individual connection parameters, these will override the ones present in the `connectionString`.
101+
{{% /alert %}}
102+
70103
### Authenticate using Microsoft Entra ID
71104

72105
Authenticating with Microsoft Entra ID is supported with Azure Database for PostgreSQL. All authentication methods supported by Dapr can be used, including client credentials ("service principal") and Managed Identity.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
type: docs
3+
title: "GoogleAI"
4+
linkTitle: "GoogleAI"
5+
description: Detailed information on the GoogleAI conversation component
6+
---
7+
8+
## Component format
9+
10+
A Dapr `conversation.yaml` component file has the following structure:
11+
12+
```yaml
13+
apiVersion: dapr.io/v1alpha1
14+
kind: Component
15+
metadata:
16+
name: googleai
17+
spec:
18+
type: conversation.googleai
19+
metadata:
20+
- name: key
21+
value: mykey
22+
- name: model
23+
value: gemini-1.5-flash
24+
- name: cacheTTL
25+
value: 10m
26+
```
27+
28+
{{% alert title="Warning" color="warning" %}}
29+
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 >}}).
30+
{{% /alert %}}
31+
32+
## Spec metadata fields
33+
34+
| Field | Required | Details | Example |
35+
|--------------------|:--------:|---------|---------|
36+
| `key` | Y | API key for GoogleAI. | `mykey` |
37+
| `model` | N | The GoogleAI LLM to use. Defaults to `gemini-1.5-flash`. | `gemini-2.0-flash` |
38+
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
39+
40+
## Related links
41+
42+
- [Conversation API overview]({{< ref conversation-overview.md >}})

0 commit comments

Comments
 (0)