Skip to main content
Lantern Home

 

Splunk Lantern

Using the Universal Configuration Console

  1. Last updated
  2. Save as PDF

The Universal Configuration Console (UCC) is a command line tool that generates a set of prebuilt files that can be packaged into an add-on with a UI interface. The tool is used by Splunk engineering teams to create officially supported add-ons. The advantages of using this tool include the following:

  • Can be integrated with a CI/CD pipeline
  • Simplifies add-on creation
  • Provides a uniform look and feel with standard UI elements
  • Facilitates open sourcing of well-known TAs

How is it different from the Splunk Add-on Builder?

  • Pros:
    • UCC operates outside of the Splunk environment, which provides flexibility
    • Version control can be applied to the packages it generates
    • It is an open-source tool maintained by the Splunk engineering team
    • The framework allows for reusable components
  • Cons:
    • It is largely missing a WYSIWYG editor
    • Requires more time and consideration to develop an add-on
    • App validation is not integrated (though this is on the roadmap)
    • Lacks Python helper functions

Prerequisites

To use the UCC, ensure that you have the following:

Solution

The process for creating add-ons with the UCC is as follows:

  1. Initialize. This step generates:
    1. A package folder. This holds the modular inputs.
    2. A globalConfig.json file. This is where all the configurations live.
  2. Build. This step generates the add-on file structure.
  3. Package. This step packages the add-on into a tar.gz file.

For step-by-step guidance to create your own add-ons, see the guidance on GitHub, About the Universal Configuration Console (UCC).

The following demo walks through an example. 

Additional resources

The following additional resources might help you implement the guidance found in this article.