Manage private apps in your Splunk Cloud deployment
Private apps are Splunk apps that are private to your Splunk Cloud deployment. These apps are not publicly available on Splunkbase. Like all Splunk apps, private apps must be approved by Splunk to be installed on your Splunk Cloud deployment. Splunk uses the validation tool AppInspect to determine if apps comply with the security requirements of Splunk Cloud. For information about AppInspect, see Splunk Appinspect tool on the Splunk developer portal.
In managed Splunk Cloud deployments, you can use Splunk App Management to manage and install private apps. You must be a Splunk Cloud administrator to manage and install private apps in your Splunk Cloud deployment. In self-service Splunk Cloud deployments, the Splunk App Management feature is not available. File a Support ticket to install private apps.
Create a private app
- See the Building Splunk Apps documentation on Splunkbase.
- For information about dependencies, see the Splunk Packaging Toolkit.
- For information about Appinspect, see Splunk AppInspect tool on the Splunk developer portal.
- Create an app that conforms to Splunk app standards and requirements.
- Make sure the app package does not have any static dependencies, because only dynamic dependencies are supported.
- Package the app as a .tgz, .spl, .zip or .gz file. Keep the package size limited to 128MB.
- Run the app through AppInspect and make sure it passes all app validation checks.
The file is ready to be installed on your Splunk Cloud deployment. If you have a managed Splunk Cloud deployment, you can install and manage your private app yourself. If you have a self-service Splunk Cloud deployment, file a Splunk Support ticket to proceed. If you aren't sure whether your Splunk Cloud deployment is self-service or managed, see Types of Splunk Cloud deployment.
Upload and manage private apps in managed Splunk Cloud deployments
In a managed Splunk Cloud deployment, you can upload, install, update, and view reports for your private apps.
Upload a private app
- In Splunk Web, click the Apps gear.
- Click the Uploaded Apps tab.
- Click Upload App.
- Enter your splunk.com credentials. These credentials are used to authenticate with AppInspect.
- Select the consent check box and click Login.
- Select the private app package that you created.
- Click Upload.
This uploaded package is private to your Splunk Cloud deployment. It is stored in your Splunk Cloud deployment and not on Splunkbase.
The Uploaded Apps table provides the following information:
|App||If the package is approved, the app name is displayed.|
If the package is not approved, the file name of the uploaded package is displayed.
|Status||Displays the status of the package in the validation process.|
For details, see the next section, Status.
|Actions||Shows what actions you can take on the package.|
|Date Submitted||Shows when the package was uploaded.|
|Version||If the package is approved, the app version is displayed.|
If the package is not approved, N/A is displayed.
Based on the result of the app validation process, status can be one of the following:
- Vetting – Package is in the validation process.
- Approved – Package has passed all AppInspect checks and is ready to be installed.
- Installed – Package is installed on your Splunk Cloud deployment.
- Rejected – Package did not pass AppInspect checks. This means that either some checks failed, or some manual checks were detected that must be reviewed by the Splunk AppInspect team. Click View Report to see which checks failed.
- Failed message – Package validation did not complete due to some issues, for example, issues with the AppInspect service. Click More Info to find out why the package failed validation.
Install a private app
- Use the Uploaded Apps table to verify that the status of your package is Approved. Your package must be approved before you can install it.
- Click Install to install your private app.
- Click the Apps tab to see that your private app is listed in the Apps table. You can also see that the value for App Origin is Uploaded.
Update a private app
- If you are installing an earlier version, uninstall the currently installed app.
- Upload your private app.
- Verify that the app status is Approved in the Uploaded Apps table.
- Click Install to install an earlier version. Click Update to replace an installed app with a later version.
- Go to the Apps tab to see that the later version of your private app is listed in the Apps table.
View Report of a private app
- Click View Report to see the AppInspect report for your package.
- Use this report to find out why AppInspect rejected the package.
- Make the required changes to the package and try uploading again.
Make private apps reloadable
When you install an app, the app might trigger a rolling restart, which can make your Splunk Cloud deployment temporarily unavailable.
Whether an app triggers a rolling restart depends on whether the app contains configuration files that require a restart, such as custom configuration files or other configuration files not explicitly listed in the
[triggers] stanza in
To reduce interruptions to your Splunk Cloud deployment caused by rolling restarts, you can pre-configure your private apps to reload instead of restart any custom configuration files that your app contains.
To make a configuration file reloadable, add a
reload.<conf_file_name> = simple entry specifying the configuration file name under the
[triggers] stanza in the private app's
For more information, see Make a configuration file reloadable in the Splunk Enterprise documentation.
Install apps in your Splunk Cloud deployment
Manage a rolling restart in Splunk Cloud
This documentation applies to the following versions of Splunk Cloud™: 8.0.1