Skip to content
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

Documents new placement environment variables #4327

Closed
wants to merge 2 commits into from

Conversation

elena-kolevska
Copy link
Contributor

@elena-kolevska elena-kolevska commented Aug 27, 2024

Description

Documents the new placement env variables added in this pr.

Please don't merge until the corresponding PR is merged

@@ -28,5 +28,8 @@ The following table lists the environment variables used by the Dapr runtime, CL
| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` |
| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. |
| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) |
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr Placement service| Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|

@@ -28,5 +28,8 @@ The following table lists the environment variables used by the Dapr runtime, CL
| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` |
| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. |
| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) |
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
| DAPR_PLACEMENT_KEEPALIVE_TIMEOUT | Dapr placement | Sets the timeout period for daprd to respond to the placement service's keepalive pings before the placement service closes the connection. Lower values will lead to shorter actor rebalancing time in case of pod loss/restart, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `3s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| DAPR_PLACEMENT_KEEPALIVE_TIMEOUT | Dapr placement | Sets the timeout period for daprd to respond to the placement service's keepalive pings before the placement service closes the connection. Lower values will lead to shorter actor rebalancing time in case of pod loss/restart, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `3s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
| DAPR_PLACEMENT_KEEPALIVE_TIMEOUT | Dapr Placement service| | Sets the timeout period for daprd to respond to the placement service's keepalive pings before the placement service closes the connection. Lower values will lead to shorter actor rebalancing time in case of pod loss/restart, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `3s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|

@@ -28,5 +28,8 @@ The following table lists the environment variables used by the Dapr runtime, CL
| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` |
| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. |
| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) |
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
| DAPR_PLACEMENT_KEEPALIVE_TIMEOUT | Dapr placement | Sets the timeout period for daprd to respond to the placement service's keepalive pings before the placement service closes the connection. Lower values will lead to shorter actor rebalancing time in case of pod loss/restart, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `3s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
| DAPR_PLACEMENT_DISSEMINATE_TIMEOUT | Dapr placement | Sets the timeout period for dissemination to be delayed after actor membership change (usually related to pod restarts) so as to avoid excessive dissemination during multiple pod restarts. Higher values will reduce the frequency of dissemination, but delay the table dissemination. Accepts values between `1s` and `5s`. If unset, it defaults to `2s`. |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| DAPR_PLACEMENT_DISSEMINATE_TIMEOUT | Dapr placement | Sets the timeout period for dissemination to be delayed after actor membership change (usually related to pod restarts) so as to avoid excessive dissemination during multiple pod restarts. Higher values will reduce the frequency of dissemination, but delay the table dissemination. Accepts values between `1s` and `5s`. If unset, it defaults to `2s`. |
| DAPR_PLACEMENT_DISSEMINATE_TIMEOUT | Dapr Placement service| | Sets the timeout period for dissemination to be delayed after actor membership change (usually related to pod restarts) so as to avoid excessive dissemination during multiple pod restarts. Higher values will reduce the frequency of dissemination, but delay the table dissemination. Accepts values between `1s` and `5s`. If unset, it defaults to `2s`. |

@@ -28,5 +28,8 @@ The following table lists the environment variables used by the Dapr runtime, CL
| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` |
| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. |
| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) |
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr Placement service| | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|

@@ -28,5 +28,8 @@ The following table lists the environment variables used by the Dapr runtime, CL
| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` |
| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. |
| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) |
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr Placement service| | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|

@@ -28,5 +28,8 @@ The following table lists the environment variables used by the Dapr runtime, CL
| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` |
| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. |
| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) |
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr Placement service| | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|

@@ -28,5 +28,8 @@ The following table lists the environment variables used by the Dapr runtime, CL
| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` |
| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. |
| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) |
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr placement | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|
| DAPR_PLACEMENT_KEEPALIVE_TIME | Dapr Placement service| | Sets the interval at which the placement service sends keepalive pings to daprd on the gRPC stream to check if the connection is still alive. Lower values will lead to shorter actor rebalancing time in case of pod loss, but higher network traffic during normal operation. Accepts values between `1s` and `10s`. If unset, it defaults to `2s`. <br> [Мore info](https://grpc.io/docs/guides/keepalive/) on gRPC keepalive.|

@elena-kolevska
Copy link
Contributor Author

Closing because we moved away from env variables for this. The values are documented as helm values in the dapr/dapr repo instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants