-
Notifications
You must be signed in to change notification settings - Fork 223
docs: add architecture diagram to README #1549
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
docs: add architecture diagram to README #1549
Conversation
cicoyle
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR 🎉 I think this is great! Just one comment from me
… runtime CORRECTION (close #<915>)
… runtime (close #<915>)
… runtime (close #<915>)
|
✅ Updated the diagram based on the review feedback:
flowchart LR
A[End User Application] -->|HTTP or gRPC| B[Dapr Java SDK]
B -->|Dapr API calls| C[Dapr Sidecar]
C -->|Components| D[State Stores, Pub/Sub, Services, etc.]
%% Optional grouping for clarity
subgraph R[Dapr Runtime]
C
D
end
|
artur-ciocanu
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@RaymundoZa thanks a lot for your contribution!
Could you please sign your commits. This a requirement for this repo. Otherwise we won't be able to merge your changes.
Thank you!
|
@cicoyle could you please check if you are OK with the changes and approve. Thank you! |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1549 +/- ##
============================================
+ Coverage 76.91% 78.46% +1.54%
- Complexity 1592 1928 +336
============================================
Files 145 216 +71
Lines 4843 5860 +1017
Branches 562 656 +94
============================================
+ Hits 3725 4598 +873
- Misses 821 924 +103
- Partials 297 338 +41 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
* Preview New README * Preview New README 2 * Preview New README 3 * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime CORRECTION (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) --------- Co-authored-by: Siri Varma Vegiraju <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Co-authored-by: Cassie Coyle <[email protected]>
* Preview New README * Preview New README 2 * Preview New README 3 * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime CORRECTION (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) --------- Co-authored-by: Siri Varma Vegiraju <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Co-authored-by: Cassie Coyle <[email protected]> Signed-off-by: salaboy <[email protected]>
|
@holopin-bot @RaymundoZa Thank you! Here's a digital badge as a small token of appreciation. |
|
Congratulations @RaymundoZa, the maintainer of this repository has issued you a badge! Here it is: https://holopin.io/claim/cmi4hokgx0001jo04anuht2vl This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account. |
* Preview New README * Preview New README 2 * Preview New README 3 * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime CORRECTION (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) --------- Co-authored-by: Siri Varma Vegiraju <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Co-authored-by: Cassie Coyle <[email protected]> Signed-off-by: sirivarma <[email protected]>
* Preview New README * Preview New README 2 * Preview New README 3 * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime CORRECTION (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) --------- Co-authored-by: Siri Varma Vegiraju <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Co-authored-by: Cassie Coyle <[email protected]> Signed-off-by: salaboy <[email protected]>
* fixing checkstyle and javadocs Signed-off-by: salaboy <[email protected]> * Replace openjdk:17-jdk-slim to eclipse-temurin:17-jdk-jammy (#1574) Signed-off-by: Matheus Cruz <[email protected]> Signed-off-by: salaboy <[email protected]> * Align Java API with other languages (#1560) * Align Java API with other languages Signed-off-by: Matheus Cruz <[email protected]> * Update documentation Signed-off-by: Matheus Cruz <[email protected]> * Change return type of waitForWorkflowStart method Signed-off-by: artur-ciocanu <[email protected]> --------- Signed-off-by: Matheus Cruz <[email protected]> Signed-off-by: artur-ciocanu <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Signed-off-by: salaboy <[email protected]> * use built in durable task Signed-off-by: salaboy <[email protected]> * exclude jacoco rules for examples and durabletask-client Signed-off-by: salaboy <[email protected]> * increasing timeout for IT Signed-off-by: salaboy <[email protected]> * removing dt build from matrix Signed-off-by: salaboy <[email protected]> * adding java to dt build Signed-off-by: salaboy <[email protected]> * Fix dependencies multi app build and add proper test deps (#1572) * Force Jackson version to override the SB Jackson version Signed-off-by: Artur Ciocanu <[email protected]> * Move all the Jackson deps to parent POM. Signed-off-by: Artur Ciocanu <[email protected]> * Ensure app JAR build order Signed-off-by: Artur Ciocanu <[email protected]> * Remove explicit Jackson from sdk-tests module. Signed-off-by: Artur Ciocanu <[email protected]> * Make sure <scope>test</scope> is used for test dependencies. Signed-off-by: Artur Ciocanu <[email protected]> * Remove extra Jackson modules. Signed-off-by: Artur Ciocanu <[email protected]> --------- Signed-off-by: Artur Ciocanu <[email protected]> Signed-off-by: salaboy <[email protected]> * docs: add architecture diagram to README (#1549) * Preview New README * Preview New README 2 * Preview New README 3 * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime CORRECTION (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) * docs: add architecture diagram showing Java SDK interaction with Dapr runtime (close #<915>) --------- Co-authored-by: Siri Varma Vegiraju <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Co-authored-by: Cassie Coyle <[email protected]> Signed-off-by: salaboy <[email protected]> * Add statestore example with Outbox pattern (#1582) * Add statestore example with Outbox pattern Signed-off-by: Matheus Cruz <[email protected]> * Clean events after each test Signed-off-by: Matheus Cruz <[email protected]> * Add license header Signed-off-by: Matheus Cruz <[email protected]> * Apply pull request suggestions Signed-off-by: Matheus Cruz <[email protected]> --------- Signed-off-by: Matheus Cruz <[email protected]> Co-authored-by: salaboy <[email protected]> Signed-off-by: salaboy <[email protected]> * adding new method signature plus test (#1570) * adding new method signature plus test Signed-off-by: salaboy <[email protected]> * re adding imports Signed-off-by: salaboy <[email protected]> * fixing style Signed-off-by: salaboy <[email protected]> * checking empty metadata Signed-off-by: salaboy <[email protected]> * copy meta for safety and check if key is present Signed-off-by: salaboy <[email protected]> * Centralize Maven dependency version management (#1564) Signed-off-by: salaboy <[email protected]> * Fix dependencies multi app build and add proper test deps (#1572) * Force Jackson version to override the SB Jackson version Signed-off-by: Artur Ciocanu <[email protected]> * Move all the Jackson deps to parent POM. Signed-off-by: Artur Ciocanu <[email protected]> * Ensure app JAR build order Signed-off-by: Artur Ciocanu <[email protected]> * Remove explicit Jackson from sdk-tests module. Signed-off-by: Artur Ciocanu <[email protected]> * Make sure <scope>test</scope> is used for test dependencies. Signed-off-by: Artur Ciocanu <[email protected]> * Remove extra Jackson modules. Signed-off-by: Artur Ciocanu <[email protected]> --------- Signed-off-by: Artur Ciocanu <[email protected]> Signed-off-by: salaboy <[email protected]> * reverting pom Signed-off-by: salaboy <[email protected]> * fix codestyle Signed-off-by: salaboy <[email protected]> * using metaCopy Signed-off-by: salaboy <[email protected]> --------- Signed-off-by: salaboy <[email protected]> Signed-off-by: Artur Ciocanu <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Signed-off-by: salaboy <[email protected]> * Bump actions/upload-artifact from 4 to 5 (#1587) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4 to 5. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@v4...v5) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: salaboy <[email protected]> * Add gRPC support to Dapr testcontainer (#1586) * Add gRPC support to Dapr testcontainer Signed-off-by: wlfgang <[email protected]> * Avoid using null to indicate default value Signed-off-by: wlfgang <[email protected]> --------- Signed-off-by: wlfgang <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Co-authored-by: wlfgang <[email protected]> Signed-off-by: salaboy <[email protected]> * Use dependencies BOM and remove duplicates. (#1588) Signed-off-by: Artur Ciocanu <[email protected]> Signed-off-by: salaboy <[email protected]> * Examples + Docs for App API Token authentication for gRPC and HTTP (#1589) * example Signed-off-by: Cassandra Coyle <[email protected]> * docs for example Signed-off-by: Cassandra Coyle <[email protected]> --------- Signed-off-by: Cassandra Coyle <[email protected]> Signed-off-by: salaboy <[email protected]> * Another set of Maven version, properties and plugin improvements (#1596) Signed-off-by: salaboy <[email protected]> * Adding a Flux based subscribeToEvents method (#1598) * Adding a Flux based subscribeToEvents method Signed-off-by: Artur Ciocanu <[email protected]> * Simplify GRPC stream handling Signed-off-by: Artur Ciocanu <[email protected]> * Simplify Javadoc Signed-off-by: Artur Ciocanu <[email protected]> * Fix unit tests and simplify implementation Signed-off-by: Artur Ciocanu <[email protected]> * Adding event subscriber stream observer to simplify subscription logic Signed-off-by: Artur Ciocanu <[email protected]> * Use start() method to start stream subscription Signed-off-by: Artur Ciocanu <[email protected]> * Add unit test for event suscriber observer Signed-off-by: Artur Ciocanu <[email protected]> * Improve the tests a little bit Signed-off-by: Artur Ciocanu <[email protected]> * Remove the unnecessary method Signed-off-by: Artur Ciocanu <[email protected]> * Improve error handling and use CloudEvent wrapper Signed-off-by: Artur Ciocanu <[email protected]> * Fix unit tests asserts Signed-off-by: Artur Ciocanu <[email protected]> * Adjust Java examples for Subscriber Signed-off-by: Artur Ciocanu <[email protected]> --------- Signed-off-by: Artur Ciocanu <[email protected]> Signed-off-by: salaboy <[email protected]> * Remove SDK docs due to migration to main Docs repo (#1593) * Remove SDK docs due to migration to main Docs repo Signed-off-by: Marc Duiker <[email protected]> * Remove sed lines related to sdk docs Signed-off-by: Marc Duiker <[email protected]> --------- Signed-off-by: Marc Duiker <[email protected]> Co-authored-by: salaboy <[email protected]> Signed-off-by: salaboy <[email protected]> * cleaning up sdk version script Signed-off-by: salaboy <[email protected]> --------- Signed-off-by: salaboy <[email protected]> Signed-off-by: Matheus Cruz <[email protected]> Signed-off-by: artur-ciocanu <[email protected]> Signed-off-by: Artur Ciocanu <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: wlfgang <[email protected]> Signed-off-by: Cassandra Coyle <[email protected]> Signed-off-by: Marc Duiker <[email protected]> Co-authored-by: Matheus Cruz <[email protected]> Co-authored-by: artur-ciocanu <[email protected]> Co-authored-by: Raymundo Zamora <[email protected]> Co-authored-by: Siri Varma Vegiraju <[email protected]> Co-authored-by: Cassie Coyle <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: wlfgang <[email protected]> Co-authored-by: wlfgang <[email protected]> Co-authored-by: Marc Duiker <[email protected]>
This PR adds an architecture diagram to the README to help new contributors and users understand how a Java application interacts with the Dapr runtime via the Java SDK.
This addresses #915.
