Update display names and descriptions; remove non-cloud-related config options

Author: ctargett

src/main/mpack/common-services/SOLR/5.5.5/configuration/solr-cloud.xml

@@ -5,7 +5,7 @@
     <property>
         <name>solr_cloud_enable</name>
         <value>true</value>
-        <description>Whether Solr should be started in Cloud mode</description>
+        <description>Whether Solr should be started in SolrCloud mode. This option cannot be changed.</description>
         <display-name>Enable SolrCloud mode</display-name>
         <value-attributes>
             <type>boolean</type>
@@ -16,7 +16,9 @@
     <property>
         <name>solr_cloud_zk_directory</name>
         <value>/solr</value>
-        <description>ZooKeeper directory (chroot) for shared Solr files</description>
+        <description>ZooKeeper directory (chroot) for shared Solr files.
+           This allows Solr's files to be isolated from files for other applications sharing
+           the same ZooKeeper instance.</description>
         <display-name>ZooKeeper root directory for Solr files</display-name>
     </property>
 </configuration>

src/main/mpack/common-services/SOLR/5.5.5/configuration/solr-config-env.xml

@@ -17,34 +17,14 @@
         <value>512m</value>
         <description>
             Sets the min (-Xms) and max (-Xmx) heap size for the
-            JVM, such as: -m 4g
+            JVM, such as: 4g
             results in: -Xms4g -Xmx4g; by default, this
             script sets the heap
             size to 512m
         </description>
         <display-name>Solr heap size for the JVM</display-name>
     </property>
 
-    <property>
-        <name>solr_config_conf_dir</name>
-        <value>/etc/solr/conf</value>
-        <description>Solr conf directory</description>
-        <value-attributes>
-            <type>directory</type>
-        </value-attributes>
-        <display-name>Solr configuration directory</display-name>
-    </property>
-
-    <property>
-        <name>solr_config_data_dir</name>
-        <value>/etc/solr/data_dir</value>
-        <description>Solr data directory</description>
-        <value-attributes>
-            <type>directory</type>
-        </value-attributes>
-        <display-name>Solr server directory</display-name>
-    </property>
-
     <property>
         <name>solr_config_pid_dir</name>
         <value>/var/run/solr</value>
@@ -103,7 +83,7 @@
           <name>solr_stop_key</name>
           <value>solrrocks</value>
           <property-type>PASSWORD</property-type>
-          <description>Solr stop key</description>
+          <description>Solr stop key (password) that must be supplied in order to stop Solr.</description>
           <value-attributes>
             <type>password</type>
             <overridable>false</overridable>

src/main/mpack/common-services/SOLR/5.5.5/configuration/solr-hdfs.xml

@@ -5,8 +5,8 @@
     <property>
         <name>solr_hdfs_enable</name>
         <value>true</value>
-        <description>Enable support for Solr on HDFS</description>
-        <display-name>Enable support for Solr on HDFS</display-name>
+        <description>Enables storing Solr's indexes in HDFS.</description>
+        <display-name>Store Solr indexes in HDFS</display-name>
         <value-attributes>
             <type>boolean</type>
             <overridable>false</overridable>
@@ -16,18 +16,21 @@
     <property>
         <name>solr_hdfs_directory</name>
         <value>/solr</value>
-        <description>HDFS directory for Solr indexes</description>
+        <description>The HDFS path where Solr indexes will be stored.</description>
         <display-name>HDFS directory for Solr indexes</display-name>
     </property>
 
     <property>
         <name>solr_hdfs_delete_write_lock_files</name>
         <value>false</value>
-        <description>Delete write.lock files on HDFS</description>
+        <description>Solr locks indexes against multiple writes. In some cases, restarting Solr will leave lock
+           files behind, which prevent successful startup. This option automatically checks for and removes any
+           lock files found in any collection on any node every time Solr starts.
+        </description>
         <display-name>Delete write.lock files on HDFS</display-name>
         <value-attributes>
             <type>boolean</type>
             <overridable>false</overridable>
         </value-attributes>
     </property>
-</configuration>
+</configuration>

src/main/mpack/common-services/SOLR/5.5.5/configuration/solr-security.xml

@@ -7,7 +7,7 @@
     <name>solr_security_json</name>
     <display-name>Solr security.json</display-name>
     <description>The security.json will be uploaded to Zookeeper.
