Splunk® Add-on Builder

Splunk Add-on Builder User Guide

Acrobat logo Download manual as PDF


This documentation does not apply to the most recent version of AddonBuilder. Click here for the latest version.
Acrobat logo Download topic as PDF

Install the Add-on Builder

The Splunk Add-on Builder is only intended for use on a single-instance development environment, such as a laptop.

Notes
  • Do not install the Splunk Add-on Builder app in a production Splunk environment with real users.
  • Do not install the Splunk Add-on Builder app in a search head cluster or index cluster environment.

Requirements

Requirements for the Splunk Add-on Builder:

  • Splunk Enterprise
  • Splunk Enterprise 6.3.3 or 6.4.0 is required, running on a single-instance development environment such as a laptop.

      For more about Splunk Enterprise system requirements, see System Requirements in the Splunk Enterprise Installation Manual.

      Note  Add-on Builder is not supported in a search head cluster or index cluster environment.

  • Google Chrome or Microsoft Internet Explorer 11
  • Admin privileges on Splunk Enterprise
  • Without admin privileges, you cannot create an add-on project, or create and run modular inputs for data collection.

  • The Splunk Common Information Model (CIM) add-on
  • This add-on is required for CIM mapping, which you apply to normalize your data fields.

Download and install the Splunk Add-on Builder app

  1. Download the Splunk Add-on Builder from Splunkbase.
  2. Log into Splunk Web.
  3. Click the Manage Apps icon.
  4. On the Apps page, click Install app from file.
  5. Click Choose File, navigate to and select the Splunk Add-on Builder package file, then click Open.
  6. Click Upload.


To install the Splunk Add-on Builder app from the command line:

  • At the command line, enter:
  • splunk install app <path>/splunk_app_addon-builder.spl
  • Alternatively, unpack the file and then copy the /splunk_app_addon-builder directory to $SPLUNK_HOME/etc/apps.


Note  Ensure that the /splunk_app_addon-builder directory and its files have proper permissions and ownership so that Splunk Enterprise can read and write to them.

 

Upgrade the Splunk Add-on Builder app

When upgrading the Add-on Builder app, use Splunk Web.

Note  Do not delete the $SPLUNK_HOME/etc/apps/splunk_app_addon-builder folder directly before upgrading the app, or else your previously-created Add-on Builder projects will no longer be configurable within the Add-on Builder.
  1. Download the Splunk Add-on Builder from Splunkbase.
  2. Log into Splunk Web.
  3. Click the Manage Apps icon.
  4. On the Apps page, click Install app from file.
  5. Click Choose File, navigate to and select the Splunk Add-on Builder package file, then click Open.
  6. Select Upgrade app.
  7. Click Upload.
Last modified on 08 August, 2016
PREVIOUS
Learn more and get help
  NEXT
What to know before you build add-ons

This documentation applies to the following versions of Splunk® Add-on Builder: 1.1.0


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters