From 2778e9dbee1ac7f5b7271888893d23321192505a Mon Sep 17 00:00:00 2001 From: Uchechukwu Obasi Date: Wed, 18 Sep 2024 12:21:53 +0100 Subject: [PATCH] feat: create integrations page (#1455) Signed-off-by: thisisobate --- config.toml | 14 ++++++++++---- content/docs/2.0/integrations/_index.md | 8 ++++++++ .../operate => 2.0/integrations}/prometheus.md | 3 ++- content/docs/2.0/operate/_index.md | 1 - content/docs/2.0/operate/prometheus.md | 16 ---------------- content/docs/2.1/integrations/_index.md | 8 ++++++++ .../2.1/{operate => integrations}/prometheus.md | 3 ++- content/docs/2.1/operate/_index.md | 1 - .../docs/2.10/concepts/scaling-deployments.md | 2 +- content/docs/2.10/integrations/_index.md | 8 ++++++++ .../{operate => integrations}/prometheus.md | 3 ++- content/docs/2.10/operate/_index.md | 1 - .../docs/2.11/concepts/scaling-deployments.md | 2 +- content/docs/2.11/integrations/_index.md | 8 ++++++++ .../{operate => integrations}/prometheus.md | 3 ++- content/docs/2.11/operate/_index.md | 1 - .../docs/2.12/concepts/scaling-deployments.md | 2 +- content/docs/2.12/integrations/_index.md | 8 ++++++++ .../{operate => integrations}/opentelemetry.md | 3 ++- .../{operate => integrations}/prometheus.md | 3 ++- content/docs/2.12/operate/_index.md | 2 -- .../docs/2.13/concepts/scaling-deployments.md | 2 +- content/docs/2.13/integrations/_index.md | 8 ++++++++ .../{operate => integrations}/opentelemetry.md | 3 ++- .../{operate => integrations}/prometheus.md | 3 ++- content/docs/2.13/operate/_index.md | 2 -- .../docs/2.14/concepts/scaling-deployments.md | 2 +- content/docs/2.14/integrations/_index.md | 8 ++++++++ .../integrations}/istio-integration.md | 5 +++-- .../integrations}/opentelemetry.md | 5 +++-- .../{operate => integrations}/prometheus.md | 3 ++- content/docs/2.14/operate/_index.md | 2 -- .../docs/2.14/reference/scaledobject-spec.md | 2 +- content/docs/2.15/integrations/_index.md | 8 ++++++++ .../integrations}/istio-integration.md | 5 +++-- .../integrations}/opentelemetry.md | 5 +++-- .../{operate => integrations}/prometheus.md | 3 ++- content/docs/2.15/operate/_index.md | 2 -- .../docs/2.15/reference/scaledobject-spec.md | 2 +- content/docs/2.16/integrations/_index.md | 8 ++++++++ .../istio-integration.md | 5 +++-- .../integrations}/opentelemetry.md | 5 +++-- .../{operate => integrations}/prometheus.md | 3 ++- content/docs/2.16/operate/_index.md | 2 -- .../docs/2.16/reference/scaledobject-spec.md | 2 +- content/docs/2.2/integrations/_index.md | 8 ++++++++ .../2.2/{operate => integrations}/prometheus.md | 3 ++- content/docs/2.2/operate/_index.md | 1 - content/docs/2.3/integrations/_index.md | 8 ++++++++ .../2.3/{operate => integrations}/prometheus.md | 3 ++- content/docs/2.3/operate/_index.md | 1 - content/docs/2.4/integrations/_index.md | 8 ++++++++ content/docs/2.4/integrations/prometheus.md | 17 +++++++++++++++++ content/docs/2.4/operate/_index.md | 3 +-- content/docs/2.5/integrations/_index.md | 8 ++++++++ .../2.5/{operate => integrations}/prometheus.md | 3 ++- content/docs/2.5/operate/_index.md | 3 +-- content/docs/2.6/integrations/_index.md | 8 ++++++++ .../2.6/{operate => integrations}/prometheus.md | 3 ++- content/docs/2.6/operate/_index.md | 3 +-- content/docs/2.7/integrations/_index.md | 8 ++++++++ .../2.7/{operate => integrations}/prometheus.md | 3 ++- content/docs/2.7/operate/_index.md | 3 +-- content/docs/2.8/integrations/_index.md | 8 ++++++++ .../2.8/{operate => integrations}/prometheus.md | 3 ++- content/docs/2.8/operate/_index.md | 3 +-- .../docs/2.9/concepts/scaling-deployments.md | 2 +- content/docs/2.9/integrations/_index.md | 8 ++++++++ .../2.9/{operate => integrations}/prometheus.md | 3 ++- content/docs/2.9/operate/_index.md | 3 +-- .../{scaler-info.html => card-info.html} | 7 +++++++ layouts/partials/home/scalers.html | 2 +- layouts/shortcodes/integrations.html | 14 ++++++++++++++ 73 files changed, 254 insertions(+), 88 deletions(-) create mode 100644 content/docs/2.0/integrations/_index.md rename content/docs/{2.4/operate => 2.0/integrations}/prometheus.md (95%) delete mode 100644 content/docs/2.0/operate/prometheus.md create mode 100644 content/docs/2.1/integrations/_index.md rename content/docs/2.1/{operate => integrations}/prometheus.md (95%) create mode 100644 content/docs/2.10/integrations/_index.md rename content/docs/2.10/{operate => integrations}/prometheus.md (98%) create mode 100644 content/docs/2.11/integrations/_index.md rename content/docs/2.11/{operate => integrations}/prometheus.md (98%) create mode 100644 content/docs/2.12/integrations/_index.md rename content/docs/2.12/{operate => integrations}/opentelemetry.md (98%) rename content/docs/2.12/{operate => integrations}/prometheus.md (98%) create mode 100644 content/docs/2.13/integrations/_index.md rename content/docs/2.13/{operate => integrations}/opentelemetry.md (98%) rename content/docs/2.13/{operate => integrations}/prometheus.md (98%) create mode 100644 content/docs/2.14/integrations/_index.md rename content/docs/{2.15/operate => 2.14/integrations}/istio-integration.md (98%) rename content/docs/{2.16/operate => 2.14/integrations}/opentelemetry.md (98%) rename content/docs/2.14/{operate => integrations}/prometheus.md (99%) create mode 100644 content/docs/2.15/integrations/_index.md rename content/docs/{2.14/operate => 2.15/integrations}/istio-integration.md (98%) rename content/docs/{2.14/operate => 2.15/integrations}/opentelemetry.md (98%) rename content/docs/2.15/{operate => integrations}/prometheus.md (99%) create mode 100644 content/docs/2.16/integrations/_index.md rename content/docs/2.16/{operate => integrations}/istio-integration.md (98%) rename content/docs/{2.15/operate => 2.16/integrations}/opentelemetry.md (98%) rename content/docs/2.16/{operate => integrations}/prometheus.md (99%) create mode 100644 content/docs/2.2/integrations/_index.md rename content/docs/2.2/{operate => integrations}/prometheus.md (95%) create mode 100644 content/docs/2.3/integrations/_index.md rename content/docs/2.3/{operate => integrations}/prometheus.md (95%) create mode 100644 content/docs/2.4/integrations/_index.md create mode 100644 content/docs/2.4/integrations/prometheus.md create mode 100644 content/docs/2.5/integrations/_index.md rename content/docs/2.5/{operate => integrations}/prometheus.md (96%) create mode 100644 content/docs/2.6/integrations/_index.md rename content/docs/2.6/{operate => integrations}/prometheus.md (96%) create mode 100644 content/docs/2.7/integrations/_index.md rename content/docs/2.7/{operate => integrations}/prometheus.md (96%) create mode 100644 content/docs/2.8/integrations/_index.md rename content/docs/2.8/{operate => integrations}/prometheus.md (96%) create mode 100644 content/docs/2.9/integrations/_index.md rename content/docs/2.9/{operate => integrations}/prometheus.md (98%) rename layouts/_default/{scaler-info.html => card-info.html} (82%) create mode 100644 layouts/shortcodes/integrations.html diff --git a/config.toml b/config.toml index 8cd4285bd..0c30e4b9d 100644 --- a/config.toml +++ b/config.toml @@ -187,29 +187,35 @@ name = "Operate" parent = "docs" weight = 5 +[[menu.docs]] +url = "/docs/integrations/" +name = "Integrations" +parent = "docs" +weight = 6 + [[menu.docs]] url = "/docs/authentication-providers" name = "Auth providers" parent = "docs" -weight = 6 +weight = 7 [[menu.docs]] url = "/docs/migration/" name = "Migration Guide" parent = "docs" -weight = 7 +weight = 8 [[menu.docs]] url = "/docs/reference/faq/" name = "FAQ" parent = "docs" -weight = 8 +weight = 9 [[menu.docs]] url = "/docs/troubleshooting/" name = "Troubleshooting" parent = "docs" -weight = 9 +weight = 10 [[menu.main]] url = "/blog" diff --git a/content/docs/2.0/integrations/_index.md b/content/docs/2.0/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.0/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.4/operate/prometheus.md b/content/docs/2.0/integrations/prometheus.md similarity index 95% rename from content/docs/2.4/operate/prometheus.md rename to content/docs/2.0/integrations/prometheus.md index 951576c8f..c41e003ab 100644 --- a/content/docs/2.4/operate/prometheus.md +++ b/content/docs/2.0/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.0/operate/_index.md b/content/docs/2.0/operate/_index.md index 0e900e6ce..a70e97160 100644 --- a/content/docs/2.0/operate/_index.md +++ b/content/docs/2.0/operate/_index.md @@ -7,4 +7,3 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) diff --git a/content/docs/2.0/operate/prometheus.md b/content/docs/2.0/operate/prometheus.md deleted file mode 100644 index de46de8d0..000000000 --- a/content/docs/2.0/operate/prometheus.md +++ /dev/null @@ -1,16 +0,0 @@ -+++ -title = "Integrate with Prometheus" -description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 -+++ - -## Prometheus Exporter Metrics - -The KEDA Metrics Adapter exposes Prometheus metrics which can be scraped on port `9022` (this can be changed by setting the `metrics-port` argument for the Metrics Adapter) at `/metrics`. The metrics collected in the Metrics Adapter are only active when the HPA is active (> 0 replicas). - -The following metrics are being gathered: - -- `keda_metrics_adapter_scaler_errors_total` - The total number of errors encountered for all scalers. -- `keda_metrics_adapter_scaled_object_error_totals`- The number of errors that have occurred for each scaled object. -- `keda_metrics_adapter_scaler_errors` - The number of errors that have occurred for each scaler. -- `keda_metrics_adapter_scaler_metrics_value`- The current value for each scaler's metric that would be used by the HPA in computing the target average. \ No newline at end of file diff --git a/content/docs/2.1/integrations/_index.md b/content/docs/2.1/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.1/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.1/operate/prometheus.md b/content/docs/2.1/integrations/prometheus.md similarity index 95% rename from content/docs/2.1/operate/prometheus.md rename to content/docs/2.1/integrations/prometheus.md index 951576c8f..c41e003ab 100644 --- a/content/docs/2.1/operate/prometheus.md +++ b/content/docs/2.1/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.1/operate/_index.md b/content/docs/2.1/operate/_index.md index 89715faa1..a70e97160 100644 --- a/content/docs/2.1/operate/_index.md +++ b/content/docs/2.1/operate/_index.md @@ -7,4 +7,3 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) \ No newline at end of file diff --git a/content/docs/2.10/concepts/scaling-deployments.md b/content/docs/2.10/concepts/scaling-deployments.md index f6266edaf..44bd1e1e6 100644 --- a/content/docs/2.10/concepts/scaling-deployments.md +++ b/content/docs/2.10/concepts/scaling-deployments.md @@ -214,7 +214,7 @@ Starting from Kubernetes v1.18 the autoscaling API allows scaling behavior to be Trigger fields: - **type**: The type of trigger to use. (Mandatory) - **metadata**: The configuration parameters that the trigger requires. (Mandatory) -- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default, the name is generated from the trigger type. (Optional) +- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../integrations/prometheus.md). By default, the name is generated from the trigger type. (Optional) - **useCachedMetrics**: ([Experimental feature](https://github.com/kedacore/governance/blob/main/DEPRECATIONS.md#experimental-features)) Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics (Experimental)"](#caching-metrics-experimental). (Values: `false`, `true`, Default: `false`, Optional) - **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment. - More details can be found [here](./authentication). (Optional) diff --git a/content/docs/2.10/integrations/_index.md b/content/docs/2.10/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.10/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.10/operate/prometheus.md b/content/docs/2.10/integrations/prometheus.md similarity index 98% rename from content/docs/2.10/operate/prometheus.md rename to content/docs/2.10/integrations/prometheus.md index 1b7290703..4f35c54d4 100644 --- a/content/docs/2.10/operate/prometheus.md +++ b/content/docs/2.10/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 100 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.10/operate/_index.md b/content/docs/2.10/operate/_index.md index 5b8c5c3ef..56bef7222 100644 --- a/content/docs/2.10/operate/_index.md +++ b/content/docs/2.10/operate/_index.md @@ -10,5 +10,4 @@ We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) - Kubernetes Events ([link](./events)) - KEDA Metrics Server ([link](./metrics-server)) -- Integrate with Prometheus ([link](./prometheus)) - Security ([link](./security)) diff --git a/content/docs/2.11/concepts/scaling-deployments.md b/content/docs/2.11/concepts/scaling-deployments.md index de738e430..866eb3a79 100644 --- a/content/docs/2.11/concepts/scaling-deployments.md +++ b/content/docs/2.11/concepts/scaling-deployments.md @@ -217,7 +217,7 @@ Starting from Kubernetes v1.18 the autoscaling API allows scaling behavior to be Trigger fields: - **type**: The type of trigger to use. (Mandatory) - **metadata**: The configuration parameters that the trigger requires. (Mandatory) -- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default the name is generated from the trigger type. (Optional) +- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../integrations/prometheus.md). By default the name is generated from the trigger type. (Optional) - **useCachedMetrics**: Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics"](#caching-metrics). (Values: `false`, `true`, Default: `false`, Optional) - **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment. - More details can be found [here](./authentication). (Optional) diff --git a/content/docs/2.11/integrations/_index.md b/content/docs/2.11/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.11/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.11/operate/prometheus.md b/content/docs/2.11/integrations/prometheus.md similarity index 98% rename from content/docs/2.11/operate/prometheus.md rename to content/docs/2.11/integrations/prometheus.md index 88d486b53..5981c16e9 100644 --- a/content/docs/2.11/operate/prometheus.md +++ b/content/docs/2.11/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 100 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.11/operate/_index.md b/content/docs/2.11/operate/_index.md index 5b8c5c3ef..56bef7222 100644 --- a/content/docs/2.11/operate/_index.md +++ b/content/docs/2.11/operate/_index.md @@ -10,5 +10,4 @@ We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) - Kubernetes Events ([link](./events)) - KEDA Metrics Server ([link](./metrics-server)) -- Integrate with Prometheus ([link](./prometheus)) - Security ([link](./security)) diff --git a/content/docs/2.12/concepts/scaling-deployments.md b/content/docs/2.12/concepts/scaling-deployments.md index eccb41e4b..a9f834f33 100644 --- a/content/docs/2.12/concepts/scaling-deployments.md +++ b/content/docs/2.12/concepts/scaling-deployments.md @@ -251,7 +251,7 @@ For examples of this feature see section [Scaling Modifiers](#scaling-modifiers- Trigger fields: - **type**: The type of trigger to use. (Mandatory) - **metadata**: The configuration parameters that the trigger requires. (Mandatory) -- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default, the name is generated from the trigger type. (Optional) +- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../integrations/prometheus.md). By default, the name is generated from the trigger type. (Optional) - **useCachedMetrics**: Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics"](#caching-metrics). (Values: `false`, `true`, Default: `false`, Optional) - **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment. - More details can be found [here](./authentication). (Optional) diff --git a/content/docs/2.12/integrations/_index.md b/content/docs/2.12/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.12/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.12/operate/opentelemetry.md b/content/docs/2.12/integrations/opentelemetry.md similarity index 98% rename from content/docs/2.12/operate/opentelemetry.md rename to content/docs/2.12/integrations/opentelemetry.md index 5d02babda..f93876611 100644 --- a/content/docs/2.12/operate/opentelemetry.md +++ b/content/docs/2.12/integrations/opentelemetry.md @@ -1,7 +1,8 @@ +++ title= "Integrate with OpenTelemetry Collector (Experimental)" description= "Detail of integrating OpenTelemetry Collector in KEDA" -weight = 100 +availability = "v2.12+" +project = "OpenTelemetry" +++ ## Push Metrics to OpenTelemetry Collector (Experimental) diff --git a/content/docs/2.12/operate/prometheus.md b/content/docs/2.12/integrations/prometheus.md similarity index 98% rename from content/docs/2.12/operate/prometheus.md rename to content/docs/2.12/integrations/prometheus.md index f801b422f..8a097dc9a 100644 --- a/content/docs/2.12/operate/prometheus.md +++ b/content/docs/2.12/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 100 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.12/operate/_index.md b/content/docs/2.12/operate/_index.md index e7604a0cf..56bef7222 100644 --- a/content/docs/2.12/operate/_index.md +++ b/content/docs/2.12/operate/_index.md @@ -10,6 +10,4 @@ We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) - Kubernetes Events ([link](./events)) - KEDA Metrics Server ([link](./metrics-server)) -- Integrate with Prometheus ([link](./prometheus)) -- Integrate with OpenTelemetry Collector (Experimental) ([link](./opentelemetry)) - Security ([link](./security)) diff --git a/content/docs/2.13/concepts/scaling-deployments.md b/content/docs/2.13/concepts/scaling-deployments.md index 248e17148..a4a5e63d5 100644 --- a/content/docs/2.13/concepts/scaling-deployments.md +++ b/content/docs/2.13/concepts/scaling-deployments.md @@ -251,7 +251,7 @@ For examples of this feature see section [Scaling Modifiers](#scaling-modifiers- Trigger fields: - **type**: The type of trigger to use. (Mandatory) - **metadata**: The configuration parameters that the trigger requires. (Mandatory) -- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default, the name is generated from the trigger type. (Optional) +- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../integrations/prometheus.md). By default, the name is generated from the trigger type. (Optional) - **useCachedMetrics**: Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics"](#caching-metrics). (Values: `false`, `true`, Default: `false`, Optional) - **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment. - More details can be found [here](./authentication). (Optional) diff --git a/content/docs/2.13/integrations/_index.md b/content/docs/2.13/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.13/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.13/operate/opentelemetry.md b/content/docs/2.13/integrations/opentelemetry.md similarity index 98% rename from content/docs/2.13/operate/opentelemetry.md rename to content/docs/2.13/integrations/opentelemetry.md index 8d6cdf2dd..2cda10de0 100644 --- a/content/docs/2.13/operate/opentelemetry.md +++ b/content/docs/2.13/integrations/opentelemetry.md @@ -1,7 +1,8 @@ +++ title= "Integrate with OpenTelemetry Collector (Experimental)" description= "Detail of integrating OpenTelemetry Collector in KEDA" -weight = 100 +availability = "v2.12+" +project = "OpenTelemetry" +++ ## Push Metrics to OpenTelemetry Collector (Experimental) diff --git a/content/docs/2.13/operate/prometheus.md b/content/docs/2.13/integrations/prometheus.md similarity index 98% rename from content/docs/2.13/operate/prometheus.md rename to content/docs/2.13/integrations/prometheus.md index 7f937615e..e56fc3c0f 100644 --- a/content/docs/2.13/operate/prometheus.md +++ b/content/docs/2.13/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 100 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.13/operate/_index.md b/content/docs/2.13/operate/_index.md index e7604a0cf..56bef7222 100644 --- a/content/docs/2.13/operate/_index.md +++ b/content/docs/2.13/operate/_index.md @@ -10,6 +10,4 @@ We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) - Kubernetes Events ([link](./events)) - KEDA Metrics Server ([link](./metrics-server)) -- Integrate with Prometheus ([link](./prometheus)) -- Integrate with OpenTelemetry Collector (Experimental) ([link](./opentelemetry)) - Security ([link](./security)) diff --git a/content/docs/2.14/concepts/scaling-deployments.md b/content/docs/2.14/concepts/scaling-deployments.md index cc8f3ffd9..cd2f23c06 100644 --- a/content/docs/2.14/concepts/scaling-deployments.md +++ b/content/docs/2.14/concepts/scaling-deployments.md @@ -263,7 +263,7 @@ For examples of this feature see section [Scaling Modifiers](#scaling-modifiers- Trigger fields: - **type**: The type of trigger to use. (Mandatory) - **metadata**: The configuration parameters that the trigger requires. (Mandatory) -- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default, the name is generated from the trigger type. (Optional) +- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../integrations/prometheus.md). By default, the name is generated from the trigger type. (Optional) - **useCachedMetrics**: Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics"](#caching-metrics). (Values: `false`, `true`, Default: `false`, Optional) - **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment. - More details can be found [here](./authentication). (Optional) diff --git a/content/docs/2.14/integrations/_index.md b/content/docs/2.14/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.14/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.15/operate/istio-integration.md b/content/docs/2.14/integrations/istio-integration.md similarity index 98% rename from content/docs/2.15/operate/istio-integration.md rename to content/docs/2.14/integrations/istio-integration.md index 78427324c..413cf3ae0 100644 --- a/content/docs/2.15/operate/istio-integration.md +++ b/content/docs/2.14/integrations/istio-integration.md @@ -1,7 +1,8 @@ +++ title = "KEDA Integration with Istio" description = "Guidance for running KEDA along with Istio in your cluster" -weight = 100 +availability = "v2.14+" +project = "Istio" +++ ## Overview @@ -60,4 +61,4 @@ Existing troubleshooting guide for KEDA with Istio. ### Conclusion By applying these annotations, you can ensure that KEDA integrates seamlessly with Istio while adhering to security requirements. This configuration allows KEDA to maintain internal mTLS communication and interact properly with other mesh services. -If you encounter any issues or have further questions, please refer to the KEDA and Istio documentation or reach out to the community for support. \ No newline at end of file +If you encounter any issues or have further questions, please refer to the KEDA and Istio documentation or reach out to the community for support. diff --git a/content/docs/2.16/operate/opentelemetry.md b/content/docs/2.14/integrations/opentelemetry.md similarity index 98% rename from content/docs/2.16/operate/opentelemetry.md rename to content/docs/2.14/integrations/opentelemetry.md index f1c5459da..1db48fb1e 100644 --- a/content/docs/2.16/operate/opentelemetry.md +++ b/content/docs/2.14/integrations/opentelemetry.md @@ -1,7 +1,8 @@ +++ title= "Integrate with OpenTelemetry Collector (Experimental)" description= "Detail of integrating OpenTelemetry Collector in KEDA" -weight = 100 +availability = "v2.12+" +project = "OpenTelemetry" +++ ## Push Metrics to OpenTelemetry Collector (Experimental) @@ -54,4 +55,4 @@ The following metrics are exposed as well, but are deprecated and will be remove | `keda.scaler.metrics.latency` | The latency of retrieving current metric from each scaler. | | `keda.resource.totals` | Total number of KEDA custom resources per namespace for each custom resource type (CRD). | | `keda.trigger.totals` | Total number of triggers per trigger type. | -| `keda.internal.scale.loop.latency` | Total deviation (in milliseconds) between the expected execution time and the actual execution time for the scaling loop. This latency could be produced due to accumulated scalers latencies or high load. This is an internal metric. | \ No newline at end of file +| `keda.internal.scale.loop.latency` | Total deviation (in milliseconds) between the expected execution time and the actual execution time for the scaling loop. This latency could be produced due to accumulated scalers latencies or high load. This is an internal metric. | diff --git a/content/docs/2.14/operate/prometheus.md b/content/docs/2.14/integrations/prometheus.md similarity index 99% rename from content/docs/2.14/operate/prometheus.md rename to content/docs/2.14/integrations/prometheus.md index 72cca70f8..a5ecc1f53 100644 --- a/content/docs/2.14/operate/prometheus.md +++ b/content/docs/2.14/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 100 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.14/operate/_index.md b/content/docs/2.14/operate/_index.md index e7604a0cf..56bef7222 100644 --- a/content/docs/2.14/operate/_index.md +++ b/content/docs/2.14/operate/_index.md @@ -10,6 +10,4 @@ We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) - Kubernetes Events ([link](./events)) - KEDA Metrics Server ([link](./metrics-server)) -- Integrate with Prometheus ([link](./prometheus)) -- Integrate with OpenTelemetry Collector (Experimental) ([link](./opentelemetry)) - Security ([link](./security)) diff --git a/content/docs/2.14/reference/scaledobject-spec.md b/content/docs/2.14/reference/scaledobject-spec.md index d9b4eb5af..0e7e11023 100644 --- a/content/docs/2.14/reference/scaledobject-spec.md +++ b/content/docs/2.14/reference/scaledobject-spec.md @@ -241,7 +241,7 @@ For examples of this feature see section [Scaling Modifiers](../concepts/scaling Trigger fields: - **type**: The type of trigger to use. (Mandatory) - **metadata**: The configuration parameters that the trigger requires. (Mandatory) -- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default, the name is generated from the trigger type. (Optional) +- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../integrations/prometheus.md). By default, the name is generated from the trigger type. (Optional) - **useCachedMetrics**: Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics"](../concepts/scaling-deployments.md#caching-metrics). (Values: `false`, `true`, Default: `false`, Optional) - **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment. - More details can be found [here](../concepts/authentication). (Optional) diff --git a/content/docs/2.15/integrations/_index.md b/content/docs/2.15/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.15/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.14/operate/istio-integration.md b/content/docs/2.15/integrations/istio-integration.md similarity index 98% rename from content/docs/2.14/operate/istio-integration.md rename to content/docs/2.15/integrations/istio-integration.md index 78427324c..413cf3ae0 100644 --- a/content/docs/2.14/operate/istio-integration.md +++ b/content/docs/2.15/integrations/istio-integration.md @@ -1,7 +1,8 @@ +++ title = "KEDA Integration with Istio" description = "Guidance for running KEDA along with Istio in your cluster" -weight = 100 +availability = "v2.14+" +project = "Istio" +++ ## Overview @@ -60,4 +61,4 @@ Existing troubleshooting guide for KEDA with Istio. ### Conclusion By applying these annotations, you can ensure that KEDA integrates seamlessly with Istio while adhering to security requirements. This configuration allows KEDA to maintain internal mTLS communication and interact properly with other mesh services. -If you encounter any issues or have further questions, please refer to the KEDA and Istio documentation or reach out to the community for support. \ No newline at end of file +If you encounter any issues or have further questions, please refer to the KEDA and Istio documentation or reach out to the community for support. diff --git a/content/docs/2.14/operate/opentelemetry.md b/content/docs/2.15/integrations/opentelemetry.md similarity index 98% rename from content/docs/2.14/operate/opentelemetry.md rename to content/docs/2.15/integrations/opentelemetry.md index f1c5459da..1db48fb1e 100644 --- a/content/docs/2.14/operate/opentelemetry.md +++ b/content/docs/2.15/integrations/opentelemetry.md @@ -1,7 +1,8 @@ +++ title= "Integrate with OpenTelemetry Collector (Experimental)" description= "Detail of integrating OpenTelemetry Collector in KEDA" -weight = 100 +availability = "v2.12+" +project = "OpenTelemetry" +++ ## Push Metrics to OpenTelemetry Collector (Experimental) @@ -54,4 +55,4 @@ The following metrics are exposed as well, but are deprecated and will be remove | `keda.scaler.metrics.latency` | The latency of retrieving current metric from each scaler. | | `keda.resource.totals` | Total number of KEDA custom resources per namespace for each custom resource type (CRD). | | `keda.trigger.totals` | Total number of triggers per trigger type. | -| `keda.internal.scale.loop.latency` | Total deviation (in milliseconds) between the expected execution time and the actual execution time for the scaling loop. This latency could be produced due to accumulated scalers latencies or high load. This is an internal metric. | \ No newline at end of file +| `keda.internal.scale.loop.latency` | Total deviation (in milliseconds) between the expected execution time and the actual execution time for the scaling loop. This latency could be produced due to accumulated scalers latencies or high load. This is an internal metric. | diff --git a/content/docs/2.15/operate/prometheus.md b/content/docs/2.15/integrations/prometheus.md similarity index 99% rename from content/docs/2.15/operate/prometheus.md rename to content/docs/2.15/integrations/prometheus.md index b6dac773a..87b8117b1 100644 --- a/content/docs/2.15/operate/prometheus.md +++ b/content/docs/2.15/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 100 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.15/operate/_index.md b/content/docs/2.15/operate/_index.md index dac7c02f2..6b076c503 100644 --- a/content/docs/2.15/operate/_index.md +++ b/content/docs/2.15/operate/_index.md @@ -10,6 +10,4 @@ We provide guidance and requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) - Kubernetes Events ([link](../reference/events)) - KEDA Metrics Server ([link](./metrics-server)) -- Integrate with Prometheus ([link](./prometheus)) -- Integrate with OpenTelemetry Collector (Experimental) ([link](./opentelemetry)) - Security ([link](./security)) diff --git a/content/docs/2.15/reference/scaledobject-spec.md b/content/docs/2.15/reference/scaledobject-spec.md index 0fb899dfc..124d02062 100644 --- a/content/docs/2.15/reference/scaledobject-spec.md +++ b/content/docs/2.15/reference/scaledobject-spec.md @@ -242,7 +242,7 @@ For examples of this feature see section [Scaling Modifiers](../concepts/scaling Trigger fields: - **type**: The type of trigger to use. (Mandatory) - **metadata**: The configuration parameters that the trigger requires. (Mandatory) -- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default, the name is generated from the trigger type. (Optional) +- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../integrations/prometheus.md). By default, the name is generated from the trigger type. (Optional) - **useCachedMetrics**: Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics"](../concepts/scaling-deployments.md#caching-metrics). (Values: `false`, `true`, Default: `false`, Optional) - **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment. - More details can be found [here](../concepts/authentication). (Optional) diff --git a/content/docs/2.16/integrations/_index.md b/content/docs/2.16/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.16/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.16/operate/istio-integration.md b/content/docs/2.16/integrations/istio-integration.md similarity index 98% rename from content/docs/2.16/operate/istio-integration.md rename to content/docs/2.16/integrations/istio-integration.md index 78427324c..413cf3ae0 100644 --- a/content/docs/2.16/operate/istio-integration.md +++ b/content/docs/2.16/integrations/istio-integration.md @@ -1,7 +1,8 @@ +++ title = "KEDA Integration with Istio" description = "Guidance for running KEDA along with Istio in your cluster" -weight = 100 +availability = "v2.14+" +project = "Istio" +++ ## Overview @@ -60,4 +61,4 @@ Existing troubleshooting guide for KEDA with Istio. ### Conclusion By applying these annotations, you can ensure that KEDA integrates seamlessly with Istio while adhering to security requirements. This configuration allows KEDA to maintain internal mTLS communication and interact properly with other mesh services. -If you encounter any issues or have further questions, please refer to the KEDA and Istio documentation or reach out to the community for support. \ No newline at end of file +If you encounter any issues or have further questions, please refer to the KEDA and Istio documentation or reach out to the community for support. diff --git a/content/docs/2.15/operate/opentelemetry.md b/content/docs/2.16/integrations/opentelemetry.md similarity index 98% rename from content/docs/2.15/operate/opentelemetry.md rename to content/docs/2.16/integrations/opentelemetry.md index f1c5459da..1db48fb1e 100644 --- a/content/docs/2.15/operate/opentelemetry.md +++ b/content/docs/2.16/integrations/opentelemetry.md @@ -1,7 +1,8 @@ +++ title= "Integrate with OpenTelemetry Collector (Experimental)" description= "Detail of integrating OpenTelemetry Collector in KEDA" -weight = 100 +availability = "v2.12+" +project = "OpenTelemetry" +++ ## Push Metrics to OpenTelemetry Collector (Experimental) @@ -54,4 +55,4 @@ The following metrics are exposed as well, but are deprecated and will be remove | `keda.scaler.metrics.latency` | The latency of retrieving current metric from each scaler. | | `keda.resource.totals` | Total number of KEDA custom resources per namespace for each custom resource type (CRD). | | `keda.trigger.totals` | Total number of triggers per trigger type. | -| `keda.internal.scale.loop.latency` | Total deviation (in milliseconds) between the expected execution time and the actual execution time for the scaling loop. This latency could be produced due to accumulated scalers latencies or high load. This is an internal metric. | \ No newline at end of file +| `keda.internal.scale.loop.latency` | Total deviation (in milliseconds) between the expected execution time and the actual execution time for the scaling loop. This latency could be produced due to accumulated scalers latencies or high load. This is an internal metric. | diff --git a/content/docs/2.16/operate/prometheus.md b/content/docs/2.16/integrations/prometheus.md similarity index 99% rename from content/docs/2.16/operate/prometheus.md rename to content/docs/2.16/integrations/prometheus.md index b6dac773a..87b8117b1 100644 --- a/content/docs/2.16/operate/prometheus.md +++ b/content/docs/2.16/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 100 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.16/operate/_index.md b/content/docs/2.16/operate/_index.md index dac7c02f2..6b076c503 100644 --- a/content/docs/2.16/operate/_index.md +++ b/content/docs/2.16/operate/_index.md @@ -10,6 +10,4 @@ We provide guidance and requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) - Kubernetes Events ([link](../reference/events)) - KEDA Metrics Server ([link](./metrics-server)) -- Integrate with Prometheus ([link](./prometheus)) -- Integrate with OpenTelemetry Collector (Experimental) ([link](./opentelemetry)) - Security ([link](./security)) diff --git a/content/docs/2.16/reference/scaledobject-spec.md b/content/docs/2.16/reference/scaledobject-spec.md index 0fb899dfc..124d02062 100644 --- a/content/docs/2.16/reference/scaledobject-spec.md +++ b/content/docs/2.16/reference/scaledobject-spec.md @@ -242,7 +242,7 @@ For examples of this feature see section [Scaling Modifiers](../concepts/scaling Trigger fields: - **type**: The type of trigger to use. (Mandatory) - **metadata**: The configuration parameters that the trigger requires. (Mandatory) -- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default, the name is generated from the trigger type. (Optional) +- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../integrations/prometheus.md). By default, the name is generated from the trigger type. (Optional) - **useCachedMetrics**: Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics"](../concepts/scaling-deployments.md#caching-metrics). (Values: `false`, `true`, Default: `false`, Optional) - **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment. - More details can be found [here](../concepts/authentication). (Optional) diff --git a/content/docs/2.2/integrations/_index.md b/content/docs/2.2/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.2/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.2/operate/prometheus.md b/content/docs/2.2/integrations/prometheus.md similarity index 95% rename from content/docs/2.2/operate/prometheus.md rename to content/docs/2.2/integrations/prometheus.md index 951576c8f..c41e003ab 100644 --- a/content/docs/2.2/operate/prometheus.md +++ b/content/docs/2.2/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.2/operate/_index.md b/content/docs/2.2/operate/_index.md index eb7e53f36..283dc0c71 100644 --- a/content/docs/2.2/operate/_index.md +++ b/content/docs/2.2/operate/_index.md @@ -7,5 +7,4 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) - Kubernetes Events ([link](./events)) diff --git a/content/docs/2.3/integrations/_index.md b/content/docs/2.3/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.3/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.3/operate/prometheus.md b/content/docs/2.3/integrations/prometheus.md similarity index 95% rename from content/docs/2.3/operate/prometheus.md rename to content/docs/2.3/integrations/prometheus.md index 951576c8f..c41e003ab 100644 --- a/content/docs/2.3/operate/prometheus.md +++ b/content/docs/2.3/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.3/operate/_index.md b/content/docs/2.3/operate/_index.md index eb7e53f36..283dc0c71 100644 --- a/content/docs/2.3/operate/_index.md +++ b/content/docs/2.3/operate/_index.md @@ -7,5 +7,4 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) - Kubernetes Events ([link](./events)) diff --git a/content/docs/2.4/integrations/_index.md b/content/docs/2.4/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.4/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.4/integrations/prometheus.md b/content/docs/2.4/integrations/prometheus.md new file mode 100644 index 000000000..c41e003ab --- /dev/null +++ b/content/docs/2.4/integrations/prometheus.md @@ -0,0 +1,17 @@ ++++ +title = "Integrate with Prometheus" +description = "Overview of all Prometheus metrics that KEDA provides" +availability = "v2.0+" +project = "Prometheus" ++++ + +## Prometheus Exporter Metrics + +The KEDA Metrics Adapter exposes Prometheus metrics which can be scraped on port `9022` (this can be changed by setting the `metrics-port` argument for the Metrics Adapter) at `/metrics`. The metrics collected in the Metrics Adapter are only active when the HPA is active (> 0 replicas). + +The following metrics are being gathered: + +- `keda_metrics_adapter_scaler_errors_total` - The total number of errors encountered for all scalers. +- `keda_metrics_adapter_scaled_object_error_totals`- The number of errors that have occurred for each scaled object. +- `keda_metrics_adapter_scaler_errors` - The number of errors that have occurred for each scaler. +- `keda_metrics_adapter_scaler_metrics_value`- The current value for each scaler's metric that would be used by the HPA in computing the target average. diff --git a/content/docs/2.4/operate/_index.md b/content/docs/2.4/operate/_index.md index 631386165..3c06f7590 100644 --- a/content/docs/2.4/operate/_index.md +++ b/content/docs/2.4/operate/_index.md @@ -7,6 +7,5 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) - Kubernetes Events ([link](./events)) -- KEDA Metrics Server ([link](./metrics-server)) \ No newline at end of file +- KEDA Metrics Server ([link](./metrics-server)) diff --git a/content/docs/2.5/integrations/_index.md b/content/docs/2.5/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.5/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.5/operate/prometheus.md b/content/docs/2.5/integrations/prometheus.md similarity index 96% rename from content/docs/2.5/operate/prometheus.md rename to content/docs/2.5/integrations/prometheus.md index f179b2eac..f74b9d3a4 100644 --- a/content/docs/2.5/operate/prometheus.md +++ b/content/docs/2.5/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.5/operate/_index.md b/content/docs/2.5/operate/_index.md index 631386165..3c06f7590 100644 --- a/content/docs/2.5/operate/_index.md +++ b/content/docs/2.5/operate/_index.md @@ -7,6 +7,5 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) - Kubernetes Events ([link](./events)) -- KEDA Metrics Server ([link](./metrics-server)) \ No newline at end of file +- KEDA Metrics Server ([link](./metrics-server)) diff --git a/content/docs/2.6/integrations/_index.md b/content/docs/2.6/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.6/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.6/operate/prometheus.md b/content/docs/2.6/integrations/prometheus.md similarity index 96% rename from content/docs/2.6/operate/prometheus.md rename to content/docs/2.6/integrations/prometheus.md index f179b2eac..f74b9d3a4 100644 --- a/content/docs/2.6/operate/prometheus.md +++ b/content/docs/2.6/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.6/operate/_index.md b/content/docs/2.6/operate/_index.md index 631386165..3c06f7590 100644 --- a/content/docs/2.6/operate/_index.md +++ b/content/docs/2.6/operate/_index.md @@ -7,6 +7,5 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) - Kubernetes Events ([link](./events)) -- KEDA Metrics Server ([link](./metrics-server)) \ No newline at end of file +- KEDA Metrics Server ([link](./metrics-server)) diff --git a/content/docs/2.7/integrations/_index.md b/content/docs/2.7/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.7/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.7/operate/prometheus.md b/content/docs/2.7/integrations/prometheus.md similarity index 96% rename from content/docs/2.7/operate/prometheus.md rename to content/docs/2.7/integrations/prometheus.md index f179b2eac..f74b9d3a4 100644 --- a/content/docs/2.7/operate/prometheus.md +++ b/content/docs/2.7/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.7/operate/_index.md b/content/docs/2.7/operate/_index.md index 631386165..3c06f7590 100644 --- a/content/docs/2.7/operate/_index.md +++ b/content/docs/2.7/operate/_index.md @@ -7,6 +7,5 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) - Kubernetes Events ([link](./events)) -- KEDA Metrics Server ([link](./metrics-server)) \ No newline at end of file +- KEDA Metrics Server ([link](./metrics-server)) diff --git a/content/docs/2.8/integrations/_index.md b/content/docs/2.8/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.8/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.8/operate/prometheus.md b/content/docs/2.8/integrations/prometheus.md similarity index 96% rename from content/docs/2.8/operate/prometheus.md rename to content/docs/2.8/integrations/prometheus.md index 3f89bac62..f7e2b49b7 100644 --- a/content/docs/2.8/operate/prometheus.md +++ b/content/docs/2.8/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.8/operate/_index.md b/content/docs/2.8/operate/_index.md index 631386165..3c06f7590 100644 --- a/content/docs/2.8/operate/_index.md +++ b/content/docs/2.8/operate/_index.md @@ -7,6 +7,5 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) - Kubernetes Events ([link](./events)) -- KEDA Metrics Server ([link](./metrics-server)) \ No newline at end of file +- KEDA Metrics Server ([link](./metrics-server)) diff --git a/content/docs/2.9/concepts/scaling-deployments.md b/content/docs/2.9/concepts/scaling-deployments.md index 63f52181e..c1ffdfcef 100644 --- a/content/docs/2.9/concepts/scaling-deployments.md +++ b/content/docs/2.9/concepts/scaling-deployments.md @@ -214,7 +214,7 @@ Starting from Kubernetes v1.18 the autoscaling API allows scaling behavior to be Trigger fields: - **type**: The type of trigger to use. (Mandatory) - **metadata**: The configuration parameters that the trigger requires. (Mandatory) -- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default the name is generated from the trigger type. (Optional) +- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../integrations/prometheus.md). By default the name is generated from the trigger type. (Optional) - **useCachedMetrics**: ([Experimental feature](https://github.com/kedacore/governance/blob/main/DEPRECATIONS.md#experimental-features)) Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics (Experimental)"](#caching-metrics-experimental). (Values: `false`, `true`, Default: `false`, Optional) - **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment. - More details can be found [here](./authentication). (Optional) diff --git a/content/docs/2.9/integrations/_index.md b/content/docs/2.9/integrations/_index.md new file mode 100644 index 000000000..745b6065b --- /dev/null +++ b/content/docs/2.9/integrations/_index.md @@ -0,0 +1,8 @@ ++++ +title = "Integrations" +weight = 6 ++++ + +An overview of tools/products integrating with KEDA: + +{{< integrations >}} diff --git a/content/docs/2.9/operate/prometheus.md b/content/docs/2.9/integrations/prometheus.md similarity index 98% rename from content/docs/2.9/operate/prometheus.md rename to content/docs/2.9/integrations/prometheus.md index 07b9eca06..922a05a23 100644 --- a/content/docs/2.9/operate/prometheus.md +++ b/content/docs/2.9/integrations/prometheus.md @@ -1,7 +1,8 @@ +++ title = "Integrate with Prometheus" description = "Overview of all Prometheus metrics that KEDA provides" -weight = 200 +availability = "v2.0+" +project = "Prometheus" +++ ## Prometheus Exporter Metrics diff --git a/content/docs/2.9/operate/_index.md b/content/docs/2.9/operate/_index.md index 631386165..3c06f7590 100644 --- a/content/docs/2.9/operate/_index.md +++ b/content/docs/2.9/operate/_index.md @@ -7,6 +7,5 @@ weight = 1 We provide guidance & requirements around various areas to operate KEDA: - Cluster ([link](./cluster)) -- Integrate with Prometheus ([link](./prometheus)) - Kubernetes Events ([link](./events)) -- KEDA Metrics Server ([link](./metrics-server)) \ No newline at end of file +- KEDA Metrics Server ([link](./metrics-server)) diff --git a/layouts/_default/scaler-info.html b/layouts/_default/card-info.html similarity index 82% rename from layouts/_default/scaler-info.html rename to layouts/_default/card-info.html index 3b26e424b..d9cf32257 100644 --- a/layouts/_default/scaler-info.html +++ b/layouts/_default/card-info.html @@ -1,6 +1,7 @@ {{ $desc := .Description | markdownify }} {{ $availability := .Params.availability }} {{ $maintainer := .Params.maintainer }} +{{ $project := .Params.project }}
@@ -30,6 +31,12 @@ Maintainer: {{ . }}
{{ end }} + + {{ with $project }} +
+ Project: {{ . }} +
+ {{ end }} {{ end }}
diff --git a/layouts/partials/home/scalers.html b/layouts/partials/home/scalers.html index 270c5a943..ecb8b415f 100644 --- a/layouts/partials/home/scalers.html +++ b/layouts/partials/home/scalers.html @@ -19,7 +19,7 @@ {{ range $scalers }} {{ $version := index (split .File.Path "/") 1 }} {{ if eq $version $latest }} - {{ .Render "scaler-info" }} + {{ .Render "card-info" }} {{ end }} {{ end }}
diff --git a/layouts/shortcodes/integrations.html b/layouts/shortcodes/integrations.html new file mode 100644 index 000000000..6c5514989 --- /dev/null +++ b/layouts/shortcodes/integrations.html @@ -0,0 +1,14 @@ +{{ $latest := index site.Params.versions.docs 0 }} +{{ $integrations := where site.RegularPages ".CurrentSection.Title" "Integrations" }} + +
+
+ {{ range $integrations }} + {{ $version := index (split .File.Path "/") 1 }} + {{ if eq $version $latest }} + {{ .Render "card-info" }} + {{ end }} + {{ end }} +
+
+