From 463f5f8e1c9f85ba6f6d843c987c28798730bfd1 Mon Sep 17 00:00:00 2001 From: Ben Dalling Date: Sat, 21 Nov 2015 12:19:47 +0000 Subject: [PATCH] Create gh-pages branch via GitHub --- index.html | 3749 +-------------------------------------------------- params.json | 2 +- 2 files changed, 8 insertions(+), 3743 deletions(-) diff --git a/index.html b/index.html index e6a702e0b..9a3b11552 100644 --- a/index.html +++ b/index.html @@ -29,3757 +29,22 @@

Installs Cassandra, DataStax Agent & OpsCenter on RHEL/Ubuntu/Debian.

-Cassandra

+Overview

-

Puppet Forge -Github Tag -Build Status -Coverage Status -Join the chat at https://gitter.im/locp/cassandra

+

This is a Puppet module for installing Cassandra by DataStax.

-

-Table of Contents

- -
    -
  1. Overview
    2. -
  2. -Setup - The basics of getting started with Cassandra - - -
    3. -
  3. -Usage - Configuration options and additional functionality +

    +Links

    -
    4. +
  4. https://forge.puppetlabs.com/locp/cassandra
  5. -Reference - An under-the-hood peek at what the module is doing and how +https://github.com/locp/cassandra
    6. -
  6. Limitations - OS compatibility, etc.
    7. -
  7. Contributers
    8. -
- -

-Overview

- -

A Puppet module to install and manage Cassandra, DataStax Agent & OpsCenter

- -

-Setup

- -

-What Cassandra affects

- -

-What the Cassandra class affects

- - - -

-What the cassandra::datastax_agent class affects

- - - -

-What the cassandra::datastax_agent class affects

- - - -

-What the cassandra::firewall_ports class affects

- - - -

-What the cassandra::java class affects

- - - -

-What the cassandra::opscenter class affects

- - - -

-What the cassandra::opscenter::cluster_name type affects

- - - -

-What the cassandra::opscenter::pycrypto class affects

- - - -

-What the cassandra::optutils class affects

- - - -

-Beginning with Cassandra

- -

A basic example is as follows:

- -
  class { 'cassandra':
-    cluster_name    => 'MyCassandraCluster',
-    endpoint_snitch => 'GossipingPropertyFileSnitch',
-    listen_address  => "${::ipaddress}",
-    seeds           => '110.82.155.0,110.82.156.3'
-  }
- -

-Upgrading

- -

-Changes in 1.8.0

- -

A somewhat embarrassing correction to the spelling of the -cassandra::fail_on_non_suppoted_os to cassandra::fail_on_non_supported_os.

- -

-Issues when Upgrading to 1.4.0

- -

Unfortunately both releases 1.3.7 and 1.4.0 have subsequently been found to -call a refresh service even when no changes had been made to the underlying -configuration. In release 1.8.0 (somewhat belatedly) the service_refresh -flag has been introduced to mitigate against similar problems.

- -

-Issues When Upgrading to 1.3.7

- - - -

-Changes in 1.0.0

- - - -

-Changes in 0.4.0

- -

There is now a cassandra::datastax_agent class, therefore:

- - - -

Likewise now there is a new class for handling the installation of Java:

- - - -

Also there is now a class for installing the optional utilities:

- - - -

-Changes in 0.3.0

- - - -

-Usage

- -

-Create a Cluster in a Single Data Center

- -

In the DataStax documentation Initializing a multiple node cluster (single -data center) -http://docs.datastax.com/en/cassandra/2.2/cassandra/initialize/initSingleDS.html -there is a basic example of a six node cluster with two seeds to be created in -a single data center spanning two racks. The nodes in the cluster are:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Node NameIP Address
node0 (seed 1)110.82.155.0
node1110.82.155.1
node2110.82.155.2
node3 (seed 2)110.82.156.3
node4110.82.156.4
node5110.82.156.5
- -

Each node is configured to use the GossipingPropertyFileSnitch and 256 virtual -nodes (vnodes). The name of the cluster is MyCassandraCluster. Also, -while building the initial cluster, we are setting the auto_bootstrap -to false.

- -

In this initial example, we are going to expand the example by:

- - - -
node /^node\d+$/ {
-  class { 'cassandra::datastax_repo':
-    before => Class['cassandra']
-  }
-
-  class { 'cassandra::java':
-    before => Class['cassandra']
-  }
-
-  class { 'cassandra':
-    cluster_name    => 'MyCassandraCluster',
-    endpoint_snitch => 'GossipingPropertyFileSnitch',
-    listen_address  => "${::ipaddress}",
-    num_tokens      => 256,
-    seeds           => '110.82.155.0,110.82.156.3',
-    auto_bootstrap  => false
-  }
-}
- -

The default value for the num_tokens is already 256, but it is -included in the example for clarity. Do not forget to either -set auto_bootstrap to true or not set the parameter at all -after initializing the cluster.

- -

-Create a Cluster in Multiple Data Centers

- -

To continue with the examples provided by DataStax, we look at the example -for a cluster across multiple data centers -http://docs.datastax.com/en/cassandra/2.2/cassandra/initialize/initMultipleDS.html.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Node NameIP AddressData CenterRack
node0 (seed 1)10.168.66.41DC1RAC1
node110.176.43.66DC1RAC1
node210.168.247.41DC1RAC1
node3 (seed 2)10.176.170.59DC2RAC1
node410.169.61.170DC2RAC1
node510.169.30.138DC2RAC1
- -

For the sake of simplicity, we will confine this example to the nodes:

- -
node /^node[012]$/ {
-  class { 'cassandra':
-    cluster_name    => 'MyCassandraCluster',
-    endpoint_snitch => 'GossipingPropertyFileSnitch',
-    listen_address  => "${::ipaddress}",
-    num_tokens      => 256,
-    seeds           => '10.168.66.41,10.176.170.59',
-    dc              => 'DC1',
-    auto_bootstrap  => false
-  }
-}
-
-node /^node[345]$/ {
-  class { 'cassandra':
-    cluster_name    => 'MyCassandraCluster',
-    endpoint_snitch => 'GossipingPropertyFileSnitch',
-    listen_address  => "${::ipaddress}",
-    num_tokens      => 256,
-    seeds           => '10.168.66.41,10.176.170.59',
-    dc              => 'DC2',
-    auto_bootstrap  => false
-  }
-}
- -

We don't need to specify the rack name (with the rack parameter) as RAC1 is -the default value. Again, do not forget to either set auto_bootstrap to -true or not set the parameter at all after initializing the cluster.

- -

-OpsCenter

- -

To continue with the original example within a single data center, say we -have an instance of OpsCenter running on a node called opscenter which has -an IP address of 110.82.157.6. We add the cassandra::datastax_agent to -the cassandra node to connect to OpsCenter:

- -
node /^node\d+$/ {
-  class { 'cassandra::datastax_repo':
-    before => Class['cassandra']
-  } ->
-  class { 'cassandra::java':
-    before => Class['cassandra']
-  } ->
-  class { 'cassandra':
-    cluster_name    => 'MyCassandraCluster',
-    endpoint_snitch => 'GossipingPropertyFileSnitch',
-    listen_address  => "${::ipaddress}",
-    num_tokens      => 256,
-    seeds           => '110.82.155.0,110.82.156.3',
-    before          => Class['cassandra::datastax_agent']
-  } ->
-  class { 'cassandra::datastax_agent':
-    stomp_interface => '110.82.157.6'
-  }
-}
-
-node /opscenter/ {
-  include '::cassandra::datastax_repo' ->
-  include '::cassandra' ->
-  include '::cassandra::opscenter'
-}
- -

We have also added the cassandra::opscenter class for the opscenter node.

- -

-DataStax Enterprise

- -

After configuring the relevant repository, the following snippet works on -CentOS 7 to install DSE Cassandra 4.7.0:

- -
class { 'cassandra::datastax_repo':
-  descr   => 'DataStax Repo for DataStax Enterprise',
-  pkg_url => 'https://username:password@rpm.datastax.com/enterprise',
-  before  => Class['cassandra'],
-}
-
-class { 'cassandra':
-  cluster_name   => 'MyCassandraCluster',
-  config_path    => '/etc/dse/cassandra',
-  package_ensure => '4.7.0-1',
-  package_name   => 'dse-full',
-  service_name   => 'dse',
-}
- -

Also with DSE, one can specify a remote keyspace for storing the metrics for -a cluster. An example is:

- -
cassandra::opscenter::cluster_name { 'Cluster1':
-  cassandra_seed_hosts       => 'host1,host2',
-  storage_cassandra_username => 'opsusr',
-  storage_cassandra_password => 'opscenter',
-  storage_cassandra_api_port => 9160,
-  storage_cassandra_cql_port => 9042,
-  storage_cassandra_keyspace => 'OpsCenter_Cluster1'
-}
- -

-Reference

- -

-Public Classes

- - - -

-Public Defined Types

- - - -

-Private Defined Types

- - - -

-Class: cassandra

- -

A class for installing the Cassandra package and manipulate settings in the -configuration file.

- -

-Parameters

- -
-authenticator -
- -

This is passed to the -cassandra.yaml file. -Default value: 'AllowAllAuthenticator.

- -
-authorizer -
- -

This is passed to the -cassandra.yaml file. -Default value: 'AllowAllAuthorizer'

- -
-auto_bootstrap -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-auto_snapshot -
- -

This is passed to the -cassandra.yaml file. -Default value 'true'

- -
-batchlog_replay_throttle_in_kb -
- -

This is passed to the -cassandra.yaml file. -Default value: '1024'

- -
-batch_size_warn_threshold_in_kb -
- -

This is passed to the -cassandra.yaml file. -Default value 5

- -
-broadcast_address -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-broadcast_rpc_address -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-cas_contention_timeout_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '1000'

- -
-cassandra_9822 -
- -

If set to true, this will apply a patch to the init file for the Cassandra -service as a workaround for -CASSANDRA-9822. This -option is silently ignored on the Red Hat family of operating systems as -this bug only affects Ubuntu systems. -Default value 'false'

- -
-cassandra_yaml_tmpl -
- -

The path to the Puppet template for the Cassandra configuration file. This -allows the user to supply their own customized template. A Cassandra 1.X -compatible template called cassandra1.yaml.erb has been provided by @Spredzy. -Default value 'cassandra/cassandra.yaml.erb'

- -
-client_encryption_algorithm -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is client_encryption_options -> algorithm. -Default value: undef

- -
-client_encryption_cipher_suites -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is client_encryption_options -> cipher_suites. -Default value: undef

- -
-client_encryption_enabled -
- -

This is passed to the -cassandra.yaml file. -The field being set is client_encryption_options -> enabled. -Default value 'false'

- -
-client_encryption_keystore -
- -

This is passed to the -cassandra.yaml file. -The field being set is client_encryption_options -> keystore. -Default value 'conf/.keystore'

- -
-client_encryption_keystore_password -
- -

This is passed to the -cassandra.yaml file. -The field being set is client_encryption_options -> keystore_password. -Default value 'cassandra'

- -
-client_encryption_protocol -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is client_encryption_options -> protocol. -Default value: undef

- -
-client_encryption_require_client_auth -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is client_encryption_options -> require_client_auth. -Default value: undef

- -
-client_encryption_store_type -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is client_encryption_options -> store_type. -Default value: undef

- -
-client_encryption_truststore -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is client_encryption_options -> truststore. -Default value: undef

- -
-client_encryption_truststore_password -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is client_encryption_options -> truststore_password. -Default value: undef

- -
-cluster_name -
- -

This is passed to the -cassandra.yaml file. -Default value 'Test Cluster'

- -
-column_index_size_in_kb -
- -

This is passed to the -cassandra.yaml file. -Default value: '64'

- -
-commit_failure_policy -
- -

This is passed to the -cassandra.yaml file. -Default value: 'stop'

- -
-commitlog_directory -
- -

This is passed to the -cassandra.yaml file. -Default value '/var/lib/cassandra/commitlog'

- -
-commitlog_directory_mode -
- -

The mode for the directory specified in commitlog_directory. -Default value '0750'

- -
-commitlog_segment_size_in_mb -
- -

This is passed to the -cassandra.yaml file. -Default value: 32

- -
-commitlog_sync -
- -

This is passed to the -cassandra.yaml file.

- -

See also commitlog_sync_batch_window_in_ms and commitlog_sync_period_in_ms. -Default value: 'periodic'

- -
-commitlog_sync_batch_window_in_ms -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file.

- -

If commitlog_sync is set to 'batch' then this value should be set. -Otherwise it should be set to undef. -Default value: undef

- -
-commitlog_sync_period_in_ms -
- -

