Extend service invocation to non-Dapr endpoints docs #3384

sicoyle · 2023-05-05T00:23:52Z

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

Add docs to support the extension of the service invocation API to allow for the invocation of non-Dapr endpoints.

Issue reference

#3365

…ndpoints Signed-off-by: Samantha Coyle <sam@diagrid.io>

sicoyle · 2023-05-05T00:30:35Z

non-Dapr endpoints vs non-Daprized endpoints? Which do we like better for docs?

hhunter-ms · 2023-05-05T17:30:19Z

non-Dapr endpoints vs non-Daprized endpoints? Which do we like better for docs?

@sicoyle I personally like "non-Dapr endpoints". @msfussell what do you think?

msfussell · 2023-05-08T23:09:51Z

non-Dapr endpoints vs non-Daprized endpoints? Which do we like better for docs?

@sicoyle I personally like "non-Dapr endpoints". @msfussell what do you think?

Let's use non-Dapr endpoints.

msfussell

Lets start with these changes.

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

...oping-applications/building-blocks/service-invocation/howto-invoke-non-daprized-endpoints.md

msfussell · 2023-05-09T00:45:47Z

...en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

+<img src="/images/service-invocation-overview-non-daprized-endpoint.png" width=800 alt="Diagram showing the steps of service invocation to non-Daprized endpoints">
+
+1. Service A makes an HTTP call targeting Service B, a non-Daprized endpoint. The call goes to the local Dapr sidecar.
+2. Dapr discovers Service B's location using the [name resolution component]({{< ref supported-name-resolution >}}) which is running on the given [hosting platform]({{< ref "hosting" >}}).


The Naming Component is not used here, that is for appId. You should update this to talk about resolving with either a name HTTPEndpoint resource or FQDM URL. I would also update this to have an picture that is a HTTP resource

I updated... however, I mostly just removed the name resolution component reference. My thinking is Service B is simply a non-Dapr service, so it is still fair game to visualize it as a "Service" icon, but the description now denotes this to be discovered either using an HTTPEndpoint or FQDN URL.

...en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

msfussell · 2023-05-09T01:00:37Z

...en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md


+### HTTP service invocation to non-Daprized endpoints
+If you are in a brownfield scenario or simply have existing non-Daprized endpoints that you want to invoke, then you can do so using the service invocation API.
+By defining a Dapr HTTPEndpoint, you declaratively define a way to interact with a non-Daprized endpoint. You then use the existing service invocation URL, while replacing the internal `appid` with the HTTPEndpoint name, and can use the existing service invocation API as is. This allows for you to also use the HTTPEndpoint name as the value if you use the `dapr-app-id` header. Alternatively, you can place a non-Daprized endpoint URL directly into the service invocation URL where you would place the `appid` or HTTPEndpoint name.


Move this into the How To Topic. This is where the details are needed. Also rewrite just to simply say how to use the HTTPEndpoint or FQDM URL and not try to say this is a replacement for appId. Blend this in with the order of precedence detail in the How To Topic.

Suggested change

By defining a Dapr HTTPEndpoint, you declaratively define a way to interact with a non-Daprized endpoint. You then use the existing service invocation URL, while replacing the internal `appid` with the HTTPEndpoint name, and can use the existing service invocation API as is. This allows for you to also use the HTTPEndpoint name as the value if you use the `dapr-app-id` header. Alternatively, you can place a non-Daprized endpoint URL directly into the service invocation URL where you would place the `appid` or HTTPEndpoint name.

By defining a HTTPEndpoint resource, you declaratively define a way to interact with a non-Daprized endpoint.

msfussell · 2023-05-09T04:08:08Z

@sicoyle - You need to perform a new pull on Dapr v1.11 branch for the build to succeed.

github-actions · 2023-05-15T00:08:41Z

Stale PR, paging all reviewers

Signed-off-by: Samantha Coyle <sam@diagrid.io>

…docs into docs-nondaprized-svc-invocation

Signed-off-by: Samantha Coyle <sam@diagrid.io>

sicoyle · 2023-05-15T19:52:22Z

@msfussell could you please remove the stale label?

yaron2 · 2023-05-15T20:21:22Z

@msfussell could you please remove the stale label?

Removed.

Editing of the docs Signed-off-by: Mark Fussell <markfussell@gmail.com>

msfussell

Good updates. Getting closer. I did one larger edit that you should review, so pull down the latest from your updated branch

daprdocs/content/en/developing-applications/building-blocks/bindings/bindings-overview.md

...eveloping-applications/building-blocks/service-invocation/howto-invoke-non-dapr-endpoints.md

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

daprdocs/content/en/reference/api/metadata_api.md

daprdocs/content/en/reference/api/service_invocation_api.md

