Skip to content

Conversation

@WhitWaldo
Copy link
Contributor

Description

Rewrote secrets management and health method sections

Issue reference

We strive to have all PR being opened based on an issue, where the problem or feature have been discussed prior to implementation.

Please reference the issue this PR will close: #[issue number]

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • Code compiles correctly
  • Created/updated tests
  • Extended the documentation

@WhitWaldo WhitWaldo self-assigned this Aug 28, 2025
@WhitWaldo WhitWaldo added the documentation Improvements or additions to documentation label Aug 28, 2025
@WhitWaldo WhitWaldo requested review from a team as code owners August 28, 2025 15:48
Copy link
Contributor

@alicejgibbons alicejgibbons left a comment

Choose a reason for hiding this comment

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

Small verbiage changes!

- For a full guide on output bindings visit [How-To: Use bindings]({{% ref howto-bindings.md %}}).

### Retrieve secrets
Prior to retrieving secrets, it's important that the outbound channel be registered and ready or the SDK will be unable
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Prior to retrieving secrets, it's important that the outbound channel be registered and ready or the SDK will be unable
Prior to retrieving secrets, it's important that the "outbound" channel to Daprd be registered and ready or the SDK will be unable

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Outbound is from daprd to the application, not application to daprd.

### Retrieve secrets
Prior to retrieving secrets, it's important that the outbound channel be registered and ready or the SDK will be unable
to communicate bidirectionally with the Dapr sidecar. The SDK provides a helper method intended to be used for this
purpose called `CheckOutboundHealthAsync`. This isn't referring to outbound from the SDK to the runtime, so much as
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
purpose called `CheckOutboundHealthAsync`. This isn't referring to outbound from the SDK to the runtime, so much as
purpose called `CheckOutboundHealthAsync`. In this case "outbound" refers to the bi-directional communication channel established by Daprd reaching out to the client application using the SDK.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This isn't accurate - outbound is from Daprd to the client application. Some of the SDKs have a bidirectional channel (e.g. workflows, cryptography), but this isn't that. This is a one-way channel for Daprd to push messages out to the client application without necessitating that the client poll anything.

Prior to retrieving secrets, it's important that the outbound channel be registered and ready or the SDK will be unable
to communicate bidirectionally with the Dapr sidecar. The SDK provides a helper method intended to be used for this
purpose called `CheckOutboundHealthAsync`. This isn't referring to outbound from the SDK to the runtime, so much as
outbound from the Dapr runtime back into the client application using the SDK.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
outbound from the Dapr runtime back into the client application using the SDK.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See previous (also, all these line breaks are there because my IDE doesn't wrap anything, so I manually wrap them at ~180 characters a line).

@WhitWaldo WhitWaldo merged commit 6e004c6 into dapr:master Sep 3, 2025
9 checks passed
@WhitWaldo WhitWaldo deleted the healthz-docs branch September 3, 2025 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants