Chef cookbook to install and configure Couchbase Server
Ruby HTML
Pull request Compare This branch is 6 commits behind disney:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
attributes
files/default/test
libraries
recipes
spec
templates/default
.gitignore
.kitchen.yml
.rspec
.travis.yml
Berksfile
CHANGELOG.md
Gemfile
Guardfile
README.md
Rakefile
chefignore
metadata.rb

README.md

Description

Installs and configures Couchbase.

Build Status

Adopt Me!

This cookbook is up for adoption. Ever since I started working at Chef Software, Inc. I have not had the need to use Couchbase. Therefore I find it difficult to keep up with the issues & PRs being filed on this cookbook. If you can help, or become a co-maintainer, please contact me: jdunn@chef.io

Requirements

Chef 0.10.10 and Ohai 0.6.12 are required due to the use of platform_family.

Platforms

  • Debian family (Debian, Ubuntu etc)
  • Red Hat family (Redhat, CentOS, Oracle etc)
  • Microsoft Windows

Note that Couchbase Server does not support Windows 8 or Server 2012: see http://www.couchbase.com/issues/browse/MB-6395. This is targeted to be fixed in Couchbase 2.1.

Attributes

couchbase-server

  • node['couchbase']['server']['edition'] - The edition of couchbase-server to install, "community" or "enterprise"
  • node['couchbase']['server']['version'] - The version of couchbase-server to install
  • node['couchbase']['server']['package_file'] - The couchbase-server package file to download and install
  • node['couchbase']['server']['package_base_url'] - The url path to download the couchbase-server package file from
  • node['couchbase']['server']['package_full_url'] - The full url to the couchbase-server package file to download and install
  • node['couchbase']['server']['database_path'] - The directory Couchbase should persist data to
  • node['couchbase']['server']['index_path'] - The directory Couchbase should write indexes to
  • node['couchbase']['server']['log_dir'] - The directory Couchbase should log to
  • node['couchbase']['server']['memory_quota_mb'] - The per server RAM quota for the entire cluster in megabytes defaults to Couchbase's maximum allowed value
  • node['couchbase']['server']['username'] - The cluster's username for the REST API and Admin UI
  • node['couchbase']['server']['password'] - The cluster's password for the REST API and Admin UI
  • node['couchbase']['server']['allow_unsigned_packages'] - Whether to allow Couchbase's unsigned packages to be installed (default to 'true')
  • node['couchbase']['server']['community_edition_guid'] - The GUID of community edition of couchbase-server. Default value set
  • node['couchbase']['server']['enterprise_edition_guid'] - The GUID of enterprise edition of couchbase-server. Default value set
  • ['couchbase']['server']['service_name'] - name of couchbase-server service. Default "couchbase-server"

client

  • node['couchbase']['client']['version'] - The version of libcouchbase to install

moxi

  • node['couchbase']['moxi']['version'] - The version of moxi to install
  • node['couchbase']['moxi']['package_file'] - The package file to download
  • node['couchbase']['moxi']['package_base_url'] - The base URL where the packages are located
  • node['couchbase']['moxi']['package_full_url'] - The full URL to the moxi package
  • node['couchbase']['moxi']['cluster_server'] - The bootstrap server for moxi to contact for the node list
  • node['couchbase']['moxi']['cluster_rest_url'] - The bootstrap server's full REST URL for retrieving the initial node list

buckets

  • mybucket1 - The name to use for the Couchbase bucket
  • node['couchbase']['buckets']['mybucket1']['cluster'] - The name of the cluster the bucket belongs to, defaults to "default"
  • node['couchbase']['buckets']['mybucket1']['type'] - The type of the bucket, defaults to "couchbase"
  • node['couchbase']['buckets']['mybucket1']['saslpassword'] - The password of the bucket, defaults to ""
  • node['couchbase']['buckets']['mybucket1']['replicas'] - Number of replica (backup) copies, defaults to 1. Set to false to disable
  • node['couchbase']['buckets']['mybucket1']['username'] - The username to use to authenticate with Couchbase
  • node['couchbase']['buckets']['mybucket1']['password'] - The password to use to authenticate with Couchbase
  • node['couchbase']['buckets']['mybucket1']['memory_quota_mb'] - The bucket's per server RAM quota for the entire cluster in megabytes
  • node['couchbase']['buckets']['mybucket1']['memory_quota_percent'] - The bucket's RAM quota as a percent (0.0-1.0) of the cluster's quota

