cassandra

Project status

GitHub:

Nightly Workflows:

Puppet Forge:

Table of Contents

• cassandra
  • Project status
  • Table of Contents
  • Description
  • Setup
    • What cassandra affects
    • Setup Requirements
    • Beginning with cassandra
  • Usage
    • Installation versions
    • Main node configuration
      • Setting up initial_token
    • Rack and DC settings
    • Topology settings
    • Setting the runtime environment
      • Environment variables
      • JVM options
      • Java runtime settings
    • Java garbage collection settings
    • JVM option sets
      • JVM options for Cassandra 3.x
      • Cassandra 4.0 JVM setup
  • Reference
  • Limitations
  • Development

Description

This module enables Puppet to install, configure and run Apache Cassandra nodes. As a spin-off of several years of experience we collected in running Cassandra in a production environment, using Puppet to maintain the configuration of the nodes. During its evolution the module has proven to be useful for Cassandra versions ranging from early 1.1, over many 2.x, 3.0, 3.11 to latest 5.0 releases and multiple distributions, e.g. DSE, Apache and other. Efforts are taken to keep the generally available Apache open-source releases supported.

Leveraging the declarative nature of Puppet DSL, Cassandra configuration is considered a declarative description of the desired state and will be ensured in the node configuration. Configuration values not declared in the manifest will be kept untouched by this module.

Conceptualized to fit into a roles/profiles design pattern, this module keeps a strong focus on the topic of Cassandra node configuration disregarding many aspects bound to the use-case and the infrastructure environment.

Setup

What cassandra affects

This module affects the following component:

• Install the Packages cassandra and cassandra-tools.
• It takes control over the file .cassandra.in.sh located in Cassandra user's home directory.
• It takes control over cassandra-rackdc.properties and cassandra-topology.properties
• Optionally it can take control over the jvm.options file and its successors for multiple Java versions and variants, used to configure Java parameters.
• It manages the content of the cassandra.yaml by merging a configuration hash to the file as it is found on the node, i.e. installed from the package.

A bit more important to know is that it does not control the contents of cassandra-env.sh and many other files, which might lead to conflicts during package updates.

Setup Requirements

Installation and running of Cassandra will require some other settings not covered by this module, e.g.:

• access to a package repository providing the necessery packages for your operating system distribution
• installation of a suitable Java runtime environment
• setup of a proper clock synchronisation, e.g. NTP
• configuration of additional settings, e.g. kernel parameter, firewall, etc.

Beginning with cassandra

Include the module to your node manifests (or your role or profile module):

contain cassandra

Usage

Once included in the node manifest the module can be configured via Hiera.

Installation versions

By default the latest available version of cassandra and cassandra-tools packages will be installed. The default settings will prevent autoatic upgrades.

If you want Puppet to install a specific version, e.g. 4.0.0, just add the following parameter to your Hiera DB:

cassandra::cassandra_ensure: 4.0.0

The version ensurement of the tools package defaults to cassandra::cassandra_ensure but can be set differently, e.g.:

cassandra::tools_ensure: latest

If you don't want to install the tools package, you can set:

cassandra::tools_ensure: absent

In the case, your package name differs from default Apache releases you may change cassandra_package and/or tools_package settings, e.g.

cassandra::cassandra_package: dsc22

Main node configuration

The module provides you access to the main configuration file, the cassandra.yaml, through the configuration parameter config. This may contain a hash resembling the structure of the cassandra.yaml, which will be merged to the current content of the cassandra.yaml file on the node. This merge will only happen on the node itself.

Thus the config parameter should contain only those settings you want to have non-default, i.e. want to change on the node. Keep in mind, that the structure of this hash must fit to the structure of cassandra.yaml, e.g.

cassandra::config:
  cluster_name: Example Cassandra cluster
  endpoint_snitch: PropertyFileSnitch
  seed_provider:
    - class_name: org.apache.cassandra.locator.SimpleSeedProvider
      parameters:
        - seeds: 10.0.0.1,10.0.1.1
  listen_address: "%{facts.networking.ip}"