-      Note: if a security.json is already store in Zookeeper, this security.json will not overwrite it.
+      Note: if a security.json is already stored in Zookeeper, this security.json will not overwrite it.
     </description>
     <value>
       {
@@ -21,4 +21,4 @@
       <show-property-name>false</show-property-name>
     </value-attributes>
   </property>
-</configuration>
+</configuration>

src/main/mpack/common-services/SOLR/7.4.0/configuration/example-collection.xml

@@ -5,7 +5,7 @@
     <property>
         <name>solr_collection_sample_create</name>
         <value>true</value>
-        <description>True to create a sample collection when Solr is deployed</description>
+        <description>True to create a sample collection when Solr is deployed.</description>
         <display-name>Create sample collection</display-name>
         <value-attributes>
             <type>boolean</type>
@@ -16,25 +16,25 @@
     <property>
         <name>solr_collection_sample_name</name>
         <value>collection1</value>
-        <description>Solr sample collection name. Mandatory</description>
+        <description>Solr sample collection name. Mandatory.</description>
         <display-name>Sample collection name</display-name>
     </property>
 
     <property>
         <name>solr_collection_sample_config_directory</name>
         <value>_default</value>
-        <description>Solr sample collection configurations directory. Mandatory
+        <description>Solr configuration set for the sample collection, which must be a directory
+            that contains at least solrconfig.xml and a schema. Mandatory.
             This directory path is relative to /opt/lucidworks-hadoop/solr/server/solr/configsets.
-            It must contain at least solrconfig.xml and schema.xml
         </description>
-        <display-name>Solr configuration directory</display-name>
+        <display-name>Solr configset</display-name>
     </property>
 
     <property>
         <name>solr_collection_sample_shards</name>
         <value>2</value>
-        <description>Number of Solr shards, for details refer to
-            (https://cwiki.apache.org/confluence/display/solr/Shards+and+Indexing+Data+in+SolrCloud)
+        <description>Number of shards (logical partitions of the collection) to create. For details refer to
+            (https://lucene.apache.org/solr/guide/7_4/shards-and-indexing-data-in-solrcloud.html)
         </description>
         <value-attributes>
             <type>int</type>
@@ -45,8 +45,8 @@
     <property>
         <name>solr_collection_sample_replicas</name>
         <value>1</value>
-        <description>Number of Solr replicas, for details refer to
-            (https://cwiki.apache.org/confluence/display/solr/NRT%2C+Replication%2C+and+Disaster+Recovery+with+SolrCloud)
+        <description>Number of Solr replicas (physical copies of shards) to create. For details refer to
+           (https://lucene.apache.org/solr/guide/7_4/shards-and-indexing-data-in-solrcloud.html)
         </description>
         <value-attributes>
             <type>int</type>

src/main/mpack/common-services/SOLR/7.4.0/configuration/solr-config-env.xml

@@ -6,7 +6,7 @@
     <property>
         <name>solr_stop_wait</name>
         <value>180</value>
-        <description>This controls the number of seconds that the solr script will wait for Solr to stop gracefully
+        <description>The number of seconds that the Solr script will wait for Solr to stop gracefully
             or Solr to start. If the graceful stop fails, the script will forcibly stop Solr. If the start fails,
             the script will give up waiting and display the last few lines of the logfile.
         </description>

src/main/mpack/common-services/SOLR/7.4.0/configuration/solr-metrics.xml

@@ -7,7 +7,7 @@
         <name>solr_enable_metrics</name>
         <value>false</value>
         <description>Enable Solr Metrics (Requires Ambari Metrics)</description>
-        <display-name>Enable Solr Metrics</display-name>
+        <display-name>Enable Solr metrics</display-name>
         <value-attributes>
             <type>boolean</type>
         </value-attributes>
@@ -137,6 +137,7 @@
         <value-attributes>
             <type>content</type>
         </value-attributes>
+        <display-name>Solr Metrics properties</display-name>
     </property>
 
     <property>
@@ -215,5 +216,6 @@
         <value-attributes>
             <type>content</type>
         </value-attributes>
+        <display-name>Solr Metrics log4j</display-name>
     </property>
-</configuration>
+</configuration>

src/main/mpack/common-services/SOLR/7.4.0/configuration/solr-ssl.xml

@@ -5,14 +5,14 @@
     <property>
         <name>solr_ssl_key_store_type</name>
         <value>JKS</value>
-        <description>SSL keystore type</description>
+        <description>The keystore type.</description>
         <display-name>SSL keystore type</display-name>
     </property>
 
     <property>
         <name>solr_ssl_trust_store_type</name>
         <value>JKS</value>
-        <description>SSL Trust store type</description>
-        <display-name>SSL Trust store type</display-name>
+        <description>The truststore type.</description>
+        <display-name>SSL truststore type</display-name>
     </property>
 </configuration>