Recipes

client

Installs the libcouchbase2 and devel packages.

server

Installs the couchbase-server package and starts the couchbase-server service.

moxi

Installs the moxi-server package and starts the moxi-server service.

buckets

Creates or updates buckets.

Resources/Providers

couchbase_node

Actions

  • :modify - Default Modify the configuration of the node

Attribute Parameters

  • id - The id of the Couchbase node, typically "self", defaults to the resource name
  • database_path - The directory the Couchbase node should persist data to
  • username - The username to use to authenticate with Couchbase
  • password - The password to use to authenticate with Couchbase

Examples

couchbase_node "self" do
  database_path "/mnt/couchbase-server/data"

  username "Administrator"
  password "password"
end

couchbase_cluster

Actions

  • :create_if_missing - Default Create a cluster/pool only if it doesn't exist yet

Attribute Parameters

  • cluster - The id of the Couchbase cluster, typically "default", defaults to the resource name
  • memory_quota_mb - The per server RAM quota for the entire cluster in megabytes
  • username - The username to use to authenticate with Couchbase
  • password - The password to use to authenticate with Couchbase

Examples

couchbase_cluster "default" do
  memory_quota_mb 256

  username "Administrator"
  password "password"
end

couchbase_settings

Actions

  • :modify - Default Modify the collection of settings

Attribute Parameters

  • group - Which group of settings to modify, defaults to the resource name
  • settings - The hash of settings to modify
  • username - The username to use to authenticate with Couchbase
  • password - The password to use to authenticate with Couchbase

Examples

couchbase_settings "autoFailover" do
  settings({
    "enabled" => true,
    "timeout" => 30,
  })

  username "Administrator"
  password "password"
end

couchbase_bucket

Actions

  • :create - Default Create a Couchbase bucket

Attribute Parameters

  • bucket - The name to use for the Couchbase bucket, defaults to the resource name
  • cluster - The name of the cluster the bucket belongs to, defaults to "default"
  • type - The type of the bucket, defaults to "couchbase"
  • saslpassword - The password of the bucket, defaults to ""
  • memory_quota_mb - The bucket's per server RAM quota for the entire cluster in megabytes
  • memory_quota_percent - The bucket's RAM quota as a percent (0.0-1.0) of the cluster's quota
  • replicas - Number of replica (backup) copies, defaults to 1. Set to false to disable
  • username - The username to use to authenticate with Couchbase
  • password - The password to use to authenticate with Couchbase

Examples

couchbase_bucket "default" do
  memory_quota_mb 128
  replicas 2

  username "Administrator"
  password "password"
end

couchbase_bucket "pillowfight" do
  memory_quota_percent 0.5
  replicas false
  saslPassword "bucketPassword"

  username "Administrator"
  password "password"
end

couchbase_bucket "memcached" do
  memory_quota_mb 128
  replicas false
  type "memcached"

  username "Administrator"
  password "password"
end

Chef Solo Note

These node attributes are stored on the Chef server when using chef-client. Because chef-solo does not connect to a server or save the node object at all, to have the same passwords persist across chef-solo runs, you must specify them in the json_attribs file used. For example:

{
  "couchbase": {
    "server": {
      "password": "somepassword"
    }
  }
  "run_list":["recipe[couchbase::server]"]
}

Couchbase Server expects the password to be longer than six characters.

An example to configure buckets with chef-solo:

{
  "couchbase": {
    "server": {
      "password": "somepassword"
    },
    "buckets": {
        "mybucket1": true,
        "mymemcached1": {
            "type": "memcached",
            "memory_quota_mb": 500
        }
    }
  }
  "run_list":["recipe[couchbase::server]"]
}

Roadmap

  • Many of the heavyweight resources/providers need to be moved to LWRPs.

If you have time to work on these things or to improve the cookbook in other ways, please submit a pull request.

License and Author

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.