Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated workflow to reflect deprecation of Workflow methods on client #4336

Merged
merged 3 commits into from
Sep 7, 2024

Conversation

WhitWaldo
Copy link
Contributor

@WhitWaldo WhitWaldo commented Sep 3, 2024

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

The .NET Workflow quickstart documentation reflected the various deprecated methods on the DaprClient. As I removed them anyway in another PR on the .NET client, they really won't be the preferred approach once the Workflow block is marked stable, so starting that effort early.

Issue reference

dapr/dotnet-sdk#1344
dapr/dotnet-sdk#1234

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
@WhitWaldo WhitWaldo requested review from a team as code owners September 3, 2024 13:30
@WhitWaldo
Copy link
Contributor Author

/assign

@WhitWaldo
Copy link
Contributor Author

While this is related to the work in this PR, it's not dependent on it as the new methods I refer to using instead as they're already on the discrete Dapr Workflow .NET SDK. That PR simply removes their already-deprecated counterparts from the omni-Dapr client .NET SDK, so it can be accepted whenever it's reviewed and validated.

Copy link
Collaborator

@hhunter-ms hhunter-ms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@yaron2 yaron2 merged commit 442b720 into dapr:v1.14 Sep 7, 2024
7 checks passed
@WhitWaldo WhitWaldo deleted the workflow-method-updates branch September 7, 2024 22:27
msfussell added a commit that referenced this pull request Oct 17, 2024
* initial freshness, start with overview

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* continue freshness pass

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* continue freshness

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* finish freshness pass

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* typo

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* add note about default app-max-concurrency

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* add to args and annotations doc

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Update config.toml

Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* fix 1.15 link

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* fix release

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* other versions

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Add AWS IAM authentication fields in PostgreSQL components (#4311)

* Add AWS IAM authentication fields in PostgreSQL components

Signed-off-by: Anton Troshin <anton@diagrid.io>

* change wording

Signed-off-by: Anton Troshin <anton@diagrid.io>

---------

Signed-off-by: Anton Troshin <anton@diagrid.io>
Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Adds clientCert and clientKey fields to spec Redis metadata fields (#4312)

* Adds clientCert and clientKey fields to spec Redis metadata fields

Signed-off-by: Elena Kolevska <elena@kolevska.com>

* remove

Signed-off-by: Elena Kolevska <elena@kolevska.com>

* removes empty line

Signed-off-by: Elena Kolevska <elena@kolevska.com>

---------

Signed-off-by: Elena Kolevska <elena@kolevska.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Fix: Scheduler Actor Reminders Wording (#4320)

* update phrasing to be scheduler actor reminders bc the jobs api has nothing to do with it really

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* Update daprdocs/content/en/operations/support/support-preview-features.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Cassie Coyle <cassie.i.coyle@gmail.com>

---------

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
Signed-off-by: Cassie Coyle <cassie.i.coyle@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* add storageClass example for s3 metadata (#4308)

* add storageClass example to docs

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* add field to table

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* update data indentation for example curl

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* Update daprdocs/content/en/reference/components-reference/supported-bindings/s3.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Cassie Coyle <cassie.i.coyle@gmail.com>

* tweaks

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* add to template example

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* add doc link for storage class

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* Update daprdocs/content/en/reference/components-reference/supported-bindings/s3.md

Signed-off-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/reference/components-reference/supported-bindings/s3.md

Signed-off-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/reference/components-reference/supported-bindings/s3.md

Signed-off-by: Mark Fussell <markfussell@gmail.com>

---------

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
Signed-off-by: Cassie Coyle <cassie.i.coyle@gmail.com>
Signed-off-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Add Prometheus auto service discovery instructions to
prometheus.md

- Updated prometheus.md with instructions for setting up Prometheus auto service discovery for Dapr and sidecar targets.

* Add Prometheus auto service discovery instructions to
prometheus.md

- Updated prometheus.md with instructions for setting up Prometheus auto service discovery for Dapr and sidecar targets.

Signed-off-by: Maulin Desai <mdesai@bosleo.com>

* clarify/correct quickstarts

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* clarify docs (#4324)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Format service discovery instructions

Updated the navigation instructions to use bold text for "Status" and "Service Discovery" for better visual clarity.

Signed-off-by: Maulin Desai <mdesai@bosleo.com>

* add note about implicit retries (#4325)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Add Jobs API to Dapr slidedeck

Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>

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

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

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

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

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

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

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

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

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

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* last update per mark review

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* docs: init scheduler in the docker compose example

Signed-off-by: Mike Nguyen <hey@mike.ee>

* update per mark, pt 2

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* fixed yaml syntax for v2alpha1 example (#4335)

Signed-off-by: Adrian Hristov <adrian@intelligentgrowthsolutions.com>

* Bump actions/download-artifact from 3 to 4.1.7 in /.github/workflows

Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 3 to 4.1.7.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@v3...v4.1.7)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

* add notes about namespacing

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* update latest version (#4341)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Add Kafka escapeHeaders documentation (#4332)

* Add Kafka escapeHeaders documentation

Signed-off-by: Anton Troshin <anton@diagrid.io>

* update the escapeHeaders setting docs

Signed-off-by: Anton Troshin <anton@diagrid.io>

* review fixes

Signed-off-by: Anton Troshin <anton@diagrid.io>

---------

Signed-off-by: Anton Troshin <anton@diagrid.io>
Co-authored-by: Yaron Schneider <schneider.yaron@live.com>

* Update roadmap.md (#4340)

* Update roadmap.md

Signed-off-by: Yaron Schneider <schneider.yaron@live.com>

* Update roadmap.md

Signed-off-by: Yaron Schneider <schneider.yaron@live.com>

---------

Signed-off-by: Yaron Schneider <schneider.yaron@live.com>

* conductor update (#4344)

* fix job api http reference (#4343)

Signed-off-by: yaron2 <schneider.yaron@live.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* update alias (#4347)

* Updated workflow to reflect deprecation of Workflow methods on client (#4336)

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* rm escape (#4348)

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* clarify per josh comment

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Fixed cron schedule table

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>

* Tweaked the endpoint description and example to reflect that the protocol may or may not be necessary based on the provider used.

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>

* Updated to reflect the need for the protocol on the zipkin endpoint though it's not necessary on the otel endpoint.

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>

* update latest version to 1.14.2 (#4352)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update Job HTTP request API (#4349)

According to dapr/dapr#8083

Signed-off-by: joshvanl <me@joshvanl.dev>
Co-authored-by: Yaron Schneider <schneider.yaron@live.com>

* Helm: Revert Scheduler storage quota size to `1Gi` (#4354)

In v1.14.3, the storage quota size for the Scheduler volume was
increased from `1Gi` to `16Gi`. This is because users where encountering
disk exhaustion fatal errors on the Scheduler under normal usage.
Because the volume size request field is protected from updates, Dapr
version upgrades to v1.14.3 failed without manual intervention.

Reverts the Scheduler storage quota size back to `1Gi`, and adds
warnings that the volume size may need to be increased for production
deployments.

See: dapr/dapr#8107

Signed-off-by: joshvanl <me@joshvanl.dev>

* Reflecting valid value of 0-6, not 0-7 in jobs schedule

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>

* Clarifiied need for the actorStateStore property in docs, regardless of whether the actor actually stores any state.

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>

* Reworded slightly

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>

* Update workflow-patterns.md

Make monitor code samples consistent between python/go and all other examples.

* Python and Go are using seconds
* Everything else is in minutes.

Signed-off-by: Vasily Chekalkin <bacek@bacek.com>

* update latest and recalled versions (#4360)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Update setup-azure-servicebus-topics.md

Signed-off-by: Andrew Riddlestone <andrew.riddlestone@gmail.com>

* Update howto-invoke-non-dapr-endpoints.md (#4369)

Update service invocation steps according to diagram

Signed-off-by: Michael Klich <inirudebwoy@users.noreply.github.com>

* Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-servicebus-topics.md

Signed-off-by: Mark Fussell <markfussell@gmail.com>

* Workflow limitations change (#4367)

* workflow limitations change

Signed-off-by: yaron2 <schneider.yaron@live.com>

* Update daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
Signed-off-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
Signed-off-by: Mark Fussell <markfussell@gmail.com>

---------

Signed-off-by: yaron2 <schneider.yaron@live.com>
Signed-off-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* rm decoding (#4373)

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* fix misleading wording (#4379)

Signed-off-by: yaron2 <schneider.yaron@live.com>

* [Jobs API] Describe Triggered Job Handling Assumptions (#4376)

* add specific logic for what assumptions are made for triggered jobs for http, grpc, sdks

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* rm space

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* add a note about this applying to all programming languages to avoid confusion

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>

* Update howto-schedule-and-handle-triggered-jobs.md

Signed-off-by: Yaron Schneider <schneider.yaron@live.com>

---------

Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
Signed-off-by: Yaron Schneider <schneider.yaron@live.com>
Co-authored-by: Yaron Schneider <schneider.yaron@live.com>

* add roadmap to main page (#4386)

Signed-off-by: yaron2 <schneider.yaron@live.com>

* Update support (#4387)

* Fixed typo (#4389)

* Update daprdocs/config.toml

Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

---------

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
Signed-off-by: Anton Troshin <anton@diagrid.io>
Signed-off-by: Elena Kolevska <elena@kolevska.com>
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
Signed-off-by: Cassie Coyle <cassie.i.coyle@gmail.com>
Signed-off-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Maulin Desai <mdesai@bosleo.com>
Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
Signed-off-by: Mike Nguyen <hey@mike.ee>
Signed-off-by: Adrian Hristov <adrian@intelligentgrowthsolutions.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Yaron Schneider <schneider.yaron@live.com>
Signed-off-by: yaron2 <schneider.yaron@live.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Signed-off-by: joshvanl <me@joshvanl.dev>
Signed-off-by: Vasily Chekalkin <bacek@bacek.com>
Signed-off-by: Andrew Riddlestone <andrew.riddlestone@gmail.com>
Signed-off-by: Michael Klich <inirudebwoy@users.noreply.github.com>
Co-authored-by: Anton Troshin <anton@diagrid.io>
Co-authored-by: Elena Kolevska <elena-kolevska@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Cassie Coyle <cassie.i.coyle@gmail.com>
Co-authored-by: Maulin Desai <mdesai@bosleo.com>
Co-authored-by: Marc Duiker <marcduiker@users.noreply.github.com>
Co-authored-by: Mike Nguyen <hey@mike.ee>
Co-authored-by: Adrian Hristov <adrianhr91@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Yaron Schneider <schneider.yaron@live.com>
Co-authored-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Cassie Coyle <cassie@diagrid.io>
Co-authored-by: Josh van Leeuwen <me@joshvanl.dev>
Co-authored-by: Vasily Chekalkin <bacek@bacek.com>
Co-authored-by: Andrew Riddlestone <andrew.riddlestone@gmail.com>
Co-authored-by: Michael Klich <inirudebwoy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants