Documentation for running ECK, Elasticsearch, and Kibana on GKE Autopilot #6760
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Michael Montgomery <mmontg1@gmail.com> Also update virtual memory documentation. Signed-off-by: Michael Montgomery <mmontg1@gmail.com> Add docs to create ns. Add missing EOF Signed-off-by: Michael Montgomery <mmontg1@gmail.com> Add Kibana docs for autopilot. Reference autopilot doc in index. Signed-off-by: Michael Montgomery <mmontg1@gmail.com>
barkbay
reviewed
May 5, 2023
docs/orchestrating-elastic-stack-applications/elasticsearch/virtual-memory.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Michael Morello <michael.morello@gmail.com>
Signed-off-by: Michael Montgomery <mmontg1@gmail.com>
|
@barkbay I believe I've addressed your concerns in your previous review. I also added a section detailing the installation of Elastic Agent, but not the other stack components. Let me know if we should document all of them here. |
barkbay
reviewed
May 11, 2023
docs/orchestrating-elastic-stack-applications/elasticsearch/virtual-memory.asciidoc
Outdated
Show resolved
Hide resolved
docs/orchestrating-elastic-stack-applications/elasticsearch/virtual-memory.asciidoc
Outdated
Show resolved
Hide resolved
docs/orchestrating-elastic-stack-applications/elasticsearch/virtual-memory.asciidoc
Show resolved
Hide resolved
Signed-off-by: Michael Montgomery <mmontg1@gmail.com>
barkbay
reviewed
May 15, 2023
docs/orchestrating-elastic-stack-applications/elasticsearch/virtual-memory.asciidoc
Outdated
Show resolved
Hide resolved
docs/orchestrating-elastic-stack-applications/elasticsearch/virtual-memory.asciidoc
Outdated
Show resolved
Hide resolved
pebrc
reviewed
May 15, 2023
There was a problem hiding this comment.
I would focus on the essentials here. Also if I look at this documentation in its rendered form then most important part (the virtual memory bit) can be easily overlooked as it does not get its own sub-chapter
If I understand correctly what is necessary to run Elasticsearch on autopilot then it's:
- set virtual memory with the white-listed DaemonSet
- you are done (but you could set this init container to improve the ES startup experience)
The extra init container to wait for it to be set is a nice to have and can be mentioned but should be qualified as such.
- Agent (but also Beats?)
Here I would describe the necessary changes (no hostpath volumes, but one can use ephemeral volumes or ephemeral storage requests instead, and you mentioned something about CPU limits) and link to an example recipe in the recipe folder
Let me know if I got something wrong.
Removing the test/e2e/run.sh modification, as it wasn't relevant to this PR. Signed-off-by: Michael Montgomery <mmontg1@gmail.com>
I'm working through adding these additional bits to I'll also work through testing some of the beats examples and getting recipes for them... |
Signed-off-by: Michael Montgomery <mmontg1@gmail.com>
Update gke autpilot docs Signed-off-by: Michael Montgomery <mmontg1@gmail.com>
barkbay
reviewed
May 22, 2023
docs/orchestrating-elastic-stack-applications/elasticsearch/virtual-memory.asciidoc
Outdated
Show resolved
Hide resolved
docs/orchestrating-elastic-stack-applications/elasticsearch/virtual-memory.asciidoc
Show resolved
Hide resolved
|
|
||
| [source,yaml,subs="attributes,+macros"] | ||
| ---- | ||
| cat $$<<$$EOF | kubectl apply -n elastic -f - |
There was a problem hiding this comment.
Suggested change
| cat $$<<$$EOF | kubectl apply -n elastic -f - | |
| cat $$<<$$EOF | kubectl apply -n elastic-system -f - |
Added PolicyIDs to the fleet example for autopilot. Removed the example for deploying Kibana. Install daemonset to elastic-system namespace. Move the note abut file system implementations to the top of the virt mem docs. Signed-off-by: Michael Montgomery <mmontg1@gmail.com>
Thanks for noting this. I had missed this change. |
|
@barkbay I believe I've updated all you had noted. Let me know if I missed anything. |
Co-authored-by: Michael Morello <michael.morello@gmail.com>
Signed-off-by: Michael Montgomery <mmontg1@gmail.com>
Co-authored-by: Michael Morello <michael.morello@gmail.com>
Co-authored-by: Michael Morello <michael.morello@gmail.com>
barkbay
pushed a commit
to barkbay/cloud-on-k8s
that referenced
this pull request
May 23, 2023
* Initial version of autopilot documentation. Signed-off-by: Michael Montgomery <mmontg1@gmail.com> Co-authored-by: Michael Morello <michael.morello@gmail.com>
barkbay
added a commit
that referenced
this pull request
May 23, 2023
barkbay
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
related #6713
This change adds a page to our documentation that discusses running ECK, Elasticsearch and Kibana on GKE Autopilot clusters. Any of the other supported stack (Beat/Agent/etc) aren't discussed at this time as we have not verified their functionality as of yet.
This also adjusts the virtual memory documentation to note that there is an additional option for setting
max_map_count.