couchdb

pdk
Installs and configures CouchDB.

sarus

sarus

3,526 downloads

3,526 latest version

5.0 quality score

Version information

  • 1.0.0 (latest)
released Nov 5th 2018
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 7.0.0
  • Ubuntu

Start using this module

Documentation

sarus/couchdb — version 1.0.0 Nov 5th 2018

couchdb

Table of Contents

  1. Description
  2. Setup - The basics of getting started with couchdb
  3. Usage - Configuration options and additional functionality
  4. Reference - Available parameters
  5. Limitations - OS compatibility, etc.

Description

The couchdb module installs and configures a CouchDB single-node-instance.

Setup

To install couchdb with the default paramters, declare the couchdb class.

include couchdb

Usage

Let CouchDB listen on any available IP addresses:

class {'couchdb':
  bind_address => '0.0.0.0',
}

Disable 'admin party' and set a password for the admin account:

class {'couchdb':
  admin_password => 'MySecretPassword',
}

For more configuration examples, se the reference section below

Reference

The couchdb class accepts these parameters, all of which are optional.

Parameter: $file_compression

Method used to compress everything that is appended to the database and view index files, except for attachments.
Data type: Enum/Pattern Available options:

  • none
  • snappy
  • deflate_1 - deflate_9

Parameter: $max_dbs_open

This option places an upper bound on the number of databases that can be open at once.
Data type: Ìnteger


Parameter: $max_document_size

Limit maximum document body size.
Data type: Integer


Parameter: $couch_peruser_enable

If set to 'true', couch_peruser ensures that a private per-user database exists for each document in _users.
Data type: Boolean
Available options:

  • true
  • false

Parameter: $couch_peruser_delete

If set to 'true' and a user is deleted, the respective database gets deleted as well.
Data type: Boolean
Available options:

  • true
  • false

Parameter: $default_security

Default security object for databases.
Data type: Enum
Available options:

  • everyone - (Anyone can perform reads and writes)
  • admin_only - (Only admins can read and write)
  • admin_local - (Sharded databases can be read and written by anyone but the shards can only be read and written by admins)

Parameter: $require_valid_user

When set to 'true', no requests are allowed from anonymous users. Everyone must be authenticated.
Data type: Boolean
Available options:

  • true
  • false

Parameter: $bind_address

Defines the IP address by which the clustered port is available.
Data type: String


Parameter: $port

Defines the port number to listen.
Data type: Integer


Parameter: $admin_password

Enables the admin account and sets the admin password. This crashes the 'admin party' (everyone is a admin).
Data type: String


Parameter: $allow_persistent_cookies

Makes cookies persistent if set to 'true'.
Data type: Boolean
Available options:

  • true
  • false

Limitations

This module runs on Ubuntu 18.04.