Merge upstream/v1.16 into add-clickhouse-state-store-docs-v1.16

This commit is contained in:
Mehmet TOSUN 2025-06-27 14:46:52 +03:00
commit 2dd30f00cd
No known key found for this signature in database
GPG Key ID: EBA7C8D3B82C18A9
16 changed files with 230 additions and 126 deletions

View File

@ -1,109 +0,0 @@
name: Azure Static Web App Root
on:
workflow_dispatch:
push:
branches:
- v1.15
pull_request:
types: [opened, synchronize, reopened, closed]
branches:
- v1.15
concurrency:
# Cancel the previously triggered build for only PR build.
group: website-${{ github.event.pull_request.number || github.sha }}
cancel-in-progress: true
jobs:
build_and_deploy_job:
name: Build Hugo Website
if: github.event.action != 'closed'
runs-on: ubuntu-latest
env:
SWA_BASE: 'proud-bay-0e9e0e81e'
HUGO_ENV: production
steps:
- name: Checkout docs repo
uses: actions/checkout@v3
with:
submodules: true
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '14'
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.5.0
with:
hugo-version: 0.102.3
extended: true
- name: Setup Docsy
run: |
cd daprdocs
git submodule update --init --recursive
sudo npm install -D --save autoprefixer
sudo npm install -D --save postcss-cli
- name: Build Hugo Website
run: |
cd daprdocs
git config --global --add safe.directory /github/workspace
if [ $GITHUB_EVENT_NAME == 'pull_request' ]; then
STAGING_URL="https://${SWA_BASE}-${{github.event.number}}.westus2.azurestaticapps.net/"
fi
hugo ${STAGING_URL+-b "$STAGING_URL"}
- name: Deploy docs site
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PROUD_BAY_0E9E0E81E }}
repo_token: ${{ secrets.GITHUB_TOKEN }}
action: "upload"
app_location: "daprdocs/public/"
api_location: "daprdocs/public/"
output_location: ""
skip_app_build: true
skip_deploy_on_missing_secrets: true
- name: Upload Hugo artifacts
uses: actions/upload-artifact@v4
with:
name: hugo_build
path: ./daprdocs/public/
if-no-files-found: error
close_staging_site:
if: github.event_name == 'pull_request' && github.event.action == 'closed'
runs-on: ubuntu-latest
name: Close Pull Request Job
steps:
- name: Close Pull Request
id: closepullrequest
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PROUD_BAY_0E9E0E81E }}
action: "close"
skip_deploy_on_missing_secrets: true
algolia_index:
name: Index site for Algolia
if: github.event_name == 'push'
needs: ['build_and_deploy_job']
runs-on: ubuntu-latest
env:
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
ALGOLIA_API_WRITE_KEY: ${{ secrets.ALGOLIA_API_WRITE_KEY }}
ALGOLIA_INDEX_NAME: daprdocs
steps:
- name: Checkout docs repo
uses: actions/checkout@v2
with:
submodules: false
- name: Download Hugo artifacts
uses: actions/download-artifact@v3
with:
name: hugo_build
path: site/
- name: Install Python packages
run: |
pip install --upgrade bs4
pip install --upgrade 'algoliasearch>=2.0,<3.0'
- name: Index site
run: python ./.github/scripts/algolia.py ./site

View File

@ -1,14 +1,14 @@
name: Azure Static Web App v1.15
name: Azure Static Web App v1.16
on:
workflow_dispatch:
push:
branches:
- v1.15
- v1.16
pull_request:
types: [opened, synchronize, reopened, closed]
branches:
- v1.15
- v1.16
jobs:
build_and_deploy_job:
@ -29,7 +29,7 @@ jobs:
HUGO_ENV: production
HUGO_VERSION: "0.100.2"
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_V1_15 }}
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_V1_16 }}
repo_token: ${{ secrets.GITHUB_TOKEN }} # Used for Github integrations (i.e. PR comments)
skip_deploy_on_missing_secrets: true
action: "upload"
@ -50,6 +50,6 @@ jobs:
id: closepullrequest
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_V1_15 }}
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_V1_16 }}
skip_deploy_on_missing_secrets: true
action: "close"

View File

