Skip to content

Add Coherence state store component docs #4696

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

Closed
wants to merge 76 commits into from

Conversation

tmiddlet2666
Copy link

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

Introduce documentation for coherence state store.

Issue reference

dapr/components-contrib#3838

hhunter-ms and others added 30 commits February 27, 2025 14:08
fix todo

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

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
Also marks all `v1.12.x` releases to not-supported. We only support N-2
versions, where N is the latest version.

Signed-off-by: joshvanl <me@joshvanl.dev>
Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
Revert back to built-in Docsy template that includes GA script
instalation -> installation

Signed-off-by: Jake Engelberg <152900222+jake-engelberg@users.noreply.github.com>
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
dapr / PVC uninstall specifics, about how a manual deletion of PVCs is required to define a new volume.

Signed-off-by: Jake Engelberg <152900222+jake-engelberg@users.noreply.github.com>
Remove specific port number, replace with placeholder
Add missing sample argument for Dapr sidecar app port config sample

Signed-off-by: Jonel Dominic Tapang <joneldominictapang.dev@gmail.com>
Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
* update patch version to latest

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

* update shortcode

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

---------

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
Signed-off-by: msfussell <markfussell@gmail.com>
…tion options (dapr#4573)

Signed-off-by: Anton Troshin <anton@diagrid.io>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Added .NET streaming subscription example to pubsub page
"Scop" fixed to "Scope"

Signed-off-by: James Pegg <jamescpegg@gmail.com>
* Update self-hosted-with-docker.md - make scheduler running

Signed-off-by: Mathieu Benoit <mathieu-benoit@hotmail.fr>

* Update self-hosted-with-docker.md - --scheduler-host-address

Signed-off-by: Mathieu Benoit <mathieu-benoit@hotmail.fr>

* Update self-hosted-with-docker.md - Use smaller container images for placement and scheduler

Signed-off-by: Mathieu Benoit <mathieu-benoit@hotmail.fr>

---------

Signed-off-by: Mathieu Benoit <mathieu-benoit@hotmail.fr>
Update to .NET 8 runtime

Signed-off-by: Alice Gibbons <alice@diagrid.io>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
…t` on Windows (dapr#4602)

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
WhitWaldo and others added 14 commits May 12, 2025 08:44
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Bilgin Ibryam <bibryam@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Bilgin Ibryam <bibryam@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
…#4622)

* Modernized the .NET examples for interacting with state in Dapr

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

* Update daprdocs/content/en/developing-applications/building-blocks/state-management/howto-get-save-state.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>

* Update daprdocs/content/en/developing-applications/building-blocks/state-management/howto-get-save-state.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>

---------

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
* dapr-latest-version.html: update to v1.15.4

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

* Update release to 1.15.5

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

* Update daprdocs/content/en/operations/support/support-release-policy.md

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

---------

Signed-off-by: joshvanl <me@joshvanl.dev>
Signed-off-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Joe Bowbeer <joe.bowbeer@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
* Update pubsub-raw.md

Updating Raw PubSub doc to be more specific about content type and delivery details.

Signed-off-by: Alice Gibbons <alice@diagrid.io>

* Update daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-raw.md

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

---------

Signed-off-by: Alice Gibbons <alice@diagrid.io>
Signed-off-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Alice Gibbons <alice@diagrid.io>
Signed-off-by: Samantha Coyle <sam@diagrid.io>
Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
…@JoshVanL (dapr#4667)

Signed-off-by: Oliver Tomlinson <oliverjamestomlinson@gmail.com>
Co-authored-by: Marc Duiker <marcduiker@users.noreply.github.com>
* Update workflow pattern diagrams

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

* Update workflow diagrams to new style

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

* Update diagrams

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

* Update workflow k8s diagram

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

---------

Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Tim Middleton <tim.middleton@oracle.com>
@tmiddlet2666 tmiddlet2666 requested review from a team as code owners June 27, 2025 02:26
@tmiddlet2666
Copy link
Author

See #4661

@msfussell msfussell changed the title Add Coherence docs Add Coherence state store component docs Jul 2, 2025
Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

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

@tmiddlet2666 - You need to target the v1.16 docs branch with this PR. Can you move this PR to that branch? Thanks

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

Choose a reason for hiding this comment

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

Is there any useful reference to the Coherence docs that you would consider adding here?

Copy link
Author

Choose a reason for hiding this comment

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

Of course, makes sense.

metadata:
name: <NAME>
spec:
type: state.coherence
Copy link
Member

Choose a reason for hiding this comment

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

This is an Oracle DB yes? Should this type then be state.oracle.coherence or state.oci.coherence

Copy link
Author

@tmiddlet2666 tmiddlet2666 Jul 2, 2025

Choose a reason for hiding this comment

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

This is not part of Oracle DB, and not dependant on it, but it is an Oracle product, for in memory caching in general.
In components-contrib i have already committed as:

  type: state.coherence

It is not sepcific to cloud like the Object Storage and ADW.

thoughts?

@@ -42,6 +42,17 @@
etag: true
ttl: false
query: false
- component: Coherence
Copy link
Member

Choose a reason for hiding this comment

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

This is an oracle DB and hence this should be in the oracle.yaml section as opposed to generic.yaml?

crud: true
transactions: false
etag: false
ttl: true
Copy link
Member

Choose a reason for hiding this comment

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

Given this has TTL enabled, do you want to provide any additional details on the operation of the TTL as a subheading for people to understand its usage patterns? Typically from any of the product docs.

Copy link
Author

Choose a reason for hiding this comment

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

good suggestion.

tmiddlet2666 and others added 4 commits July 3, 2025 08:02
…tate-stores/setup-coherence.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Tim Middleton <tim.middleton@oracle.com>
…tate-stores/setup-coherence.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Tim Middleton <tim.middleton@oracle.com>
…tate-stores/setup-coherence.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Tim Middleton <tim.middleton@oracle.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Tim Middleton <tim.middleton@oracle.com>
@tmiddlet2666 tmiddlet2666 changed the base branch from v1.15 to v1.16 July 3, 2025 00:08
@tmiddlet2666
Copy link
Author

@msfussell
After moving to v1.16 there are a lot of commits, coming along with this, i'm going to close this and re-create against v1.16 properly.

@tmiddlet2666
Copy link
Author

@msfussell please see new PR - #4702

@tmiddlet2666 tmiddlet2666 deleted the coherence branch July 3, 2025 00:42
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.