From a618868389203e6358feb58df0ac2acc5e30ecdd Mon Sep 17 00:00:00 2001 From: Ivan Tuzhilkin <1it@users.noreply.github.com> Date: Tue, 30 Jul 2024 14:28:34 +0100 Subject: [PATCH] add: Istio operation doc (#1418) Signed-off-by: ivan.tuzhilkin Signed-off-by: shubhusion --- .../docs/2.14/operate/istio-integration.md | 63 +++++++++++++++++++ .../docs/2.15/operate/istio-integration.md | 63 +++++++++++++++++++ 2 files changed, 126 insertions(+) create mode 100644 content/docs/2.14/operate/istio-integration.md create mode 100644 content/docs/2.15/operate/istio-integration.md diff --git a/content/docs/2.14/operate/istio-integration.md b/content/docs/2.14/operate/istio-integration.md new file mode 100644 index 000000000..78427324c --- /dev/null +++ b/content/docs/2.14/operate/istio-integration.md @@ -0,0 +1,63 @@ ++++ +title = "KEDA Integration with Istio" +description = "Guidance for running KEDA along with Istio in your cluster" +weight = 100 ++++ + +## Overview + +Integrating KEDA with Istio can present challenges, particularly in environments with enforced mTLS. This document provides guidance on how to configure KEDA to work within an Istio service mesh without disabling Istio sidecar injection. This solution allows KEDA components to communicate securely and effectively while maintaining compliance with security requirements. + +This can be considered as workaround, however it's perfectly valid from the security standpoint. +Keda is still using own mTLS certificates for secure communication between it's components and at the same time it's able to communicate with Istio Mesh services (like Prometheus) through Istio sidecar proxies. + +## Background + +In some scenarios, users might face issues with KEDA components failing discovery checks when Istio sidecar injection is enabled. The current [troubleshooting guide](../../../troubleshooting/istio-keda-faileddiscoverycheck) suggests disabling Istio sidecar injection in the KEDA namespace. However, if this is not feasible due to security policies, the following workaround can be applied. + + +### Requirements + +- Istio version >= 1.18.* +- Kubernetes cluster with KEDA installed + +### Example configuration + +`values.yaml` fragment for the [helm chart](https://github.com/kedacore/charts/blob/main/keda/values.yaml) +``` +... + +podAnnotations: + # -- Pod annotations for KEDA operator + keda: + traffic.sidecar.istio.io/excludeInboundPorts: "9666" + traffic.sidecar.istio.io/excludeOutboundPorts: "9443,6443" + # -- Pod annotations for KEDA Metrics Adapter + metricsAdapter: + traffic.sidecar.istio.io/excludeInboundPorts: "6443" + traffic.sidecar.istio.io/excludeOutboundPorts: "9666,9443" + # -- Pod annotations for KEDA Admission webhooks + webhooks: + traffic.sidecar.istio.io/excludeInboundPorts: "9443" + traffic.sidecar.istio.io/excludeOutboundPorts: "9666,6443" + +... + +``` + +*Check your respective ports set correctly for each component.* + +### Applying the Annotations +- Annotate the KEDA Components: Update the deployment manifests for the KEDA operator, Metrics Adapter, and Admission Webhooks to include the specified pod annotations. +- Deploy Updated Manifests: Apply the updated manifests to your Kubernetes cluster. +- Verify Communication: Ensure that KEDA components can communicate internally and with external mesh services without failing discovery checks. + + +### References +For more information on the annotations used, refer to the Istio documentation on traffic management. +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 diff --git a/content/docs/2.15/operate/istio-integration.md b/content/docs/2.15/operate/istio-integration.md new file mode 100644 index 000000000..78427324c --- /dev/null +++ b/content/docs/2.15/operate/istio-integration.md @@ -0,0 +1,63 @@ ++++ +title = "KEDA Integration with Istio" +description = "Guidance for running KEDA along with Istio in your cluster" +weight = 100 ++++ + +## Overview + +Integrating KEDA with Istio can present challenges, particularly in environments with enforced mTLS. This document provides guidance on how to configure KEDA to work within an Istio service mesh without disabling Istio sidecar injection. This solution allows KEDA components to communicate securely and effectively while maintaining compliance with security requirements. + +This can be considered as workaround, however it's perfectly valid from the security standpoint. +Keda is still using own mTLS certificates for secure communication between it's components and at the same time it's able to communicate with Istio Mesh services (like Prometheus) through Istio sidecar proxies. + +## Background + +In some scenarios, users might face issues with KEDA components failing discovery checks when Istio sidecar injection is enabled. The current [troubleshooting guide](../../../troubleshooting/istio-keda-faileddiscoverycheck) suggests disabling Istio sidecar injection in the KEDA namespace. However, if this is not feasible due to security policies, the following workaround can be applied. + + +### Requirements + +- Istio version >= 1.18.* +- Kubernetes cluster with KEDA installed + +### Example configuration + +`values.yaml` fragment for the [helm chart](https://github.com/kedacore/charts/blob/main/keda/values.yaml) +``` +... + +podAnnotations: + # -- Pod annotations for KEDA operator + keda: + traffic.sidecar.istio.io/excludeInboundPorts: "9666" + traffic.sidecar.istio.io/excludeOutboundPorts: "9443,6443" + # -- Pod annotations for KEDA Metrics Adapter + metricsAdapter: + traffic.sidecar.istio.io/excludeInboundPorts: "6443" + traffic.sidecar.istio.io/excludeOutboundPorts: "9666,9443" + # -- Pod annotations for KEDA Admission webhooks + webhooks: + traffic.sidecar.istio.io/excludeInboundPorts: "9443" + traffic.sidecar.istio.io/excludeOutboundPorts: "9666,6443" + +... + +``` + +*Check your respective ports set correctly for each component.* + +### Applying the Annotations +- Annotate the KEDA Components: Update the deployment manifests for the KEDA operator, Metrics Adapter, and Admission Webhooks to include the specified pod annotations. +- Deploy Updated Manifests: Apply the updated manifests to your Kubernetes cluster. +- Verify Communication: Ensure that KEDA components can communicate internally and with external mesh services without failing discovery checks. + + +### References +For more information on the annotations used, refer to the Istio documentation on traffic management. +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