This is passed to the -cassandra.yaml file. -If set to a value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file.

- -

If commitlog_sync is set to 'periodic' then this value should be set. -Otherwise it should be set to undef. -Default value: 10000

- -
-commitlog_total_space_in_mb -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-compaction_throughput_mb_per_sec -
- -

This is passed to the -cassandra.yaml file. -Default value: '16'

- -
-concurrent_counter_writes -
- -

This is passed to the -cassandra.yaml file. -Default value '32'

- -
-concurrent_reads -
- -

This is passed to the -cassandra.yaml file. -Default value '32'

- -
-concurrent_writes -
- -

This is passed to the -cassandra.yaml file. -Default value '32'

- -
-config_file_mode -
- -

The permissions mode of the cassandra configuration file. -Default value '0644'

- -
-config_path -
- -

The path to the cassandra configuration file. If this is undef, it will be -changed to /etc/cassandra/default.conf on the Red Hat family of operating -systems or /etc/cassandra on Ubuntu. Otherwise the user can specify the -path name. -Default value undef

- -
-concurrent_compactors -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-counter_cache_save_period -
- -

This is passed to the -cassandra.yaml file. -Default value: '7200'

- -
-counter_cache_keys_to_save -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-counter_cache_size_in_mb -
- -

This is passed to the -cassandra.yaml file. -Default value: ''

- -
-counter_write_request_timeout_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '5000'

- -
-cross_node_timeout -
- -

This is passed to the -cassandra.yaml file. -Default value: 'false'

- -
-data_file_directories -
- -

This is passed to the -cassandra.yaml file. -Default value '['/var/lib/cassandra/data']'

- -
-data_file_directories_mode -
- -

The mode for the directories specified in data_file_directories. -Default value '0750'

- -
-dc -
- -

Sets the value for dc in config_path/snitch_properties_file see -http://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureSnitchesAbout_c.html -for more details. -Default value 'DC1'

- -
-dc_suffix -
- -

Sets the value for dc_suffix in config_path/snitch_properties_file see -http://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureSnitchesAbout_c.html -for more details. If the value is undef then change will be made to the -snitch properties file for this setting. -Default value undef

- -
-disk_failure_policy -
- -

This is passed to the -cassandra.yaml file. -Default value 'stop'

- -
-dynamic_snitch_badness_threshold -
- -

This is passed to the -cassandra.yaml file. -Default value: '0.1'

- -
-dynamic_snitch_reset_interval_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '600000'

- -
-dynamic_snitch_update_interval_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '100'

- -
-endpoint_snitch -
- -

This is passed to the -cassandra.yaml file. -Default value 'SimpleSnitch'

- -
-fail_on_non_supported_os -
- -

A flag that dictates if the module should fail if it is not RedHat or Debian. -If you set this option to false then you must also at least set the -config_path parameter as well. -Default value 'true'

- -
-file_cache_size_in_mb -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-hinted_handoff_enabled -
- -

This is passed to the -cassandra.yaml file. -Default value 'true'

- -
-hinted_handoff_throttle_in_kb -
- -

This is passed to the -cassandra.yaml file. -Default value: '1024'

- -
-index_summary_capacity_in_mb -
- -

This is passed to the -cassandra.yaml file. -Default value: ''

- -
-index_summary_resize_interval_in_minutes -
- -

This is passed to the -cassandra.yaml file. -Default value: '60'

- -
-incremental_backups -
- -

This is passed to the -cassandra.yaml file. -Default value 'false'

- -
-initial_token -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-inter_dc_tcp_nodelay -
- -

This is passed to the -cassandra.yaml file. -Default value: 'false'

- -
-internode_authenticator -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-internode_compression -
- -

This is passed to the -cassandra.yaml file. -Default value 'all'

- -
-internode_recv_buff_size_in_bytes -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-internode_send_buff_size_in_bytes -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-key_cache_save_period -
- -

This is passed to the -cassandra.yaml file. -Default value: 14400

- -
-key_cache_size_in_mb -
- -

This is passed to the -cassandra.yaml file. -Default value: ''

- -
-key_cache_keys_to_save -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-listen_address -
- -

This is passed to the -cassandra.yaml file. -Default value 'localhost'

- -
-manage_dsc_repo -
- -

DEPRECATION WARNING: This option is deprecated. Please include the -the ::cassandra::datastax_repo instead.

- -

If set to true then a repository will be setup so that packages can be -downloaded from DataStax community. -Default value 'false'

- -
-max_hints_delivery_threads -
- -

This is passed to the -cassandra.yaml file. -Default value: '2'

- -
-max_hint_window_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '10800000'

- -
-memory_allocator -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-memtable_cleanup_threshold -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-memtable_flush_writers -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-memtable_heap_space_in_mb -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-memtable_offheap_space_in_mb -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-native_transport_max_concurrent_connections -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-native_transport_max_concurrent_connections_per_ip -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-native_transport_max_frame_size_in_mb -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-native_transport_max_threads -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-native_transport_port -
- -

This is passed to the -cassandra.yaml file. -Default value '9042'

- -
-num_tokens -
- -

This is passed to the -cassandra.yaml file. -Default value '256'

- -
-package_ensure -
- -

The status of the package specified in package_name. Can be -present, latest or a specific version number. -Default value 'present'

- -
-package_name -
- -

The name of the Cassandra package. Must be available from a repository. -Default value 'dsc22'

- -
-partitioner -
- -

This is passed to the -cassandra.yaml file. -Default value 'org.apache.cassandra.dht.Murmur3Partitioner'

- -
-permissions_update_interval_in_ms -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-permissions_validity_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '2000'

- -
-phi_convict_threshold -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-prefer_local -
- -

Sets the value for prefer_local in config_path/snitch_properties_file see -http://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureSnitchesAbout_c.html -for more details. Valid values are true, false or undef. If the value is -undef then change will be made to the snitch properties file for this -setting. -Default value undef

- -
-rack -
- -

Sets the value for rack in config_path/snitch_properties_file see -http://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureSnitchesAbout_c.html -for more details. -Default value 'RAC1'

- -
-range_request_timeout_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '10000'

- -
-read_request_timeout_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '5000'

- -
-request_scheduler -
- -

This is passed to the -cassandra.yaml file. -Default value: 'org.apache.cassandra.scheduler.NoScheduler'

- -
-request_scheduler_options_default_weight -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-request_scheduler_options_throttle_limit -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-request_timeout_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '10000'

- -
-row_cache_keys_to_save -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-row_cache_save_period -
- -

This is passed to the -cassandra.yaml file. -Default value: '0'

- -
-row_cache_size_in_mb -
- -

This is passed to the -cassandra.yaml file. -Default value: '0'

- -
-rpc_address -
- -

This is passed to the -cassandra.yaml file. -Default value 'localhost'

- -
-rpc_max_threads -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-rpc_min_threads -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-rpc_port -
- -

This is passed to the -cassandra.yaml file. -Default value '9160'

- -
-rpc_recv_buff_size_in_bytes -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-rpc_send_buff_size_in_bytes -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-rpc_server_type -
- -

This is passed to the -cassandra.yaml file. -Default value 'sync'

- -
-saved_caches_directory -
- -

This is passed to the -cassandra.yaml file. -Default value '/var/lib/cassandra/saved_caches'

- -
-saved_caches_directory_mode -
- -

The mode for the directory specified in saved_caches_directory. -Default value '0750'

- -
-seeds -
- -

This is passed to the -cassandra.yaml file. -The field being set is seed_provider -> parameters -> seeds. -Default value '127.0.0.1'

- -
-seed_provider_class_name -
- -

This is passed to the -cassandra.yaml file. -The field being set is seed_provider -> class_name. -Default value 'org.apache.cassandra.locator.SimpleSeedProvider'

- -
-server_encryption_algorithm -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is server_encryption_options -> algorithm. -Default value: undef

- -
-server_encryption_cipher_suites -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is server_encryption_options -> cipher_suites. -Default value: undef

- -
-server_encryption_internode -
- -

This is passed to the -cassandra.yaml file. -The field being set is server_encryption_options -> internode_encryption. -Default value 'none'

- -
-server_encryption_keystore -
- -

This is passed to the -cassandra.yaml file. -The field being set is server_encryption_options -> keystore. -Default value 'conf/.keystore'

- -
-server_encryption_keystore_password -
- -

This is passed to the -cassandra.yaml file. -The field being set is server_encryption_options -> keystore_password. -Default value 'cassandra'

- -
-server_encryption_protocol -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is server_encryption_options -> protocol. -Default value: undef

- -
-server_encryption_require_client_auth -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is server_encryption_options -> require_client_auth. -Default value: undef

- -
-server_encryption_store_type -
- -

If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -The field being set is server_encryption_options -> store_type. -Default value: undef

- -
-server_encryption_truststore -
- -

This is passed to the -cassandra.yaml file. -The field being set is server_encryption_options -> truststore. -Default value 'conf/.truststore'

- -
-server_encryption_truststore_password -
- -

This is passed to the -cassandra.yaml file. -The field being set is server_encryption_options -> truststore_password. -Default value 'cassandra'

- -
-service_enable -
- -

Enable the Cassandra service to start at boot time. Valid values are true -or false. -Default value 'true'

- -
-service_ensure -
- -

Ensure the Cassandra service is running. Valid values are running or stopped. -Default value 'running'

- -
-service_name -
- -

The name of the service that runs the Cassandra software. -Default value 'cassandra'

- -
-service_refresh -
- -

If set to true, changes to the Cassandra config file or the data directories -will ensure that Cassandra service is refreshed after the changes. Setting -this flag to false will disable this behaviour, therefore allowing the changes -to be made but allow the user to control when the service is restarted. -Default value true

- -
-snapshot_before_compaction -
- -

This is passed to the -cassandra.yaml file. -Default value 'false'

- -
-snitch_properties_file -
- -

The name of the snitch properties file. The full path name would be -config_path/snitch_properties_file. -Default value 'cassandra-rackdc.properties'

- -
-ssl_storage_port -
- -

This is passed to the -cassandra.yaml file. -Default value '7001'

- -
-sstable_preemptive_open_interval_in_mb -
- -

This is passed to the -cassandra.yaml file. -Default value: '50'

- -
-start_native_transport -
- -

This is passed to the -cassandra.yaml file. -Default value 'true'

- -
-start_rpc -
- -

This is passed to the -cassandra.yaml file. -Default value 'true'

- -
-storage_port -
- -

This is passed to the -cassandra.yaml file. -Default value '7000'

- -
-streaming_socket_timeout_in_ms -
- -

This is passed to the -cassandra.yaml file. -If left at the default value of undef then the entry in the configuration -file is absent or commented out. If a value is set, then the parameter -and variable are placed into the configuration file. -Default value: undef

- -
-tombstone_failure_threshold -
- -

This is passed to the -cassandra.yaml file. -Default value: '100000'

- -
-tombstone_warn_threshold -
- -

This is passed to the -cassandra.yaml file. -Default value: '1000'

- -
-trickle_fsync -
- -

This is passed to the -cassandra.yaml file. -Default value: 'false'

- -
-trickle_fsync_interval_in_kb -
- -

This is passed to the -cassandra.yaml file. -Default value: '10240'

- -
-truncate_request_timeout_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '60000'

- -
-write_request_timeout_in_ms -
- -

This is passed to the -cassandra.yaml file. -Default value: '2000'

- -

-Class: cassandra::datastax_agent

- -

A class for installing the DataStax Agent and to point it at an OpsCenter -instance.

- -

-Parameters

- -
-defaults_file -
- -

The full path name to the file where java_home is set. -Default value '/etc/default/datastax-agent'

- -
-java_home -
- -

If the value of this variable is left as undef, no action is taken. -Otherwise the value is set as JAVA_HOME in defaults_file. -Default value undef

- -
-package_ensure -
- -

Is passed to the package reference. Valid values are present or a version -number. -Default value 'present'

- -
-package_name -
- -

Is passed to the package reference. -Default value 'datastax-agent'

- -
-service_ensure -
- -

Is passed to the service reference. -Default value 'running'

- -
-service_enable -
- -

Is passed to the service reference. -Default value 'true'

- -
-service_name -
- -

Is passed to the service reference. -Default value 'datastax-agent'

- -
-stomp_interface -
- -

If the value is changed from the default of undef then this is what is -set as the stomp_interface setting in -/var/lib/datastax-agent/conf/address.yaml -which connects the agent to an OpsCenter instance. -Default value undef

- -

-Class: cassandra::datastax_repo

- -

An optional class that will allow a suitable repository to be configured -from which packages for DataStax Community can be downloaded. Changing -the defaults will allow any Debian Apt or Red Hat Yum repository to be -configured.

