Merge pull request #778 from untergeek/doc/776

Fix documentation and bump version to 4.1.2

.travis.yml

@@ -11,7 +11,7 @@ env:
   - ES_VERSION=2.2.2
   - ES_VERSION=2.3.5
   - ES_VERSION=2.4.0
-  - ES_VERSION=5.0.0-alpha5
+  - ES_VERSION=5.0.0-beta1
 
 os: linux
 

README.rst

@@ -10,7 +10,7 @@ Like a museum curator manages the exhibits and collections on display,
 Elasticsearch Curator helps you curate, or manage your indices.
 
 Compatibility Matrix
-=======
+====================
 
 +--------+----------+----------+----------+
 |Version | ES 1.x   | ES 2.x   | ES 5.x   |
@@ -147,6 +147,55 @@ integration tests against it. This will delete all the data stored there! You
 can use the env variable ``TEST_ES_SERVER`` to point to a different instance
 (for example, 'otherhost:9203').
 
+Binary Executables
+------------------
+
+The combination of `setuptools <https://github.com/pypa/setuptools>`_ and
+`cx_Freeze <http://cx-freeze.sourceforge.net>`_ allows for Curator to be
+compiled into binary packages.  These consist of a binary file placed in a
+directory which contains all the libraries required to run it.
+
+In order to make a binary package you must manually install the ``cx_freeze``
+python module.  You can do this via ``pip``, or ``python setup.py install``,
+or by package, if such exists for your platform.  In order to make it compile on
+recent Debian/Ubuntu platforms, a patch had to be applied to the ``setup.py``
+file in the extracted folder.  This patch file is in the ``unix_packages``
+directory in this repository.
+
+With ``cx_freeze`` installed, building a binary package is as simple as running
+``python setup.py build_exe``.  In Linux distributions, the results will be in
+the ``build`` directory, in a subdirectory labelled
+``exe.linux-x86_64-${PYVER}``, where `${PYVER}` is the current major/minor
+version of Python, e.g. ``2.7``.  This directory can be renamed as desired.
+
+Other entry-points that are defined in the ``setup.py`` file, such as
+``es_repo_mgr``, will also appear in this directory.
+
+The process is identical for building the binary package for Windows.  It must
+be run from a Windows machine with all dependencies installed.  Executables in
+Windows will have the ``.exe`` suffix attached.  The directory in ``build`` will
+be named ``exe.win-amd64-${PYVER}``, where `${PYVER}` is the current major/minor
+version of Python, e.g. ``2.7``.  This directory can be renamed as desired.
+
+In Windows, cx_Freeze also allows for building rudimentary MSI installers.  This
+can be done by invoking ``python setup.py bdist_msi``.  The MSI fill will be in
+the ``dist`` directory, and will be named
+``elasticsearch-curator-#.#.#-amd64.msi``, where the major, minor, and patch
+version numbers are substituted accordingly.  One drawback to this rudimentary
+MSI is that it does not allow updates to be installed on top of the existing
+installation.  You must uninstall the old version before installing the newer
+one.
+
+The ``unix_packages`` directory contains the ``build_packages.sh`` script used
+to generate the packages for the Curator YUM and APT repositories.  The
+``Vagrant`` directory has the Vagrantfiles used in conjunction with the
+``build_packages.sh`` script.  If you wish to use this method on your own, you
+must ensure that the shared folders exist.  ``/curator_packages`` is where the
+packages will be placed after building.  ``/curator_source`` is the path to the
+Curator source code, so that the ``build_packages.sh`` script can be called from
+there.  The ``build_packages.sh`` script does `not` use the local source code,
+but rather pulls the version specified as an argument directly from GitHub.
+
 Versioning
 ----------
 

curator/_version.py

@@ -1 +1 @@
-__version__ = '4.1.1'
+__version__ = '4.1.2'

docs/Changelog.rst

@@ -3,8 +3,11 @@
 Changelog
 =========
 
-4.1.2 (? ? ?)
--------------
+4.1.2 (6 October 2016)
+----------------------
+
+This release does not actually add any new code to Curator, but instead improves
+documentation and includes new linux binary packages.
 
 **General**
 
@@ -25,6 +28,24 @@ Changelog
     The script used is in the unix_packages directory.  The Vagrantfiles for
     the various build systems are in the Vagrant directory.
 
