From 75d28f4116d40a7a6f7236da6f6aca4f259503d6 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Tue, 13 Aug 2024 13:40:47 +0200 Subject: [PATCH] docs: Clarify HTTP timeout configuration (#1452) --- content/docs/2.10/operate/cluster.md | 14 ++------------ content/docs/2.11/operate/cluster.md | 14 ++------------ content/docs/2.12/operate/cluster.md | 14 ++------------ content/docs/2.13/operate/cluster.md | 14 ++------------ content/docs/2.14/operate/cluster.md | 14 ++------------ content/docs/2.15/operate/cluster.md | 15 ++------------- content/docs/2.16/operate/cluster.md | 14 ++------------ content/docs/2.6/operate/cluster.md | 14 ++------------ content/docs/2.7/operate/cluster.md | 14 ++------------ content/docs/2.8/operate/cluster.md | 14 ++------------ content/docs/2.9/operate/cluster.md | 14 ++------------ 11 files changed, 22 insertions(+), 133 deletions(-) diff --git a/content/docs/2.10/operate/cluster.md b/content/docs/2.10/operate/cluster.md index b705893e8..aa64a0c0c 100644 --- a/content/docs/2.10/operate/cluster.md +++ b/content/docs/2.10/operate/cluster.md @@ -61,19 +61,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP connection disable keep alive diff --git a/content/docs/2.11/operate/cluster.md b/content/docs/2.11/operate/cluster.md index ffb15a12a..71eefeae8 100644 --- a/content/docs/2.11/operate/cluster.md +++ b/content/docs/2.11/operate/cluster.md @@ -62,19 +62,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP connection disable keep alive diff --git a/content/docs/2.12/operate/cluster.md b/content/docs/2.12/operate/cluster.md index 4f200e90a..5b5387495 100644 --- a/content/docs/2.12/operate/cluster.md +++ b/content/docs/2.12/operate/cluster.md @@ -63,19 +63,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP connection disable keep alive diff --git a/content/docs/2.13/operate/cluster.md b/content/docs/2.13/operate/cluster.md index 4f9c61068..bf6dc679d 100644 --- a/content/docs/2.13/operate/cluster.md +++ b/content/docs/2.13/operate/cluster.md @@ -64,19 +64,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP connection disable keep alive diff --git a/content/docs/2.14/operate/cluster.md b/content/docs/2.14/operate/cluster.md index 4ec1e1049..03d6013f8 100644 --- a/content/docs/2.14/operate/cluster.md +++ b/content/docs/2.14/operate/cluster.md @@ -65,19 +65,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP Connection: Disable Keep Alive diff --git a/content/docs/2.15/operate/cluster.md b/content/docs/2.15/operate/cluster.md index 6d0fd7b11..76783c36b 100644 --- a/content/docs/2.15/operate/cluster.md +++ b/content/docs/2.15/operate/cluster.md @@ -61,24 +61,13 @@ Here is an overview of all KEDA deployments and the HA notes: | -------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Metrics Server | 1 | You can run multiple replicas of our metrics sever, and it is recommended to add the `--enable-aggregator-routing=true` CLI flag to the kube-apiserver so that requests sent to our metrics servers are load balanced. However, [you can only run one active metric server in a Kubernetes cluster serving external.metrics.k8s.io](https://github.com/kubernetes-sigs/custom-metrics-apiserver/issues/70) which has to be the KEDA metric server. | | Operator | 2 | While you can run multiple replicas of our operator, only one operator instance will be active. The rest will be standing by, which may reduce downtime during a failure. Multiple replicas will not improve the performance of KEDA, it could only reduce a downtime during a failover. | - ## HTTP Timeouts Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: - -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP Connection: Disable Keep Alive diff --git a/content/docs/2.16/operate/cluster.md b/content/docs/2.16/operate/cluster.md index 23b367d23..920584bea 100644 --- a/content/docs/2.16/operate/cluster.md +++ b/content/docs/2.16/operate/cluster.md @@ -67,19 +67,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP Connection: Disable Keep Alive diff --git a/content/docs/2.6/operate/cluster.md b/content/docs/2.6/operate/cluster.md index 10e6a4043..02d8bf3b0 100644 --- a/content/docs/2.6/operate/cluster.md +++ b/content/docs/2.6/operate/cluster.md @@ -49,19 +49,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## Kubernetes Client Parameters diff --git a/content/docs/2.7/operate/cluster.md b/content/docs/2.7/operate/cluster.md index dfb78df81..810cd623c 100644 --- a/content/docs/2.7/operate/cluster.md +++ b/content/docs/2.7/operate/cluster.md @@ -49,19 +49,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP Proxies diff --git a/content/docs/2.8/operate/cluster.md b/content/docs/2.8/operate/cluster.md index 01a4f368d..eb325f3b9 100644 --- a/content/docs/2.8/operate/cluster.md +++ b/content/docs/2.8/operate/cluster.md @@ -49,19 +49,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP Proxies diff --git a/content/docs/2.9/operate/cluster.md b/content/docs/2.9/operate/cluster.md index 18bca5f61..d3f57ff13 100644 --- a/content/docs/2.9/operate/cluster.md +++ b/content/docs/2.9/operate/cluster.md @@ -59,19 +59,9 @@ Here is an overview of all KEDA deployments and the HA notes: Some scalers issue HTTP requests to external servers (i.e. cloud services). Each applicable scaler uses its own dedicated HTTP client with its own connection pool, and by default each client is set to time out any HTTP request after 3 seconds. -You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable to your desired timeout in milliseconds. For example, on Linux/Mac/Windows WSL2 operating systems, you'd use this command to set to 1 second: +You can override this default by setting the `KEDA_HTTP_DEFAULT_TIMEOUT` environment variable on the KEDA operator deployment to your desired timeout in milliseconds. -```shell -export KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -And on Windows Powershell, you'd use this command: - -```shell -$env:KEDA_HTTP_DEFAULT_TIMEOUT=1000 -``` - -All applicable scalers will use this timeout. Setting a per-scaler timeout is currently unsupported. +> ⚠️ All applicable scalers will use this timeout and setting this on a per-scaler is currently not supported. ## HTTP connection disable keep alive