hazelcast

Table of Contents

1. Description
2. Setup - The basics of getting started with hazelcast
   • Setup requirements
   • Beginning with hazelcast
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

The aim of this module is to help you with the instalation and setup of the hazelcast cluster

You can give more descriptive information in a second paragraph. This paragraph should answer the questions: "What does this module do?" and "Why would I use it?" If your module has a range of functionality (installation, configuration, management, etc.), this is the time to mention it.

Setup

A minimal setup using the default parameter values would be something like this:

class { '::hazelcast': }

or better using the import clause in this form:

import '::hazelcast'

Setup Requirements

Here you can see a more complex setup

class { '::hazelcast':
  version           => '3.9.3',
  root_dir          => '/opt',
  config_dir        => '/etc/hazelcast',
  service_ensure    => 'running',
  manage_user       => true,
  user              => 'hazelcast',
  group             => 'hazelcast',
  download_url      => 'http://download.hazelcast.com/download.jsp?verson=3.9.3&type=tar&p=28888',
  java_home         => '/usr/lib/jvm/jre1.8.0',
  java_options      => '-Dfoo=bar',
  cluster_discovery => 'tcp',
  cluster_user      => 'hzuser',
  cluster_password  => 'supersecret',
  cluster_members   => [
    '192.168.0.23',
    '192.168.0.24',
    '192.168.0.25'
  ]   
}

Of course we recomend you to configure the module using hiera, this is more reliable and flexible depending of your hierarchy, you can view the previous example here:

---
  hazelcast::version: '3.9.3'
  hazelcast::root_dir: '/opt'
  hazelcast::config_dir: '/etc/hazelcast'
  hazelcast::service_ensure: 'running'
  hazelcast::manage_user: true
  hazelcast::user: 'hazelcast'
  hazelcast::group: 'hazelcast'
  hazelcast::download_url: 'http://download.hazelcast.com/download.jsp?verson=3.9.3&type=tar&p=28888'
  hazelcast::java_home: '/usr/lib/jvm/jre1.8.0'
  hazelcast::java_options: '-Dfoo=bar'
  hazelcast::cluster_discovery: 'tcp'
  hazelcast::cluster_user: 'hzuser'
  hazelcast::cluster_password: 'supersecret'
  hazelcast::cluster_members:
    - '192.168.0.23'
    - '192.168.0.24'
    - '192.168.0.25'

Beginning with hazelcast

The very basic steps needed for a user to get the module up and running. This can include setup steps, if necessary, or it can be an example of the most basic use of the module.

Usage

As you can seen in the setup example configuration you can setup a lot of aspects of the module, it's pretty easy

Reference

Limitations

The module supports only Debian systemd distributions: Stretch and Jessie, but we've plans to support another distrobutions that might compatible like CentOS 7 and Ubuntu in a near future (I hope). The configuration of the discovery mechanims supports only TCP in the current version (0.2.0 at the time to write this)

Development

Please feel free to send your ideas in the form of pull requests, and fill an issue if you discover one

Changelog

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

Release 0.1.0

Features

Implements only the basics to support the process up and running

Bugfixes

Known Issues

Release 0.1.1

Features

Bugfixes

• A shilly issue related with the module metadata.json file

Release 0.2.0

Features You can call this the first release of the module, it includes the next features:

• Supports (only) the TCP discovery mechanism, but this is the begining
• Solves the issue with the logging configuration of the process

Bugfixes