Skip to content

Commit 1e2a3f3

Browse files
committed
Adds Warning that Actor Reminder Partition is not relevant by default
Updates the Actor Reminder Partition config page with a Warning that the feature is only relevant when using state store Actor Reminders which are no longer used by default. De-references this page from the actor rutime config page to softly hide it. Updates some verbiage around using Scheduler reminders & the feature gate as it's on by default. This should be merged in dapr/[email protected]. Signed-off-by: joshvanl <[email protected]>
1 parent 906165b commit 1e2a3f3

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

daprdocs/content/en/developing-applications/building-blocks/actors/actors-runtime-config.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -195,12 +195,8 @@ func configHandler(w http.ResponseWriter, r *http.Request) {
195195

196196
{{< /tabs >}}
197197

198-
## Next steps
199-
200-
{{< button text="Enable actor reminder partitioning >>" page="howto-actors-partitioning.md" >}}
201-
202198
## Related links
203199

204200
- Refer to the [Dapr SDK documentation and examples]({{< ref "developing-applications/sdks/#sdk-languages" >}}).
205201
- [Actors API reference]({{< ref actors_api.md >}})
206-
- [Actors overview]({{< ref actors-overview.md >}})
202+
- [Actors overview]({{< ref actors-overview.md >}})

daprdocs/content/en/developing-applications/building-blocks/actors/howto-actors-partitioning.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ aliases:
88
- "/developing-applications/building-blocks/actors/actors-background"
99
---
1010

11+
{{% alert title="Warning" color="warning" %}}
12+
This feature is only relevant when using State Store Actor reminders, no longer enabled by default.
13+
As of v1.15, Dapr uses the far more performant [Scheduler Actor Reminders]({{< ref "scheduler.md#actor-reminders" >}}) by default.
14+
This page is only relevant if you are using the legacy State Store Actor reminders, enabled via setting the [`SchedulerReminders` feature flag]({{< ref "support-preview-features.md#current-preview-features" >}}) to false.
15+
It is highly recommended you continue using the Scheduler Actor Reminders feature.
16+
{{% /alert %}}
17+
1118
[Actor reminders]({{< ref "actors-timers-reminders.md#actor-reminders" >}}) are persisted and continue to be triggered after sidecar restarts. Applications with multiple reminders registered can experience the following issues:
1219

1320
- Low throughput on reminders registration and de-registration
@@ -193,4 +200,4 @@ Watch [this video for a demo of actor reminder partitioning](https://youtu.be/Zw
193200
## Related links
194201

195202
- [Actors API reference]({{< ref actors_api.md >}})
196-
- [Actors overview]({{< ref actors-overview.md >}})
203+
- [Actors overview]({{< ref actors-overview.md >}})

daprdocs/content/en/operations/hosting/kubernetes/kubernetes-persisting-scheduler.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This means that there is no additional parameter required to run the scheduler s
1212

1313
{{% alert title="Warning" color="warning" %}}
1414
The default storage size for the Scheduler is `1Gi`, which is likely not sufficient for most production deployments.
15-
Remember that the Scheduler is used for [Actor Reminders]({{< ref actors-timers-reminders.md >}}) & [Workflows]({{< ref workflow-overview.md >}}) when the [SchedulerReminders]({{< ref support-preview-features.md >}}) preview feature is enabled, and the [Jobs API]({{< ref jobs_api.md >}}).
15+
Remember that the Scheduler is used for [Actor Reminders]({{< ref actors-timers-reminders.md >}}) & [Workflows]({{< ref workflow-overview.md >}}), and the [Jobs API]({{< ref jobs_api.md >}}).
1616
You may want to consider reinstalling Dapr with a larger Scheduler storage of at least `16Gi` or more.
1717
For more information, see the [ETCD Storage Disk Size](#etcd-storage-disk-size) section below.
1818
{{% /alert %}}
@@ -30,8 +30,8 @@ error running scheduler: etcdserver: mvcc: database space exceeded
3030
```
3131

3232
Knowing the safe upper bound for your storage size is not an exact science, and relies heavily on the number, persistence, and the data payload size of your application jobs.
33-
The [Job API]({{< ref jobs_api.md >}}) and [Actor Reminders]({{< ref actors-timers-reminders.md >}}) (with the [SchedulerReminders]({{< ref support-preview-features.md >}}) preview feature enabled) transparently maps one to one to the usage of your applications.
34-
Workflows (when the [SchedulerReminders]({{< ref support-preview-features.md >}}) preview feature is enabled) create a large number of jobs as Actor Reminders, however these jobs are short lived- matching the lifecycle of each workflow execution.
33+
The [Job API]({{< ref jobs_api.md >}}) and [Actor Reminders]({{< ref actors-timers-reminders.md >}}) transparently maps one to one to the usage of your applications.
34+
Workflows preview feature is enabled) create a large number of jobs as Actor Reminders, however these jobs are short lived- matching the lifecycle of each workflow execution.
3535
The data payload of jobs created by Workflows is typically empty or small.
3636

3737
The Scheduler uses Etcd as its storage backend database.

0 commit comments

Comments
 (0)