+**Bug Fixes**
+
+  * The only bug that can be called a bug is actually a stray ``.exe`` suffix
+    in the binary package creation section (cx_freeze) of ``setup.py``.  The
+    Windows binaries should have ``.exe`` extensions, but not unix variants.
+  * Elasticsearch 5.0.0-beta1 testing revealed that a document ID is required
+    during document creation in tests.  This has been fixed, and a redundant bit
+    of code in the forcemerge integration test was removed.
+
+**Documentation**
+
+  * The documentation has been updated and improved.  Examples and installation
+    are now top-level events, with the sub-sections each having their own link.
+    They also now show how to install and use the binary packages, and the
+    section on installation from source has been improved.  The missing
+    section on installing the voluptuous schema verification module has been
+    written and included. #776 (untergeek)
+
 4.1.1 (27 September 2016)
 -------------------------
 

docs/asciidoc/examples.asciidoc

@@ -1,13 +1,29 @@
 [[examples]]
-== Examples
+= Examples
 
+[partintro]
+--
 These examples should help illustrate how to build your own <<actions,actions>>.
 
 Starting in Curator 4.1, you can use <<envvars,environment variables>> in your
 configuration files.
 
+* <<ex_alias,alias>>
+* <<ex_allocation,allocation>>
+* <<ex_close,close>>
+* <<ex_create_index,create_index>>
+* <<ex_delete_indices,delete_indices>>
+* <<ex_delete_snapshots,delete_snapshots>>
+* <<ex_forcemerge,forcemerge>>
+* <<ex_open,open>>
+* <<ex_replicas,replicas>>
+* <<ex_restore,restore>>
+* <<ex_snapshot,snapshot>>
+
+--
+
 [[ex_alias]]
-=== alias
+== alias
 
 [source,text]
 -------------
@@ -64,7 +80,7 @@ actions:
 -------------
 
 [[ex_allocation]]
-=== allocation
+== allocation
 
 [source,text]
 -------------
@@ -104,7 +120,7 @@ actions:
 -------------
 
 [[ex_close]]
-=== close
+== close
 
 [source,text]
 -------------
@@ -141,7 +157,7 @@ actions:
 -------------
 
 [[ex_create_index]]
-=== create_index
+== create_index
 
 [source,text]
 -------------
@@ -169,7 +185,7 @@ actions:
 
 
 [[ex_delete_indices]]
-=== delete_indices
+== delete_indices
 
 [source,text]
 -------------
@@ -207,7 +223,7 @@ actions:
 -------------
 
 [[ex_delete_snapshots]]
-=== delete_snapshots
+== delete_snapshots
 
 [source,text]
 -------------
@@ -244,7 +260,7 @@ actions:
 
 
 [[ex_forcemerge]]
-=== forcemerge
+== forcemerge
 
 [source,text]
 -------------
@@ -284,7 +300,7 @@ actions:
 -------------
 
 [[ex_open]]
-=== open
+== open
 
 [source,text]
 -------------
@@ -327,7 +343,7 @@ actions:
 -------------
 
 [[ex_replicas]]
-=== replicas
+== replicas
 
 [source,text]
 -------------
@@ -364,7 +380,7 @@ actions:
 -------------
 
 [[ex_restore]]
-=== restore
+== restore
 
 [source,text]
 -------------
@@ -412,7 +428,7 @@ actions:
 -------------
 
 [[ex_snapshot]]
-=== snapshot
+== snapshot
 
 [source,text]
 -------------

docs/asciidoc/index.asciidoc

@@ -1,4 +1,4 @@
-:curator_version: 4.1.1
+:curator_version: 4.1.2
 :curator_major: 4
 :es_py_version: 2.4.0
 :ref:  http://www.elastic.co/guide/en/elasticsearch/reference/current
@@ -7,11 +7,12 @@
 = Curator Reference
 
 include::about.asciidoc[]
-include::getting_started.asciidoc[]
+include::installation.asciidoc[]
 include::command-line.asciidoc[]
 include::configuration.asciidoc[]
 include::actions.asciidoc[]
 include::options.asciidoc[]
 include::filters.asciidoc[]
 include::filter_elements.asciidoc[]
+include::examples.asciidoc[]
 include::faq.asciidoc[]