Merge pull request #46 from lucidworks/LWSHADOOP-769

LWSHADOOP-769: Update display names and descriptions

Author: gerlowskija

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,32 +17,33 @@
         <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>
 
     <property>
         <name>solr_config_conf_dir</name>
         <value>/etc/solr/conf</value>
-        <description>Solr conf directory</description>
+        <description>Holds miscellaneous configuration files for Solr and other related processes. (e.g. logging properties, jaas files)</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>
+        <name>solr_config_home_dir</name>
+        <value>/etc/solr/home</value>
+        <description>Solr's "home" directory; used to store configuration for the Solr instance and metadata about the cores it hosts.</description>
         <value-attributes>
             <type>directory</type>
         </value-attributes>
-        <display-name>Solr server directory</display-name>
+        <display-name>Solr home directory</display-name>
     </property>
 
     <property>
@@ -103,7 +104,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>
@@ -223,7 +224,7 @@
 
             # Path to a directory for Solr to store cores and their data. By default, Solr will use server/solr
             # If solr.xml is not stored in ZooKeeper, this directory needs to contain solr.xml
-            SOLR_HOME={{solr_config_data_dir}}
+            SOLR_HOME={{solr_config_home_dir}}
 
             # Solr provides a default Log4J configuration properties file in server/resources
             # however, you may want to customize the log settings and file appender location

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/5.5.5/package/scripts/params.py

@@ -44,7 +44,7 @@ def build_zookeeper_hosts():
 solr_config_service_log_dir = map_solr_config['solr_config_service_log_dir']
 solr_config_service_log_file = format('{solr_config_service_log_dir}/solr-service.log')
 solr_config_conf_dir = map_solr_config['solr_config_conf_dir']
-solr_config_data_dir = map_solr_config['solr_config_data_dir']
+solr_config_home_dir = map_solr_config['solr_config_home_dir']
 solr_stop_key = map_solr_config['solr_stop_key']
 solr_config_in_sh = map_solr_config['solr_in_sh_template']
 solr_hostname = hostname

src/main/mpack/common-services/SOLR/5.5.5/package/scripts/setup_solr.py

@@ -13,7 +13,7 @@ def setup_solr():
                 params.solr_config_service_log_dir,
                 params.solr_config_pid_dir,
                 params.solr_config_conf_dir,
-                params.solr_config_data_dir
+                params.solr_config_home_dir
             ],
             mode=0755,
             cd_access='a',
@@ -40,7 +40,7 @@ def setup_solr():
     )
 
     File(
-            format("{solr_config_data_dir}/solr.xml"),
+            format("{solr_config_home_dir}/solr.xml"),
             content=Template("solr.xml.j2"),
             owner=params.solr_config_user
     )

src/main/mpack/common-services/SOLR/5.5.5/package/scripts/solr_utils.py

@@ -47,7 +47,7 @@ def exists_collection(collection_name):
     import params
 
     if not params.solr_cloud_mode:
-        if os.path.isdir(format("{solr_config_data_dir}/{collection_name}")):
+        if os.path.isdir(format("{solr_config_home_dir}/{collection_name}")):
             return True
         return False
 

src/main/mpack/common-services/SOLR/5.5.5/service_advisor.py

@@ -100,7 +100,7 @@ def validate_solr_configuration(self):
             self.validator_entry('solr_config_port', self.is_number, self.solr_config_properties),
             self.validator_entry('solr_config_memory', self.is_memory_format, self.solr_config_properties),
             self.validator_entry('solr_config_conf_dir', self.is_absolute_path, self.solr_config_properties),
-            self.validator_entry('solr_config_data_dir', self.is_absolute_path, self.solr_config_properties),
+            self.validator_entry('solr_config_home_dir', self.is_absolute_path, self.solr_config_properties),
             self.validator_entry('solr_config_pid_dir', self.is_absolute_path, self.solr_config_properties),
             self.validator_entry('solr_config_log_dir', self.is_absolute_path, self.solr_config_properties),
             self.validator_entry('solr_config_service_log_dir', self.is_absolute_path, self.solr_config_properties)

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

@@ -127,7 +127,7 @@
 
             # Path to a directory for Solr to store cores and their data. By default, Solr will use server/solr
             # If solr.xml is not stored in ZooKeeper, this directory needs to contain solr.xml
-            SOLR_HOME={{solr_config_data_dir}}
+            SOLR_HOME={{solr_config_home_dir}}
 
             # Solr provides a default Log4J configuration properties file in server/resources
             # however, you may want to customize the log settings and file appender location

src/main/mpack/common-services/SOLR/6.6.2/package/scripts/params.py

@@ -44,7 +44,7 @@ def build_zookeeper_hosts():
 solr_config_service_log_dir = map_solr_config['solr_config_service_log_dir']
 solr_config_service_log_file = format('{solr_config_service_log_dir}/solr-service.log')
 solr_config_conf_dir = map_solr_config['solr_config_conf_dir']
-solr_config_data_dir = map_solr_config['solr_config_data_dir']
+solr_config_home_dir = map_solr_config['solr_config_home_dir']
 solr_stop_key = map_solr_config['solr_stop_key']
 solr_config_in_sh = map_solr_config['solr_in_sh_template']
 solr_xml_template = map_solr_config['solr_xml_template']