search

apache / solr-operator

Official Kubernetes operator for Apache Solr
https://solr.apache.org/operator
Apache License 2.0
242 stars 112 forks source link

Improve documentation for additional volumes #675

Open mcarroll1 opened 5 months ago

mcarroll1 commented 5 months ago

Hello,

I found it difficult to specify additional volumes in the podOptions.volumes values, specifically specifying a source for the volume. It appears @janhoy had a similar issue here: https://github.com/apache/solr-operator/issues/484. Reading that issue helped me determine the correct syntax, but it might be helpful to improve the documentation in this regard for posterity. The syntax seems to be specific to the SolrCloud resource, and not generic K8s.

I'm happy to submit documentation updates, but first: where is the best place to add such documentation? It might be too complex for the chart values doc. Perhaps it would be best in these docs? Another place?

Thanks!

HoustonPutman commented 3 months ago

Sorry for the delay @mcarroll1 . Yes, I would say https://apache.github.io/solr-operator/docs/solr-cloud/solr-cloud-crd.html is probably the page you want. When making a PR, make it against the main branch, not the gh-pages branch though.

And documentation help is always appreciated, thanks for helping out!