neo4j puppet module

=====================

####Table of Contents

1. Overview
2. Setup
3. Usage
4. Reference

Overview

Installs Neo4J (http://www.neo4j.com) on Ubuntu/Debian from their distribution tarballs downloaded directly from their site.

##Setup

All of the setup for any of the configuration is done through via class neo4j. There are default options provided such that you can install Neo4j into /opt/neo4j and start listening on http://your_ip:7474/ by specifying:

include neo4j

To install enterprise edition 2.0.3, you can specify:

class { 'neo4j' :
  version => '2.0.3',
  edition => 'enterprise',
}

See usage scenarios below for further usages.

##Usage

Currently, all of the configurations are done through the class neo4j including clustered Neo4j server.

Here are some example of different configurations that people could use this module to manage their Neo4j instances.

Note: For an explain of parameters and a complete list, please see the reference section below.

Basic Install

class { 'neo4j' :
}

Different Version

All known versions >= 2.0.0 can be installed. For the list of current releases, you can go to http://neo4j.com/download/.

class { 'neo4j' :
  version => '2.0.3',
  edition => 'enterprise',
}

Different Install Path

If you want to install to another directory, use the install_prefix parameter.

class { 'neo4j' :
  install_prefix => '/tmp',
}

Custom JVM Memory Options

class { 'neo4j' :
  jvm_init_memory => '1024',
  jvm_max_memory  => '1024',
}

Cache Options

The cache options can be customized too to allow for better performance scaling. For an explanation and usage of these options, see Neo4j documentation on caching.

class { 'neo4j' :
  nodestore_memory                  => '25M',
  relationshipstore_memory          => '50M',
  propertystore_memory              => '100M',
  propertystore_strings_memory      => '130M',
  propertystore_arrays_memory       => '130M',
  cache_type                        => 'hpc',
  cache_memory_ratio                => '50.0',
  node_cache_array_fraction         => '5',
  relationship_cache_array_fraction => '5',
  node_cache_size                   => '100M',
  relationship_cache_size           => '100M',
}

Authentication and User Management

To force authentication of the data and management entry points, you can use the auth_ensure and include auth_admin_user and auth_admin_password parameters too. The auth_users is optional, but can be used to manage authorized users.

$auth_users = {
  user1 => {
    ensure     => present,
    password   => 'puppet',
    readWrite  => true,
  },
}

class { 'neo4j' :
  auth_ensure         => present,
  auth_admin_user     => 'admin',
  auth_admin_password => 'password',
  auth_users          => $auth_users, #optional
}

New Relic Monitoring

You can also specify to monitor the server with New Relic. Sign-up and monitoring is free from http://www.newrelic.com.

class { 'neo4j' :
  newrelic_jar_path => '/path/to/newrelic.jar',
}

##Reference

###neo4j Manages the server. ####Attributes

• version -- The version of Neo4j to install. Default: 2.1.2
• edition -- The edition of Neo4j to install. Possibles: (community, enterprise). Default: community
• install_prefix -- Where to install the software. Default: /opt/neo4j
• allow_remote_connections -- Whether to allow remote connections to Neo4j instead of only from localhost. Default: true
• address -- Specify the address to listen at if allow_remote_connections is set to true. Default: ipaddress (from puppet facts)

######Custom Memory Attributes

• jvm_init_memory* -- Initial memory size of the jvm. Equates to java option "-Xms=XXX". Specified in MBs. Default: 1024
• jvm_max_memory* -- Maximum memory size of the jvm. Equates to java option "-Xmx=XXX". Specified in MBs. Default: 1024

######Custom Cache Attributes -- See Neo4j documentation on caching

• nodestore_memory* -- See Neo4j documentation. Default: Neo4j default value
• relationshipstore_memory* -- See Neo4j documentation. Default: Neo4j default value
• propertystore_memory* -- See Neo4j documentation. Default: Neo4j default value
• propertystore_strings_memory* -- See Neo4j documentation. Default: Neo4j default value
• propertystore_arrays_memory* -- See Neo4j documentation. Default: Neo4j default value
• cache_type* -- See Neo4j documentation. Default: Neo4j default value
• cache_memory_ratio* -- See Neo4j documentation. Default: Neo4j default value
• node_cache_array_fraction* -- See Neo4j documentation. Default: Neo4j default value
• relationship_cache_array_fraction* -- See Neo4j documentation. Default: Neo4j default value
• node_cache_size* -- See Neo4j documentation. Default: Neo4j default value
• relationship_cache_size* -- See Neo4j documentation. Default: Neo4j default value

* - see Max DeMarzi's Neo4j blog entry titled Scaling-Up

######Authentication Attributes

• auth_ensure** -- Turns on/off authentication. Possibles: present, absent. Default: absent

• auth_admin_user -- Admin user name. Must be specified when using authentication. Default: undef

• auth_admin_password -- Admin password. Must be specified when using authentication. Default: undef

• auth_users -- Hash of users, passwords, and roles that can access Neo4j when using authentication. Default: undef

  Sample Input:

  $auth_users = {
    username1 => {
      ensure     => present,   #optional, defaults to present
      password   => 'mypass',
      readWrite  => true,      #optional, defaults to true
    },
    username2 => {
      password   => 'mypass',
    },
    username3 => {
      ensure     => absent,
      password   => '',        #you must specify this when removing the user
    },
  }
  

######New Relic Parameters

• newrelic_jar_path -- Specifies the full path to the newrelic java agent jar file. Default: undef

######HA Parameters These parameters configure the Neo4j HA options.

• ha_ensure -- Turns on/off ha features. Possibles: present, absent. Default: absent

• ha_server_id -- Required. Unique server id in cluster. Must be an integer. Default: undef

• ha_initial_hosts -- Required. Other hosts in the cluster. Default: undef

  $ha_initial_hosts = "${::ipaddress}:5001,other_ip:5001,another_ip:5001"
  

  $ha_initial_hosts = "${::fqdn}:5001,host1.domain:5001,host2.domain:5001"
  

• ha_cluster_port -- Port to listen to cluster heartbeats and management communications. Default: 5001

• ha_data_port -- Port to send/receive cluster data on. Default: 6001

• ha_pull_interval -- Pull interval from master. Specified in seconds. Default: Neo4j default

• ha_tx_push_factor -- Push factor to X slave servers. Specified as an integer. Default: Neo4j default

• ha_tx_push_strategy -- Push strategy to slave servers. Default: Neo4j default

• ha_allow_init_cluster -- Allow server to initialize a cluster if it cannot contact other hosts. Default: Neo4j default

• ha_slave_only -- Server can only be a slave in the cluster. Default: Neo4j default

######Logging Parameters

• keep_logical_logs -- Specifies the logical logs property. Default: '7 days'

##2016-08-12 - Release 1.1.0

Summary

This is a minor release, targeted at neo4j 2.x users. We're not going to put any more effort in supporting this version, as most users (should) be migrating to 3.x anyway.

##2016-02-02 - Release 1.0.3

Summary

Taken over module from Amos Wood

##2014-10-13 - Supported Release 1.0.2

Summary

Added logical log parameter to configuration

Features

• Added control parameter keep_logical_logs.

##2014-10-02 - Supported Release 1.0.1

Summary

Added changelog and feature for object cache new to version 2.1.5

Features

• Added control parameter cache_memory_ratio from version 2.1.5 object cache settings.

Bugfixes

• Switched to use function versioncmp instead.
• Added dependencies and requirements to metadata.

##2014-06-27 - Release 1.0.0

Summary

The initial release

Features

Added custom configuration of:

1. Version 2.x.x or later
2. Community or Enterprise editions
3. JVM Wrapper Settings
4. File Buffer Cache Options (see Max DeMarzi's blog Scaling-Up)
5. Object Cache Options
6. New Relic java agent path specified (see http://www.newrelic.com)
7. Authentication Plugin installed and configured (see http://www.github.com)
8. Authenticated User Management

- Admin User
- Users and Passwords
- Read/Write or ReadOnly

1. High Availability Options