@ -1,5 +1,5 @@
# Site Configuration
baseURL = "https://docs.dapr.io"
baseURL = "https://v1-16.docs.dapr.io"
title = "Dapr Docs"
theme = "docsy"
disableFastRender = true
@ -200,20 +200,20 @@ offlineSearch = false
github_repo = "https://github.com/dapr/docs"
github_project_repo = "https://github.com/dapr/dapr"
github_subdir = "daprdocs"
github_branch = "v1.15"
github_branch = "v1.16"
# Versioning
version_menu = "v1.15 (latest)"
version = "v1.15"
version_menu = "v1.16 (preview)"
version = "v1.16"
archived_version = false
url_latest_version = "https://docs.dapr.io"
[[params.versions]]
version = "v1.16 (preview)"
url = "https://v1-16.docs.dapr.io"
url = "#"
[[params.versions]]
version = "v1.15 (latest)"
url = "#"
url = "https://docs.dapr.io"
[[params.versions]]
version = "v1.14"
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
name = "Zoom"
url = "https://aka.ms/dapr-community-call"
icon = "fas fa-video"
desc = "Meetings happen here!"
desc = "Meetings happen here!"

View File

@ -59,7 +59,7 @@ Want to put the Dapr conversation API to the test? Walk through the following qu
| Quickstart/tutorial | Description |
| ------------------- | ----------- |
| [Conversation quickstart]({{< ref conversation-quickstart.md >}}) | Learn how to interact with Large Language Models (LLMs) using the conversation API. |
| [Conversation quickstart]({{< ref conversation-quickstart.md >}}) | Learn how to interact with Large Language Models (LLMs) using the conversation API. |
### Start using the conversation API directly in your app

View File

@ -19,8 +19,7 @@ All jobs are registered with a case-sensitive job name. These names are intended
interfacing with the Dapr runtime. The name is used as an identifier when creating and modifying the job as well as
to indicate which job a triggered invocation is associated with.
Only one job can be associated with a name at any given time. Any attempt to create a new job using the same name
as an existing job will result in an overwrite of this existing job.
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.
## Scheduling Jobs
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
or the not-before time from which the schedule should take effect
- `Ttl`: An optional value indicating when the job should expire
- `Payload`: A collection of bytes containing data originally stored when the job was scheduled
- `Overwrite`: A flag to allow the requested job to overwrite an existing job with the same name, if it already exists.
The `DueTime` and `Ttl` fields will reflect an RC3339 timestamp value reflective of the time zone provided when the job was
originally scheduled. If no time zone was provided, these values indicate the time zone used by the server running

View File

@ -53,11 +53,11 @@ Dapr's jobs API ensures the tasks represented in these scenarios are performed c
## Features
The jobs API provides several features to make it easy for you to schedule jobs.
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.
### Schedule jobs across multiple replicas
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.
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.
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.

View File

@ -37,6 +37,7 @@ Parameter | Description
`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.
`repeats` | An optional number of times in which the job should be triggered. If not set, the job runs indefinitely or until expiration.
`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.
`overwrite` | A boolean value to specify if the job can overwrite an existing one with the same name. Default value is `false`
#### schedule
`schedule` accepts both systemd timer-style cron expressions, as well as human readable '@' prefixed period strings, as defined below.

View File

@ -41,6 +41,24 @@ The following metadata options are **required** to authenticate using a PostgreS
|--------|:--------:|---------|---------|
| `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"`
#### Authenticate using individual connection parameters
In addition to using a connection string, you can optionally specify individual connection parameters. These parameters are equivalent to the standard PostgreSQL connection parameters.
| Field | Required | Details | Example |
|--------|:--------:|---------|---------|
| `host` | Y | The host name or IP address of the PostgreSQL server | `"localhost"` |
| `hostaddr` | N | The IP address of the PostgreSQL server (alternative to host) | `"127.0.0.1"` |
| `port` | Y | The port number of the PostgreSQL server | `"5432"` |
| `database` | Y | The name of the database to connect to | `"my_db"` |
| `user` | Y | The PostgreSQL user to connect as | `"postgres"` |
| `password` | Y | The password for the PostgreSQL user | `"example"` |
| `sslRootCert` | N | Path to the SSL root certificate file | `"/path/to/ca.crt"` |
{{% alert title="Note" color="primary" %}}
When using individual connection parameters, these will override the ones present in the `connectionString`.
{{% /alert %}}
### Authenticate using Microsoft Entra ID
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.

View File

@ -27,6 +27,21 @@ spec:
# Name of the table which holds configuration information
- name: table
value: "[your_configuration_table_name]"
# Individual connection parameters - can be used instead to override connectionString parameters
#- name: host
# value: "localhost"
#- name: hostaddr
# value: "127.0.0.1"
#- name: port
# value: "5432"
#- name: database
# value: "my_db"
#- name: user
# value: "postgres"
#- name: password
# value: "example"
#- name: sslRootCert
# value: "/path/to/ca.crt"
# Timeout for database operations, in seconds (optional)
#- name: timeoutInSeconds
# value: 20
@ -67,6 +82,24 @@ The following metadata options are **required** to authenticate using a PostgreS
|--------|:--------:|---------|---------|
| `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"`
#### Authenticate using individual connection parameters
In addition to using a connection string, you can optionally specify individual connection parameters. These parameters are equivalent to the standard PostgreSQL connection parameters.
| Field | Required | Details | Example |
|--------|:--------:|---------|---------|
| `host` | Y | The host name or IP address of the PostgreSQL server | `"localhost"` |
| `hostaddr` | N | The IP address of the PostgreSQL server (alternative to host) | `"127.0.0.1"` |
| `port` | Y | The port number of the PostgreSQL server | `"5432"` |
| `database` | Y | The name of the database to connect to | `"my_db"` |
| `user` | Y | The PostgreSQL user to connect as | `"postgres"` |
| `password` | Y | The password for the PostgreSQL user | `"example"` |
| `sslRootCert` | N | Path to the SSL root certificate file | `"/path/to/ca.crt"` |
{{% alert title="Note" color="primary" %}}
When using individual connection parameters, these will override the ones present in the `connectionString`.
{{% /alert %}}
### Authenticate using Microsoft Entra ID
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.

View File

