From 2af9ea9bd5b61f650637f63b1e6cdb41dcd39522 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Thu, 4 Mar 2021 07:01:02 +0100 Subject: [PATCH 1/2] docs: Provide overview of required ports to be accessible Relates to https://github.com/kedacore/keda/discussions/1634 Closes https://github.com/kedacore/keda-docs/issues/384 Signed-off-by: Tom Kerkhove --- content/docs/2.0/operate/cluster.md | 13 ++++++++++- content/docs/2.1/operate/cluster.md | 33 ++++++++++++++++++---------- content/docs/2.2/operate/cluster.md | 34 ++++++++++++++--------------- 3 files changed, 51 insertions(+), 29 deletions(-) diff --git a/content/docs/2.0/operate/cluster.md b/content/docs/2.0/operate/cluster.md index 095bf32c3..389a1c274 100644 --- a/content/docs/2.0/operate/cluster.md +++ b/content/docs/2.0/operate/cluster.md @@ -26,4 +26,15 @@ Here is an overview of all KEDA deployments and the supported replicas: | Deployment | Support Replicas | Reasoning | |----------------|-------------------------|-------------------------------| | Operator | 1 | | -| Metrics Server | 1 | Limitation in [k8s custom metrics server](https://github.com/kubernetes-sigs/custom-metrics-apiserver/issues/70) | \ No newline at end of file +| Metrics Server | 1 | Limitation in [k8s custom metrics server](https://github.com/kubernetes-sigs/custom-metrics-apiserver/issues/70) | + +## Firewall requirements + +KEDA requires to be accessible inside the cluster to be able to autoscale. + +Here is an overview of the required ports that need to be accessible for KEDA to work: + +| Port | Why? | Remarks | +| ------ | -------------------------------------------- | ---------------------------------------------------- | +| `443` | Used by Kubernetes API server to get metrics | Required for all platforms, except for Google Cloud. | +| `6443` | Used by Kubernetes API server to get metrics | Only required for Google Cloud | \ No newline at end of file diff --git a/content/docs/2.1/operate/cluster.md b/content/docs/2.1/operate/cluster.md index 928baaf83..851125b2b 100644 --- a/content/docs/2.1/operate/cluster.md +++ b/content/docs/2.1/operate/cluster.md @@ -4,17 +4,6 @@ description = "Guidance & requirements for running KEDA in your cluster" weight = 100 +++ -## High Availability - -KEDA does not provide support for high-availability due to upstream limitations. - -Here is an overview of all KEDA deployments and the supported replicas: - -| Deployment | Support Replicas | Reasoning | -|----------------|-------------------------|-------------------------------| -| Operator | 1 | | -| Metrics Server | 1 | Limitation in [k8s custom metrics server](https://github.com/kubernetes-sigs/custom-metrics-apiserver/issues/70) | - ## Cluster capacity requirements The KEDA runtime require the following resources in a production-ready setup: @@ -28,6 +17,28 @@ These are used by default when deploying through YAML. > 💡 For more info on CPU and Memory resource units and their meaning, see [this](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes) link. +## Firewall requirements + +KEDA requires to be accessible inside the cluster to be able to autoscale. + +Here is an overview of the required ports that need to be accessible for KEDA to work: + +| Port | Why? | Remarks | +| ------ | -------------------------------------------- | ---------------------------------------------------- | +| `443` | Used by Kubernetes API server to get metrics | Required for all platforms, except for Google Cloud. | +| `6443` | Used by Kubernetes API server to get metrics | Only required for Google Cloud | + +## High Availability + +KEDA does not provide support for high-availability due to upstream limitations. + +Here is an overview of all KEDA deployments and the supported replicas: + +| Deployment | Support Replicas | Reasoning | +|----------------|-------------------------|-------------------------------| +| Operator | 1 | | +| Metrics Server | 1 | Limitation in [k8s custom metrics server](https://github.com/kubernetes-sigs/custom-metrics-apiserver/issues/70) | + ## 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. diff --git a/content/docs/2.2/operate/cluster.md b/content/docs/2.2/operate/cluster.md index b5ef5fc5a..83803d2de 100644 --- a/content/docs/2.2/operate/cluster.md +++ b/content/docs/2.2/operate/cluster.md @@ -4,40 +4,40 @@ description = "Guidance & requirements for running KEDA in your cluster" weight = 100 +++ -## High Availability - -KEDA does not provide support for high-availability due to upstream limitations. - -Here is an overview of all KEDA deployments and the supported replicas: - -| Deployment | Support Replicas | Reasoning | -|----------------|-------------------------|-------------------------------| -| Operator | 1 | | -| Metrics Server | 1 | Limitation in [k8s custom metrics server](https://github.com/kubernetes-sigs/custom-metrics-apiserver/issues/70) | - ## Cluster capacity requirements The KEDA runtime require the following resources in a production-ready setup: | Deployment | CPU | Memory | -|----------------|-------------------------|-------------------------------| -| Operator | Limit: 1, Request: 100m | Limit: 1000Mi, Request: 100Mi | +| -------------- | ----------------------- | ----------------------------- | | Metrics Server | Limit: 1, Request: 100m | Limit: 1000Mi, Request: 100Mi | +| Operator | Limit: 1, Request: 100m | Limit: 1000Mi, Request: 100Mi | These are used by default when deploying through YAML. > 💡 For more info on CPU and Memory resource units and their meaning, see [this](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes) link. +## Firewall requirements + +KEDA requires to be accessible inside the cluster to be able to autoscale. + +Here is an overview of the required ports that need to be accessible for KEDA to work: + +| Port | Why? | Remarks | +| ------ | -------------------------------------------- | ---------------------------------------------------- | +| `443` | Used by Kubernetes API server to get metrics | Required for all platforms, except for Google Cloud. | +| `6443` | Used by Kubernetes API server to get metrics | Only required for Google Cloud | + ## High Availability KEDA does not provide support for high-availability due to upstream limitations. Here is an overview of all KEDA deployments and the supported replicas: -| Deployment | Support Replicas | Reasoning | -|----------------|-------------------------|-------------------------------| -| Operator | 1 | | -| Metrics Server | 1 | Limitation in [k8s custom metrics server](https://github.com/kubernetes-sigs/custom-metrics-apiserver/issues/70) | +| Deployment | Support Replicas | Reasoning | +| -------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------- | +| Metrics Server | 1 | Limitation in [k8s custom metrics server](https://github.com/kubernetes-sigs/custom-metrics-apiserver/issues/70) | +| Operator | 1 | | ## HTTP Timeouts From 713c95cd238109da7f25f9415e847ef5c85c35f0 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Fri, 5 Mar 2021 07:35:56 +0100 Subject: [PATCH 2/2] Add port details Signed-off-by: Tom Kerkhove --- content/docs/2.2/operate/cluster.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/content/docs/2.2/operate/cluster.md b/content/docs/2.2/operate/cluster.md index 83803d2de..b8f356436 100644 --- a/content/docs/2.2/operate/cluster.md +++ b/content/docs/2.2/operate/cluster.md @@ -23,10 +23,12 @@ KEDA requires to be accessible inside the cluster to be able to autoscale. Here is an overview of the required ports that need to be accessible for KEDA to work: -| Port | Why? | Remarks | -| ------ | -------------------------------------------- | ---------------------------------------------------- | -| `443` | Used by Kubernetes API server to get metrics | Required for all platforms, except for Google Cloud. | -| `6443` | Used by Kubernetes API server to get metrics | Only required for Google Cloud | + +| Port | Why? | Remarks | +| ------ | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `443` | Used by Kubernetes API server to get metrics | Required for all platforms because it uses Control Plane → port 443 on the Service IP range communication.

This is not applicable for Google Cloud. | +| `6443` | Used by Kubernetes API server to get metrics | Only required for Google Cloud because it uses Control Plane → port 6443 on the Pod IP range for communication | + ## High Availability