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.

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

Conversation

alaudazzi
Copy link
Contributor

This PR makes some config/recipes more discoverable from the ECK product documentation.

Fixes #5012

@alaudazzi alaudazzi added the >docs Documentation label Jun 13, 2022
@alaudazzi alaudazzi requested review from pebrc, naemono and david-kow June 13, 2022 06:07
Copy link
Contributor

@naemono naemono left a comment

Choose a reason for hiding this comment

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

Looked through the generated documentation, and everything looks good.

@alaudazzi alaudazzi merged commit 2a594ba into elastic:main Jun 14, 2022
* 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.

@thbkrkr thbkrkr added the v2.4.0 label Jun 14, 2022
fantapsody pushed a commit to fantapsody/cloud-on-k8s that referenced this pull request Feb 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs Documentation v2.4.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expose recipes in ECK documentation
4 participants