@ -0,0 +1,42 @@
---
type: docs
title: "GoogleAI"
linkTitle: "GoogleAI"
description: Detailed information on the GoogleAI conversation component
---
## Component format
A Dapr `conversation.yaml` component file has the following structure:
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: googleai
spec:
type: conversation.googleai
metadata:
- name: key
value: mykey
- name: model
value: gemini-1.5-flash
- name: cacheTTL
value: 10m
```
{{% 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 | Details | Example |
|--------------------|:--------:|---------|---------|
| `key` | Y | API key for GoogleAI. | `mykey` |
| `model` | N | The GoogleAI LLM to use. Defaults to `gemini-1.5-flash`. | `gemini-2.0-flash` |
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
## Related links
- [Conversation API overview]({{< ref conversation-overview.md >}})

View File

@ -0,0 +1,39 @@
---
type: docs
title: "Ollama"
linkTitle: "Ollama"
description: Detailed information on the Ollama conversation component
---
## Component format
A Dapr `conversation.yaml` component file has the following structure:
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: ollama
spec:
type: conversation.ollama
metadata:
- name: model
value: llama3.2:latest
- name: cacheTTL
value: 10m
```
{{% 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 | Details | Example |
|--------------------|:--------:|---------|---------|
| `model` | N | The Ollama LLM to use. Defaults to `llama3.2:latest`. | `phi4:latest` |
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
## Related links
- [Conversation API overview]({{< ref conversation-overview.md >}})

View File

@ -21,6 +21,8 @@ spec:
value: mykey
- name: model
value: gpt-4-turbo
- name: endpoint
value: 'https://api.openai.com/v1'
- name: cacheTTL
value: 10m
```
@ -35,6 +37,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|--------------------|:--------:|---------|---------|
| `key` | Y | API key for OpenAI. | `mykey` |
| `model` | N | The OpenAI LLM to use. Defaults to `gpt-4-turbo`. | `gpt-4-turbo` |
| `endpoint` | N | Custom API endpoint URL for OpenAI API-compatible services. If not specified, the default OpenAI API endpoint is used. | `https://api.openai.com/v1` |
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
## Related links

View File

@ -91,6 +91,7 @@ The above example uses secrets as plain strings. It is recommended to use a [sec
| keys | N | A comma delimited string containing names of [Pulsar session keys](https://pulsar.apache.org/docs/3.0.x/security-encryption/#how-it-works-in-pulsar). Used in conjunction with `publicKey` for publisher encryption |
| processMode | N | Enable processing multiple messages at once. Default: `"async"` | `"async"`, `"sync"`|
| subscribeType | N | Pulsar supports four kinds of [subscription types](https://pulsar.apache.org/docs/3.0.x/concepts-messaging/#subscription-types). Default: `"shared"` | `"shared"`, `"exclusive"`, `"failover"`, `"key_shared"`|
| subscribeInitialPosition | N | Subscription position is the initial position which the cursor is set when start consuming. Default: `"latest"` | `"latest"`, `"earliest"` |
| partitionKey | N | Sets the key of the message for routing policy. Default: `""` | |
| `maxConcurrentHandlers` | N | Defines the maximum number of concurrent message handlers. Default: `100` | `10`

View File

@ -31,6 +31,21 @@ spec:
# Connection string
- name: connectionString
value: "<CONNECTION STRING>"
# Individual connection parameters - can be used instead to override connectionString parameters
#- name: host
# value: "localhost"
#- name: hostaddr
# value: "127.0.0.1"
#- name: port
# value: "5432"
#- name: database
# value: "my_db"
#- name: user
# value: "postgres"
#- name: password
# value: "example"
#- name: sslRootCert
# value: "/path/to/ca.crt"
# Timeout for database operations, as a Go duration or number of seconds (optional)
#- name: timeout
# value: 20
@ -71,6 +86,24 @@ The following metadata options are **required** to authenticate using a PostgreS
|--------|:--------:|---------|---------|
| `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"` |
#### Authenticate using individual connection parameters
In addition to using a connection string, you can optionally specify individual connection parameters. These parameters are equivalent to the standard PostgreSQL connection parameters.
| Field | Required | Details | Example |
|--------|:--------:|---------|---------|
| `host` | Y | The host name or IP address of the PostgreSQL server | `"localhost"` |
| `hostaddr` | N | The IP address of the PostgreSQL server (alternative to host) | `"127.0.0.1"` |
| `port` | Y | The port number of the PostgreSQL server | `"5432"` |
| `database` | Y | The name of the database to connect to | `"my_db"` |
| `user` | Y | The PostgreSQL user to connect as | `"postgres"` |
| `password` | Y | The password for the PostgreSQL user | `"example"` |
| `sslRootCert` | N | Path to the SSL root certificate file | `"/path/to/ca.crt"` |
{{% alert title="Note" color="primary" %}}
When using individual connection parameters, these will override the ones present in the `connectionString`.
{{% /alert %}}
### Authenticate using Microsoft Entra ID
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.

View File

@ -31,6 +31,21 @@ spec:
# Connection string
- name: connectionString
value: "<CONNECTION STRING>"
# Individual connection parameters - can be used instead to override connectionString parameters
#- name: host
# value: "localhost"
#- name: hostaddr
# value: "127.0.0.1"
#- name: port
# value: "5432"
#- name: database
# value: "my_db"
#- name: user
# value: "postgres"
#- name: password
# value: "example"
#- name: sslRootCert
# value: "/path/to/ca.crt"
# Timeout for database operations, as a Go duration or number of seconds (optional)
#- name: timeout
# value: 20
@ -71,6 +86,24 @@ The following metadata options are **required** to authenticate using a PostgreS
|--------|:--------:|---------|---------|
| `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"` |
#### Authenticate using individual connection parameters
In addition to using a connection string, you can optionally specify individual connection parameters. These parameters are equivalent to the standard PostgreSQL connection parameters.
| Field | Required | Details | Example |
|--------|:--------:|---------|---------|
| `host` | Y | The host name or IP address of the PostgreSQL server | `"localhost"` |
| `hostaddr` | N | The IP address of the PostgreSQL server (alternative to host) | `"127.0.0.1"` |
| `port` | Y | The port number of the PostgreSQL server | `"5432"` |
| `database` | Y | The name of the database to connect to | `"my_db"` |
| `user` | Y | The PostgreSQL user to connect as | `"postgres"` |
| `password` | Y | The password for the PostgreSQL user | `"example"` |
| `sslRootCert` | N | Path to the SSL root certificate file | `"/path/to/ca.crt"` |
{{% alert title="Note" color="primary" %}}
When using individual connection parameters, these will override the ones present in the `connectionString`.
{{% /alert %}}
### Authenticate using Microsoft Entra ID
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.

View File

@ -28,3 +28,13 @@
state: Stable
version: v1
since: "1.15"
- component: Ollama
link: ollama
state: Alpha
version: v1
since: "1.16"
- component: GoogleAI
link: googleai
state: Alpha
version: v1
since: "1.16"