As seen for listen_address in the example, you can use Hiera interpolation to access Facts to setup the Cassandra node.

For deeper understanding of this merge procedure refer to the cataphract/yaml_settings module, which is used to merge the config hash with the cassandra.yaml on the node.

Setting up initial_token

If your Cassandra setup relies on the setting of initial_token within cassandra.yaml, the module is providing a sophisticated feature. You may set the initial_tokens parameter containing a hash mapping the initial token for each node by a node key. The module will lookup the initial_token for each node by the configured node_key and set the initial_token within the config hash. If there is no entry for a node found, an error is raised which stops the Puppet agent on that node. Example:

cassandra::initial_tokens:
  node01.server.lan: '0'
  node02.server.lan: '56713727820156410577229101238628035242'
  node03.server.lan: '113427455640312821154458202477256070484'

The node_key parameter, which defaults to $facts['networking']['fqdn'] can be changed if you want to map the initial_token by some other ID.

Rack and DC settings

When using GossipingPropertyFileSnitch class for endpoint snitch your cluster, you can manage the cassandra-rackdc.properties file through the rackdc parameter of this module.

cassandra::rackdc:
  dc: dc1
  rack: rackA

Optionally parameters prefer_local and dc_suffix are also accepted in the rackdc hash.

Topology settings

Using enpoint snitch classes PropertyFileSnitch or GossipingPropertyFileSnitch, you might want to control the contents of cassandra-topology.properties file. This is enabled through the topology parameter of this module. Containing a multi-leveld hash mapping arrays of your nodes to the racks and the racks to the datacenters. For example:

cassandra::topology:
  dc1:
    rackA:
    - 10.0.0.1
    - 10.0.0.2
    rackB:
    - 10.0.0.3
    - 10.0.0.4
  dc2:
    rackA:
    - 10.0.1.1
    - 10.0.1.2
    rackB:
    - 10.0.1.3
    - 10.0.1.4

This will end up in a cassandra-topology.properties file containing:

10.0.0.1=dc1:rackA
10.0.0.2=dc1:rackA
10.0.0.3=dc1:rackB
10.0.0.4=dc1:rackB
10.0.1.1=dc2:rackA
10.0.1.2=dc2:rackA
10.0.1.3=dc2:rackB
10.0.1.4=dc2:rackB

Note #1: leaving the topology parameter undef (which is default), the module will remove the cassandra-topology.properties file from your nodes. This is intended behaviour to support the migration from PropertyFileSnitch to GossipingPropertyFileSnitch.

Note #2: while many configuration changes will notify the service to restart, this is suppressed in the module on updates to the cassandra-topology.properties file. Changes made to the topology won't bump the Cassandra node, because both snitch classes using this file are reloading it in runtime to read its updated content.

Setting the runtime environment

The module provides a variety of settings to runtime environment and the Java VM.

Environment variables

The defined type cassandra::environment::variable can be used to created variables in the Cassandra process's environment. These typically contain MAX_HEAP_SIZE, HEAP_NEWSIZE, JAVA_HOME, LOCAL_JMX and other Cassandra specific variables.

Using the environment parameter will create cassandra::environment::variable instances, e.g.:

cassandra::environment:
  MAX_HEAP_SIZE: 8G
  HEAP_NEWSIZE: 2G

JVM options

The defined type cassandra::environment::jvm_option add options to the JVM Cassandra is running on.

Using the jvm_options parameter will create instances of cassandra::environment::jvm_option, e.g.:

cassandra::jvm_options:
  - verbose:gc
  - server

Java runtime settings

Within the cassandra::java namespace there are components allowing to setup:

• Java agents through defined type cassandra::java::agent
• Properties through defined type cassandra::java::property
• runtime options through defined type cassandra::java::runtimeoption
• advanced runtime options through defined type cassandra::java::advancedruntimeoption
• garbage collector settings through class cassandra::java::gc

