[Solr Wiki] Update of "SolrCollectionDistributionScripts" by BillAu

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.

The following page has been changed by BillAu:
http://wiki.apache.org/solr/SolrCollectionDistributionScripts

------------------------------------------------------------------------------
     -d   specify directory holding index data
     -u   specify user to sudo to before running script
     -v   increase verbosity
+    -V   output debugging info
  }}}
  
  '''snapshooter''' takes a snapshot of the current Lucene index by using hard links.  Snapshots directories are named '''snapshot.''yyyymmddHHMMSS''''' where '''''yyymmddHHMMSS''''' is the timestamp of when the snapshot was taken.  All relative paths specified with the -d option start at the Solr root directory '''solr'''.
@@ -53, +54 @@

  usage: rsyncd-enable [-u username] [-v]
     -u   specify user to sudo to before running script
     -v   increase verbosity
+    -V   output debugging info
  }}}
  
  '''rsyncd-enable''' enables the starting of the rsyncd daemon by creating the file '''solr/logs/rsyncd-enabled'''.  Please note that this script will not actually starts the rsyncd daemon.
@@ -63, +65 @@

  usage: rsyncd-disable [-u username] [-v]
     -u   specify user to sudo to before running script
     -v   increase verbosity
+    -V   output debugging info
  }}}
  
  '''rsyncd-disable''' disables the starting of the rsyncd daemon by removing the file '''solr/logs/rsyncd-enabled'''.  Please note that this script will not actually stop the rsyncd daemon if it is already running.
@@ -75, +78 @@

     -p   specify rsyncd port number
     -u   specify user to sudo to before running script
     -v   increase verbosity
+    -V   output debugging info
  }}}
  
  Starts the rsyncd daemon on the master Solr server. The rsyncd daemon sets its port number to be the port number of the Solr server incremented by 10000 if the environment variable '''rsyncd_port''' is not set in '''solr/conf/scripts/conf''' and the '''-p''' command line argument is not specified. For example, if the Solr server runs at port 7000, then its  rsyncd daemon runs at port 17000. The start script is synchronous. After starting the rsyncd daemon, it will attempt to connect to it for up to 15 seconds. The start script will exit with error code 2 if it fails to connect to the rsyncd daemon. Before starting the rsyncd daemon, it generates the configuration file '''solr/conf/rsyncd.conf''' which is in turn removed by '''rsyncd-stop''' at shutdown time.  The process ID of the rsyncd daemon is written into the file '''solr/logs/rsyncd.pid'''. Output of the rsyncd daemon is written into the file '''solr/logs/rsyncd.log'''.  All relative paths specified with the -d option
  start at the Solr root directory '''solr'''.
@@ -85, +89 @@

  usage: rsyncd-stop [-u username] [-v]
     -u   specify user to sudo to before running script
     -v   increase verbosity
+    -V   output debugging info
  }}}
  
  Stops the rsyncd daemon on the master Solr server. The stop script is synchronous. After stopping the rsyncd daemon, it makes sure that the daemon has exited by trying to connect to it for up to 300 seconds. The stop script will exit with error code 2 if it fails to stop the rsyncd daemon.  After the rsyncd daemon has been stopped, it removes the configuration file '''solr/conf/rsyncd.conf''' which is generated by '''rsyncd-start''' at startup time.
@@ -95, +100 @@

  usage: snappuller-enable [-u username] [-v]
     -u   specify user to sudo to before running script
     -v   increase verbosity
+    -V   output debugging info
  }}}
  
  '''snappuller_enable''' enables the snappuller by creating the file '''solr/logs/snappuller-enabled'''.
@@ -105, +111 @@

  usage: snappuller-disable [-u username] [-v]
     -u   specify user to sudo to before running script
     -v   increase verbosity
+    -V   output debugging info
  }}}
  
  '''snappuller-disable''' disables the snappuller by removing the file '''solr/logs/snappuller-enabled'''.
@@ -130, +137 @@

     -s          use the --size-only option with rsync
     -v          increase verbosity (-vv show file
                 transfer stats also)
+    -V          output debugging info
     -z          enable compression of data
  }}}
  
@@ -154, +162 @@

     -u        specify user to sudo to before running
               script
     -v        increase verbosity
+    -V        output debugging info
  }}}
  
  After a snapshot has been installed, '''snapinstaller''' writes its name into the file '''solr/logs/snapshot.current''', and scp a copy of this file back to the master Solr server. See SolrCollectionDistributionStatusStats for more details.  All relative paths specified with the -d option start at the Solr root directory '''solr'''.
@@ -171, +180 @@

     -u        specify user to sudo to before running
               script
     -v        increase verbosity
+    -V        output debugging info
  }}}
  
  Please note that the argument to the commnand line option -d is not inclusive. In addition, a day old is defined as more than 24 hours old from the time the command is invoked. For example, -d 1 will cause '''snapcleaner''' to remove snapshots more than but not including 1 day old, ie 2 days and older. Therefore, snapshots more than 48 hours old will be removed.  All relative paths specified with the -d option start at the Solr root directory '''solr'''.