Skip to content

Commit 1cd30d2

Browse files
committed
update 2.x docs about support policy for ingress
Pairing PR of elastic/docs-content#908
1 parent 2285c2e commit 1cd30d2

File tree

4 files changed

+45
-0
lines changed

4 files changed

+45
-0
lines changed

docs/advanced-topics/traffic-splitting.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ The default Kubernetes service created by ECK, named `<cluster_name>-es-http`, i
1212

1313
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.
1414

15+
[NOTE]
16+
================================
17+
**Support Scope for Ingress Controllers**
18+
19+
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.
20+
21+
If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative.
22+
================================
23+
1524
The service configurations shown in these sections are based on the following Elasticsearch cluster definition:
1625

1726
[source,yaml,subs="attributes"]

docs/orchestrating-elastic-stack-applications/maps.asciidoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ The following sections describe how to customize an {ems} deployment to suit you
2727
** <<{p}-maps-http-disable-tls,Disable TLS>>
2828
** <<{p}-maps-ingress>>
2929
30+
[NOTE]
31+
================================
32+
**Support Scope for Ingress Controllers**
33+
34+
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.
35+
36+
If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative.
37+
================================
38+
3039
[id="{p}-maps-es"]
3140
== Deploy Elastic Maps Server
3241

@@ -262,3 +271,12 @@ You can disable the generation of the self-signed certificate and hence disable
262271
[id="{p}-maps-ingress"]
263272
==== Ingress and Kibana configuration
264273
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.
274+
275+
[NOTE]
276+
================================
277+
**Support Scope for Ingress Controllers**
278+
279+
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.
280+
281+
If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative.
282+
================================

docs/orchestrating-elastic-stack-applications/recipes.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,12 @@ This section includes recipes that provide configuration examples for some commo
1818
* 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]
1919
2020
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.
21+
22+
[NOTE]
23+
================================
24+
**Support Scope for Ingress Controllers**
25+
26+
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.
27+
28+
If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative.
29+
================================

docs/orchestrating-elastic-stack-applications/stack-helm-chart.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,15 @@ helm install es-quickstart elastic/eck-elasticsearch -n elastic-stack --create-n
124124
[id="{p}-eck-stack-ingress"]
125125
=== Adding Ingress to the Elastic stack using the Helm Charts
126126

127+
[NOTE]
128+
================================
129+
**Support Scope for Ingress Controllers**
130+
131+
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.
132+
133+
If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative.
134+
================================
135+
127136
Both Elasticsearch and Kibana support Ingress, which can be enabled using the following options:
128137

129138
[source,sh]

0 commit comments

Comments
 (0)