docs/attributes.md
Attributes
==========
In depth look at all attributes available for this cookbook.
Required
----------
* `node['splunk']['config']['clusters']` - Array of strings "data_bag/data_bag_item" identifying the [databags](databags.md) containing cluster/site information to connect to.
Configurable (with defaults)
-----------------------------
* `node['splunk']['exclude_groups']` - Array of local groups to which the splunk user should not belong. Checking existing memberships and removing the splunk user from these groups during the chef run only works on Chef 11.10+, users of prior versions should remove the splunk user from these groups manually. (`['root','wheel','admin']`)
* `node['splunk']['groups']` - Array of local groups to which splunk user should be a member in addition to `node['splunk']['group']`. ([] - no additional groups)
* `node['splunk']['user_home']` - The home directory to set for the splunk user. If unset the home directory will be the one created by the splunk package install in node['splunk']['home'] (nil - no default)
* `node['splunk']['main_project_index']` - Index to send all configured monitors to by default (nil - no default)
* `node['splunk']['monitors']` - Array of Hashes, to setup Monitoring stanzas (empty - no monitors)
* `node['splunk']['monitors'][]['path']` - Path to monitor !!Required!!
* `node['splunk']['monitors'][]['sourcetype']` - Sourcetype to set on events from this stanza !!Required!!
* `node['splunk']['monitors'][]['index']` - Index to send events from this monitor to (`node['splunk']['main_project_index']`).
* `node['splunk']['monitors'][]['type']` - Type of stanza (`monitor`). See [inputs.conf][] for stanzas.
* `node['splunk']['monitors'][][???]` - Other attributes for an inputs.conf stanza. See [inputs.conf][]
* `node['splunk']['cleanup']` - Determines whether the recipe should attempt to clean up the old forwarder install (`true`)
* `node['splunk']['package']['version']` - Major version to install (`9.0.5`)
* `node['splunk']['package']['build']` - Corresponding build number (`e9494146ae5c`)
* `node['splunk']['package']['base_url']` - Base download path (`https://download.splunk.com/products`)
* `node['splunk']['package']['base_name']` - Name of the package to install (`splunkforwarder`/`splunk`)
* `node['splunk']['package']['name']` - Name of the package being installed (`"#{node['splunk']['package']['base_name']}-#{node['splunk']['package']['version']}-#{node['splunk']['package']['build']}"`)
* `node['splunk']['package']['download_group']` - URI Path segment grouping for the the download path (`universalforwarder`/`splunk`)
* `node['splunk']['package']['platform']` - URI Path segment indicating OS type (`node['os']`)
* `node['splunk']['package']['file_suffix']` - URI path portion, suffix to append after building (set based on ohai attributes)
* `node['splunk']['package']['file_name']` - Actual package file name (`"#{node['splunk']['package']['name']}#{node['splunk']['package']['file_suffix']}"`)
* `node['splunk']['package']['url']` - Full URI to the Splunk package to download (Constructed from above package attributes)
* `node['splunk']['package']['authorization']` - A Contextual Hash of coordinate strings (see [data bags documentation][data_bags]) pointing to a key within a data bag item containing the Authorization header value for retrieving the splunk package. (nil - no default)
* `node['splunk']['config']['alerts']` - Data bag item used to configure alerts (`nil` - alerts not managed by chef)
* `node['splunk']['config']['authentication']` - Data bag item used to configure authentication (`nil` - authentication not managed by chef)
* `node['splunk']['config']['host']` - Hostname to configure the Splunk instance to report as. (EC2 Instance ID or Fully Qualified Domain Name)
* `node['splunk']['config']['roles']` - Data bag item used to configure roles (`nil` - roles not managed by chef)
* `node['splunk']['config']['secrets']` - A Contextual Hash of coordinate strings (see [data bags documentation][data_bags]), pointing to a key within a data bag item used to configure the splunk.secret file. (`nil` - secrets not managed by chef). Note: this is currently not supported on windows.
* `node['splunk']['config']['admin_password']` - A Contextual Hash of coordinate strings (see [data bags documentation][data_bags]), pointing to a key within a data bag item used to configure the local admin password. (`nil` - password is randomly generated and changed on every chef-client run).
* `node['splunk']['config']['sslPassword']` - Sets the sslPassword config under the sslConfig stanza in server.conf. This needs to match any app overrides you have as it is set in `$SPLUNK_HOME/etc/system/local/server.conf`.
* `node['splunk']['config']['licenses']` - Data bag item that the license server recipe uses as the source of truth for the license data.
* `node['splunk']['config']['license-pool']` - Data bag item used to configure license pools.
* `node['splunk']['config']['ui_prefs']` - Hash of stanzas used to configure [ui-prefs.conf][] on the search head in a clustered configuration or a standalone instance.
* `node['splunk']['config']['assumed_index']` - Name of the index to which data is forwarded to by default, when the index is not configured for the input.(`main`)
* `node['splunk']['bootstrap_shc_member']` - Set this attribute to `true` to bootstrap a member to the Search Head Cluster (SHC). (`false`)
* `node['splunk']['heavy_forwarder']['use_license_uri']` - Set this attribute to `true` to point the Heavy Forwarder to the license master. (`false`)
* `node['splunk']['apps']` - An [apps hash](databags.md#apps-hash) of apps to configure locally.
* `node['splunk']['data_bag_secret']` - The location of the shared secret file if your encrypted data bags are encrypted via shared secret rather than chef-vault. If this is not specified, and the encrypted data bags are using shared secret encryption then chef looks for a secret at the path specified by the encrypted_data_bag_secret setting in the client.rb file.
* `node['splunk']['forwarder_site']` - Set this attribute to configure site awareness for your forwarders.(`site0`)
* `node['splunk']['mgmt_host']` - The host other SHC members use when connecting to the current node. You probably want a wrapper cookbook to override this. By default `node['splunk']['mgmt_interface']` is now used, but to support existing configurations this attribute is still available and takes precedence when set. (`nil`)
* `node['splunk']['mgmt_interface']` - The network interface this node should use for communicating with other members of a SHC. (`node['network']['default_interface']`)
* `node['splunk']['is_cloud']` - Set this attribute to `true` on cloud instances for Search Head Cluster (SHC). (`false`)
* `node['splunk']['boot_start_args']` - Set splunk enabled boot-start arguments here. (` -systemd-managed 0`)
* `node['splunk']['logs']` - Specify the contents of log-local.cfg, to override the default settings of Splunk's internal logging.
* `node['splunk']['ignore_already_installed_instance']` - Set this attribute to `true` to allow the installation of a universal fowarder along side a full splunk installation. This will need to be a completely separate chef run.
* `node['splunk']['systemd_unit_file_name']` - Allows the changing of the systemd unit file name.
Non-configurable (defaults)
----------------------------
DO NOT override these attributes. [Funky Putin shows scientists what for](http://vimeo.com/68930177) every time you think of overriding these attributes. So don't do it.
* `node['splunk']['node_type']` - The type of node (name of the installation recipe)
* `node['splunk']['user']` - The user to run as (`splunk`)
* `node['splunk']['group']` - The group to run as (`splunk`)
* `node['splunk']['home']` - Splunk Install path (`/opt/#{node['splunk']['package']['base_name']}`)
* `node['splunk']['cmd']` - `splunk` executable (`/opt/#{node['splunk']['package']['base_name']}/bin/splunk`)
* `node['splunk']['external_config_directory']` - directory to place configuration related to this chef run of Splunk ('/etc/splunk')
Docs Navigation
===============
* [Docs Readme](README.md)
* [Repository Readme](../README.md)
[data_bags]: databags.md#contextual-hashes
[inputs.conf]: http://docs.splunk.com/Documentation/Splunk/6.0.1/admin/Inputsconf
[ui-prefs.conf]: http://docs.splunk.com/Documentation/Splunk/6.0.1/Admin/Ui-prefsconf