Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose recipes in ECK product documentation #5763

Merged
merged 1 commit into from
Jun 14, 2022
Merged

Expose recipes in ECK product documentation #5763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...ng-elastic-stack-applications/orchestrating-elastic-stack-applications.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ endif::[]
- <<{p}-maps>>
- <<{p}-enterprise-search>>
- <<{p}-beat>>
- <<{p}-recipes>>
- <<{p}-securing-stack>>
- <<{p}-accessing-elastic-services>>
- <<{p}-customize-pods>>
Expand All @@ -34,6 +35,7 @@ include::agent-fleet.asciidoc[leveloffset=+1]
include::maps.asciidoc[leveloffset=+1]
include::enterprise-search.asciidoc[leveloffset=+1]
include::beat.asciidoc[leveloffset=+1]
include::recipes.asciidoc[leveloffset=+1]
include::securing-stack.asciidoc[leveloffset=+1]
include::accessing-elastic-services.asciidoc[leveloffset=+1]
include::customize-pods.asciidoc[leveloffset=+1]
Expand Down
19 changes: 19 additions & 0 deletions docs/orchestrating-elastic-stack-applications/recipes.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:page_id: recipes
ifdef::env-github[]
****
link:https://www.elastic.co/guide/en/cloud-on-k8s/master/k8s-{page_id}.html[View this document on the Elastic website]
****
endif::[]
[id="{p}-{page_id}"]
= Recipes

This section includes recipes that provide configuration examples for some common use cases.

* link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/gclb[Expose Elasticsearch and Kibana using a Google Cloud Load Balancer (GCLB)]
* link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/istio-gateway[Expose Elasticsearch and Kibana using Istio ingress gateway]
* link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/logstash[Using Logstash with ECK]
* link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/maps[Expose Elastic Maps Server and Kibana using a Kubernetes Ingress]
* link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/psp[Secure your cluster with Pod Security Policies]
* link:https://github.com/elastic/cloud-on-k8s/tree/main/config/recipes/traefik[Use Traefik to expose Elastic Stack applications]
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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry but I only now got around to take a look at this. I think the wording around production readiness is misleading. The Agent and Beats recipes are also not production ready as they take certain liberties to illustrate typical configurations (e.g. no volume configuration, no memory mapped files in Elasticsearch to name just two). The main difference is that those Beats and Agent recipes are guaranteed to work when applied to a Kubernetes cluster while the ones listed here only worked when we created them but we do not continuously test them to ensure that they still work on for example newer versions of Kubernetes.