deployment.conf

deployment.conf

Deployment.conf contains settings for configuring both deployment servers and clients.

deployment.conf.spec

# Copyright (C) 2005-2008 Splunk Inc.  All Rights Reserved.  Version 3.0
#
# This file contains possible attributes and values for configuring deployment settings for both 
# a Deployment Server and Deployment Clients in deployment.conf.
#
# There is NO DEFAULT deployment.conf.  
# To set custom configurations, place a deployment.conf in $SPLUNK_HOME/etc/system/local/. 
# For examples, see deployment.conf.example. You must restart Splunk to enable configurations.
#
# To learn more about configuration files (including precedence) please see the documentation 
# located at http://www.splunk.com/base/Documentation/latest/Admin/HowDoConfigurationFilesWork.
#******************************************************************************
# SERVER SETTINGS: These settings are for the Deployment Server (not client).
# The Deployment Server is the Splunk instance that pushes configs to Deployment Clients.
#******************************************************************************
[distributedDeployment]
serverClassPath=/opt/splunk/etc/modules/distributedDeployment/classes
        * The directory which contains the base of your server class configuration directories.
        * Defaults to $SPLUNK_HOME/etc/modules/distributedDeployment/classes
[distributedDeployment-classMaps]
www.* = web,apache
10.1.*.1 = osx
        * Map IP ranges or DNS entries to server classes.
        * You can put a wildcard (*) anywhere in the string.
        
        
#****************************************************************************** 
# MULTICAST: The following settings are only for multicast configuration (as opposed to polling).
# Only use this group of tags if you are using multicast to notify deployment clients.
[distributedDeployment-multicast]
        * Set multicast configuration options under this stanza name.
        * Follow this stanza name with any number of the following attribute/value pairs.  
        * If you do not specify an entry for each attribute, Splunk uses the default value.
sendMulticast = <true/false>
        * To use multicast, set this to true.
        * Defaults to false.
multicastUri = <IP:Port>
        * Which multicast group to send to.  
        * Only used if 'sendMulticast = true'.
        * Multicast is disabled if this field is not set.
        * No default.
interfaceIP = <IP Address>
        * The IP address of the interface to send multicast packets on.
        * Defaults to whatever the kernel picks (usually sufficient).
frequency = <integer>
        * How often (in seconds) to send multicast packets.
        * Defaults to 30 seconds.
useDNS = <true/false>
        * Look up host name.
        * Defaults to false.
#******************************************************************************
# CLIENT SETTINGS: These settings are for Deployment Clients.
# Deployment Clients are Splunk instances that receive configs from the Deployment Server.
#******************************************************************************
# NOTE: You do not need to write these settings in deployment.conf if you enable the client
# from the CLI using ./splunk set deploy.  These settings are written out automatically.
[deployment-client]
deploymentServerUri = <IP:Port, IP2:Port2, etc>
        * List of deployment servers to poll.
        * Use this setting concurrently with multicast, but typically it is used instead of multicast.
pollingFrequency = <integer>
        * How often (in seconds) to poll each deployment server listed in 'deploymentServerUri'.
        * Only used if deploymentServerUri is specified.
maxBackoff = <integer>
        * Back off polling the deployment server at a random number between 0 and <integer> (in seconds).
        * The more deployment clients controlled by a single deployment server, the higher this number should be.  
        * maxBackoff effectively "smooths" the number of concurrent requests on the server.
serverClasses = <comma separated list>
        * List of server classes that this deployment client is a member of. 
        * Usually set on the server side, under [distributedDeployment-classMaps].
        * If not set on the server side, specify membership here.
#******************************************************************************
# Multicast configuration -- these settings are only necessary if you are using multicast.
multicastUri = <IP:Port, IP2:Port2, etc>
        * A comma-separated list of multicast addresses for deployment server instructions. 
        * Each deployment server needs to be in control over a unique set of server classes.  
        * Typically there is one entry in this list, or it is left blank.
mcastInterfaceIp = <IP Address>
        * Use the physical interface bound to this IP address to listen to multicasts. 
        * Only set this if using multicast.

deployment.conf.example

# Copyright (C) 2005-2008 Splunk Inc.  All Rights Reserved.  Version 3.0
#
# This is an example deployment.conf.  Use this file to configure deployment.
#
# There is NO DEFAULT deployment.conf. 
#
# To use one or more of these configurations, copy the configuration block into deployment.conf 
# in $SPLUNK_HOME/etc/system/local/.  You must restart Splunk to enable configurations.
#
# To learn more about configuration files (including precedence) please see the documentation 
# located at http://www.splunk.com/base/Documentation/latest/Admin/HowDoConfigurationFilesWork.
#################
# Server settings
[distributedDeployment]
serverClassPath=/opt/splunk/etc/modules/distributedDeployment/classes
        # Path to the server class configuration files.
        # By default, this example directory does not exist -- you must create your own.
# Multicast configuration
[distributedDeployment-multicast]
sendMulticast=true
multicastUri=225.0.0.39:9999
        # Enable multicast
        
# Class map settings
        
[distributedDeployment-classMaps]
www.* = web,apache
10.1.1.2* = osx
        # Map server classes to host names and IP addresses
#################
# Client settings
[deployment-client]
multicastUri=225.0.0.39.9999
        # This stanza enables a distributed deployment client which listens on the same 
        # multicast IP as the above server sends.

• Was this topic useful?
• Post a comment