- -

-Parameters

- -
-descr -
- -

On the Red Hat family, this is passed as the descr parameter to a -yumrepo resource. On the Debian family, it is passed as the comment -parameter to an apt::source resource. -Default value 'DataStax Repo for Apache Cassandra'

- -
-key_id -
- -

On the Debian family, this is passed as the id parameter to an apt::key -resource. On the Red Hat family, it is ignored. -Default value '7E41C00F85BFC1706C4FFFB3350200F2B999A372'

- -
-key_url -
- -

On the Debian family, this is passed as the source parameter to an -apt::key resource. On the Red Hat family, it is ignored. -Default value 'http://debian.datastax.com/debian/repo_key'

- -
-pkg_url -
- -

If left as the default, this will set the baseurl to -'http://rpm.datastax.com/community' on a yumrepo resource -on the Red Hat family. On the Debian family, leaving this as the default -will set the location parameter on an apt::source to -'http://debian.datastax.com/community'. Default value undef

- -
-release -
- -

On the Debian family, this is passed as the release parameter to an -apt::source resource. On the Red Hat family, it is ignored. -Default value 'stable'

- -

-Class: cassandra::firewall_ports

- -

An optional class to configure incoming network ports on the host that are -relevant to the Cassandra installation. If firewalls are being managed -already, simply do not include this module in your manifest.

- -

IMPORTANT: The full list of which ports should be configured is assessed at -evaluation time of the configuration. Therefore if one is to use this class, -it must be the final cassandra class included in the manifest.

- -

-Parameters

- -
-client_ports -
- -

Only has any effect if the cassandra class is defined on the node.

- -

Allow these TCP ports to be opened for traffic -coming from the client subnets. -Default value '[9042, 9160]'

- -
-client_subnets -
- -

Only has any effect if the cassandra class is defined on the node.

- -

An array of the list of subnets that are to allowed connection to -cassandra::native_transport_port and cassandra::rpc_port. -Default value '['0.0.0.0/0']'

- -
-inter_node_ports -
- -

Only has any effect if the cassandra class is defined on the node.

- -

Allow these TCP ports to be opened for traffic -between the Cassandra nodes. -Default value '[7000, 7001, 7199]'

- -
-inter_node_subnets -
- -

Only has any effect if the cassandra class is defined on the node.

- -

An array of the list of subnets that are to allowed connection to -cassandra::storage_port, cassandra::ssl_storage_port and port 7199 -for cassandra JMX monitoring. -Default value '['0.0.0.0/0']'

- -
-inter_node_ports -
- -

Allow these TCP ports to be opened for traffic -coming from OpsCenter subnets. -Default value '[7000, 7001, 7199]'

- -
-public_ports -
- -

Allow these TCP ports to be opened for traffic -coming from public subnets the port specified in $ssh_port will be -appended to this list. -Default value '[8888]'

- -
-public_subnets -
- -

An array of the list of subnets that are to allowed connection to -cassandra::firewall_ports::ssh_port and if cassandra::opscenter has been -included, both cassandra::opscenter::webserver_port and -cassandra::opscenter::webserver_ssl_port. -Default value '['0.0.0.0/0']'

- -
-ssh_port -
- -

Which port does SSH operate on. -Default value '22'

- -
-opscenter_ports -
- -

Only has any effect if the cassandra::datastax_agent or -cassandra::opscenter classes are defined.

- -

Allow these TCP ports to be opened for traffic -coming to or from OpsCenter -appended to this list. -Default value '[61620, 61621]'

- -
-opscenter_subnets -
- -

A list of subnets that are to be allowed connection to -port 61620 for nodes built with cassandra::opscenter and 61621 for nodes -built with cassandra::datastax_agent. -Default value '['0.0.0.0/0']'

- -

-Class: cassandra::java

- -

A class to install an appropriate Java package.

- -

-Parameters

- -
-ensure -
- -

Is passed to the package reference for the JRE/JDK package. Valid values are -present or a version number. -Default value 'present'

- -
-jna_ensure -
- -

Is passed to the package reference for the JNA package. Valid values are -present or a version number. -Default value 'present'

- -
-jna_package_name -
- -

If the default value of undef is left as it is, then a package called -jna or libjna-java will be installed on a Red Hat family or Ubuntu system -respectively. Alternatively, one can specify a package that is available in -a package repository to the node. -Default value undef

- -
-package_name -
- -

If the default value of undef is left as it is, then a package called -java-1.8.0-openjdk-headless or openjdk-7-jre-headless will be installed -on a Red Hat family or Ubuntu system respectively. Alternatively, one -can specify a package that is available in a package repository to the -node. -Default value undef

- -

-Class: cassandra::opscenter

- -

This class installs and manages the DataStax OpsCenter. Leaving the defaults -as they are will provide a running OpsCenter without any authentication on -port 8888.

- -

-Parameters

- -
-agents_agent_certfile -
- -

This sets the agent_certfile setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_agent_keyfile -
- -

This sets the agent_keyfile setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_agent_keyfile_raw -
- -

This sets the agent_keyfile_raw setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_config_sleep -
- -

This sets the config_sleep setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_fingerprint_throttle -
- -

This sets the fingerprint_throttle setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_incoming_interface -
- -

This sets the incoming_interface setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_incoming_port -
- -

This sets the incoming_port setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_install_throttle -
- -

This sets the install_throttle setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_not_seen_threshold -
- -

This sets the not_seen_threshold setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_path_to_deb -
- -

This sets the path_to_deb setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_path_to_find_java -
- -

This sets the path_to_find_java setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_path_to_installscript -
- -

This sets the path_to_installscript setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_path_to_rpm -
- -

This sets the path_to_rpm setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_path_to_sudowrap -
- -

This sets the path_to_sudowrap setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_reported_interface -
- -

This sets the reported_interface setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_runs_sudo -
- -

This sets the runs_sudo setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_scp_executable -
- -

This sets the scp_executable setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_ssh_executable -
- -

This sets the ssh_executable setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_ssh_keygen_executable -
- -

This sets the ssh_keygen_executable setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_ssh_keyscan_executable -
- -

This sets the ssh_keyscan_executable setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_ssh_port -
- -

This sets the ssh_port setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_ssh_sys_known_hosts_file -
- -

This sets the ssh_sys_known_hosts_file setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_ssh_user_known_hosts_file -
- -

This sets the ssh_user_known_hosts_file setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_ssl_certfile -
- -

This sets the ssl_certfile setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_ssl_keyfile -
- -

This sets the ssl_keyfile setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_tmp_dir -
- -

This sets the tmp_dir setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-agents_use_ssl -
- -

This sets the use_ssl setting in the agents section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-authentication_audit_auth -
- -

This sets the audit_auth setting in the authentication section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-authentication_audit_pattern -
- -

This sets the audit_pattern setting in the authentication section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-authentication_method -
- -

This sets the authentication_method setting in the authentication section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-authentication_enabled -
- -

This sets the enabled setting in the authentication section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value 'False'

- -
-authentication_passwd_db -
- -

This sets the passwd_db setting in the authentication section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-authentication_timeout -
- -

This sets the timeout setting in the authentication section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-cloud_accepted_certs -
- -

This sets the accepted_certs setting in the cloud section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-clusters_add_cluster_timeout -
- -

This sets the add_cluster_timeout setting in the clusters section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-clusters_startup_sleep -
- -

This sets the startup_sleep setting in the clusters section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-config_file -
- -

The full path to the OpsCenter configuration file. -Default value '/etc/opscenter/opscenterd.conf'

- -
-definitions_auto_update -
- -

This sets the auto_update setting in the definitions section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-definitions_definitions_dir -
- -

This sets the definitions_dir setting in the definitions section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-definitions_download_filename -
- -

This sets the download_filename setting in the definitions section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-definitions_download_host -
- -

This sets the download_host setting in the definitions section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-definitions_download_port -
- -

This sets the download_port setting in the definitions section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-definitions_hash_filename -
- -

This sets the hash_filename setting in the definitions section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-definitions_sleep -
- -

This sets the sleep setting in the definitions section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-definitions_ssl_certfile -
- -

This sets the ssl_certfile setting in the definitions section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-definitions_use_ssl -
- -

This sets the use_ssl setting in the definitions section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ensure -
- -

This is passed to the package reference for opscenter. Valid values are -present or a version number. -Default value 'present'

- -
-failover_configuration_directory -
- -

This sets the failover_configuration_directory setting in the failover section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-failover_heartbeat_fail_window -
- -

This sets the heartbeat_fail_window setting in the failover section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-failover_heartbeat_period -
- -

This sets the heartbeat_period setting in the failover section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-failover_heartbeat_reply_period -
- -

This sets the heartbeat_reply_period setting in the failover section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-hadoop_base_job_tracker_proxy_port -
- -

This sets the base_job_tracker_proxy_port setting in the hadoop section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_admin_group_name -
- -

This sets the admin_group_name setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_connection_timeout -
- -

This sets the connection_timeout setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_debug_ssl -
- -

This sets the debug_ssl setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_group_name_attribute -
- -

This sets the group_name_attribute setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_group_search_base -
- -

This sets the group_search_base setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_group_search_filter -
- -

This sets the group_search_filter setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_group_search_type -
- -

This sets the group_search_type setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_ldap_security -
- -

This sets the ldap_security setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_opt_referrals -
- -

This sets the opt_referrals setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_protocol_version -
- -

This sets the protocol_version setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_search_dn -
- -

This sets the search_dn setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_search_password -
- -

This sets the search_password setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_server_host -
- -

This sets the server_host setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_server_port -
- -

This sets the server_port setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_ssl_cacert -
- -

This sets the ssl_cacert setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_ssl_cert -
- -

This sets the ssl_cert setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_ssl_key -
- -

This sets the ssl_key setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_tls_demand -
- -

This sets the tls_demand setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_tls_reqcert -
- -

This sets the tls_reqcert setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_uri_scheme -
- -

This sets the uri_scheme setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_user_memberof_attribute -
- -

This sets the user_memberof_attribute setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_user_search_base -
- -

This sets the user_search_base setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ldap_user_search_filter -
- -

This sets the user_search_filter setting in the ldap section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-logging_level -
- -

This sets the level setting in the logging section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-logging_log_length -
- -

This sets the log_length setting in the logging section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-logging_log_path -
- -

This sets the log_path setting in the logging section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-logging_max_rotate -
- -

This sets the max_rotate setting in the logging section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-logging_resource_usage_interval -
- -

This sets the resource_usage_interval setting in the logging section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-package_name -
- -

The name of the OpsCenter package. -Default value 'opscenter'

- -
-provisioning_agent_install_timeout -
- -

This sets the agent_install_timeout setting in the provisioning section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-provisioning_keyspace_timeout -
- -

This sets the keyspace_timeout setting in the provisioning section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-provisioning_private_key_dir -
- -

This sets the private_key_dir setting in the provisioning section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_alert_on_repair_failure -
- -

This sets the alert_on_repair_failure setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_cluster_stabilization_period -
- -

This sets the cluster_stabilization_period setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_error_logging_window -
- -

This sets the error_logging_window setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_incremental_err_alert_threshold -
- -

This sets the incremental_err_alert_threshold setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_incremental_range_repair -
- -

This sets the incremental_range_repair setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_incremental_repair_tables -
- -

This sets the incremental_repair_tables setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_ks_update_period -
- -

This sets the ks_update_period setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_log_directory -
- -

This sets the log_directory setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_log_length -
- -

This sets the log_length setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_max_err_threshold -
- -

This sets the max_err_threshold setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_max_parallel_repairs -
- -

This sets the max_parallel_repairs setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_max_pending_repairs -
- -

This sets the max_pending_repairs setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_max_rotate -
- -

This sets the max_rotate setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_min_repair_time -
- -

This sets the min_repair_time setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_min_throughput -
- -

This sets the min_throughput setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_num_recent_throughputs -
- -

This sets the num_recent_throughputs setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_persist_directory -
- -

This sets the persist_directory setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_persist_period -
- -

This sets the persist_period setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_restart_period -
- -

This sets the restart_period setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_single_repair_timeout -
- -

This sets the single_repair_timeout setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_single_task_err_threshold -
- -

This sets the single_task_err_threshold setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-repair_service_snapshot_override -
- -

This sets the snapshot_override setting in the repair_service section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-request_tracker_queue_size -
- -

This sets the queue_size setting in the request_tracker section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-security_config_encryption_active -
- -

This sets the config_encryption_active setting in the security section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-security_config_encryption_key_name -
- -

This sets the config_encryption_key_name setting in the security section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-security_config_encryption_key_path -
- -