Using the java property will create instances of the above. E.g.:

cassandra::java:
  properties:
    cassandra.consistent.rangemovement: false
    cassandra.replace_address: 10.0.0.2
  agents:
    jmx_prometheus_javaagent.jar: 8080:config.yaml
  runtime_options:
    check: jni
  adv_runtime_options:
    LargePageSizeInBytes: 2m
    UseLargePages: true
    AlwaysPreTouch: true

Java garbage collection settings

Deprication notice: cassandra::java_gc and the class cassandra::java::gc are now deprecated. Consider using JVM option sets instead.

Settings to Java garbage collector can be made by instanciating the cassandra::java::gc class. Using the java_gc parameter will instantiate the class, e.g.:

cassandra::java_gc:
  collector: g1
  params:
    maxGCPauseMillis: 300

JVM option sets

Since version 2.2 the module is supporting a novel approach to setup options of Cassandra Java runtime. The JVM option set feature is controlling the jvm.options file of Cassandra 3.x and many combinations used for different Java versions and use case scopes by Cassandra 4.0 and later.

Note, that much of these settings will override settings done with cassandra::java and all of this will collide with cassandra::java_gc if set. Thus remove cassandra::java_gc at all when starting with cassandra::jvm_option_sets and consider migrating cassandra::java settings to cassandra::jvm_options.

JVM options for Cassandra 3.x

Default behaviour will control the jvm.options file. The defined type cassandra::jvm_option_set resource take parameters options, sizeoptions, properties and advancedoptions and add the settings to the jvm.options file.

Use the cassandra::jvm_option_sets parameter to build instances of cassandra::jvm_option_set type. For example:

cassandra::jvm_option_sets:
  example:
    options:
      - ea
      - server
    sizeoptions:
      Xms: 4G
      Xmx: 4G
      Xmn: 800M
    advancedoptions:
      LargePageSizeInBytes: 2m
      UseLargePages: true
      AlwaysPreTouch: true
    properties:
      cassandra.start_rpc: false

For all options, advanced runtime options and properties in the above example, the Puppet module will take control over the according lines in the jvm.options file only and set the desired options. Many other settings within jvm.options will not be touched by Puppet.

The top level ID (example) is the name of the option set allowing the grouping of options. Multiple option sets are allowed, however, it is not allowed to set the same option within different option sets.

In order to enable the removal of specific settings from jvm.options, use a tilde ~ to prefix options, and undef value (denoted with tilde ~ in Hiera) of properties, sizeoptions and advancedoptions. The example below show how to remove specific settings.

cassandra::jvm_option_sets:
  remove:
    options:
      - ~ea
    sizeoptions:
      Xmn: ~
    advancedoptions:
      FlightRecorder: ~
    properties:
      cassandra.initial_token: ~

Cassandra 4.0 and later JVM setup

Cassandra 4.0 and later are using distinct option files for server operation and client tools, for Java version independent options and for different Java versions. Set the parameters optsfile to jvm, jvm8, jvm11 or jvm17 and variant to server or clients accordingly.

cassandra::jvm_option_sets:
  java8example:
    optsfile: jvm8
    variant: server
    advancedoptions:
      ThreadPriorityPolicy: 42
  java11example:
    optsfile: jvm11
    variant: server
    advancedoptions:
      UseConcMarkSweepGC: false
      CMSParallelRemarkEnabled: ~
      UnlockExperimentalVMOptions: true
      UseZGC: true

Reference

Automatically generated reference documentation is available in the REFERENCE.md file or at https://rtib.github.io/puppet-cassandra/.

Limitations

For supported operating systems and dependencies, see metadata.json.

Extensive itegration tests are run nightly to assure quality and compatibility with next releases.

The current integration test matrix:

1: Note, that this module will not manage any JDK installation. The JDK versions listed here are automatically installed via dependencies while the module is installing the latest available Cassandra version from the release branch.

Development

