From 1cd30d212937ca801040ee882e92aad42d293258 Mon Sep 17 00:00:00 2001 From: Kuni Sen Date: Wed, 26 Mar 2025 09:49:07 +0900 Subject: [PATCH] update 2.x docs about support policy for ingress Pairing PR of https://github.com/elastic/docs-content/pull/908 --- .../advanced-topics/traffic-splitting.asciidoc | 9 +++++++++ .../maps.asciidoc | 18 ++++++++++++++++++ .../recipes.asciidoc | 9 +++++++++ .../stack-helm-chart.asciidoc | 9 +++++++++ 4 files changed, 45 insertions(+) diff --git a/docs/advanced-topics/traffic-splitting.asciidoc b/docs/advanced-topics/traffic-splitting.asciidoc index 669c5a0c25..81391619f3 100644 --- a/docs/advanced-topics/traffic-splitting.asciidoc +++ b/docs/advanced-topics/traffic-splitting.asciidoc @@ -12,6 +12,15 @@ The default Kubernetes service created by ECK, named `-es-http`, i As an alternative, you can use features provided by third-party software such as service meshes and ingress controllers to achieve more advanced traffic management configurations. Check the link:{eck_github}/tree/{eck_release_branch}/config/recipes[recipes directory] in the ECK source repository for a few examples. +[NOTE] +================================ +**Support Scope for Ingress Controllers** + +link:https://kubernetes.io/docs/concepts/services-networking/ingress/[Ingress] is a standard Kubernetes concept. While ECK-managed workloads can be publicly exposed using ingress resources, and we provide link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/[example configurations], setting up an Ingress controller requires in-house Kubernetes expertise. + +If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative. +================================ + The service configurations shown in these sections are based on the following Elasticsearch cluster definition: [source,yaml,subs="attributes"] diff --git a/docs/orchestrating-elastic-stack-applications/maps.asciidoc b/docs/orchestrating-elastic-stack-applications/maps.asciidoc index 2fd467c744..e34f5f8f47 100644 --- a/docs/orchestrating-elastic-stack-applications/maps.asciidoc +++ b/docs/orchestrating-elastic-stack-applications/maps.asciidoc @@ -27,6 +27,15 @@ The following sections describe how to customize an {ems} deployment to suit you ** <<{p}-maps-http-disable-tls,Disable TLS>> ** <<{p}-maps-ingress>> +[NOTE] +================================ +**Support Scope for Ingress Controllers** + +link:https://kubernetes.io/docs/concepts/services-networking/ingress/[Ingress] is a standard Kubernetes concept. While ECK-managed workloads can be publicly exposed using ingress resources, and we provide link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/[example configurations], setting up an Ingress controller requires in-house Kubernetes expertise. + +If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative. +================================ + [id="{p}-maps-es"] == Deploy Elastic Maps Server @@ -262,3 +271,12 @@ You can disable the generation of the self-signed certificate and hence disable [id="{p}-maps-ingress"] ==== Ingress and Kibana configuration To use {ems} from your Kibana instances, you need to configure Kibana to fetch maps from your {ems} instance by using the link:https://www.elastic.co/guide/en/kibana/current/maps-connect-to-ems.html#elastic-maps-server-kibana[`map.emsUrl`] configuration key. The value of this setting needs to be the URL where the {ems} instance is reachable from your browser. The certificates presented by {ems} need to be trusted by the browser, and the URL must have the same origin as the URL where your Kibana is hosted to avoid cross origin resource issues. Check the link:{eck_github}/tree/{eck_release_branch}/config/recipes/[recipe section] for an example on how to set this up using an Ingress resource. + +[NOTE] +================================ +**Support Scope for Ingress Controllers** + +link:https://kubernetes.io/docs/concepts/services-networking/ingress/[Ingress] is a standard Kubernetes concept. While ECK-managed workloads can be publicly exposed using ingress resources, and we provide link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/[example configurations], setting up an Ingress controller requires in-house Kubernetes expertise. + +If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative. +================================ \ No newline at end of file diff --git a/docs/orchestrating-elastic-stack-applications/recipes.asciidoc b/docs/orchestrating-elastic-stack-applications/recipes.asciidoc index c2befe0b2f..1fd585242c 100644 --- a/docs/orchestrating-elastic-stack-applications/recipes.asciidoc +++ b/docs/orchestrating-elastic-stack-applications/recipes.asciidoc @@ -18,3 +18,12 @@ This section includes recipes that provide configuration examples for some commo * link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/autopilot[Deploy Elasticsearch, Kibana, Elastic Fleet Server and Elastic Agent within GKE Autopilot] WARNING: Compared to other configuration examples that are consistently tested, like <<{p}-elastic-agent-fleet-configuration-examples,fleet-managed Elastic Agent on ECK>>, <<{p}-elastic-agent-configuration-examples,standalone Elastic Agent on ECK>>, or <<{p}-beat-configuration-examples,Beats on ECK>>, the recipes in this section are not regularly tested by our automation system, and therefore should not be considered to be production-ready. + +[NOTE] +================================ +**Support Scope for Ingress Controllers** + +link:https://kubernetes.io/docs/concepts/services-networking/ingress/[Ingress] is a standard Kubernetes concept. While ECK-managed workloads can be publicly exposed using ingress resources, and we provide link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/[example configurations], setting up an Ingress controller requires in-house Kubernetes expertise. + +If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative. +================================ diff --git a/docs/orchestrating-elastic-stack-applications/stack-helm-chart.asciidoc b/docs/orchestrating-elastic-stack-applications/stack-helm-chart.asciidoc index 486bb2afbb..4d3746a263 100644 --- a/docs/orchestrating-elastic-stack-applications/stack-helm-chart.asciidoc +++ b/docs/orchestrating-elastic-stack-applications/stack-helm-chart.asciidoc @@ -124,6 +124,15 @@ helm install es-quickstart elastic/eck-elasticsearch -n elastic-stack --create-n [id="{p}-eck-stack-ingress"] === Adding Ingress to the Elastic stack using the Helm Charts +[NOTE] +================================ +**Support Scope for Ingress Controllers** + +link:https://kubernetes.io/docs/concepts/services-networking/ingress/[Ingress] is a standard Kubernetes concept. While ECK-managed workloads can be publicly exposed using ingress resources, and we provide link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/[example configurations], setting up an Ingress controller requires in-house Kubernetes expertise. + +If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative. +================================ + Both Elasticsearch and Kibana support Ingress, which can be enabled using the following options: [source,sh]