Skip to content

Commit

Permalink
docs: Clarify HTTP timeout configuration (#1452)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkerkhove authored Aug 13, 2024
1 parent 64c77aa commit 75d28f4
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 133 deletions.
14 changes: 2 additions & 12 deletions content/docs/2.10/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 2 additions & 12 deletions content/docs/2.11/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 2 additions & 12 deletions content/docs/2.12/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 2 additions & 12 deletions content/docs/2.13/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 2 additions & 12 deletions content/docs/2.14/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
15 changes: 2 additions & 13 deletions content/docs/2.15/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 2 additions & 12 deletions content/docs/2.16/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 2 additions & 12 deletions content/docs/2.6/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 2 additions & 12 deletions content/docs/2.7/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 2 additions & 12 deletions content/docs/2.8/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 2 additions & 12 deletions content/docs/2.9/operate/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 75d28f4

Please sign in to comment.