daprdocs/content/en/reference/resource-specs/httpendpoints-reference.md

msfussell

Good updates. Getting closer. I did one larger edit that you should review, so pull down the latest from your updated branch

...eveloping-applications/building-blocks/service-invocation/howto-invoke-non-dapr-endpoints.md

Signed-off-by: Samantha Coyle <sam@diagrid.io>

hhunter-ms

quick grammar review

...eveloping-applications/building-blocks/service-invocation/howto-invoke-non-dapr-endpoints.md

daprdocs/content/en/reference/api/metadata_api.md

daprdocs/content/en/reference/api/service_invocation_api.md

...en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Signed-off-by: Samantha Coyle <sam@diagrid.io>

Updating weight in docs Signed-off-by: Mark Fussell <markfussell@gmail.com>

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

docs(httpendpoint): add docs for service invocation to non-daprized e…

d48d41d

…ndpoints Signed-off-by: Samantha Coyle <sam@diagrid.io>

sicoyle requested review from a team as code owners May 5, 2023 00:23

sicoyle changed the base branch from v1.10 to v1.11 May 5, 2023 00:24

msfussell reviewed May 9, 2023

View reviewed changes

Merge branch 'v1.11' into docs-nondaprized-svc-invocation

f0a92bd

msfussell mentioned this pull request May 9, 2023

Need Dapr Resources Reference section #3400

Closed

github-actions bot added the stale label May 15, 2023

msfussell and others added 5 commits May 15, 2023 08:40

Merge branch 'v1.11' into docs-nondaprized-svc-invocation

b427966

style: non-daprized -> non-dapr

af78e7f

Signed-off-by: Samantha Coyle <sam@diagrid.io>

Merge branch 'docs-nondaprized-svc-invocation' of github.com:sicoyle/…

cacbc04

…docs into docs-nondaprized-svc-invocation

docs: address some feedback

dcfda7d

Signed-off-by: Samantha Coyle <sam@diagrid.io>

docs: update according to rest of feedback

514f57f

Signed-off-by: Samantha Coyle <sam@diagrid.io>

yaron2 removed the stale label May 15, 2023

Update howto-invoke-non-dapr-endpoints.md

bb6a0a2

Editing of the docs Signed-off-by: Mark Fussell <markfussell@gmail.com>

msfussell reviewed May 16, 2023

View reviewed changes

This comment was marked as duplicate.

Sign in to view

msfussell reviewed May 16, 2023

View reviewed changes

...eveloping-applications/building-blocks/service-invocation/howto-invoke-non-dapr-endpoints.md Show resolved Hide resolved

docs: update last pr feedback

ece1b85

Signed-off-by: Samantha Coyle <sam@diagrid.io>

hhunter-ms requested changes May 16, 2023

View reviewed changes

style: address grammar feedback

45fe56e

Signed-off-by: Samantha Coyle <sam@diagrid.io>

hhunter-ms approved these changes May 17, 2023

View reviewed changes

msfussell and others added 5 commits May 17, 2023 15:59

Merge branch 'v1.11' into docs-nondaprized-svc-invocation

97da568

Merge branch 'v1.11' into docs-nondaprized-svc-invocation

219fe5d

Merge branch 'v1.11' into docs-nondaprized-svc-invocation

62c7e44

Update _index.md

1524292

Updating weight in docs Signed-off-by: Mark Fussell <markfussell@gmail.com>

Update howto-invoke-non-dapr-endpoints.md

c29eb08

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

msfussell mentioned this pull request May 18, 2023

Add the Dapr resource specs (Schemas) into the reference for Resiliency Policies and Subscriptions #3434

Closed

msfussell merged commit c1f152a into dapr:v1.11 May 18, 2023

hhunter-ms mentioned this pull request Jun 7, 2023

fix link #3505

Closed

7 tasks

Extend service invocation to non-Dapr endpoints docs #3384

Extend service invocation to non-Dapr endpoints docs #3384

Uh oh!

Conversation

sicoyle commented May 5, 2023

Description

Issue reference

Uh oh!

sicoyle commented May 5, 2023

Uh oh!

hhunter-ms commented May 5, 2023

Uh oh!

msfussell commented May 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

msfussell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

msfussell May 9, 2023

Choose a reason for hiding this comment

Uh oh!

sicoyle May 15, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

msfussell May 9, 2023

Choose a reason for hiding this comment

Uh oh!

msfussell commented May 9, 2023

Uh oh!

github-actions bot commented May 15, 2023

Uh oh!

sicoyle commented May 15, 2023

Uh oh!

yaron2 commented May 15, 2023

Uh oh!

msfussell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

msfussell left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as duplicate.

Uh oh!

Uh oh!

hhunter-ms left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

msfussell commented May 8, 2023 •

edited

Loading