deploymentclient.conf

deploymentclient.conf

The following are the spec and example files for deploymentclient.conf.

deploymentclient.conf.spec

# Copyright (C) 2005-2010 Splunk Inc.  All Rights Reserved.  Version 4.1.5
#
# This file contains possible attributes and values for configuring a deployment client to receive
# content (apps and configurations) from a deployment server. 
# 
# To customize the way a deployment client behaves, place a deploymentclient.conf in $SPLUNK_HOME/etc/system/local/ 
# on that Splunk instance. Configure what apps/configuration content is deployed to a given deployment client in 
# serverclass.conf. Refer to serverclass.conf.spec and serverclass.conf.example for more information. 
#
# You must restart Splunk for changes to this configuration file to take effect.
#
# To learn more about configuration files (including precedence) please see the documentation 
# located at http://www.splunk.com/base/Documentation/latest/Admin/Aboutconfigurationfiles

#***************************************************************************
# Configure a Splunk deployment client.
# 
# Note: At a minimum the [deployment-client] stanza is required in deploymentclient.conf for
# deployment client to be enabled.
#***************************************************************************

[deployment-client]

disabled = <false or true>
    * Defaults to false
    * Enable/Disable deployment client.

clientName=deploymentClient
    * also referred to as 'tag'. Defaults to 'deploymentClient'.
    * a name that can be used to filter on by deployment server, and takes precedence over dns names.
    
workingDir=$SPLUNK_HOME/var/run/deploy-client
    * temporary folder used by the deploymentClient to download apps and configuration content.

repositoryLocation = $SPLUNK_HOME/etc/apps
    * The location into which content is installed after being downloaded from a deployment server.
    * Apps and configuration content must be installed into the default location ($SPLUNK_HOME/etc/apps) or it will not be recognized by the Splunk instance on the deployment client. 
    * Note: Apps and configuration content to be deployed may be located in an alternate location on the deployment server, so you may wish to set repositoryLocation and serverRepositoryLocationPolicy to ensure that the content is installed into the correct location ($SPLUNK_HOME/etc/apps) on the deployment client. 
    * The deployment client will use the 'serverRepositoryLocationPolicy' defined below to determine which value of repositoryLocation to use.

serverRepositoryLocationPolicy = < one of acceptSplunkHome, acceptAlways, rejectAlways>
    * defaults to 'acceptSplunkHome'.
    * acceptSplunkHome - accept the repositoryLocation supplied by the deployment server, only if it is rooted by $SPLUNK_HOME.
    * acceptAlways - always accept the repositoryLocation supplied by the deployment server.
    * rejectAlways - reject the server supplied value and only use the repositoryLocation specified in the local deploymentclient.conf.

endpoint=$deploymentServerUri$/services/streams/deployment?name=$serverClassName$:$appName$
    * The HTTP endpoint from which content should be downloaded.
    * Note: The deployment server may specify a different endpoint from which to download each set of content (individual apps, etc).
    * The deployment client will use the 'serverEndpointPolicy' defined below to determine which value to use.
    * $deploymentServerUri$ will resolve to 'targetUri' defined in the [target-broker] stanza below.
    * $serverClassName$ and $appName$ mean what they say.

serverEndpointPolicy = < one of acceptAlways, rejectAlways>
    * defaults to acceptAlways
    * acceptAlways - always accept the endpoint supplied by the server.
    * rejectAlways - reject the endpoint supplied by the server. Always use the 'endpoint' definition above.

phoneHomeIntervalInSecs = <N>
    * defaults to 30
    * This determines how frequently this deployment client should check for new content. 

# Advanced!
# You should use this property only when you have a hierarchical DS installation, and have a Splunk instance that behaves as both - a DeploymentClient as well as a DeploymentServer.
reloadDSOnAppInstall = <false or true>
    * Defaults to false
    * Setting this flag to true will cause the DeploymentServer on this Splunk to be reloaded, whenever an app is installed by this DeploymentClient.

# The following stanza specifies deployment server connection information

[target-broker:deploymentServer]

targetUri= <deploymentServer>:<mgmtPort>
    * URI of the deployment server.

deploymentclient.conf.example

# Copyright (C) 2005-2010 Splunk Inc.  All Rights Reserved.  Version 4.1.5 
#
# Example 1
# Deployment client receives apps and places them into the same repositoryLocation 
# (locally, relative to $SPLUNK_HOME) as it picked them up from. This is typically $SPLUNK_HOME/etc/apps. 
# There is nothing in [deployment-client] because the deployment client is not overriding the value set 
# on the deployment server side.

[deployment-client]

[target-broker:deploymentServer]
targetUri= deploymentserver.splunk.mycompany.com:8089


# Example 2
# Deployment server keeps apps to be deployed in a non-standard location on the server side 
# (perhaps for organization purposes). 
# Deployment client receives apps and places them in the standard location. 
# Note: Apps deployed to any location other than $SPLUNK_HOME/etc/apps on the deployment client side 
# will not be recognized and run. 
# This configuration rejects any location specified by the deployment server and replaces it with the 
# standard client-side location. 

[deployment-client]
serverRepositoryLocationPolicy = rejectAlways
repositoryLocation = $SPLUNK_HOME/etc/apps

[target-broker:deploymentServer]
targetUri= deploymentserver.splunk.mycompany.com:8089


# Example 3
# Deployment client should get apps from an HTTP server that is different from the one specified by 
# the deployment server. 

[deployment-client]
serverEndpointPolicy = rejectAlways
endpoint = http://apache.mycompany.server:8080/$serverClassName$/$appName$.tar

[target-broker:deploymentServer]
targetUri= deploymentserver.splunk.mycompany.com:8089


# Example 4
# Deployment client should get apps from a location on the file system and not from a location specified 
# by the deployment server

[deployment-client]
serverEndpointPolicy = rejectAlways
endpoint = file:/<some_mount_point>/$serverClassName$/$appName$.tar

[target-broker:deploymentServer]
targetUri= deploymentserver.splunk.mycompany.com:8089

• Was this topic useful?
• Post a comment