The module is developed using recent Puppet Development Kit, validated and extensively tested using Puppet Litmus. Automated workflows, implemented with GitHub Actions are run on demand and nightly, doing validation, spec tests and continuous integration tests.

As an open project, you are welcome to contribute to this module. Currently, there is no contribution guide specific to this module, general information about the workflow may apply. In case of questions feel free to open a issue or join community Slack channels #forge-modules, #puppet, #puppet-dev, #testing on slack.puppet.com.

Issues and pull requests will be addressed in a timely manner, according to community best practice. Releases are going to be published on demand, after having merged an set of sufficiently important changes and all tests succeeded. There may be automated rule enforcement in place to provide a healthy issue lifecycle.

Reference

Table of Contents

Classes

• cassandra: This is the main entry point and API for Cassandra module.
• cassandra::config: Manages the configuration files on your Cassandra nodes
• cassandra::config::rackdc: Class to manage the cassandra-rackdc.properties file
• cassandra::config::topology: Class to manage the cassandra-topology.properties file
• cassandra::install: Installs the Cassandra packages.
• cassandra::java::gc: Setup the Java garbage collection for Cassandra
• cassandra::reaper: Manage a cassandra-reaper instance
• cassandra::reaper::config: Do not include this class for its own.
• cassandra::reaper::install: Do not include this class for its own.
• cassandra::reaper::service: Do not include this class for its own.
• cassandra::service: Controls the service

Defined types

• cassandra::environment::jvm_option: Creates a JVM option for Cassandra.
• cassandra::environment::variable: Creating an environment variable for Cassandra.
• cassandra::java::advancedruntimeoption: Add an advanced runtime option to the JVM running Cassandra.
• cassandra::java::agent: Add an agent to the JVM running Cassandra.
• cassandra::java::property: Add a Java property to the JVM running Cassandra.
• cassandra::java::runtimeoption: Add a runtime option to the JVM running Cassandra.
• cassandra::jvm_option_set: Set JVM options by controlling particular lines of jvm.options file.

Data types

• Cassandra::Rackdc: Hash allowing to setup the content of cassandra-rackdc.properties. Note, that the fields dc and rack mandatory to setup rackdc, while `
• Cassandra::Service::Enable: Service enable can be manual or mask besides the Boolean.
• Cassandra::Service::Ensure: This type is simply missing from Stdlib.

Classes

cassandra

Puppet module for Cassandra cluster which enables to install, configure and manage Cassandra nodes. The module consists of the install class, which is included first, followed by config and config::topology classes. Finally, the service class is included and notification from config are forwarded to service.

This class is the main class of this module and the only one which should be included in your node manifests. For documentation of the particular feature, refer to the reference documentation of the other components.

Examples

include cassandra

Parameters

The following parameters are available in the cassandra class:

• cassandra_package
• cassandra_ensure
• tools_package
• tools_ensure
• manage_service
• service_ensure
• service_enable
• service_name
• config_dir
• environment
• jvm_option_sets
• jvm_options
• java
• java_gc
• config
• initial_tokens
• node_key
• cassandra_home
• envfile
• rackdc
• topology
• topology_default

cassandra_package

Data type: String

name of the package to be installed

Default value: 'cassandra'

cassandra_ensure

Data type: String

ensure clause for cassandra package

Default value: 'installed'

tools_package

Data type: String

package name of cassandra tools

Default value: 'cassandra-tools'

tools_ensure

Data type: String

ensure clause for tools package

Default value: $cassandra_ensure

manage_service

Data type: Boolean

enables puppet to manage the service

Default value: true

service_ensure

Data type: Cassandra::Service::Ensure

ensure clause for cassandra service

Default value: undef

service_enable

Data type: Cassandra::Service::Enable

enable state of cassandra service

Default value: false

service_name

Data type: String

the name of the cassandra service

Default value: 'cassandra'

config_dir

Data type: Stdlib::Absolutepath

cassandra configuration directory

Default value: '/etc/cassandra'

environment

Data type: Hash

hash of environment variable name-value pairs which should be add

Default value: {}

jvm_option_sets

Data type: Hash

list of option sets containing JVM options, properties and advanced runtime options

Default value: {}

jvm_options

Data type: Array[String]

list of options to be passed to the JVM

Default value: []

java

Data type: Struct[{ properties => Optional[Hash], agents => Optional[Hash], runtime_options => Optional[Hash], adv_runtime_options => Optional[Hash], }]

input hash to the factory of java properties, agents, runtime_options and advanced_runtime_options

Default value: {}

java_gc

Data type: Optional[Hash]

input hash to the java::gc class

Default value: undef

config

Data type: Hash

configuration hash to be merged with local cassandra.yaml on the node

Default value: {}

initial_tokens

Data type: Optional[Hash[Stdlib::Host,Pattern[/^[0-9]+$/]]]

mapping inital token to nodes and merge them into the config

Default value: undef

node_key

Data type: Stdlib::Host

the key used in initial_tokens to identify nodes

Default value: $facts['networking']['fqdn']

cassandra_home

Data type: Stdlib::Absolutepath

homedirectory of cassandra user

Default value: '/var/lib/cassandra'

envfile

Data type: Stdlib::Absolutepath

envfile path containing environment settings

Default value: "${cassandra_home}/.cassandra.in.sh"

rackdc

Data type: Optional[Cassandra::Rackdc]

rack and dc settings to be used by GossipingPropertyFileSnitch

Default value: undef

topology

Data type: Optional[Hash]

hash describing the topology to be used by PropertyFileSnitch and GossipingPropertyFileSnitch

Default value: undef

topology_default

Data type: Optional[Pattern[/[a-zA-Z0-9.]:[a-zA-Z0-9.-]/]]

default dc and rack settings

Default value: undef

cassandra::config

This class is managing the following files:

• /var/lib/cassandra/.cassandra.in.sh
• /etc/cassandra/cassandra-rackdc.properties
• /etc/cassandra/cassandra.yaml
• /etc/cassandra/jvm.options

The main class of this module will include this class, you should not invoke this at all.

All parameter necessery for this class are defined in the main class.

The config parameter should contain only those settings you want to have non-default, i.e. want to change on the node. Keep in mind, that the structure of this hash must fit to the structure of cassandra.yaml.

Examples

main config file handling

cassandra::config:
  cluster_name: Example Cassandra cluster
  endpoint_snitch: PropertyFileSnitch
  seed_provider:
    - class_name: org.apache.cassandra.locator.SimpleSeedProvider
      parameters:
        - seeds: 10.0.0.1,10.0.1.1
  listen_address: "%{facts.networking.ip}"

cassandra::config::rackdc

This class manages the cassandra-rackdc.properties file, which is needed when using GossippingPropertyFileSnitch.

This class is contained with config, thus do not use it for its own.

Examples

simple rack and DC settings

cassandra::rackdc:
  dc: dc1
  rack: rackA

rack, DC and dc_suffix settings

cassandra::rackdc:
  dc: dc1
  rack: rackA
  dc_suffix: .example.org

cassandra::config::topology

This class manages the cassandra-topology.properties file, which is needed when using PropertyFileSnitch or GossippingPropertyFileSnitch.

This class is contained with config, thus do not use it for its own.

Examples

multi-dc and multi-rack topology

cassandra::topology:
  dc1:
    rackA:
    - 10.0.0.1
    - 10.0.0.2
    rackB:
    - 10.0.0.3
    - 10.0.0.4
  dc2:
    rackA:
    - 10.0.1.1
    - 10.0.1.2
    rackB:
    - 10.0.1.3
    - 10.0.1.4

setting up topology_default

cassandra::topology:
  dc1:
    rackA:
    - 10.0.0.1
    - 10.0.0.2
    rackB:
    - 10.0.0.3
    - 10.0.0.4
  dc2:
    rackA:
    - 10.0.1.1
    - 10.0.1.2
    rackB:
    - 10.0.1.3
    - 10.0.1.4
cassandra::topology_default: dc1:rackA

cassandra::install

This class is installing the Cassandra and optionally the Tools packages.

The main class of this module will include this class, you should not invoke this at all.

All parameter necessery for this class are defined in the main class.

Examples

install a specific version

cassandra::cassandra_ensure: 3.0.18

to install the latest version of cassandra-tools, independently from the cassandra version above

cassandra::tools_ensure: latest

if you don't want to install the tools package

cassandra::tools_ensure: absent

in the case, your package name is other

cassandra::cassandra_package: dsc22

cassandra::java::gc

Deprication notice: this class is now deprecated. Consider using JVM option sets instead.

This class allows to set consistent JVM options at once, especially for the purpose of garbage collection settings. This is enabled by managing jvm.options file, available from Cassandra version 3.0 and later.

GC parameters could be:

• common parameters
  • numberOfGCLogFiles (Integer, defaults to: 10) - -XX:NumberOfGCLogFiles
  • gCLogFileSize (String, defaults to: 10M) - -XX:GCLogFileSize
• G1 specific parameters
  • maxGCPauseMillis (Integer, defaults to: 500) - -XX:MaxGCPauseMillis
  • g1RSetUpdatingPauseTimePercent (Integer, defaults to: 5) - -XX:G1RSetUpdatingPauseTimePercent
  • initiatingHeapOccupancyPercent (Integer, defaults to: 70) - -XX:InitiatingHeapOccupancyPercent
  • parallelGCThreads (Optional[Integer], defaults to: undef) - -XX:ParallelGCThreads automatically set to number or cores-2 if >10 cores present
  • concGCThreads (Optional[Integer], defaults to: undef) - -XX:ConcGCThreads automatically set to -XX:ParallelGCThreads if the above is set

The config class contains a factory for this class which will create an instance using the settings of cassandra::java_gc, if not undef.

Examples

directly created

class { 'cassandra::java::gc':
  collector => 'g1',
}

factory generated

cassandra::java_gc:
  collector: g1
  params:
    maxGCPauseMillis: 300

Parameters

The following parameters are available in the cassandra::java::gc class:

• collector
• params

collector

Data type: Enum['cms','g1']

select the garbage collector to use

params

Data type: Hash[String,Data]

parameter to set up the selected GC

Default value: {}

cassandra::reaper

This class is installing and managing an instance of cassandra-repear.

Examples

include cassandra::reaper

Parameters

The following parameters are available in the cassandra::reaper class:

• package_ensure
• template
• settings
• configdir
• templatedir
• service_ensure
• service_enable

package_ensure

Data type: String

package state to be ensured

Default value: 'latest'

template

Data type: Optional[String]

select the configuration template to which the settings are going to be merged

Default value: undef

settings

Data type: Hash

hash of cassandra-reaper settings to be merged

Default value: {}

configdir

Data type: Stdlib::Absolutepath

directory where to place the configuration file

Default value: '/etc/cassandra-reaper'

templatedir

Data type: Stdlib::Absolutepath

directory containing the template configurations

Default value: "${configdir}/configs"

service_ensure

Data type: Cassandra::Service::Ensure

serivce state to be ensured

Default value: 'running'

service_enable

Data type: Cassandra::Service::Enable

whether to enable or disable the service

Default value: true

cassandra::reaper::config

Managing the configuration of a cassandra reaper instance.

This class is included by cassandra::reaper and should not be used otherwise.

cassandra::reaper::install

Installing a cassandra reaper instance.

This class is included by cassandra::reaper and should not be used otherwise.

cassandra::reaper::service

Managing the service of a cassandra reaper instance.

This class is included by cassandra::reaper and should not be used otherwise.

cassandra::service

This class is controlling the Cassandra service on the nodes. Take care of the fact, that configuration changes will notify the service which may lead to onorchestrated node restarts on your cluster.

You probably don't want this happen in production.

Defined types

cassandra::environment::jvm_option

Each instance of this type is adding a JVM option to the JVM running the Cassandra. This enables you to set e.g. verbose:gc.

The config class contains a factory for this type which will create instances for each key of cassandra::jvm_options.

Examples

directly created

cassandra::jvm_option { 'verbose:gc': }

factory generated

cassandra::jvm_options:
  - verbose:gc
  - server

cassandra::environment::variable

Each instance of this type is adding a environment variable to the Cassandra process. This enables you to set e.g. MAX_HEAP_SIZE, HEAP_NEWSIZE, etc.

The config class contains a factory for this type which will create instances for each key of cassandra::environment.

Examples

directly created

cassandra::environment::variable { 'MAX_HEAP_SIZE':
  value => '8G',
}

factory generated

cassandra::environment:
  MAX_HEAP_SIZE: 8G
  HEAP_NEWSIZE: 2G

Parameters

The following parameters are available in the cassandra::environment::variable defined type:

• id
• value

id

Data type: String

name of the environment variable

Default value: $title

value

Data type: String

value to be assigned to the variable

cassandra::java::advancedruntimeoption

Each instance of this type adds a advanced runtime option to the JVM running Cassandra.

The config class contains a factory for this type which will create instances for each key of cassandra::java::runtime_options.

Examples

directly created

cassandra::java::advancedruntimeoption { 'LargePageSizeInBytes':
  value => '2m',
}

factory generated

cassandra::java:
  adv_runtime_options:
    LargePageSizeInBytes: 2m
    UseLargePages: true
    AlwaysPreTouch: true

Parameters

The following parameters are available in the cassandra::java::advancedruntimeoption defined type:

• value

value

Data type: Scalar

a string value to be added to the runtime option or a boolean which will prefix the option with + or -

cassandra::java::agent

Each instance of this type adds an agent to the JVM running Cassandra.

The config class contains a factory for this type which will create instances for each key of cassandra::java::agents.

Examples

directly created

cassandra::java::agent { 'jmx_prometheus_javaagent.jar':
  value => '8080:config.yaml',
}

factory created

cassandra::java:
  agents:
    jmx_prometheus_javaagent.jar: 8080:config.yaml

Parameters

The following parameters are available in the cassandra::java::agent defined type:

• value

value

Data type: Optional[String]

options to be added to the agent

Default value: undef

cassandra::java::property

Each instance of this type adds a property to the JVM running Cassandra.

The config class contains a factory for this type which will create instances for each key of cassandra::java::properties.

Examples

directly created

cassandra::java::property { 'cassandra.replace_address':
  value => '10.0.0.2'
}

factory generated

cassandra::java:
  properties:
    cassandra.consistent.rangemovement: false
    cassandra.replace_address: 10.0.0.2

Parameters

The following parameters are available in the cassandra::java::property defined type:

• value

value

Data type: Scalar

the value the property is set to

cassandra::java::runtimeoption

Each instance of this type adds a runtime option to the JVM running Cassandra.

The config class contains a factory for this type which will create instances for each key of cassandra::java::runtime_options.

Examples

directly created

cassandra::java::runtimeoption { 'prof': }

factory generated

cassandra::java:
  runtime_options:
    check: jni
    prof:

Parameters

The following parameters are available in the cassandra::java::runtimeoption defined type:

• value

value

Data type: Optional[Scalar]

value to be added to the runtime option

Default value: undef

cassandra::jvm_option_set

Select the file to be controlled by choosing, jvm, jvm8 or jvm11 and the variant server or clients. Options, properties and advanced runtime options can be defined to have particular values or to be removed from the configuration. Any option not mentioned will not be touched.

For Cassandra 3.x versions, only optsfile = jvm with variant = undef is supported, which will control the /etc/cassandra/jvm.options file. Since Cassandra versions >= 4.0 use distinct option files for server and clients, as well as Java independent, Java-8 and Java-11, use parameters optsfile and variant to select a particular options file.

Parameters

The following parameters are available in the cassandra::jvm_option_set defined type:

• optsfile
• variant
• options
• properties
• sizeoptions
• advancedoptions

optsfile

Data type: Enum['jvm', 'jvm8', 'jvm11']

determine the file to control, either jvm for the independet options or jvm8 or jvm11 for the version dependant options

Default value: 'jvm'

variant

Data type: Optional[Enum['clients', 'server']]

leave this undef for Cassandra < 4.0, set it to server or clients if running >= 4.0

Default value: undef

options

Data type: Array[String]

list of basic JVM options, e.g. ea, server, Xms4g, etc.

Default value: []

properties

Data type: Hash[String,Optional[Scalar]]

java properties to be passed to the JVM

Default value: {}

sizeoptions

Data type: Hash[String,Optional[Scalar]]

JVM options having a value concatenated directly to the options, e.g. Xmx4g.

Default value: {}

advancedoptions

Data type: Hash[String,Optional[Scalar]]

advanced runtime options which may be feature toggles or values

Default value: {}

Data types

Cassandra::Rackdc

Hash allowing to setup the content of cassandra-rackdc.properties. Note, that the fields dc and rack mandatory to setup rackdc, while dc_suffix and prefer_local can be set optionally.

Alias of

Struct[{
  dc           => String,
  rack         => String,
  dc_suffix    => Optional[String],
  prefer_local => Optional[Boolean],
}]

Cassandra::Service::Enable

Service enable can be manual or mask besides the Boolean.

Alias of

Variant[Boolean, Enum['manual','mask']]

Cassandra::Service::Ensure

This type is simply missing from Stdlib.

Alias of

Optional[Variant[Boolean,Enum['stopped', 'running']]]

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v6.0.0 - 2024-10-23

Full Changelog

Changed

• Maintenance updates #40 (rtib)

Added

• add support for Cassandra 5 jvm17 options #41 (rtib)

v5.0.2 - 2023-06-28

Full Changelog

Fixed

• adopt stdlib-9 #39 (rtib)
• [MODULES-11117] enforce documentation template conformance to meet requirements #37 (rtib)
• update stdlib dependency version limit #35 (rtib)

v5.0.1 - 2021-08-05

Full Changelog

Fixed

• remove disclaimer on Cassandra 4 feature #34 (rtib)

v5.0.0 - 2021-06-28

Full Changelog

Changed

• review requirement and dependencies, version cut #32 (rtib)
• change default value service enable #31 (rtib)

v4.0.0 - 2021-05-28

Full Changelog

Changed

• dynamic test matrix, update os support #30 (rtib)

v3.1.0 - 2021-03-03

Full Changelog

Added

• Add management of reaper #24 (rtib)

Fixed

• Upgrade module dependencies #25 (rtib)

v3.0.0 - 2021-03-02

Full Changelog

Changed

• Drop support for Puppet 5 #20 (rtib)

Fixed

• Migrate CI/CD to GHA #21 (rtib)

v2.3.0 - 2020-07-20

Full Changelog

Added

• add sizeoptions parameter to jvm_option_set #16 (rtib)

Fixed

• raise loglevel of deprecation message to warning #17 (rtib)

v2.2.1 - 2020-07-14

Full Changelog

Fixed

• parameter names fixed in docs #14 (rtib)

v2.2.0 - 2020-07-13

Full Changelog

Added

• Deprecate cassandra::java::gc #12 (rtib)
• New feature: JVM option sets #11 (rtib)

Fixed

• Make type enforcement less restrictive #13 (rtib)

v2.1.2 - 2020-02-07

Full Changelog

Added

• Prepare for Cassandra 4 #7 (rtib)

v2.1.1 - 2019-07-22

Full Changelog

Fixed

• text improvements #5 (rtib)
• fix some latent syntax errors #4 (rtib)

v2.1.0 - 2019-07-19

Full Changelog

Added

• add feature to add initial_token by lookup #2 (rtib)

Fixed

• text improvements #3 (rtib)

v2.0.1 - 2019-07-18

Full Changelog