Ksconf

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Add initial support for building ksconf into a Splunk app.

- App contains a local copy of the docs, helpful for anyone who’s working offline.
- Credit to Sarah Larson for the ksconf logos.
- No ``ksconf`` functionality exposed to the Splunk UI at the moment.

- Docs/Sphinx improvements (more coming)

- Begin work on cleaning up API docs.
- Started converting various document pages into reStructuredText for greatly improved docs.
- Improved PDF fonts and fixed a bunch of sphinx errors/warnings.

- Refactored the install docs into 2 parts. With the new ability to install ksconf as a Splunk app
it’s quite likely that most of the wonky corner cases will be less frequently needed, hence all
the more exotic content was moved into the “Advanced Install Guide”, tidying things up.

Ksconf 0.5.x
------------

Add Python 3 support, new commands, support for external command plugins, tox and vagrant for testing.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Fixes and improvements to the ``filter`` command. Found issue with processing from stdin,
inconsistency in some CLI arguments, and finished implementation for various output modes.
- Add logo (fist attempt).

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- New :ref:`ksconf_cmd_filter` command added for slicing up a conf file into smaller pieces. Think of this as
GREP that’s stanza-aware. Can also allow or block attributes, if desirable.
- Expanded ``rest-export`` CLI capabilities to include a new ``--delete`` option, pretty-printing,
and now supports stdin by allowing the user to explicitly set the file type using ``--conf``.
- Refactored all CLI unittests for increased readability and long-term maintenance. Unit tests
now can also be run individually as scripts from the command line.
- Minor tweaks to the ``snapshot`` output format, v0.2. This feature is still highly experimental.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- New commands added:

- :ref:`ksconf_cmd_snapshot` will dump a set of configuration files to a JSON formatted file. This can be used
used for incremental "snapshotting" of running Splunk apps to track changes overtime.
- :ref:`ksconf_cmd_rest-export` builds a series of custom ``curl`` commands that can be used to publish or update
stanzas on a remote instance without file system access. This can be helpful when pushing
configs to Splunk Cloud when all you have is REST (splunkd) access. This command is indented
for interactive admin not batch operations.

- Added the concept of command maturity. A listing is available by running ``ksconf --version``
- Fix typo in ``KSCONF_DEBUG``.
- Resolving some build issues.
- Improved support for development/testing environments using Vagrant (fixes) and Docker (new).
Thanks to Lars Jonsson for these enhancements.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Fixed bug where ``ksconf combine`` could incorrectly order directories on certain file systems
(like ext4), effectively ignoring priorities. Repeated runs may resulted in undefined behavior.
Solved by explicitly sorting input paths forcing processing to be done in lexicographical order.
- Fixed more issues with handling files with BOM encodings. BOMs and encodings in general are NOT
preserved by ksconf. If this is an issue for you, please add an enhancement issue.
- Add Python 3.7 support
- Expand install docs specifically for offline mode and some OS-specific notes.
- Enable additional tracebacks for CLI debugging by setting ``KSCONF_DEBUG=1`` in the environment.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Expand CLI output for ``--help`` and ``--version``
- Internal cleanup of CLI entry point module name. Now the ksconf CLI can be invoked as
``python -m ksconf``, you know, for anyone who’s into that sort of thing.
- Minor docs and CI/testing improvements.