Currently, the official Spring Boot documentation does not provide a clear section on how to configure Elasticsearch properties in application.yml or application.properties.
While various snippets exist across blogs and Q&A sites, they often differ and may confuse first-time users. It would be helpful if the reference documentation included a dedicated section describing the available configuration properties, their meaning, and default values.
For example:
Property Description Default spring.data.elasticsearch.cluster-name The name of the Elasticsearch cluster - spring.data.elasticsearch.cluster-nodes Comma-separated list of cluster nodes localhost:9200 spring.data.elasticsearch.connection-timeout Timeout for establishing a connection 10s … … …
Adding such a section would improve the onboarding experience for developers who want to configure Elasticsearch through Spring Boot’s configuration files.
If the team agrees that this documentation addition would be useful, I’d be happy to work on a PR to update the reference docs accordingly. Please let me know if that would be acceptable.
Comment From: wilkinsona
I believe we already have such documentation:
- https://docs.spring.io/spring-boot/reference/data/nosql.html#data.nosql.elasticsearch
- https://docs.spring.io/spring-boot/appendix/application-properties/index.html#application-properties.data.spring.elasticsearch.connection-timeout
Comment From: mostwantedroy
I mean it would be good to add documentation on https://docs.spring.io/spring-data/elasticsearch/reference/
Comment From: snicoll
I mean it would be good to add documentation on https://docs.spring.io/spring-data/elasticsearch/reference/
On? This is Spring Data Elasticsearch that Spring Boot is consuming. The reference you've linked does not use Spring Boot so you can't document that there. Please review Andy's comment and mine so that we understand what you are requesting.