From 93d77644b140193d03994ff85e18bedba460dd73 Mon Sep 17 00:00:00 2001 From: Whit Waldo Date: Wed, 14 Aug 2024 09:42:10 -0500 Subject: [PATCH 1/2] Listed missing HTTP and gRPC endpoint envvars used Signed-off-by: Whit Waldo --- daprdocs/content/en/reference/environment/_index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/daprdocs/content/en/reference/environment/_index.md b/daprdocs/content/en/reference/environment/_index.md index d5ed2d529c1..99eeded2c25 100644 --- a/daprdocs/content/en/reference/environment/_index.md +++ b/daprdocs/content/en/reference/environment/_index.md @@ -14,7 +14,9 @@ The following table lists the environment variables used by the Dapr runtime, CL | APP_PORT | Dapr sidecar | The port your application is listening on | | APP_API_TOKEN | Your application | The token used by the application to authenticate requests from Dapr API. Read [authenticate requests from Dapr using token authentication]({{< ref app-api-token >}}) for more information. | | DAPR_HTTP_PORT | Your application | The HTTP port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | +| DAPR_HTTP_ENDPOINT | Your application | The HTTP endpoint that the Dapr sidecar is listening on. Your application should use this variable to change the endpoint used to connect to the Dapr sidecar instead of hardcoding an alternative hostname. It is expected that this value minimally include the schema and hostname.| | DAPR_GRPC_PORT | Your application | The gRPC port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | +| DAPR_GRPC_ENDPOINT | Your application | The gRPC endpoint that the Dapr sidecar is listening on. Your application should use this variable to change the endpoint used to connect to the Dapr sidecar instead of hardcoding an alternative hostname. It is expected that this value minimally include the schema and hostname.| | DAPR_API_TOKEN | Dapr sidecar | The token used for Dapr API authentication for requests from the application. [Enable API token authentication in Dapr]({{< ref api-token >}}). | | NAMESPACE | Dapr sidecar | Used to specify a component's [namespace in self-hosted mode]({{< ref component-scopes >}}). | | DAPR_DEFAULT_IMAGE_REGISTRY | Dapr CLI | In self-hosted mode, it is used to specify the default container registry to pull images from. When its value is set to `GHCR` or `ghcr`, it pulls the required images from Github container registry. To default to Docker hub, unset this environment variable. | From 61106e49fa3f439ce7cfcc4993af267476806d74 Mon Sep 17 00:00:00 2001 From: Whit Waldo Date: Wed, 14 Aug 2024 23:55:34 -0500 Subject: [PATCH 2/2] Added examples Signed-off-by: Whit Waldo --- daprdocs/content/en/reference/environment/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/daprdocs/content/en/reference/environment/_index.md b/daprdocs/content/en/reference/environment/_index.md index 99eeded2c25..afff9cbca82 100644 --- a/daprdocs/content/en/reference/environment/_index.md +++ b/daprdocs/content/en/reference/environment/_index.md @@ -14,9 +14,9 @@ The following table lists the environment variables used by the Dapr runtime, CL | APP_PORT | Dapr sidecar | The port your application is listening on | | APP_API_TOKEN | Your application | The token used by the application to authenticate requests from Dapr API. Read [authenticate requests from Dapr using token authentication]({{< ref app-api-token >}}) for more information. | | DAPR_HTTP_PORT | Your application | The HTTP port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | -| DAPR_HTTP_ENDPOINT | Your application | The HTTP endpoint that the Dapr sidecar is listening on. Your application should use this variable to change the endpoint used to connect to the Dapr sidecar instead of hardcoding an alternative hostname. It is expected that this value minimally include the schema and hostname.| +| DAPR_HTTP_ENDPOINT | Your application | The HTTP endpoint that the Dapr sidecar is listening on. Your application should use this variable to change the endpoint used to connect to the Dapr sidecar instead of hardcoding an alternative hostname. It is expected that this value minimally include the schema and hostname: `https://dapr.io` would indicate an `https` schema, a hostname of `dapr.io` and the implied (via the `https` scheme) port of `443` | | DAPR_GRPC_PORT | Your application | The gRPC port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | -| DAPR_GRPC_ENDPOINT | Your application | The gRPC endpoint that the Dapr sidecar is listening on. Your application should use this variable to change the endpoint used to connect to the Dapr sidecar instead of hardcoding an alternative hostname. It is expected that this value minimally include the schema and hostname.| +| DAPR_GRPC_ENDPOINT | Your application | The gRPC endpoint that the Dapr sidecar is listening on. Your application should use this variable to change the endpoint used to connect to the Dapr sidecar instead of hardcoding an alternative hostname. It is expected that this value minimally include the schema and hostname: `http://grpc.dapr.io` would indicate an `http` schema, a hostname of `dapr.io` and the implied (via the `http` scheme) port of `80`| | DAPR_API_TOKEN | Dapr sidecar | The token used for Dapr API authentication for requests from the application. [Enable API token authentication in Dapr]({{< ref api-token >}}). | | NAMESPACE | Dapr sidecar | Used to specify a component's [namespace in self-hosted mode]({{< ref component-scopes >}}). | | DAPR_DEFAULT_IMAGE_REGISTRY | Dapr CLI | In self-hosted mode, it is used to specify the default container registry to pull images from. When its value is set to `GHCR` or `ghcr`, it pulls the required images from Github container registry. To default to Docker hub, unset this environment variable. |