Skip to content

Commit a01bf95

Browse files
authored
Add chart README caveat for 'addtionalLibs' (#785)
1 parent e29ac90 commit a01bf95

4 files changed

Lines changed: 7 additions & 4 deletions

File tree

api/v1beta1/solrcloud_types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,8 @@ type SolrCloudSpec struct {
149149
SolrModules []string `json:"solrModules,omitempty"`
150150

151151
// List of paths in the Solr Docker image to load in the classpath.
152-
// Note: Solr Modules will be auto-loaded if specified in the "solrModules" property. There is no need to specify them here as well.
152+
// There is no need to include paths for Solr Modules already specified in the "solrModules" property, those paths will be added automatically.
153+
// Note that this setting has no effect on solrcloud clusters that rely on a user-provided solr.xml file.
153154
//
154155
//+optional
155156
AdditionalLibs []string `json:"additionalLibs,omitempty"`

config/crd/bases/solr.apache.org_solrclouds.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ spec:
8888
additionalLibs:
8989
description: |-
9090
List of paths in the Solr Docker image to load in the classpath.
91-
Note: Solr Modules will be auto-loaded if specified in the "solrModules" property. There is no need to specify them here as well.
91+
There is no need to include paths for Solr Modules already specified in the "solrModules" property, those paths will be added automatically.
92+
Note that this setting has no effect on solrcloud clusters that rely on a user-provided solr.xml file.
9293
items:
9394
type: string
9495
type: array

helm/solr-operator/crds/crds.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,8 @@ spec:
346346
additionalLibs:
347347
description: |-
348348
List of paths in the Solr Docker image to load in the classpath.
349-
Note: Solr Modules will be auto-loaded if specified in the "solrModules" property. There is no need to specify them here as well.
349+
There is no need to include paths for Solr Modules already specified in the "solrModules" property, those paths will be added automatically.
350+
Note that this setting has no effect on solrcloud clusters that rely on a user-provided solr.xml file.
350351
items:
351352
type: string
352353
type: array

helm/solr/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Descriptions on how to use these options can be found in the [SolrCloud document
9595
| solrOptions.logLevel | string | `"INFO"` | Log level to run Solr under |
9696
| solrOptions.gcTune | string | `""` | GC Tuning parameters for Solr |
9797
| solrOptions.solrModules | []string | | List of packaged Solr Modules to load when running Solr. Note: There is no need to specify solr modules necessary for other parts of the Spec (i.e. `backupRepositories[].gcs`), those will be added automatically. |
98-
| solrOptions.additionalLibs | []string | | List of paths in the Solr Image to add to the classPath when running Solr. Note: There is no need to include paths for solrModules here if already listed in `solrModules`, those paths will be added automatically. |
98+
| solrOptions.additionalLibs | []string | | List of paths in the Solr Image to add to the classPath when running Solr. (There is no need to include paths for solrModules here if already listed in `solrModules`, those paths will be added automatically.) Note that this setting has no effect on solrcloud clusters that rely on a user-provided `solr.xml` file. |
9999
| solrOptions.security.authenticationType | string | `""` | Type of authentication to use for Solr |
100100
| solrOptions.security.basicAuthSecret | string | `""` | Name of Secret in the same namespace that stores the basicAuth information for the Solr user |
101101
| solrOptions.security.probesRequireAuth | boolean | | Whether the probes for the SolrCloud pod require auth |

0 commit comments

Comments
 (0)