docs: Graduate Component HotReloading to GA#5162
Conversation
Reflect dapr/dapr#9577 and dapr/dapr#9811: HotReload is on by default in v1.18. Remove the preview rows and update prose to default-on with an opt-out note. Signed-off-by: Javier Aliaga <javier@diagrid.io>
e144be0 to
d23df25
Compare
msfussell
left a comment
There was a problem hiding this comment.
@javier-aliaga. Reviewed. Additional changes needed
- You need to update the https://docs.dapr.io/operations/configuration/configuration-overview/ application configuration section to add the hot reload feature into the list and then reference it here.
- You also need to update https://docs.dapr.io/reference/resource-specs/configuration-schema/
- Same as the pub/sub you should add a note about HTTPEndpoint hot reloading into this topic https://docs.dapr.io/developing-applications/building-blocks/service-invocation/howto-invoke-non-dapr-endpoints/
| ## Hot Reloading | ||
|
|
||
| When the [`HotReload` feature gate]({{% ref "support-preview-features" %}}) is enabled, changes to Configuration resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the new configuration. Unchanged Configuration resources are silently ignored. SIGHUP is not supported on Windows. | ||
| Since Dapr v1.18, changes to Configuration resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the new configuration. Unchanged Configuration resources are silently ignored. SIGHUP is not supported on Windows. To opt out, disable the `HotReload` feature in the [Dapr application configuration]({{% ref "preview-features.md" %}}). |
There was a problem hiding this comment.
| Since Dapr v1.18, changes to Configuration resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the new configuration. Unchanged Configuration resources are silently ignored. SIGHUP is not supported on Windows. To opt out, disable the `HotReload` feature in the [Dapr application configuration]({{% ref "preview-features.md" %}}). | |
| Changes to Configuration resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the new configuration. Unchanged Configuration resources are silently ignored. SIGHUP is not supported on Windows. To opt out, disable the `HotReload` feature in the [Dapr application configuration]({{% ref "preview-features.md" %}}). |
| ## Hot Reloading | ||
|
|
||
| When the [`HotReload` feature gate]({{% ref "support-preview-features" %}}) is enabled, changes to Configuration resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the new configuration. Unchanged Configuration resources are silently ignored. SIGHUP is not supported on Windows. | ||
| Since Dapr v1.18, changes to Configuration resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the new configuration. Unchanged Configuration resources are silently ignored. SIGHUP is not supported on Windows. To opt out, disable the `HotReload` feature in the [Dapr application configuration]({{% ref "preview-features.md" %}}). |
There was a problem hiding this comment.
We cannot have a feature that does not work on Windows. This has to be fixed.
Also Are you saying the just Configuration resources uses SIGHUP, or that any hot reloading does not work on Windows.
There was a problem hiding this comment.
If this works on Windows and Linux, no need to talk about the implementation in the docs. Just say
"Changes to Configuration resources are automatically detected and trigger a graceful restart of the Dapr sidecar to apply the new configuration. To opt out, disable the HotReload feature in the [Dapr application configuration]({{% ref "configuration-overview.md" %}})"
You need to update the https://docs.dapr.io/operations/configuration/configuration-overview/ application configuration section to add the hot reload feature into the list and then reference it here.
| ## Hot Reloading | ||
|
|
||
| When the [`HotReload` feature gate]({{% ref "support-preview-features" %}}) is enabled, changes to Resiliency resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the updated resiliency policies. Unchanged Resiliency resources are silently ignored. SIGHUP is not supported on Windows. | ||
| Since Dapr v1.18, changes to Resiliency resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the updated resiliency policies. Unchanged Resiliency resources are silently ignored. SIGHUP is not supported on Windows. To opt out, disable the `HotReload` feature in the [Dapr application configuration]({{% ref "preview-features.md" %}}). |
There was a problem hiding this comment.
| Since Dapr v1.18, changes to Resiliency resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the updated resiliency policies. Unchanged Resiliency resources are silently ignored. SIGHUP is not supported on Windows. To opt out, disable the `HotReload` feature in the [Dapr application configuration]({{% ref "preview-features.md" %}}). | |
| Changes to Resiliency resources are automatically detected and trigger a graceful restart of the Dapr sidecar to apply the updated resiliency policies. Unchanged Resiliency resources are silently ignored.. To opt out, disable the `HotReload` feature in the [Dapr Resiliency]({{% ref "configuration-overview.md" %}}). |
There was a problem hiding this comment.
Same here. This has to be fixed for Windows. Cannot release otherwise.
| ## Hot Reloading | ||
|
|
||
| When the [`HotReload` feature gate]({{% ref "support-preview-features" %}}) is enabled, changes to Resiliency resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the updated resiliency policies. Unchanged Resiliency resources are silently ignored. SIGHUP is not supported on Windows. | ||
| Since Dapr v1.18, changes to Resiliency resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the updated resiliency policies. Unchanged Resiliency resources are silently ignored. SIGHUP is not supported on Windows. To opt out, disable the `HotReload` feature in the [Dapr application configuration]({{% ref "preview-features.md" %}}). |
There was a problem hiding this comment.
| Since Dapr v1.18, changes to Resiliency resources are automatically detected and trigger a graceful restart of the Dapr sidecar (via SIGHUP) to apply the updated resiliency policies. Unchanged Resiliency resources are silently ignored. SIGHUP is not supported on Windows. To opt out, disable the `HotReload` feature in the [Dapr application configuration]({{% ref "preview-features.md" %}}). | |
| Changes to Resiliency resources are automatically detected and trigger a graceful restart of the Dapr sidecar to apply the updated resiliency policies. To opt out, disable the `HotReload` feature in the [Dapr application configuration]({{% ref "configuration-overview.md" %}}). |
There was a problem hiding this comment.
You need to update the https://docs.dapr.io/operations/configuration/configuration-overview/ application configuration section to add the hot reload feature into the list and then reference it here.
| ### Configurations, Resiliency, and HTTPEndpoints | ||
|
|
||
| With the `HotReload` feature gate enabled, the Dapr sidecar also supports reloading [Configuration]({{% ref "configuration-overview.md" %}}), [Resiliency]({{% ref "resiliency-overview.md" %}}), and [HTTPEndpoint]({{% ref "service-invocation-overview.md" %}}) resources. | ||
| The Dapr sidecar also reloads [Configuration]({{% ref "configuration-overview.md" %}}), [Resiliency]({{% ref "resiliency-overview.md" %}}), and [HTTPEndpoint]({{% ref "service-invocation-overview.md" %}}) resources. |
There was a problem hiding this comment.
| The Dapr sidecar also reloads [Configuration]({{% ref "configuration-overview.md" %}}), [Resiliency]({{% ref "resiliency-overview.md" %}}), and [HTTPEndpoint]({{% ref "service-invocation-overview.md" %}}) resources. | |
| The Dapr sidecar also reloads [Configuration]({{% ref "configuration-overview.md" %}}), [Resiliency]({{% ref "resiliency-overview.md" %}}), WorkflowAccessPolicy({{% ref "workflow-access-policy.md" %}}) and [HTTPEndpoint]({{% ref "service-invocation-overview.md" %}}) resources. |
There was a problem hiding this comment.
@msfussell I cannot find the workflow-access-policy.md file, they are still pending to be merged https://github.com/dapr/docs/pull/5114/changes , I will add the reference but it will not work until the other one is merged
kit uses a named pipe on Windows, so the SIGHUP-not-supported caveats were misleading. Drop them. Signed-off-by: Javier Aliaga <javier@diagrid.io>
Co-authored-by: Mark Fussell <markfussell@gmail.com> Signed-off-by: Javier Aliaga <javier@diagrid.io>
Signed-off-by: Javier Aliaga <javier@diagrid.io>
Reflect dapr/dapr#9577 and dapr/dapr#9811: HotReload is on by default in v1.18. Remove the preview rows and update prose to default-on with an opt-out note.
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Issue reference