Forge Home

zookeeper_node

Puppet provider to manage nodes on Zookeeper server.

12,801 downloads

12,546 latest version

3.8 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.1 (latest)
  • 0.1.0
released Feb 23rd 2015
This version is compatible with:

    Start using this module

    • r10k or Code Manager
    • Bolt
    • Manual installation
    • Direct download

    Add this module to your Puppetfile:

    mod 'imaravic-zookeeper_node', '0.1.1'
    Learn more about managing modules with a Puppetfile

    Add this module to your Bolt project:

    bolt module add imaravic-zookeeper_node
    Learn more about using this module with an existing project

    Manually install this module globally with Puppet module tool:

    puppet module install imaravic-zookeeper_node --version 0.1.1

    Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

    Download
    Tags: zookeeper

    Documentation

    imaravic/zookeeper_node — version 0.1.1 Feb 23rd 2015

    zookeeper_node

    Table of Contents

    1. Overview
    2. Module Description - What the module does and why it is useful
    3. Setup - The basics of getting started with zookeeper_node
    4. Usage - Configuration options and additional functionality
    5. Reference - An under-the-hood peek at what the module is doing and how
    6. Limitations - OS compatibility, etc.
    7. Development - Guide for contributing to the module

    Overview

    Puppet provider to manage nodes on Zookeeper server.

    Module Description

    Module supports creation and deletion of Zookeeper nodes. It also supports data management on them.

    It auto requires all the parent nodes of the Zookeeper node that it manages.

    It doesn't do recursive creation of nodes, ie. like 'mkdir -p'. Zookeeper node must not have any children so it can be deleted.

    Setup

    What zookeeper_node affects

    • Zookeeper nodes on Zookeeper cluster

    Setup Requirements

    Pluginsync should be enabled for this module to be used. This module requires 'zookeeper' gem to be installed. Gem is automatically installed by zookeeper_node defined resource type.

    Beginning with zookeeper_node

    Simple example how to manage Node on Zookeeper cluster

      zookeeper_node { "/zookeeper_node":
        ensure  => present,
        server  => 'zookeeper.awesome.com',
        port    => 2181,
        data    => 'some data',
      }
    

    Usage

    Defined Resource Type: zookeeper_node

    Defined resource type which wraps zookeeper_node_t and installs 'zookeeper' gem to manage Zookeeper node on Zookeeper cluster.

    Parameters within zookeeper_node:

    ####ensure

    Defines if the zookeeper_node should be 'present' or 'absent'. Defaults to 'present'.

    ####path

    Path to manage on Zookeeper cluster. Needs to be absolute path. Must not end with /. It defaults to resource title.

    ####data

    Data to be stored on path on Zookeeper cluster.

    ####server

    Zookeeper server to connect to. Defaults to localhost.

    ####port

    Zookeeper port to connect to. Defaults to 2181.

    Type: zookeeper_node_t

    Base type to manage Zookeeper node on Zookeeper cluster.

    Parameters within zookeeper_node_t:

    ####path

    Path to manage on Zookeeper cluster. Needs to be absolute path. Must not end with /. It defaults to namevar.

    ####data

    Data to be stored on path on Zookeeper cluster.

    ####server

    Zookeeper server to connect to. Defaults to localhost.

    ####port

    Zookeeper port to connect to. Defaults to 2181.

    Reference

    Defined Resource Types

    • zookeeper_node: Manages Zookeeper node on Zookeeper cluster. It's installing zookeeper gem automatically so the zookeeper_node_t could be applied.

    Defined Types

    • zookeeper_node_t: Base type to manage Zookeeper node on Zookeeper cluster. Can be used independently of zookeeper_node. It requires 'zookeeper' gem to be installed so it would work.

    Defined Classes

    • zookeeper_node::dependencies: Ensures 'zookeeper' gem to be of the latest version. It's included from zookeeper_node defined resource type.

    Limitations

    Zookeeper ACL management isn't supported at the moment

    Development

    Pull Requests on GitHub are welcome.