Cloud-on-k8s: Improve Elasticsearch memory requirements documentation

Created on 13 Feb 2020  路  8Comments  路  Source: elastic/cloud-on-k8s

I think the current doc could be improved. JVM heap size and memory requirements documentation is spread over 3 different pages:

  • the [podTemplate page] demonstrates how the JVM heap size can be overridden, but does not mention resource reqs
  • the managing compute resources page descibes resource requests and limits but not JVM heap size. The example does override the JVM heap size though.
  • the JVM heap size page mentions the JAVA_OPTS environment variable and resource reqs but does not provide any example.

I think we also want to make it clear that we recommend setting memory requests and limits to twice the JVM heap size.

>docs

Most helpful comment

This issue might be closed in favour of #2673, where the section https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-jvm-heap-size.html will be part of a general reorganisation of the topics currently under Run Elastic on ECK.
@sebgl and @charith-elastic what do you think?

All 8 comments

After discussion with @sebgl:

@sebgl can you please provide an appropriate example for https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-pod-template.html?

@sebgl can you please provide an appropriate example for https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-pod-template.html?

Looking at it I think it is fine to just remove this example. The other example and the links to the Kubernetes documentation seem enough to me.

I was thinking of suggesting that we move the pod template document out of the Elasticsearch section because pod templates are applicable to Kibana and APM Server as well. We should probably provide an example each because the location of podTemplate in the manifest is different. I have a draft document ready and will create a PR shortly.

Further discussing with @charith-elastic:
Let's reconsider the https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-jvm-heap-size.html removal when we get to a more global reorg of the Run Elasticsearch on ECK section.

Also, IMO, setting the heap size is a common thing that most users want to do (and probably search for in a search engine) so having a section titled "JVM heap size" might be better for ease of discovery. It simply points users to the "Managing compute resources" section so there's no danger of content duplication either.

This issue might be closed in favour of #2673, where the section https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-jvm-heap-size.html will be part of a general reorganisation of the topics currently under Run Elastic on ECK.
@sebgl and @charith-elastic what do you think?

Close in favour of #2673.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

pebrc picture pebrc  路  5Comments

djschny picture djschny  路  4Comments

spencergilbert picture spencergilbert  路  3Comments

nkvoll picture nkvoll  路  4Comments

sebgl picture sebgl  路  5Comments