This sets the config_encryption_key_path setting in the security section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-service_enable -
- -

Enable the OpsCenter service to start at boot time. Valid values are true -or false. -Default value 'true'

- -
-service_ensure -
- -

Ensure the OpsCenter service is running. Valid values are running or stopped. -Default value 'running'

- -
-service_name -
- -

The name of the service that runs the OpsCenter software. -Default value 'opscenterd'

- -
-spark_base_master_proxy_port -
- -

This sets the base_master_proxy_port setting in the spark section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-stat_reporter_initial_sleep -
- -

This sets the initial_sleep setting in the stat_reporter section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-stat_reporter_interval -
- -

This sets the interval setting in the stat_reporter section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-stat_reporter_report_file -
- -

This sets the report_file setting in the stat_reporter section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-stat_reporter_ssl_key -
- -

This sets the ssl_key setting in the stat_reporter section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ui_default_api_timeout -
- -

This sets the default_api_timeout setting in the ui section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ui_max_metrics_requests -
- -

This sets the max_metrics_requests setting in the ui section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ui_node_detail_refresh_delay -
- -

This sets the node_detail_refresh_delay setting in the ui section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-ui_storagemap_ttl -
- -

This sets the storagemap_ttl setting in the ui section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-webserver_interface -
- -

This sets the interface setting in the webserver section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value '0.0.0.0'

- -
-webserver_log_path -
- -

This sets the log_path setting in the webserver section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-webserver_port -
- -

This sets the port setting in the webserver section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value '8888'

- -
-webserver_ssl_certfile -
- -

This sets the ssl_certfile setting in the webserver section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-webserver_ssl_keyfile -
- -

This sets the ssl_keyfile setting in the webserver section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-webserver_ssl_port -
- -

This sets the ssl_port setting in the webserver section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-webserver_staticdir -
- -

This sets the staticdir setting in the webserver section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-webserver_sub_process_timeout -
- -

This sets the sub_process_timeout setting in the webserver section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -
-webserver_tarball_process_timeout -
- -

This sets the tarball_process_timeout setting in the webserver section of the -OpsCenter configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html -for more details. A value of undef will ensure the setting is not present -in the file. Default value undef

- -

-Class: cassandra::opscenter::pycrypto

- -

On the Red Hat family of operating systems, if one intends to use encryption -for configuration values then the pycrypto library is required. This class -will install it for the user. See -http://docs.datastax.com/en/opscenter/5.2//opsc/configure/installPycrypto.html -for more details.

- -

This class has no effect when included on nodes that are not in the Red Hat -family.

- -

-Parameters

- -
-ensure -
- -

This is passed to the package reference for pycrypto. Valid values are -present or a version number. -Default value 'present'

- -
-manage_epel -
- -

If set to true, the epel-release package will be installed. -Default value 'false'

- -
-package_name -
- -

The name of the PyCrypto package. -Default value 'pycrypto'

- -
-provider -
- -

The name of the provider of the pycrypto package. -Default value 'pip'

- -
-reqd_pckgs -
- -

Packages that are required to install the pycrypto package. -Default value '['python-devel', 'python-pip' ]'

- -

-Class: cassandra::optutils

- -

A class to install the optional Cassandra tools package.

- -

-Parameters

- -
-ensure -
- -

Is passed to the package reference. Valid values are present or a version -number. -Default value 'present'

- -
-package_name -
- -

If the default value of undef is left as it is, then a package called -cassandra22-tools or cassandra-tools will be installed -on a Red Hat family or Ubuntu system respectively. Alternatively, one -can specify a package that is available in a package repository to the -node. -Default value undef

- -

-Defined Type cassandra::opscenter::cluster_name

- -

With DataStax Enterprise, one can specify a remote keyspace for OpsCenter -to store metric data (this is not available in the DataStax Community Edition).

- -

-Parameters

- -
-cassandra_seed_hosts -
- -

This sets the seed_hosts setting in the cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_api_port -
- -

This sets the api_port setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_bind_interface -
- -

This sets the bind_interface setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_connection_pool_size -
- -

This sets the connection_pool_size setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_connect_timeout -
- -

This sets the connect_timeout setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_cql_port -
- -

This sets the cql_port setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_keyspace -
- -

This sets the keyspace setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_local_dc_pref -
- -

This sets the local_dc_pref setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_password -
- -

This sets the password setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_retry_delay -
- -

This sets the retry_delay setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_seed_hosts -
- -

This sets the seed_hosts setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_send_rpc -
- -

This sets the send_rpc setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_ssl_ca_certs -
- -

This sets the ssl_ca_certs setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_ssl_client_key -
- -

This sets the ssl_client_key setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_ssl_client_pem -
- -

This sets the ssl_client_pem setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_ssl_validate -
- -

This sets the ssl_validate setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_used_hosts_per_remote_dc -
- -

This sets the used_hosts_per_remote_dc setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -
-storage_cassandra_username -
- -

This sets the username setting in the storage_cassandra section of the -cluster_name.conf configuration file. See -http://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html -for more details. A value of undef will ensure the setting is not -present in the file. Default value undef

- -

-Defined Type cassandra::firewall_ports::rule

- -

A defined type to be used as a macro for setting host based firewall -rules. This is not intended to be used by a user (who should use the -API provided by cassandra::firewall_ports instead) but is documented -here for completeness.

- -

-Parameters

- -
-title -
- -

A text field that contains the protocol name and CIDR address of a subnet.

- -
-port -
- -

The number(s) of the port(s) to be opened.

- -

-Defined Type cassandra::opscenter::setting

- -

A defined type to be used as a macro for settings in the OpsCenter -configuration file. This is not intended to be used by a user (who -should use the API provided by cassandra::opscenter instead) but is documented -here for completeness.

- -

-Parameters

- -
-service_name -
- -

The name of the service to be notified if a change is made to the -configuration file. Typically this would by opscenterd.

- -
-path -
- -

The path to the configuration file. Typically this would by -/etc/opscenter/opscenterd.conf.

- -
-section -
- -

The section in the configuration file to be added to (e.g. webserver).

- -
-setting -
- -

The setting within the section of the configuration file to changed -(e.g. port).

- -
-value -
- -

The setting value to be changed to (e.g. 8888).

- -

-Limitations

- -

Tested on the Red Hat family versions 6 and 7, Ubuntu 12.04 and 14.04, -Debian 7 Puppet (CE) 3.7.5 and DSC 2.

- -

From release 1.6.0 of this module, regular updates of the Cassandra 1.X -template will cease and testing against this template will cease. Testing -against the template for versions of Cassandra >= 2.X will continue.

- -

-Contributers

- -

Contributions will be gratefully accepted. Please go to the project page, -fork the project, make your changes locally and then raise a pull request. -Details on how to do this are available at -https://guides.github.com/activities/contributing-to-open-source.

- -

Please also see the -CONTRIBUTING.md -page for project specific requirements.

- -

-Additional Contributers

