This is an automated email from the ASF dual-hosted git repository.
houston pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr-operator.git
The following commit(s) were added to refs/heads/main by this push:
new f862c00 Clear up difference between SolrCloud CRD options and Solr
Helm chart options. (#362)
f862c00 is described below
commit f862c000dcdcca6b77f2563d1934394cd9217081
Author: Houston Putman <[email protected]>
AuthorDate: Tue Nov 2 11:08:54 2021 -0400
Clear up difference between SolrCloud CRD options and Solr Helm chart
options. (#362)
---
docs/solr-cloud/solr-cloud-crd.md | 5 +++++
helm/solr/README.md | 8 ++++++++
2 files changed, 13 insertions(+)
diff --git a/docs/solr-cloud/solr-cloud-crd.md
b/docs/solr-cloud/solr-cloud-crd.md
index 67c2ba1..689d7f6 100644
--- a/docs/solr-cloud/solr-cloud-crd.md
+++ b/docs/solr-cloud/solr-cloud-crd.md
@@ -24,6 +24,11 @@ Those configuration options are laid out on this page.
The SolrCloud CRD gives users the ability to customize how Solr is run.
+Please note that the options described below are shown using the base
SolrCloud resource, not the helm chart.
+Most options will have the same name and path, however there are differences
such as `customSolrKubeOptions`.
+If using Helm, refer to the [Helm Chart
documentation](https://artifacthub.io/packages/helm/apache-solr/solr#chart-values)
to see the names for the options you are looking to use.
+This document should still be used to see how the SolrCloud options can be
used.
+
### Solr Modules and Additional Libraries
_Since v0.5.0_
diff --git a/helm/solr/README.md b/helm/solr/README.md
index 75a22b0..2ab26d7 100644
--- a/helm/solr/README.md
+++ b/helm/solr/README.md
@@ -71,6 +71,11 @@ The command removes the SolrCloud resource, and then
Kubernetes will garbage col
## Chart Values
+Please note that there is not a 1-1 mapping from SolrCloud CRD options to Solr
Helm options.
+All options should be supported, but they might be slightly renamed in some
scenarios, such as `customSolrKubeOptions`.
+Please read below to see what the Helm chart values are for the options you
need.
+Descriptions on how to use these options can be found in the [SolrCloud
documentation](https://apache.github.io/solr-operator/docs/solr-cloud/solr-cloud-crd.html).
+
### Running Solr
| Key | Type | Default | Description |
@@ -241,6 +246,9 @@ Configure Solr to use a separate TLS certificate for client
auth.
### Custom Kubernetes Options
+Note: In the `SolrCloud` Spec, all of these options all fall under
`customSolrKubeOptions`.
+When using the helm chart, omit `customSolrKubeOptions.`
+
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| podOptions.annotations | map[string]string | | Custom annotations to add to
the Solr pod |
