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 Splunk Add-ons. It includes UI, Rest handler, Modular input, Oauth, Alert action templates.
What is UCC?
UCC is Universal Configuration Console. It is a service for Generating Splunk Add-ons which is easily customizable and flexible. It is helpful to control the activity by using hooks and other functionalities. UCC provides basic UI template for creating Addon's UI.
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
You can install "splunk-add-on-ucc-framework" 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
directory andglobalConfig.json
file present in the directory - The final addon package will be generated, at
output
directory.
Workflow
By the running the ucc-gen
command, the following steps came in action:
- Cleaning out the
output
directory - 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 were 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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69db58cb9a772d231900bafc7b4cfca7ffe03d7475bb7bc0bad29589b306d675 |
|
MD5 | 406edce6579707966eadc799a96c02f8 |
|
BLAKE2b-256 | 480c7be04829f2b7ae97a0b761855eeed593a89ccb4bfd96bed47157e233ecd8 |
Hashes for splunk_add_on_ucc_framework-4.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7ec949f7c43b46ad548d4c064edbc83de16239410d60a14826495699e5629a4 |
|
MD5 | a29c85da5308c0b529e4ef70410f7d9a |
|
BLAKE2b-256 | bd854d7f65b73d9f4cf7a0a7c6385a616f02223cf3f13f4c809b5dc4027cb4fc |