- - diff --git a/params.json b/params.json index 66c76c433..d3bc59c67 100644 --- a/params.json +++ b/params.json @@ -1 +1 @@ -{"name":"Cassandra","tagline":"Installs Cassandra, DataStax Agent & OpsCenter on RHEL/Ubuntu/Debian.","body":"# Cassandra\r\n[![Puppet Forge](http://img.shields.io/puppetforge/v/locp/cassandra.svg)](https://forge.puppetlabs.com/locp/cassandra)\r\n[![Github Tag](https://img.shields.io/github/tag/locp/cassandra.svg)](https://github.com/locp/cassandra)\r\n[![Build Status](https://travis-ci.org/locp/cassandra.png?branch=master)](https://travis-ci.org/locp/cassandra)\r\n[![Coverage Status](https://coveralls.io/repos/locp/cassandra/badge.svg?branch=master&service=github)](https://coveralls.io/github/locp/cassandra?branch=master)\r\n[![Join the chat at https://gitter.im/locp/cassandra](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/locp/cassandra?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\r\n\r\n#### Table of Contents\r\n\r\n1. [Overview](#overview)\r\n2. [Setup - The basics of getting started with Cassandra](#setup)\r\n * [What Cassandra affects](#what-cassandra-affects)\r\n * [Beginning with Cassandra](#beginning-with-cassandra)\r\n * [Upgrading](#upgrading)\r\n3. [Usage - Configuration options and additional functionality](#usage)\r\n * [Create a Cluster in a Single Data Center](#create-a-cluster-in-a-single-data-center)\r\n * [Create a Cluster in Multiple Data Centers](#create-a-cluster-in-multiple-data-centers)\r\n * [OpsCenter](#opscenter)\r\n * [DataStax Enterprise](#datastax-enterprise)\r\n4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)\r\n * [cassandra](#class-cassandra)\r\n * [cassandra::datastax_agent](#class-cassandradatastax_agent)\r\n * [cassandra::datastax_repo](#class-cassandradatastax_repo)\r\n * [cassandra::firewall_ports](#class-cassandrafirewall_ports)\r\n * [cassandra::java](#class-cassandrajava)\r\n * [cassandra::opscenter](#class-cassandraopscenter)\r\n * [cassandra::opscenter::cluster_name](#defined-type-cassandraopscentercluster_name)\r\n * [cassandra::opscenter::pycrypto](#class-cassandraopscenterpycrypto)\r\n * [cassandra::optutils](#class-cassandraoptutils)\r\n * [cassandra::opscenter::setting](#defined-type-cassandraopscentersetting)\r\n5. [Limitations - OS compatibility, etc.](#limitations)\r\n6. [Contributers](#contributers)\r\n\r\n## Overview\r\n\r\nA Puppet module to install and manage Cassandra, DataStax Agent & OpsCenter\r\n\r\n## Setup\r\n\r\n### What Cassandra affects\r\n\r\n#### What the Cassandra class affects\r\n\r\n* Installs the Cassandra package (default **dsc22**).\r\n* Configures settings in *${config_path}/cassandra.yaml*.\r\n* Optionally ensures that the Cassandra service is enabled and running.\r\n* On Ubuntu systems, optionally replace ```/etc/init.d/cassandra``` with a\r\n workaround for \r\n [CASSANDRA-9822](https://issues.apache.org/jira/browse/CASSANDRA-9822).\r\n\r\n#### What the cassandra::datastax_agent class affects\r\n\r\n* Optionally installs the DataStax agent.\r\n* Optionally sets JAVA_HOME in **/etc/default/datastax-agent**.\r\n\r\n#### What the cassandra::datastax_agent class affects\r\n\r\n* Optionally configures a Yum repository to install the Cassandra packages\r\n from (on Red Hat).\r\n* Optionally configures an Apt repository to install the Cassandra packages\r\n from (on Ubuntu).\r\n\r\n#### What the cassandra::firewall_ports class affects\r\n\r\n* Optionally configures the firewall for the Cassandra related network\r\n ports.\r\n\r\n#### What the cassandra::java class affects\r\n\r\n* Optionally installs a JRE/JDK package (e.g. java-1.7.0-openjdk) and the\r\n Java Native Access (JNA).\r\n\r\n#### What the cassandra::opscenter class affects\r\n\r\n* Installs the OpsCenter package.\r\n* Manages the content of the configuration file\r\n (/etc/opscenter/opscenterd.conf).\r\n* Manages the opscenterd service.\r\n\r\n#### What the cassandra::opscenter::cluster_name type affects\r\n\r\n* An optional type that allows DataStax OpsCenter to connect to a remote\r\n key space for metrics storage. These files will be created in\r\n /etc/opscenter/clusters. The module also creates this directory if\r\n required. This functionality is only valid in DataStax Enterprise.\r\n\r\n#### What the cassandra::opscenter::pycrypto class affects\r\n\r\n* On the Red Hat family it installs the pycrypto library and it's\r\n pre-requisites (the python-devel and python-pip packages).\r\n* Optionally installs the Extra Packages for Enterprise Linux (EPEL)\r\n repository.\r\n* As a workaround for\r\n [PUP-3829](https://tickets.puppetlabs.com/browse/PUP-3829) a symbolic\r\n link is created from ```/usr/bin/pip``` to\r\n ```/usr/bin/pip-python```. Hopefully this can be removed in the not\r\n too distant future.\r\n\r\n#### What the cassandra::optutils class affects\r\n\r\n* Optionally installs the Cassandra support tools (e.g. cassandra22-tools).\r\n\r\n### Beginning with Cassandra\r\n\r\nA basic example is as follows:\r\n\r\n```puppet\r\n class { 'cassandra':\r\n cluster_name => 'MyCassandraCluster',\r\n endpoint_snitch => 'GossipingPropertyFileSnitch',\r\n listen_address => \"${::ipaddress}\",\r\n seeds => '110.82.155.0,110.82.156.3'\r\n }\r\n```\r\n\r\n### Upgrading\r\n\r\n#### Changes in 1.8.0\r\n\r\nA somewhat embarrassing correction to the spelling of the\r\ncassandra::fail_on_non_suppoted_os to cassandra::fail_on_non_supported_os.\r\n\r\n#### Issues when Upgrading to 1.4.0\r\n\r\nUnfortunately both releases 1.3.7 and 1.4.0 have subsequently been found to\r\ncall a refresh service even when no changes had been made to the underlying\r\nconfiguration. In release 1.8.0 (somewhat belatedly) the service_refresh\r\nflag has been introduced to mitigate against similar problems.\r\n\r\n#### Issues When Upgrading to 1.3.7\r\n\r\n* Please see the notes for 1.4.0.\r\n\r\n#### Changes in 1.0.0\r\n\r\n* cassandra::cassandra_package_ensure has been renamed to\r\n cassandra::package_ensure.\r\n* cassandra::cassandra_package_name has been renamed to\r\n cassandra::package_name.\r\n\r\n#### Changes in 0.4.0\r\n\r\nThere is now a cassandra::datastax_agent class, therefore:\r\n\r\n* cassandra::datastax_agent_package_ensure has now been replaced with\r\n cassandra::datastax_agent::package_ensure.\r\n* cassandra::datastax_agent_service_enable has now been replaced with\r\n cassandra::datastax_agent::service_enable.\r\n* cassandra::datastax_agent_service_ensure has now been replaced with\r\n cassandra::datastax_agent::service_ensure.\r\n* cassandra::datastax_agent_package_name has now been replaced with\r\n cassandra::datastax_agent::package_name.\r\n* cassandra::datastax_agent_service_name has now been replaced with\r\n cassandra::datastax_agent::service_name.\r\n\r\nLikewise now there is a new class for handling the installation of Java:\r\n\r\n* cassandra::java_package_ensure has now been replaced with\r\n cassandra::java::ensure.\r\n* cassandra::java_package_name has now been replaced with\r\n cassandra::java::package_name.\r\n\r\nAlso there is now a class for installing the optional utilities:\r\n\r\n* cassandra::cassandra_opt_package_ensure has now been replaced with\r\n cassandra::optutils:ensure.\r\n* cassandra::cassandra_opt_package_name has now been replaced with\r\n cassandra::optutils:package_name.\r\n\r\n#### Changes in 0.3.0\r\n\r\n* cassandra_opt_package_ensure changed from 'present' to undef.\r\n\r\n* The manage_service option has been replaced with service_enable and\r\n service_ensure.\r\n\r\n## Usage\r\n\r\n### Create a Cluster in a Single Data Center\r\n\r\nIn the DataStax documentation _Initializing a multiple node cluster (single\r\ndata center)_\r\n\r\nthere is a basic example of a six node cluster with two seeds to be created in\r\na single data center spanning two racks. The nodes in the cluster are:\r\n\r\n**Node Name** | **IP Address** |\r\n---------------|----------------|\r\nnode0 (seed 1) | 110.82.155.0 |\r\nnode1 | 110.82.155.1 |\r\nnode2 | 110.82.155.2 |\r\nnode3 (seed 2) | 110.82.156.3 |\r\nnode4 | 110.82.156.4 |\r\nnode5 | 110.82.156.5 |\r\n\r\nEach node is configured to use the GossipingPropertyFileSnitch and 256 virtual\r\nnodes (vnodes). The name of the cluster is _MyCassandraCluster_. Also,\r\nwhile building the initial cluster, we are setting the auto_bootstrap\r\nto false.\r\n\r\nIn this initial example, we are going to expand the example by:\r\n\r\n* Ensuring that the software is installed via the DataStax Community\r\n repository by including `cassandra::datastax_repo`. This needs to be\r\n executed before the Cassandra package is installed.\r\n* That a suitable Java Runtime environment (JRE) is installed with Java Native\r\n Access (JNA) by including `cassandra::java`. This need to be executed\r\n before the Cassandra service is started.\r\n\r\n```puppet\r\nnode /^node\\d+$/ {\r\n class { 'cassandra::datastax_repo':\r\n before => Class['cassandra']\r\n }\r\n\r\n class { 'cassandra::java':\r\n before => Class['cassandra']\r\n }\r\n\r\n class { 'cassandra':\r\n cluster_name => 'MyCassandraCluster',\r\n endpoint_snitch => 'GossipingPropertyFileSnitch',\r\n listen_address => \"${::ipaddress}\",\r\n num_tokens => 256,\r\n seeds => '110.82.155.0,110.82.156.3',\r\n auto_bootstrap => false\r\n }\r\n}\r\n```\r\n\r\nThe default value for the num_tokens is already 256, but it is\r\nincluded in the example for clarity. Do not forget to either\r\nset auto_bootstrap to true or not set the parameter at all\r\nafter initializing the cluster.\r\n\r\n### Create a Cluster in Multiple Data Centers\r\n\r\nTo continue with the examples provided by DataStax, we look at the example\r\nfor a cluster across multiple data centers\r\n.\r\n\r\n**Node Name** | **IP Address** | **Data Center** | **Rack** |\r\n---------------|----------------|-----------------|----------|\r\nnode0 (seed 1) | 10.168.66.41 | DC1 | RAC1 |\r\nnode1 | 10.176.43.66 | DC1 | RAC1 |\r\nnode2 | 10.168.247.41 | DC1 | RAC1 |\r\nnode3 (seed 2) | 10.176.170.59 | DC2 | RAC1 |\r\nnode4 | 10.169.61.170 | DC2 | RAC1 |\r\nnode5 | 10.169.30.138 | DC2 | RAC1 |\r\n\r\nFor the sake of simplicity, we will confine this example to the nodes:\r\n\r\n```puppet\r\nnode /^node[012]$/ {\r\n class { 'cassandra':\r\n cluster_name => 'MyCassandraCluster',\r\n endpoint_snitch => 'GossipingPropertyFileSnitch',\r\n listen_address => \"${::ipaddress}\",\r\n num_tokens => 256,\r\n seeds => '10.168.66.41,10.176.170.59',\r\n dc => 'DC1',\r\n auto_bootstrap => false\r\n }\r\n}\r\n\r\nnode /^node[345]$/ {\r\n class { 'cassandra':\r\n cluster_name => 'MyCassandraCluster',\r\n endpoint_snitch => 'GossipingPropertyFileSnitch',\r\n listen_address => \"${::ipaddress}\",\r\n num_tokens => 256,\r\n seeds => '10.168.66.41,10.176.170.59',\r\n dc => 'DC2',\r\n auto_bootstrap => false\r\n }\r\n}\r\n```\r\n\r\nWe don't need to specify the rack name (with the rack parameter) as RAC1 is\r\nthe default value. Again, do not forget to either set auto_bootstrap to\r\ntrue or not set the parameter at all after initializing the cluster.\r\n\r\n### OpsCenter\r\n\r\nTo continue with the original example within a single data center, say we\r\nhave an instance of OpsCenter running on a node called opscenter which has\r\nan IP address of 110.82.157.6. We add the `cassandra::datastax_agent` to\r\nthe cassandra node to connect to OpsCenter:\r\n\r\n```puppet\r\nnode /^node\\d+$/ {\r\n class { 'cassandra::datastax_repo':\r\n before => Class['cassandra']\r\n } ->\r\n class { 'cassandra::java':\r\n before => Class['cassandra']\r\n } ->\r\n class { 'cassandra':\r\n cluster_name => 'MyCassandraCluster',\r\n endpoint_snitch => 'GossipingPropertyFileSnitch',\r\n listen_address => \"${::ipaddress}\",\r\n num_tokens => 256,\r\n seeds => '110.82.155.0,110.82.156.3',\r\n before => Class['cassandra::datastax_agent']\r\n } ->\r\n class { 'cassandra::datastax_agent':\r\n stomp_interface => '110.82.157.6'\r\n }\r\n}\r\n\r\nnode /opscenter/ {\r\n include '::cassandra::datastax_repo' ->\r\n include '::cassandra' ->\r\n include '::cassandra::opscenter'\r\n}\r\n```\r\n\r\nWe have also added the `cassandra::opscenter` class for the opscenter node.\r\n\r\n### DataStax Enterprise\r\n\r\nAfter configuring the relevant repository, the following snippet works on\r\nCentOS 7 to install DSE Cassandra 4.7.0:\r\n\r\n```puppet\r\nclass { 'cassandra::datastax_repo':\r\n descr => 'DataStax Repo for DataStax Enterprise',\r\n pkg_url => 'https://username:password@rpm.datastax.com/enterprise',\r\n before => Class['cassandra'],\r\n}\r\n\r\nclass { 'cassandra':\r\n cluster_name => 'MyCassandraCluster',\r\n config_path => '/etc/dse/cassandra',\r\n package_ensure => '4.7.0-1',\r\n package_name => 'dse-full',\r\n service_name => 'dse',\r\n}\r\n```\r\n\r\nAlso with DSE, one can specify a remote keyspace for storing the metrics for\r\na cluster. An example is:\r\n\r\n```puppet\r\ncassandra::opscenter::cluster_name { 'Cluster1':\r\n cassandra_seed_hosts => 'host1,host2',\r\n storage_cassandra_username => 'opsusr',\r\n storage_cassandra_password => 'opscenter',\r\n storage_cassandra_api_port => 9160,\r\n storage_cassandra_cql_port => 9042,\r\n storage_cassandra_keyspace => 'OpsCenter_Cluster1'\r\n}\r\n```\r\n\r\n## Reference\r\n\r\n### Public Classes\r\n\r\n* [cassandra](#class-cassandra)\r\n* [cassandra::datastax_agent](#class-cassandradatastax_agent)\r\n* [cassandra::datastax_repo](#class-cassandradatastax_repo)\r\n* [cassandra::firewall_ports](#class-cassandrafirewall_ports)\r\n* [cassandra::java](#class-cassandrajava)\r\n* [cassandra::opscenter](#class-cassandraopscenter)\r\n* [cassandra::opscenter::pycrypto](#class-cassandraopscenterpycrypto)\r\n* [cassandra::optutils](#class-cassandraoptutils)\r\n\r\n### Public Defined Types\r\n* [cassandra::opscenter::cluster_name](#defined-type-cassandraopscentercluster_name)\r\n\r\n### Private Defined Types\r\n\r\n* cassandra::opscenter::setting\r\n* cassandra::firewall_ports::rule\r\n\r\n### Class: cassandra\r\n\r\nA class for installing the Cassandra package and manipulate settings in the\r\nconfiguration file.\r\n\r\n#### Parameters\r\n\r\n##### `authenticator`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: 'AllowAllAuthenticator.\r\n\r\n##### `authorizer`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: 'AllowAllAuthorizer'\r\n\r\n##### `auto_bootstrap`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `auto_snapshot`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'true'\r\n\r\n##### `batchlog_replay_throttle_in_kb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '1024'\r\n\r\n##### `batch_size_warn_threshold_in_kb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 5\r\n\r\n##### `broadcast_address`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `broadcast_rpc_address`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `cas_contention_timeout_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '1000'\r\n\r\n##### `cassandra_9822`\r\nIf set to true, this will apply a patch to the init file for the Cassandra\r\nservice as a workaround for\r\n[CASSANDRA-9822](https://issues.apache.org/jira/browse/CASSANDRA-9822). This\r\noption is silently ignored on the Red Hat family of operating systems as\r\nthis bug only affects Ubuntu systems.\r\nDefault value 'false'\r\n\r\n##### `cassandra_yaml_tmpl`\r\nThe path to the Puppet template for the Cassandra configuration file. This\r\nallows the user to supply their own customized template. A Cassandra 1.X\r\ncompatible template called cassandra1.yaml.erb has been provided by @Spredzy.\r\nDefault value 'cassandra/cassandra.yaml.erb'\r\n\r\n##### `client_encryption_algorithm`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `client_encryption_options -> algorithm`.\r\nDefault value: *undef*\r\n\r\n##### `client_encryption_cipher_suites`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `client_encryption_options -> cipher_suites`.\r\nDefault value: *undef*\r\n\r\n##### `client_encryption_enabled`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `client_encryption_options -> enabled`.\r\nDefault value 'false'\r\n\r\n##### `client_encryption_keystore`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `client_encryption_options -> keystore`.\r\nDefault value 'conf/.keystore'\r\n\r\n##### `client_encryption_keystore_password`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `client_encryption_options -> keystore_password`.\r\nDefault value 'cassandra'\r\n\r\n##### `client_encryption_protocol`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `client_encryption_options -> protocol`.\r\nDefault value: *undef*\r\n\r\n##### `client_encryption_require_client_auth`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `client_encryption_options -> require_client_auth`.\r\nDefault value: *undef*\r\n\r\n##### `client_encryption_store_type`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `client_encryption_options -> store_type`.\r\nDefault value: *undef*\r\n\r\n##### `client_encryption_truststore`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `client_encryption_options -> truststore`.\r\nDefault value: *undef*\r\n\r\n##### `client_encryption_truststore_password`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `client_encryption_options -> truststore_password`.\r\nDefault value: *undef*\r\n\r\n##### `cluster_name`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'Test Cluster'\r\n\r\n##### `column_index_size_in_kb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '64'\r\n\r\n##### `commit_failure_policy`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: 'stop'\r\n\r\n##### `commitlog_directory`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '/var/lib/cassandra/commitlog'\r\n\r\n##### `commitlog_directory_mode`\r\nThe mode for the directory specified in `commitlog_directory`.\r\nDefault value '0750'\r\n\r\n##### `commitlog_segment_size_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: 32\r\n\r\n##### `commitlog_sync`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\n\r\nSee also `commitlog_sync_batch_window_in_ms` and `commitlog_sync_period_in_ms`.\r\nDefault value: 'periodic'\r\n\r\n##### `commitlog_sync_batch_window_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\n\r\nIf `commitlog_sync` is set to 'batch' then this value should be set.\r\nOtherwise it should be set to *undef*.\r\nDefault value: *undef*\r\n\r\n##### `commitlog_sync_period_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf set to a value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\n\r\nIf `commitlog_sync` is set to 'periodic' then this value should be set.\r\nOtherwise it should be set to *undef*.\r\nDefault value: 10000\r\n\r\n##### `commitlog_total_space_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `compaction_throughput_mb_per_sec`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '16'\r\n\r\n##### `concurrent_counter_writes`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '32'\r\n\r\n##### `concurrent_reads`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '32'\r\n\r\n##### `concurrent_writes`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '32'\r\n\r\n##### `config_file_mode`\r\nThe permissions mode of the cassandra configuration file.\r\nDefault value '0644'\r\n\r\n##### `config_path`\r\nThe path to the cassandra configuration file. If this is undef, it will be\r\nchanged to **/etc/cassandra/default.conf** on the Red Hat family of operating\r\nsystems or **/etc/cassandra** on Ubuntu. Otherwise the user can specify the\r\npath name.\r\nDefault value *undef*\r\n\r\n##### `concurrent_compactors`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `counter_cache_save_period`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '7200'\r\n\r\n##### `counter_cache_keys_to_save`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `counter_cache_size_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: ''\r\n\r\n##### `counter_write_request_timeout_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '5000'\r\n\r\n##### `cross_node_timeout`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: 'false'\r\n\r\n##### `data_file_directories`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '['/var/lib/cassandra/data']'\r\n\r\n##### `data_file_directories_mode`\r\nThe mode for the directories specified in `data_file_directories`.\r\nDefault value '0750'\r\n\r\n##### `dc`\r\nSets the value for dc in *config_path*/*snitch_properties_file* see\r\nhttp://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureSnitchesAbout_c.html\r\nfor more details.\r\nDefault value 'DC1'\r\n\r\n##### `dc_suffix`\r\nSets the value for dc_suffix in *config_path*/*snitch_properties_file* see\r\nhttp://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureSnitchesAbout_c.html\r\nfor more details. If the value is *undef* then change will be made to the\r\nsnitch properties file for this setting.\r\nDefault value *undef*\r\n\r\n##### `disk_failure_policy`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'stop'\r\n\r\n##### `dynamic_snitch_badness_threshold`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '0.1'\r\n\r\n##### `dynamic_snitch_reset_interval_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '600000'\r\n\r\n##### `dynamic_snitch_update_interval_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '100'\r\n\r\n##### `endpoint_snitch`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'SimpleSnitch'\r\n\r\n##### `fail_on_non_supported_os`\r\nA flag that dictates if the module should fail if it is not RedHat or Debian.\r\nIf you set this option to false then you must also at least set the\r\n`config_path` parameter as well.\r\nDefault value 'true'\r\n\r\n##### `file_cache_size_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `hinted_handoff_enabled`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'true'\r\n\r\n##### `hinted_handoff_throttle_in_kb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '1024'\r\n\r\n##### `index_summary_capacity_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: ''\r\n\r\n##### `index_summary_resize_interval_in_minutes`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '60'\r\n\r\n##### `incremental_backups`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'false'\r\n\r\n##### `initial_token`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `inter_dc_tcp_nodelay`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: 'false'\r\n\r\n##### `internode_authenticator`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `internode_compression`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'all'\r\n\r\n##### `internode_recv_buff_size_in_bytes`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `internode_send_buff_size_in_bytes`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `key_cache_save_period`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: 14400\r\n\r\n##### `key_cache_size_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: ''\r\n\r\n##### `key_cache_keys_to_save`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `listen_address`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'localhost'\r\n\r\n##### `manage_dsc_repo`\r\nDEPRECATION WARNING: This option is deprecated. Please include the\r\nthe ::cassandra::datastax_repo instead.\r\n\r\nIf set to true then a repository will be setup so that packages can be\r\ndownloaded from DataStax community.\r\nDefault value 'false'\r\n\r\n##### `max_hints_delivery_threads`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '2'\r\n\r\n##### `max_hint_window_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '10800000'\r\n\r\n##### `memory_allocator`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `memtable_cleanup_threshold`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `memtable_flush_writers`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `memtable_heap_space_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `memtable_offheap_space_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `native_transport_max_concurrent_connections`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `native_transport_max_concurrent_connections_per_ip`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `native_transport_max_frame_size_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `native_transport_max_threads`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `native_transport_port`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '9042'\r\n\r\n##### `num_tokens`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '256'\r\n\r\n##### `package_ensure`\r\nThe status of the package specified in **package_name**. Can be\r\n*present*, *latest* or a specific version number.\r\nDefault value 'present'\r\n\r\n##### `package_name`\r\nThe name of the Cassandra package. Must be available from a repository.\r\nDefault value 'dsc22'\r\n\r\n##### `partitioner`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'org.apache.cassandra.dht.Murmur3Partitioner'\r\n\r\n##### `permissions_update_interval_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `permissions_validity_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '2000'\r\n\r\n##### `phi_convict_threshold`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `prefer_local`\r\nSets the value for prefer_local in *config_path*/*snitch_properties_file* see\r\nhttp://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureSnitchesAbout_c.html\r\nfor more details. Valid values are true, false or *undef*. If the value is\r\n*undef* then change will be made to the snitch properties file for this\r\nsetting.\r\nDefault value *undef*\r\n\r\n##### `rack`\r\nSets the value for rack in *config_path*/*snitch_properties_file* see\r\nhttp://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureSnitchesAbout_c.html\r\nfor more details.\r\nDefault value 'RAC1'\r\n\r\n##### `range_request_timeout_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '10000'\r\n\r\n##### `read_request_timeout_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '5000'\r\n\r\n##### `request_scheduler`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: 'org.apache.cassandra.scheduler.NoScheduler'\r\n\r\n##### `request_scheduler_options_default_weight`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `request_scheduler_options_throttle_limit`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `request_timeout_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '10000'\r\n\r\n##### `row_cache_keys_to_save`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `row_cache_save_period`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '0'\r\n\r\n##### `row_cache_size_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '0'\r\n\r\n##### `rpc_address`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'localhost'\r\n\r\n##### `rpc_max_threads`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `rpc_min_threads`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `rpc_port`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '9160'\r\n\r\n##### `rpc_recv_buff_size_in_bytes`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `rpc_send_buff_size_in_bytes`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `rpc_server_type`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'sync'\r\n\r\n##### `saved_caches_directory`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '/var/lib/cassandra/saved_caches'\r\n\r\n##### `saved_caches_directory_mode`\r\nThe mode for the directory specified in `saved_caches_directory`.\r\nDefault value '0750'\r\n\r\n##### `seeds`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `seed_provider -> parameters -> seeds`.\r\nDefault value '127.0.0.1'\r\n\r\n##### `seed_provider_class_name`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `seed_provider -> class_name`.\r\nDefault value 'org.apache.cassandra.locator.SimpleSeedProvider'\r\n\r\n##### `server_encryption_algorithm`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `server_encryption_options -> algorithm`.\r\nDefault value: *undef*\r\n\r\n##### `server_encryption_cipher_suites`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `server_encryption_options -> cipher_suites`.\r\nDefault value: *undef*\r\n\r\n##### `server_encryption_internode`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `server_encryption_options -> internode_encryption`.\r\nDefault value 'none'\r\n\r\n##### `server_encryption_keystore`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `server_encryption_options -> keystore`.\r\nDefault value 'conf/.keystore'\r\n\r\n##### `server_encryption_keystore_password`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `server_encryption_options -> keystore_password`.\r\nDefault value 'cassandra'\r\n\r\n##### `server_encryption_protocol`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `server_encryption_options -> protocol`.\r\nDefault value: *undef*\r\n\r\n##### `server_encryption_require_client_auth`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `server_encryption_options -> require_client_auth`.\r\nDefault value: *undef*\r\n\r\n##### `server_encryption_store_type`\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nThe field being set is `server_encryption_options -> store_type`.\r\nDefault value: *undef*\r\n\r\n##### `server_encryption_truststore`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `server_encryption_options -> truststore`.\r\nDefault value 'conf/.truststore'\r\n\r\n##### `server_encryption_truststore_password`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nThe field being set is `server_encryption_options -> truststore_password`.\r\nDefault value 'cassandra'\r\n\r\n##### `service_enable`\r\nEnable the Cassandra service to start at boot time. Valid values are true\r\nor false.\r\nDefault value 'true'\r\n\r\n##### `service_ensure`\r\nEnsure the Cassandra service is running. Valid values are running or stopped.\r\nDefault value 'running'\r\n\r\n##### `service_name`\r\nThe name of the service that runs the Cassandra software.\r\nDefault value 'cassandra'\r\n\r\n##### `service_refresh`\r\nIf set to true, changes to the Cassandra config file or the data directories\r\nwill ensure that Cassandra service is refreshed after the changes. Setting\r\nthis flag to false will disable this behaviour, therefore allowing the changes\r\nto be made but allow the user to control when the service is restarted.\r\nDefault value true\r\n\r\n##### `snapshot_before_compaction`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'false'\r\n\r\n##### `snitch_properties_file`\r\nThe name of the snitch properties file. The full path name would be\r\n*config_path*/*snitch_properties_file*.\r\nDefault value 'cassandra-rackdc.properties'\r\n\r\n##### `ssl_storage_port`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '7001'\r\n\r\n##### `sstable_preemptive_open_interval_in_mb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '50'\r\n\r\n##### `start_native_transport`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'true'\r\n\r\n##### `start_rpc`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value 'true'\r\n\r\n##### `storage_port`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value '7000'\r\n\r\n##### `streaming_socket_timeout_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nIf left at the default value of *undef* then the entry in the configuration\r\nfile is absent or commented out. If a value is set, then the parameter\r\nand variable are placed into the configuration file.\r\nDefault value: *undef*\r\n\r\n##### `tombstone_failure_threshold`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '100000'\r\n\r\n##### `tombstone_warn_threshold`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '1000'\r\n\r\n##### `trickle_fsync`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: 'false'\r\n\r\n##### `trickle_fsync_interval_in_kb`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '10240'\r\n\r\n##### `truncate_request_timeout_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '60000'\r\n\r\n##### `write_request_timeout_in_ms`\r\nThis is passed to the\r\n[cassandra.yaml](http://docs.datastax.com/en/cassandra/2.1/cassandra/configuration/configCassandra_yaml_r.html) file.\r\nDefault value: '2000'\r\n\r\n### Class: cassandra::datastax_agent\r\n\r\nA class for installing the DataStax Agent and to point it at an OpsCenter\r\ninstance.\r\n\r\n#### Parameters\r\n\r\n##### `defaults_file`\r\nThe full path name to the file where `java_home` is set.\r\nDefault value '/etc/default/datastax-agent'\r\n\r\n##### `java_home`\r\nIf the value of this variable is left as *undef*, no action is taken.\r\nOtherwise the value is set as JAVA_HOME in `defaults_file`.\r\nDefault value *undef*\r\n\r\n##### `package_ensure`\r\nIs passed to the package reference. Valid values are **present** or a version\r\nnumber.\r\nDefault value 'present'\r\n\r\n##### `package_name`\r\nIs passed to the package reference.\r\nDefault value 'datastax-agent'\r\n\r\n##### `service_ensure`\r\nIs passed to the service reference.\r\nDefault value 'running'\r\n\r\n##### `service_enable`\r\nIs passed to the service reference.\r\nDefault value 'true'\r\n\r\n##### `service_name`\r\nIs passed to the service reference.\r\nDefault value 'datastax-agent'\r\n\r\n##### `stomp_interface`\r\nIf the value is changed from the default of *undef* then this is what is\r\nset as the stomp_interface setting in\r\n**/var/lib/datastax-agent/conf/address.yaml**\r\nwhich connects the agent to an OpsCenter instance.\r\nDefault value *undef*\r\n\r\n### Class: cassandra::datastax_repo\r\n\r\nAn optional class that will allow a suitable repository to be configured\r\nfrom which packages for DataStax Community can be downloaded. Changing\r\nthe defaults will allow any Debian Apt or Red Hat Yum repository to be\r\nconfigured.\r\n\r\n#### Parameters\r\n\r\n##### `descr`\r\nOn the Red Hat family, this is passed as the `descr` parameter to a\r\n`yumrepo` resource. On the Debian family, it is passed as the `comment`\r\nparameter to an `apt::source` resource.\r\nDefault value 'DataStax Repo for Apache Cassandra'\r\n\r\n##### `key_id`\r\nOn the Debian family, this is passed as the `id` parameter to an `apt::key`\r\nresource. On the Red Hat family, it is ignored.\r\nDefault value '7E41C00F85BFC1706C4FFFB3350200F2B999A372'\r\n\r\n##### `key_url`\r\nOn the Debian family, this is passed as the `source` parameter to an\r\n`apt::key` resource. On the Red Hat family, it is ignored.\r\nDefault value 'http://debian.datastax.com/debian/repo_key'\r\n\r\n##### `pkg_url`\r\nIf left as the default, this will set the `baseurl` to\r\n'http://rpm.datastax.com/community' on a `yumrepo` resource\r\non the Red Hat family. On the Debian family, leaving this as the default\r\nwill set the `location` parameter on an `apt::source` to\r\n'http://debian.datastax.com/community'. Default value *undef*\r\n\r\n##### `release`\r\nOn the Debian family, this is passed as the `release` parameter to an\r\n`apt::source` resource. On the Red Hat family, it is ignored.\r\nDefault value 'stable'\r\n\r\n### Class: cassandra::firewall_ports\r\n\r\nAn optional class to configure incoming network ports on the host that are\r\nrelevant to the Cassandra installation. If firewalls are being managed \r\nalready, simply do not include this module in your manifest.\r\n\r\nIMPORTANT: The full list of which ports should be configured is assessed at\r\nevaluation time of the configuration. Therefore if one is to use this class,\r\nit must be the final cassandra class included in the manifest.\r\n\r\n#### Parameters\r\n\r\n##### `client_ports`\r\nOnly has any effect if the `cassandra` class is defined on the node.\r\n\r\nAllow these TCP ports to be opened for traffic\r\ncoming from the client subnets.\r\nDefault value '[9042, 9160]'\r\n\r\n##### `client_subnets`\r\nOnly has any effect if the `cassandra` class is defined on the node.\r\n\r\nAn array of the list of subnets that are to allowed connection to\r\ncassandra::native_transport_port and cassandra::rpc_port.\r\nDefault value '['0.0.0.0/0']'\r\n\r\n##### `inter_node_ports`\r\nOnly has any effect if the `cassandra` class is defined on the node.\r\n\r\nAllow these TCP ports to be opened for traffic\r\nbetween the Cassandra nodes.\r\nDefault value '[7000, 7001, 7199]'\r\n\r\n##### `inter_node_subnets`\r\nOnly has any effect if the `cassandra` class is defined on the node.\r\n\r\nAn array of the list of subnets that are to allowed connection to\r\ncassandra::storage_port, cassandra::ssl_storage_port and port 7199\r\nfor cassandra JMX monitoring.\r\nDefault value '['0.0.0.0/0']'\r\n\r\n##### `inter_node_ports`\r\nAllow these TCP ports to be opened for traffic\r\ncoming from OpsCenter subnets.\r\nDefault value '[7000, 7001, 7199]'\r\n\r\n##### `public_ports`\r\nAllow these TCP ports to be opened for traffic\r\ncoming from public subnets the port specified in `$ssh_port` will be\r\nappended to this list.\r\nDefault value '[8888]'\r\n\r\n##### `public_subnets`\r\nAn array of the list of subnets that are to allowed connection to\r\ncassandra::firewall_ports::ssh_port and if cassandra::opscenter has been\r\nincluded, both cassandra::opscenter::webserver_port and\r\ncassandra::opscenter::webserver_ssl_port.\r\nDefault value '['0.0.0.0/0']'\r\n\r\n##### `ssh_port`\r\nWhich port does SSH operate on.\r\nDefault value '22'\r\n\r\n##### `opscenter_ports`\r\nOnly has any effect if the `cassandra::datastax_agent` or\r\n`cassandra::opscenter` classes are defined.\r\n\r\nAllow these TCP ports to be opened for traffic\r\ncoming to or from OpsCenter\r\nappended to this list.\r\nDefault value '[61620, 61621]'\r\n\r\n##### `opscenter_subnets`\r\nA list of subnets that are to be allowed connection to\r\nport 61620 for nodes built with cassandra::opscenter and 61621 for nodes\r\nbuilt with cassandra::datastax_agent.\r\nDefault value '['0.0.0.0/0']'\r\n\r\n### Class: cassandra::java\r\n\r\nA class to install an appropriate Java package.\r\n\r\n#### Parameters\r\n\r\n##### `ensure`\r\nIs passed to the package reference for the JRE/JDK package. Valid values are\r\n**present** or a version number.\r\nDefault value 'present'\r\n\r\n##### `jna_ensure`\r\nIs passed to the package reference for the JNA package. Valid values are\r\n**present** or a version number.\r\nDefault value 'present'\r\n\r\n##### `jna_package_name`\r\nIf the default value of *undef* is left as it is, then a package called\r\njna or libjna-java will be installed on a Red Hat family or Ubuntu system\r\nrespectively. Alternatively, one can specify a package that is available in\r\na package repository to the node.\r\nDefault value *undef*\r\n\r\n##### `package_name`\r\nIf the default value of *undef* is left as it is, then a package called\r\njava-1.8.0-openjdk-headless or openjdk-7-jre-headless will be installed\r\non a Red Hat family or Ubuntu system respectively. Alternatively, one\r\ncan specify a package that is available in a package repository to the\r\nnode.\r\nDefault value *undef*\r\n\r\n### Class: cassandra::opscenter\r\n\r\nThis class installs and manages the DataStax OpsCenter. Leaving the defaults\r\nas they are will provide a running OpsCenter without any authentication on\r\nport 8888.\r\n\r\n#### Parameters\r\n\r\n##### `agents_agent_certfile`\r\nThis sets the agent_certfile setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_agent_keyfile`\r\nThis sets the agent_keyfile setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_agent_keyfile_raw`\r\nThis sets the agent_keyfile_raw setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_config_sleep`\r\nThis sets the config_sleep setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_fingerprint_throttle`\r\nThis sets the fingerprint_throttle setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_incoming_interface`\r\nThis sets the incoming_interface setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_incoming_port`\r\nThis sets the incoming_port setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_install_throttle`\r\nThis sets the install_throttle setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_not_seen_threshold`\r\nThis sets the not_seen_threshold setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_path_to_deb`\r\nThis sets the path_to_deb setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_path_to_find_java`\r\nThis sets the path_to_find_java setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_path_to_installscript`\r\nThis sets the path_to_installscript setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_path_to_rpm`\r\nThis sets the path_to_rpm setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_path_to_sudowrap`\r\nThis sets the path_to_sudowrap setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_reported_interface`\r\nThis sets the reported_interface setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_runs_sudo`\r\nThis sets the runs_sudo setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_scp_executable`\r\nThis sets the scp_executable setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_ssh_executable`\r\nThis sets the ssh_executable setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_ssh_keygen_executable`\r\nThis sets the ssh_keygen_executable setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_ssh_keyscan_executable`\r\nThis sets the ssh_keyscan_executable setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_ssh_port`\r\nThis sets the ssh_port setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_ssh_sys_known_hosts_file`\r\nThis sets the ssh_sys_known_hosts_file setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_ssh_user_known_hosts_file`\r\nThis sets the ssh_user_known_hosts_file setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_ssl_certfile`\r\nThis sets the ssl_certfile setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_ssl_keyfile`\r\nThis sets the ssl_keyfile setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_tmp_dir`\r\nThis sets the tmp_dir setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `agents_use_ssl`\r\nThis sets the use_ssl setting in the agents section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `authentication_audit_auth`\r\nThis sets the audit_auth setting in the authentication section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `authentication_audit_pattern`\r\nThis sets the audit_pattern setting in the authentication section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `authentication_method`\r\nThis sets the authentication_method setting in the authentication section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `authentication_enabled`\r\nThis sets the enabled setting in the authentication section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value 'False'\r\n\r\n##### `authentication_passwd_db`\r\nThis sets the passwd_db setting in the authentication section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `authentication_timeout`\r\nThis sets the timeout setting in the authentication section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `cloud_accepted_certs`\r\nThis sets the accepted_certs setting in the cloud section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `clusters_add_cluster_timeout`\r\nThis sets the add_cluster_timeout setting in the clusters section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `clusters_startup_sleep`\r\nThis sets the startup_sleep setting in the clusters section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `config_file`\r\nThe full path to the OpsCenter configuration file.\r\nDefault value '/etc/opscenter/opscenterd.conf'\r\n\r\n##### `definitions_auto_update`\r\nThis sets the auto_update setting in the definitions section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `definitions_definitions_dir`\r\nThis sets the definitions_dir setting in the definitions section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `definitions_download_filename`\r\nThis sets the download_filename setting in the definitions section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `definitions_download_host`\r\nThis sets the download_host setting in the definitions section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `definitions_download_port`\r\nThis sets the download_port setting in the definitions section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `definitions_hash_filename`\r\nThis sets the hash_filename setting in the definitions section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `definitions_sleep`\r\nThis sets the sleep setting in the definitions section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `definitions_ssl_certfile`\r\nThis sets the ssl_certfile setting in the definitions section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `definitions_use_ssl`\r\nThis sets the use_ssl setting in the definitions section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ensure`\r\nThis is passed to the package reference for **opscenter**. Valid values are\r\n**present** or a version number.\r\nDefault value 'present'\r\n\r\n##### `failover_configuration_directory`\r\nThis sets the failover_configuration_directory setting in the failover section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `failover_heartbeat_fail_window`\r\nThis sets the heartbeat_fail_window setting in the failover section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `failover_heartbeat_period`\r\nThis sets the heartbeat_period setting in the failover section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `failover_heartbeat_reply_period`\r\nThis sets the heartbeat_reply_period setting in the failover section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `hadoop_base_job_tracker_proxy_port`\r\nThis sets the base_job_tracker_proxy_port setting in the hadoop section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_admin_group_name`\r\nThis sets the admin_group_name setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_connection_timeout`\r\nThis sets the connection_timeout setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_debug_ssl`\r\nThis sets the debug_ssl setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_group_name_attribute`\r\nThis sets the group_name_attribute setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_group_search_base`\r\nThis sets the group_search_base setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_group_search_filter`\r\nThis sets the group_search_filter setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_group_search_type`\r\nThis sets the group_search_type setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_ldap_security`\r\nThis sets the ldap_security setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_opt_referrals`\r\nThis sets the opt_referrals setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_protocol_version`\r\nThis sets the protocol_version setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_search_dn`\r\nThis sets the search_dn setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_search_password`\r\nThis sets the search_password setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_server_host`\r\nThis sets the server_host setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_server_port`\r\nThis sets the server_port setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_ssl_cacert`\r\nThis sets the ssl_cacert setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_ssl_cert`\r\nThis sets the ssl_cert setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_ssl_key`\r\nThis sets the ssl_key setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_tls_demand`\r\nThis sets the tls_demand setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_tls_reqcert`\r\nThis sets the tls_reqcert setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_uri_scheme`\r\nThis sets the uri_scheme setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_user_memberof_attribute`\r\nThis sets the user_memberof_attribute setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_user_search_base`\r\nThis sets the user_search_base setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ldap_user_search_filter`\r\nThis sets the user_search_filter setting in the ldap section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `logging_level`\r\nThis sets the level setting in the logging section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `logging_log_length`\r\nThis sets the log_length setting in the logging section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `logging_log_path`\r\nThis sets the log_path setting in the logging section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `logging_max_rotate`\r\nThis sets the max_rotate setting in the logging section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `logging_resource_usage_interval`\r\nThis sets the resource_usage_interval setting in the logging section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `package_name`\r\nThe name of the OpsCenter package.\r\nDefault value 'opscenter'\r\n\r\n##### `provisioning_agent_install_timeout`\r\nThis sets the agent_install_timeout setting in the provisioning section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `provisioning_keyspace_timeout`\r\nThis sets the keyspace_timeout setting in the provisioning section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `provisioning_private_key_dir`\r\nThis sets the private_key_dir setting in the provisioning section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_alert_on_repair_failure`\r\nThis sets the alert_on_repair_failure setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_cluster_stabilization_period`\r\nThis sets the cluster_stabilization_period setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_error_logging_window`\r\nThis sets the error_logging_window setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_incremental_err_alert_threshold`\r\nThis sets the incremental_err_alert_threshold setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_incremental_range_repair`\r\nThis sets the incremental_range_repair setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_incremental_repair_tables`\r\nThis sets the incremental_repair_tables setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_ks_update_period`\r\nThis sets the ks_update_period setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_log_directory`\r\nThis sets the log_directory setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_log_length`\r\nThis sets the log_length setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_max_err_threshold`\r\nThis sets the max_err_threshold setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_max_parallel_repairs`\r\nThis sets the max_parallel_repairs setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_max_pending_repairs`\r\nThis sets the max_pending_repairs setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_max_rotate`\r\nThis sets the max_rotate setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_min_repair_time`\r\nThis sets the min_repair_time setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_min_throughput`\r\nThis sets the min_throughput setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_num_recent_throughputs`\r\nThis sets the num_recent_throughputs setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_persist_directory`\r\nThis sets the persist_directory setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_persist_period`\r\nThis sets the persist_period setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_restart_period`\r\nThis sets the restart_period setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_single_repair_timeout`\r\nThis sets the single_repair_timeout setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_single_task_err_threshold`\r\nThis sets the single_task_err_threshold setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `repair_service_snapshot_override`\r\nThis sets the snapshot_override setting in the repair_service section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `request_tracker_queue_size`\r\nThis sets the queue_size setting in the request_tracker section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `security_config_encryption_active`\r\nThis sets the config_encryption_active setting in the security section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `security_config_encryption_key_name`\r\nThis sets the config_encryption_key_name setting in the security section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `security_config_encryption_key_path`\r\nThis sets the config_encryption_key_path setting in the security section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `service_enable`\r\nEnable the OpsCenter service to start at boot time. Valid values are true\r\nor false.\r\nDefault value 'true'\r\n\r\n##### `service_ensure`\r\nEnsure the OpsCenter service is running. Valid values are running or stopped.\r\nDefault value 'running'\r\n\r\n##### `service_name`\r\nThe name of the service that runs the OpsCenter software.\r\nDefault value 'opscenterd'\r\n\r\n##### `spark_base_master_proxy_port`\r\nThis sets the base_master_proxy_port setting in the spark section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `stat_reporter_initial_sleep`\r\nThis sets the initial_sleep setting in the stat_reporter section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `stat_reporter_interval`\r\nThis sets the interval setting in the stat_reporter section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `stat_reporter_report_file`\r\nThis sets the report_file setting in the stat_reporter section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `stat_reporter_ssl_key`\r\nThis sets the ssl_key setting in the stat_reporter section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ui_default_api_timeout`\r\nThis sets the default_api_timeout setting in the ui section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ui_max_metrics_requests`\r\nThis sets the max_metrics_requests setting in the ui section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ui_node_detail_refresh_delay`\r\nThis sets the node_detail_refresh_delay setting in the ui section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `ui_storagemap_ttl`\r\nThis sets the storagemap_ttl setting in the ui section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `webserver_interface`\r\nThis sets the interface setting in the webserver section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value '0.0.0.0'\r\n\r\n##### `webserver_log_path`\r\nThis sets the log_path setting in the webserver section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `webserver_port`\r\nThis sets the port setting in the webserver section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value '8888'\r\n\r\n##### `webserver_ssl_certfile`\r\nThis sets the ssl_certfile setting in the webserver section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `webserver_ssl_keyfile`\r\nThis sets the ssl_keyfile setting in the webserver section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `webserver_ssl_port`\r\nThis sets the ssl_port setting in the webserver section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `webserver_staticdir`\r\nThis sets the staticdir setting in the webserver section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `webserver_sub_process_timeout`\r\nThis sets the sub_process_timeout setting in the webserver section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n##### `webserver_tarball_process_timeout`\r\nThis sets the tarball_process_timeout setting in the webserver section of the\r\nOpsCenter configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscConfigProps_r.html\r\nfor more details. A value of *undef* will ensure the setting is not present\r\nin the file. Default value *undef*\r\n\r\n\r\n### Class: cassandra::opscenter::pycrypto\r\n\r\nOn the Red Hat family of operating systems, if one intends to use encryption\r\nfor configuration values then the pycrypto library is required. This class\r\nwill install it for the user. See\r\nhttp://docs.datastax.com/en/opscenter/5.2//opsc/configure/installPycrypto.html\r\nfor more details.\r\n\r\nThis class has no effect when included on nodes that are not in the Red Hat\r\nfamily.\r\n\r\n#### Parameters\r\n\r\n##### `ensure`\r\nThis is passed to the package reference for **pycrypto**. Valid values are\r\n**present** or a version number.\r\nDefault value 'present'\r\n\r\n##### `manage_epel`\r\nIf set to true, the **epel-release** package will be installed.\r\nDefault value 'false'\r\n\r\n##### `package_name`\r\nThe name of the PyCrypto package.\r\nDefault value 'pycrypto'\r\n\r\n##### `provider`\r\nThe name of the provider of the pycrypto package.\r\nDefault value 'pip'\r\n\r\n##### `reqd_pckgs`\r\nPackages that are required to install the pycrypto package.\r\nDefault value '['python-devel', 'python-pip' ]'\r\n\r\n### Class: cassandra::optutils\r\n\r\nA class to install the optional Cassandra tools package.\r\n\r\n#### Parameters\r\n\r\n##### `ensure`\r\nIs passed to the package reference. Valid values are **present** or a version\r\nnumber.\r\nDefault value 'present'\r\n\r\n##### `package_name`\r\nIf the default value of *undef* is left as it is, then a package called\r\ncassandra22-tools or cassandra-tools will be installed\r\non a Red Hat family or Ubuntu system respectively. Alternatively, one\r\ncan specify a package that is available in a package repository to the\r\nnode.\r\nDefault value *undef*\r\n\r\n### Defined Type cassandra::opscenter::cluster_name\r\n\r\nWith DataStax Enterprise, one can specify a remote keyspace for OpsCenter\r\nto store metric data (this is not available in the DataStax Community Edition).\r\n\r\n#### Parameters\r\n\r\n##### `cassandra_seed_hosts`\r\nThis sets the seed_hosts setting in the cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_api_port`\r\nThis sets the api_port setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_bind_interface`\r\nThis sets the bind_interface setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_connection_pool_size`\r\nThis sets the connection_pool_size setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_connect_timeout`\r\nThis sets the connect_timeout setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_cql_port`\r\nThis sets the cql_port setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_keyspace`\r\nThis sets the keyspace setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_local_dc_pref`\r\nThis sets the local_dc_pref setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_password`\r\nThis sets the password setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_retry_delay`\r\nThis sets the retry_delay setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_seed_hosts`\r\nThis sets the seed_hosts setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_send_rpc`\r\nThis sets the send_rpc setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_ssl_ca_certs`\r\nThis sets the ssl_ca_certs setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_ssl_client_key`\r\nThis sets the ssl_client_key setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_ssl_client_pem`\r\nThis sets the ssl_client_pem setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_ssl_validate`\r\nThis sets the ssl_validate setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_used_hosts_per_remote_dc`\r\nThis sets the used_hosts_per_remote_dc setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n##### `storage_cassandra_username`\r\nThis sets the username setting in the storage_cassandra section of the\r\n_cluster_name_.conf configuration file. See\r\nhttp://docs.datastax.com/en/opscenter/5.2/opsc/configure/opscStoringCollectionDataDifferentCluster_t.html\r\nfor more details. A value of *undef* will ensure the setting is not\r\npresent in the file. Default value *undef*\r\n\r\n### Defined Type cassandra::firewall_ports::rule\r\n\r\nA defined type to be used as a macro for setting host based firewall\r\nrules. This is not intended to be used by a user (who should use the\r\nAPI provided by cassandra::firewall_ports instead) but is documented\r\nhere for completeness.\r\n\r\n#### Parameters\r\n\r\n##### `title`\r\nA text field that contains the protocol name and CIDR address of a subnet.\r\n\r\n##### `port`\r\nThe number(s) of the port(s) to be opened.\r\n\r\n### Defined Type cassandra::opscenter::setting\r\n\r\nA defined type to be used as a macro for settings in the OpsCenter\r\nconfiguration file. This is not intended to be used by a user (who\r\nshould use the API provided by cassandra::opscenter instead) but is documented\r\nhere for completeness.\r\n\r\n#### Parameters\r\n\r\n##### `service_name`\r\nThe name of the service to be notified if a change is made to the\r\nconfiguration file. Typically this would by **opscenterd**.\r\n\r\n##### `path`\r\nThe path to the configuration file. Typically this would by\r\n**/etc/opscenter/opscenterd.conf**.\r\n\r\n##### `section`\r\nThe section in the configuration file to be added to (e.g. **webserver**).\r\n\r\n##### `setting`\r\nThe setting within the section of the configuration file to changed\r\n(e.g. **port**).\r\n\r\n##### `value`\r\nThe setting value to be changed to (e.g. **8888**).\r\n\r\n## Limitations\r\n\r\nTested on the Red Hat family versions 6 and 7, Ubuntu 12.04 and 14.04,\r\nDebian 7 Puppet (CE) 3.7.5 and DSC 2.\r\n\r\nFrom release 1.6.0 of this module, regular updates of the Cassandra 1.X\r\ntemplate will cease and testing against this template will cease. Testing\r\nagainst the template for versions of Cassandra >= 2.X will continue.\r\n\r\n## Contributers\r\n\r\nContributions will be gratefully accepted. Please go to the project page,\r\nfork the project, make your changes locally and then raise a pull request.\r\nDetails on how to do this are available at\r\nhttps://guides.github.com/activities/contributing-to-open-source.\r\n\r\nPlease also see the\r\n[CONTRIBUTING.md](https://github.com/locp/cassandra/blob/master/CONTRIBUTING.md)\r\npage for project specific requirements.\r\n\r\n### Additional Contributers\r\n\r\n* Yanis Guenane (GitHub [@spredzy](https://github.com/Spredzy)) provided the\r\nCassandra 1.x compatible template\r\n(see [#11](https://github.com/locp/cassandra/pull/11)).\r\n\r\n* Amos Shapira (GitHub [@amosshapira](https://github.com/amosshapira)) fixed\r\na bug in the requirements metadata that caused a problem with Puppetfile\r\n(see [#34](https://github.com/locp/cassandra/pull/34)).\r\n\r\n* Dylan Griffith (GitHub [@DylanGriffith](https://github.com/DylanGriffith))\r\nidentified that the dependency for puppetlabs-apt was incorrect\r\n(see [#87](https://github.com/locp/cassandra/pull/87)).\r\n\r\n* Sam Powers (GitHub [@sampowers](https://github.com/sampowers)) reported a\r\nbug in the ability to set the running state of the Cassandra service and\r\nsubsequently submitted a pull request with a fix\r\n(see [#93](https://github.com/locp/cassandra/issues/93)).\r\n\r\n* [@markasammut](https://github.com/markasammut) contributed a pull request\r\nto set the batch_size_warn_threshold_in_kb parameter (see\r\n[#100](https://github.com/locp/cassandra/pull/100)).\r\n\r\n* [@markasammut](https://github.com/markasammut) also contributed a pull\r\nrequest to restart the service if the datastax-agent package is upgraded\r\n(see [#110](https://github.com/locp/cassandra/pull/110)).\r\n","google":"UA-6773548-6","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file +{"name":"Cassandra","tagline":"Installs Cassandra, DataStax Agent & OpsCenter on RHEL/Ubuntu/Debian.","body":"# Overview\r\nThis is a Puppet module for installing Cassandra by DataStax.\r\n\r\n# Links\r\n\r\n* https://forge.puppetlabs.com/locp/cassandra\r\n* https://github.com/locp/cassandra\r\n * https://github.com/locp/cassandra/wiki","google":"UA-6773548-6","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file