Splunk Add-on SDK formerly UCC is a build and code generation framework
Project description
SPDX-FileCopyrightText: 2020 Splunk Inc.
splunk-add-on-ucc-framework
A framework to generate UI based Splunk Add-ons. It includes UI, Rest handler, Modular input, Oauth, Alert action templates.
Note: after UCC 5.2 Python 2 specific libraries are not supported anymore. This means if the add-on has
package/lib/py2/requirements.txt
they will not be installed while runningucc-gen
command. Therefore modular inputs that are supposed to run on Python 2 will not be supported by UCC.
What is UCC?
UCC stands for Universal Configuration Console. It is a service for generating Splunk Add-ons which is easily customizable and flexible. UCC provides basic UI template for creating Addon's UI. It is helpful to control the activity by using hooks and other functionalities.
Features
- Generate UCC based addons for your Splunk Technology Add-ons
UCC 5
UCC 5 has potentially breaking changes to add-ons using hook extension in the UX. Previously such hooks were limited to un-optimized js files placed in the package. Add-ons may now package such extensions with webpack.
Requirements
- Addon package and globalConfig.json file
Note: You may refer the globalConfig.json file here
Installation
"splunk-add-on-ucc-framework" can be installed via pip
from PyPI
:
$ pip3 install splunk-add-on-ucc-framework
pre-commit
Please visit pre-commit
quick start section.
How to use
To build the UCC based addon follow the below steps:
- Install the
splunk-add-on-ucc-framework
viapip3
. - Run the
ucc-gen
command. - Make sure that
package
folder andglobalConfig.json
file are present in the addon folder. - The final addon package will be generated, in the
output
folder.
Workflow
By the running the ucc-gen
command, the following steps are executed:
-
Cleaning out the
output
folder. -
Retrieve the package ID of addon.
-
Copy UCC template directory under
output/<package_ID>
directory. -
Copy
globalConfig.json
file tooutput/<package_ID>/appserver/static/js/build
directory. -
Collect and install Addon's requirements into
output/<package_ID>/lib
directory of addon's package. -
For the addon's requirements, packages are installed according to following table:
File Name Description Output directory in UCC build lib/requirements.txt Python3 compatible packages output/<package_ID>/lib -
Replace tokens in views.
-
Copy addon's
package/*
tooutput/<package_ID>/*
directory. -
If an addon requires some additional configurations in packaging than implement the steps in additional_packaging.py
Params
splunk-add-on-ucc-framework supports the following params:
Name | Description |
---|---|
source | Folder containing the app.manifest and app source |
config | Path to the configuration file, Defaults to GlobalConfig.json in the parent directory of source provided |
ta-version | Optional override Current version of TA, Default version is version specified in globalConfig.json a Splunkbase compatible version of SEMVER will be used by default |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for splunk_add_on_ucc_framework-5.8.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4adfa5966ece1e25c32f7904a4a412d185b125fc8805b4aa5847a93ff1cfd722 |
|
MD5 | 478f6dffc63c27568aa40f10096e1c1f |
|
BLAKE2b-256 | 4c842ad4fea0614b890d2eaf04905a2a62f9e5f918f2b7236274193ba5ac3a5e |
Hashes for splunk_add_on_ucc_framework-5.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a077b78a0cb6d557ecca64e0991016a6d6ae621267a5044c6d39ca87d6e837a7 |
|
MD5 | 771860cbd9b435b32b5ad71e663191cf |
|
BLAKE2b-256 | 5e3b993f5157fc46b6b9e87711691e317a127cd34ac0101111cb030410b51760 |