Deploy apps and configurations
This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Contents
Deploy apps and configurations
After configuring the deployment server and clients, two steps remain:
1. Put the new or updated deployment content into deployment directories.
2. Inform the clients that it's time to download new content.
Create directories for deployment apps and place content in them
The location of deployment directories is configurable by means of the repositoryLocation attribute in serverclass.conf, as described in "Define server classes". The default location for deployment directories is $SPLUNK_HOME/etc/deployment-apps. Note that this default directory needs to be created manually. Each app must have its own subdirectory, with the same name as the app itself, as specified in serverclass.conf.
This example creates a deployment directory in the default repository location, for an app named "fwd_to_splunk1":
mkdir –p $SPLUNK_HOME/etc/deployment-apps/fwd_to_splunk1/default
Place the content for each app into the app's subdirectory. To update the app by with new or changed content, just add or overwrite the files in the directory.
Inform clients of new content
When you first configure the deployment server, and whenever you update its configuration by editing serverclass.conf, you'll need to restart or reload it for the changes to take effect. The clients will then pick up any new or changed content in configuration and in apps. You may use the CLI reload command instead of restarting the server.
To use Splunk's CLI, change to the $SPLUNK_HOME/bin/ directory and use the ./splunk command. (On Windows, you do not need to include the ./ beforehand.)
This command checks all server classes for change and notifies the relevant clients:
./splunk reload deploy-server
This command notifies and updates only the server class you specify:
./splunk reload deploy-server -class <server class>
For example:
./splunk reload deploy-server -class www
In this example, the command notifies and updates only the clients that are members of the www server class.
Confirm the deployment update
To confirm that all clients received the configuration correctly, run this command from the deployment server:
./splunk list deploy-clients
This lists all the deployment clients and specifies the last time they were successfully synced.
This documentation applies to the following versions of Splunk: 4.1 , 4.1.1 , 4.1.2 , 4.1.3 , 4.1.4 , 4.1.5 , 4.1.6 , 4.1.7 , 4.1.8 View the Article History for its revisions.