Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We
also use these cookies to improve our products and services, support our marketing
campaigns, and advertise to you on our website and other websites. Some cookies may continue
to collect information after you have left our website.
Learn more (including
how to update your settings) here.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the
license provided by that third-party licensor. Splunk is not responsible for any third-party
apps and does not provide any warranty or support. If you have any questions, complaints or
claims with respect to this app, please contact the licensor directly.

To install your download

For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

KSCONF

Splunk AppInspect Passed

Overview

Details

Git and Splunk don't always fit together perfectly. Introducing KSCONF, a tool written to alleviate painful tasks associated with managing Splunk apps in a git repository. This open source tool supports many functions to help both admins and developers manage Splunk content in git in a simple way without getting stuck in the details.

https://github.com/Kintyre/ksconf

What is KSCONF?

KSCONF is a command-line tool that helps administrators and developers manage their Splunk environments by enhancing control of their configuration files. The interface is modular so that each function (or subcommand) can be learned quickly and used independently. While most users will probably only use a subset of the total capabilities of this tool, it’s reassuring to have a deep toolbox of power goodies ready to be unleashed at a moments notice. Ksconf works with (and does not replace) your existing Splunk deployment mechanisms and version control tools.

KSCONF is open source and an open development effort. Check us out on GitHub

Pronounced: k·s·kȯnf

Design principles

Ksconf is a toolbox. - Each tool has a specific purpose and function that works independently. Borrowing from the Unix philosophy, each command should do one small thing well and be easily combined to handle higher-order tasks.

When possible, be familiar. - Various commands borrow from popular UNIX command line tools such as “grep” and “diff”. The overall modular nature of the command is similar to the modular interface used by “git” and the “splunk” cli.

Don’t impose workflow. - Ksconf works with or without version control and independently of your deployment mechanisms. (If you are looking to implement these things, ksconf is a great building block)

Embrace automated testing. - It’s impractical to check every scenarios between each release, but significant work has gone into unittesting the CLI to avoid breaks between releases.

What's in the KSCONF App for Splunk?

This Splunk app comes bundled with a CLI tool that helps manage other Splunk apps. While this is not a traditional use case for a Splunk app, it is a very quick and easy way to deploy ksconf.

Why did we make this a Splunk app? Well, while ksconf is technically just a Python package that can be deployed in a variety of ways, we found that the logistics of getting it deployed can be quite difficult due to a packaging issues, legacy cruft, and OS limitations. This approach avoids all that mess.

Getting Started

Full documentation for ksconf and, therefore this app, is hosted at read-the-docs. A full copy of the ksconf documentation is also included, just like how Splunk ships with a fully copy of the docs in the system/README folder. (And all the air-gapped people rejoice! but sadly, no one could hear them.)

Need help?

Get Involved

Roadmap

Additional Splunk UI feature are planned, but currently not implemented.

Dashboard to track all changes coordinated by ksconf

Configuration snapshot tracking

Custom SPL command to give visibility into the what exists in the local folder. (The built-in rest command only shows you the final merged view of your settings; and sometimes you have to look deeper.)

Installation & Configuration

See the Install an add-on in Splunk's official documentation. There is one manual step required to active the CLI portion of this app, if you choose to do so. See the Installation docs for more details.

Support

Community support is available on best-effort basis. For information about commercial support, contact Kintyre
Issues are tracked via GitHub

AppInspect Tooling

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 50GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps and add-ons from Splunk, our partners and our community. Find an app or add-on for most any data source and user need, or simply create your own with help from our developer portal.

Splunk®, Splunk>®, Listen to Your Data®, The Engine for Machine Data®, Hunk®, Splunk Cloud™, Splunk Light™, SPL™ and Splunk MINT™ are trademarks and registered trademarks of Splunk Inc. in the United States and other countries. All other brand names, product names, or trademarks belong to their respective owners.