[1.18] Add workflow history signing documentation#5082
Open
JoshVanL wants to merge 3 commits intodapr:v1.18from
Open
[1.18] Add workflow history signing documentation#5082JoshVanL wants to merge 3 commits intodapr:v1.18from
JoshVanL wants to merge 3 commits intodapr:v1.18from
Conversation
Add documentation for the workflow history signing feature, which provides cryptographic tamper detection for workflow execution histories using the sidecar's mTLS X.509 SPIFFE identity. Implemented in dapr/dapr#9666 Signed-off-by: joshvanl <me@joshvanl.dev>
Signed-off-by: joshvanl <me@joshvanl.dev>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the “workflow history signing” feature, explaining how Dapr workflows sign and verify workflow history using the sidecar’s mTLS X.509 identity, and surfaces operational guidance around certificate/CA rotation.
Changes:
- Adds a new concept doc detailing workflow history signing, verification, failure modes, and state layout.
- Links the new doc from the workflow overview and the preview features list.
- Adds mTLS certificate rotation warnings specific to signed workflow history.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| daprdocs/content/en/operations/support/support-preview-features.md | Adds “Workflow History Signing” to the preview features table and links to the new doc. |
| daprdocs/content/en/operations/security/mtls.md | Adds warnings about CA rotation impact on signed workflow histories. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-overview.md | Adds a “History signing” overview section linking to the detailed doc. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-history-signing.md | New, comprehensive documentation page for workflow history signing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...docs/content/en/developing-applications/building-blocks/workflow/workflow-history-signing.md
Outdated
Show resolved
Hide resolved
...docs/content/en/developing-applications/building-blocks/workflow/workflow-history-signing.md
Outdated
Show resolved
Hide resolved
Signed-off-by: joshvanl <me@joshvanl.dev>
JoshVanL
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add documentation for the workflow history signing feature, which provides cryptographic tamper detection for workflow execution histories using the sidecar's mTLS X.509 SPIFFE identity.
Implemented in dapr/dapr#9666