Skip to content

Commit

Permalink
feat: create integrations page (#1455)
Browse files Browse the repository at this point in the history
Signed-off-by: thisisobate <obasiuche62@gmail.com>
  • Loading branch information
thisisobate committed Sep 18, 2024
1 parent de0986c commit 2778e9d
Show file tree
Hide file tree
Showing 73 changed files with 254 additions and 88 deletions.
14 changes: 10 additions & 4 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
8 changes: 8 additions & 0 deletions content/docs/2.0/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Integrations"
weight = 6
+++

An overview of tools/products integrating with KEDA:

{{< integrations >}}
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion content/docs/2.0/operate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ weight = 1
We provide guidance & requirements around various areas to operate KEDA:

- Cluster ([link](./cluster))
- Integrate with Prometheus ([link](./prometheus))
16 changes: 0 additions & 16 deletions content/docs/2.0/operate/prometheus.md

This file was deleted.

8 changes: 8 additions & 0 deletions content/docs/2.1/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Integrations"
weight = 6
+++

An overview of tools/products integrating with KEDA:

{{< integrations >}}
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion content/docs/2.1/operate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ weight = 1
We provide guidance & requirements around various areas to operate KEDA:

- Cluster ([link](./cluster))
- Integrate with Prometheus ([link](./prometheus))
2 changes: 1 addition & 1 deletion content/docs/2.10/concepts/scaling-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions content/docs/2.10/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Integrations"
weight = 6
+++

An overview of tools/products integrating with KEDA:

{{< integrations >}}
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion content/docs/2.10/operate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion content/docs/2.11/concepts/scaling-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions content/docs/2.11/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Integrations"
weight = 6
+++

An overview of tools/products integrating with KEDA:

{{< integrations >}}
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion content/docs/2.11/operate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion content/docs/2.12/concepts/scaling-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions content/docs/2.12/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Integrations"
weight = 6
+++

An overview of tools/products integrating with KEDA:

{{< integrations >}}
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions content/docs/2.12/operate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion content/docs/2.13/concepts/scaling-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions content/docs/2.13/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Integrations"
weight = 6
+++

An overview of tools/products integrating with KEDA:

{{< integrations >}}
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions content/docs/2.13/operate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion content/docs/2.14/concepts/scaling-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions content/docs/2.14/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Integrations"
weight = 6
+++

An overview of tools/products integrating with KEDA:

{{< integrations >}}
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
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.
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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. |
| `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. |
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions content/docs/2.14/operate/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion content/docs/2.14/reference/scaledobject-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions content/docs/2.15/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Integrations"
weight = 6
+++

An overview of tools/products integrating with KEDA:

{{< integrations >}}
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
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.
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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. |
| `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. |
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading

0 comments on commit 2778e9d

Please sign in to comment.