Splunk Add-on SDK formerly UCC is a build and code generation framework
Project description
SPDX-FileCopyrightText: 2020 Splunk Inc.
SPDX-License-Identifier: Apache-2.0
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.
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
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
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 Python2/Python3 compatible packages output/<package_ID>/lib lib/py2/requirements.txt Only Python2 compatible packages output/<package_ID>/lib/py2 lib/py3/requirements.txt Only Python3 compatible packages output/<package_ID>/lib/py3 -
Replace tokens in views.
-
Copy addon's
package/*
tooutput/<package_ID>/*
directory.
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-4.1.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62f090556f602a5f31a414a05088e62f6b5bc2e6a81b0c82a3263699e5372700 |
|
MD5 | 920ebb4c50b562c118d4725e75ba3833 |
|
BLAKE2b-256 | 9446f8c681fa85de5351c89ecc58f6303a6f09ad8d5d4f1945e1662c874dbb65 |
Hashes for splunk_add_on_ucc_framework-4.1.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 935a1c8439285754964cffd00f53e3081e6e43d405667954fe1b57d0e96a3032 |
|
MD5 | d30cf2c43d4e9b1aa9a659d7ed5f6255 |
|
BLAKE2b-256 | 5faa57556abd6eaed5ad3b79fb68a54aa4ecc23b2489f86605ee026ecd477ec7 |