Ksconf

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

- Added the new :ref:`ksconf_cmd_xml-format` command.

- The ``ksconf xml-format`` command brings format consistency to your XML representations of Simple XML dashboards and navigation files by fixing indentation automatically adding ``<![CDATA[ ... ]]>`` blocks, as needed, to reduce the need for XML escaping, resulting in more readable source.
- Additionally, a new pre-commit hook named :ref:`ksconf-xml-format <ksconf_pre_commit>` was added to leverage this new functionality. It looks specifically for xml views and navigation files based on path. This may also include Advanced XML, which hasn't been tested; So if you use Advanced XML, proceed with caution.
- Note that this adds ``lxml`` as a packaging dependency which is needed for pre-commit hooks, but not strictly required at run time for other ksconf commands. This is NOT ideal, and may change in the future in attempts to keep ksconf as light-weight and standalone as possible. One possible alternative is setting up a different repo for pre-commit hooks. Python packaging and distribution tips welcome.

- Fixed data loss bug in ``promote`` (interactive mode only) and improved some UI text and prompts.
- Fixed colorization of ``ksconf diff`` output where certain lines failed to show up in the correct color.
- Fixed bug where debug tracebacks didn't work correctly on Python 2.7. (Enable using ``KSCONF_DEBUG=1``.)
- Extended the output of ``ksconf --version`` to show the names and version of external modules, when present.
- Improved some resource allocation in corner cases.
- Tested with Splunk 7.3 (numeric similarity in version numbers is purely coincidental)

.. attention:: **API BREAKAGE**

The ``DiffOp`` output values for ``DIFF_OP_INSERT`` and ``DIFF_OP_DELETE`` have been changed in a backwards-compatible breaking way.
The values of ``a`` and ``b`` were previously reversed for these two operations, leading to some code confusion.

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

- Fixed bug where ``filter`` would crash when doing stanza matching if global entries were present. Global stanzas can be matched by searching for a stanza named ``default``.
- Fixed broken ``pre-commit`` issue that occurred for the ``v0.7.1`` tag. This also kept ``setup.py`` from working if the ``six`` module wasn't already installed. Developers and pre-commit users were impacted.

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

- Additional fixes for UTF-8 BOM files which appear to happen more frequently with ``local`` files on Windows.
This time some additional unit tests were added so hopefully there are few regressions in the future.
- Add the ``ignore-missing`` argument to :ref:`ksconf_cmd_merge` to prevent errors when input files are absent.
This allows bashisms ``Some_App/{{default,local}}/savedsearches.conf`` to work without errors if the local or default file is missing.
- Check for incorrect environment setup and suggest running sourcing :file:`setSplunkEnv` to get a working environment.
See `48 <https://github.com/Kintyre/ksconf/issues/48>`__ for more info.
- Minor improvements to some internal error handling, packaging, docs, and troubleshooting code.

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

.. attention:: For anyone who installed 0.6.x, we recommend a fresh install of the Splunk app due to packaging changes. This shouldn't be an issue in the future.

*General changes:*

- Added new :ref:`ksconf_cmd_rest-publish` command that supersedes the use of ``rest-export`` for nearly every use case. Warning: No unit-testing has been created for this command yet, due to technical hurdles.
- Added :doc:`cheatsheet` to the docs.
- Massive doc cleanup of hundreds of typos and many expanded/clarified sections.
- Significant improvement to entrypoint handling and support for conditional inclusion of 3rd party libraries with sane behavior on import errors, and improved warnings. This information is conveniently viewable to the user via ``ksconf --version``.
- Refactored internal diff logic and added additional safeties and unit tests. This includes improvements to TTY colorization which should avoid previous color leaks scenarios that were likely if unhandled exceptions occur.
- New support for metadata handling.
- CLI change for ``rest-export``: The ``--user`` argument has been replaced with ``--owner`` to keep clean separation between the login account and object owners. (The old argument is still accept for now.)

*Splunk app changes:*

- Modified installation of python package installation. In previous releases, various ``.dist-info`` folders were created with version-specific names leading to a mismatch of package versions after upgrade.
For this reason, we suggest that anyone who previously installed 0.6.x should do a fresh install.
- Changed Splunk app install script to ``install.py`` (it was ``bootstrap_bin.py``). Hopefully this is more intuitive.
- Added Windows support to ``install.py``.
- Now includes the Splunk Python SDK. Currently used for ``rest-publish`` but will eventually be used for additional functionally unique to the Splunk app.

Ksconf 0.6.x
------------

Add deployment as a Splunk app for simplicity and significant docs cleanup.

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

- Massive rewrite and restructuring of the docs. Highlights include:

- Reference material has been moved out of the user manual into a different top-level section.
- Many new topics were added, such as

- :ref:`ksconf_ext_diff`
- :ref:`splunk conf updates`
- :ref:`configuration-layers`
- :ref:`What's so important about minimizing files? <minimizing_files>`

- A new approach for CLI documentation. We're moving away from the **WALL OF TEXT** thing.
(Yeah, it was really just the output from ``--help``). That was limiting formatting,
linking, and making the CLI output way too long.

- Refreshed Splunk app icons. Add missing alt icon.
- Several minor internal cleanups. Specifically the output of ``--version`` had a face lift.

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

- (Trivial) Fixed some small issues with the Splunk App (online AppInspect)