Options for submitting content
There are two content types that you can submit to Splunkbase.
Apps are self-service extensions that have their own UI contexts. Apps offer specialized insight into data and systems with pre-configured dashboards, reports, data inputs, and saved searches. Apps can include new views and dashboards that completely reconfigure the way Splunk looks, or they can be as complex as a new program using Splunk's REST API. Once installed, users select your app from the App list in the upper right-hand corner of Splunk Web.
Add-ons are reusable components that can change the look and feel of the Splunk platform, add data sources, or share information between users. Add-ons can be as simple as a collection of one or more event type definitions or saved searches. Unlike apps, add-ons have no standalone GUI component.Tthey don't show up in the Home list or in the Apps menu in Splunk Web.
When you submit content to Splunkbase, you provide information about how you want to categorize, host, license, and support your content.
Content category
You can choose a category for your app or add-on as part of its description during submission. These are the categories you can choose:
- IT Operations
- Security, Fraud & Compliance
- Business Analytics
- Utilities
- IoT & Industrial Data
- DevOps
- Directory Service
- Endpoint
- Firewall
- Generic
- Identity Management
- Information
- Investigative
- Network Access Control
- Network Device
- Network Security
- Reputation
- Sandbox
- SIEM
- Threat Intel
- Ticketing
- Virtualization
- Vulnerability Scanner
Licenses for content hosted on Splunkbase
You can designate your own end-user license or you can choose the default End User License Agreement for Third-Party Content.
You can also choose other license types by entering another license name and URL. For more information on choosing an open source license for your content, see http://choosealicense.com.
Host content
Your app or add-on can either be hosted on Splunkbase or externally, also known as a directory listing. You cannot switch between these hosting options after you publish your app or add-on, so decide which type you want before you submit.
You might want to Splunkbase to host your content in these scenarios:
- You want the Splunkbase team to host the content.
- You are not planning to sell or monetize your app or add-on.
- You are satisfied with the licensing options.
- You do not require lead generation information or email notifications when someone downloads your app or add-on.
You might decide to host your content as a directory listing instead of Splunkbase in these scenarios:
- You want to sell your app or add-on, or monitize it in some way. Splunkbase does not support financial transactions.
- You want to implement licensing options that are not provided when the app or add-on is hosted on Splunkbase.
- You want manage lead generation regarding your app or add-on.
With a directory listing, your content can be available for free or for a fee with your own financial transaction platform and access provisioning.
Restrict access
If you're planning to charge for your content, or you want to restrict access to it for another reason, you can specify that its access level is restricted. When your app or add-on is approved and published on Splunkbase, the Download button on the product on Splunkbase page sends interested users to a specified URL. You must set up a site at the specified URL so that interested users can provide their splunk.com user ID, which is required to enable a specific Splunk.com user account to download your app or add-on. You can then use either the Splunkbase Entitlement API to tell Splunkbase which users can download your content, or you can specify them on the Manage App page for your content. See Manage app downloads from Splunkbase.
Support content
You can choose whether to provide technical support for your Splunkbase app or add-on.
| Type | Description |
|---|---|
| Splunk-supported | Apps and add-ons published by Splunk Inc. that are supported and maintained by Splunk. Splunk will provide customers with active support subscriptions an initial response and acknowledgement to any support request for these apps or add-ons in accordance with Splunk Support terms. Splunk will also ensure compatibility of Splunk-supported apps and add-ons with future releases of applicable Software. Splunk ensures this compatibility for any Splunk-supported apps or add-ons installed in Splunk Cloud Platform before commencing Splunk Cloud Platform upgrades. Splunk does not provide support or maintenance for apps or add-ons published by any party other than Splunk Inc., including third-party developers. |
| Developer-supported | Apps and add-ons published by parties other than Splunk Inc. Any support or maintenance for these apps and add-ons is provided by the developer, whose contact information can be found on the download page. Splunk reserves the right to remove the Developer-supported classification of third-party apps and add-ons if the developer is not, in Splunk's determination, fulfilling reasonable obligations for support and maintenance. Customers are responsible for engaging directly with the developer of Developer-supported apps and add-ons to ensure proper functionality and version compatibility with the applicable Splunk software. If functional or compatibility issues that may arise are not resolved, customers may be required to uninstall the app or add-on from their Splunk environment in order for Splunk to fulfill support obligations. For Splunk Cloud Platform customers, the Service Level Commitment and Service Level Credit in the Splunk Service Level Schedule will not apply for any issues caused by Developer-supported apps or add-ons. |
| Not-supported | Apps and add-ons published either by Splunk or third-party developers. Indicates that no support or maintenance are provided by the publisher. Information from the user community might be available from sources such as Splunk Answers. Customers are solely responsible for ensuring proper functionality and version compatibility of Not-supported apps and add-ons with the applicable Splunk software. If unresolvable functional or compatibility issues are encountered, customers may be required to uninstall the app or add-on from their Splunk environment in order for Splunk to fulfill support obligations. For Splunk Cloud Platform customers, the Service Level Commitment and Service Level Credit in the Splunk Service Level Schedule will not apply to issues caused by Not-Supported apps or add-ons. |
Document content
You can make documentation available on the product page on Splunkbase, or you can provide this content on your own site. Provide both step-by-step and conceptual documentation on how to get the most out of your app or add-on.
- Know your audience. Who are the intended users of your app or add-on? What do you expect a user of your app to know before starting? Do you expect your users to know how to write a regular expression or a Splunk search? Do they need to know statistics or networking concepts? Be clear about the prerequisites for using your app.
- Include detailed steps and examples of how to use your app. You should also include how to install your app or add-on.
- Provide links out to other needed material. Link to topics in the Splunk platform documentation to provide context or background relating to your content.
- Use clear, simple language whenever possible. Users of your app might not be native English speakers.
Documentation structure
You can organize your documentation that help your users understand your app or add-on. These are suggested documentation sections that might be relevant and useful:
- Table of contents: A table of contents allows your users to see what information is available and access different sections easily.
- Introduction: Include a brief description of the goals and features of your app.
- Prerequisites: List any content that your app needs to function correctly. List any specific hardware or licensing requirements that your app needs. Explain any technologies or concepts that your users need.
- Architecture: Describe the structure of your app. If your app contains many components and/or is to be installed on different Splunk components (such as forwarders, deployment servers, indexers, search heads, etc), then a diagram is especially helpful. You can upload images if you are hosting your documentation on Splunkbase.
- Installation: Provide detailed, sequence-ordered steps for installing your app or add-on. If required, explain any specific commands.
- Use cases: Explain how to use your app to reach the goals you state in your introduction. If possible, provide a separate section for each unique use case, with detailed instructions for achieving the desired outcome.
- Upgrade instructions: If you can upgrade this version release of your app from a previous version, provide detailed instructions on how to do so, as well as any relevant changes in structure or operation your existing users should expect.
- Reference material: If your app includes lookup tables, saved searches, scripted inputs, or other similar knowledge objects, it's useful to provide details about them so your users know what's included and how to use them in your app. You can list them in detail, or describe where to find them within the package.
Contact information
Use the email address of your Splunk user account to submit your content. The address provided also receives notifications users post a question to Splunk Answers tagged with your app's tag.