Pool LWRP and auto create user-defined pools

This change introduces a pool LWRP that allows Ceph user pools to be
created and/or deleted by simply specifying their name and number of
placement groups.

It also allows users to define their own pools in Chef attributes or
environments that are then created automatically when nodes are
provisioned.

diff --git a/README.md b/README.md
index a30cf863cc2aa2465d856dc720c7f68e3a371439..493ea9cc8213b28cbb94d2fe310533a031f4748b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -102,6 +102,8 @@ Ceph Rados Gateway nodes should use the ceph-radosgw role
 * `node['ceph']['config']['global']['cluster network']` - a CIDR specification of a separate cluster replication network
 * `node['ceph']['config']['config-sections']` - add to this hash to add extra config sections to the ceph.conf
 
+* `node['ceph']['user_pools']` - an array of pool definitions, with attributes `name`, `pg_num` and `create_options` (optional), that are automatically created when a monitor is deployed
+
 ### Ceph MON
 
 * `node['ceph']['config']['mon']` - a hash of settings to save in ceph.conf in the [mon] section, such as `'mon osd nearfull ratio' => '0.70'`
@@ -167,6 +169,24 @@ The ceph\_cephfs LWRP provides an easy way to mount CephFS. It will automaticall
 - :use\_fuse - whether to use ceph-fuse or the kernel client to mount the filesystem. ceph-fuse is updated more often, but the kernel client allows for subdirectory mounting. Defaults to true
 - :cephfs\_subdir - which CephFS subdirectory to mount. Defaults to '/'. An exception will be thrown if this option is set to anything other than '/' if use\_fuse is also true
 
+### ceph\_pool
+
+The ceph\_pool LWRP provides an easy way to create and delete Ceph pools.
+
+It assumes that connectivity to the cluster is setup and that admin credentials are available from default locations, e.g. /etc/ceph/ceph.client.admin.keyring.
+
+#### Actions
+
+- :add - creates a pool with the given number of placement groups
+- :delete - deletes an existing pool
+
+#### Parameters
+
+- :name - the name of the pool to create or delete
+- :pg_num - number of placement groups, when creating a new pool
+- :create_options - arguments for pool creation (optional)
+- :force - force the deletion of an exiting pool along with any data that is stored in it
+
 ## DEVELOPING
 
 ### Style Guide

diff --git a/attributes/default.rb b/attributes/default.rb
index e05bec6300a9997cd09f30116365f8bf1ceb173c..2b7e5412bee037fc59dcc2febf793e9348de5970 100644 (file)
--- a/attributes/default.rb
+++ b/attributes/default.rb
@@ -3,6 +3,8 @@ default['ceph']['encrypted_data_bags'] = false
 
 default['ceph']['install_repo'] = true
 
+default['ceph']['user_pools'] = []
+
 case node['platform']
 when 'ubuntu'
   default['ceph']['init_style'] = 'upstart'

diff --git a/providers/pool.rb b/providers/pool.rb
new file mode 100644 (file)
index 0000000..2c2b0b0
--- /dev/null
+++ b/providers/pool.rb
@@ -0,0 +1,68 @@
+#
+# Cookbook Name:: ceph
+# Provider:: pool
+#
+# Author:: Sergio de Carvalho <scarvalhojr@users.noreply.github.com>
+#
+
+def whyrun_supported?
+  true
+end
+
+use_inline_resources
+
+action :create do
+  if @current_resource.exists
+    Chef::Log.info "#{ @new_resource } already exists - nothing to do."
+  else
+    converge_by("Creating #{ @new_resource }") do
+      create_pool
+    end
+  end
+end
+
+action :delete do
+  if @current_resource.exists
+    converge_by("Deleting #{ @new_resource }") do
+      delete_pool
+    end
+  else
+    Chef::Log.info "#{ @current_resource } does not exist - nothing to do."
+  end
+end
+
+def load_current_resource
+  @current_resource = Chef::Resource::CephPool.new(@new_resource.name)
+  @current_resource.name(@new_resource.name)
+  @current_resource.exists = pool_exists?(@current_resource.name)
+end
+
+def create_pool
+  cmd_text = "ceph osd pool create #{new_resource.name} #{new_resource.pg_num}"
+  cmd_text << " #{new_resource.create_options}" if new_resource.create_options
+  cmd = Mixlib::ShellOut.new(cmd_text)
+  cmd.run_command
+  cmd.error!
+  Chef::Log.debug "Pool created: #{ cmd.stderr }"
+end
+
+def delete_pool
+  cmd_text = "ceph osd pool delete #{new_resource.name}"
+  cmd_text << " #{new_resource.name} --yes-i-really-really-mean-it" if
+    new_resource.force
+  cmd = Mixlib::ShellOut.new(cmd_text)
+  cmd.run_command
+  cmd.error!
+  Chef::Log.debug "Pool deleted: #{ cmd.stderr }"
+end
+
+def pool_exists?(name)
+  cmd = Mixlib::ShellOut.new("ceph osd pool get #{name} size")
+  cmd.run_command
+  cmd.error!
+  Chef::Log.debug "Pool exists: #{ cmd.stdout }"
+  true
+rescue
+  Chef::Log.debug "Pool doesn't seem to exist: #{ cmd.stderr }"
+  false
+end

diff --git a/recipes/mon.rb b/recipes/mon.rb
index 88ac8805b2ac35c5d05aaffa66bf6bb7fa3f2a74..72569f1cff85a45ef8b9380c31d23a714ada4772 100644 (file)
--- a/recipes/mon.rb
+++ b/recipes/mon.rb
@@ -125,3 +125,13 @@ if use_cephx? && !node['ceph']['encrypted_data_bags']
     not_if { node['ceph']['bootstrap_osd_key'] }
   end
 end
+
+if node['ceph']['user_pools']
+  # Create user-defined pools
+  node['ceph']['user_pools'].each do |pool|
+    ceph_pool pool['name'] do
+      pg_num pool['pg_num']
+      create_options pool['create_options'] if pool['create_options']
+    end
+  end
+end

diff --git a/resources/pool.rb b/resources/pool.rb
new file mode 100644 (file)
index 0000000..2e3052e
--- /dev/null
+++ b/resources/pool.rb
@@ -0,0 +1,22 @@
+#
+# Cookbook Name:: ceph
+# Resource:: pool
+#
+# Author:: Sergio de Carvalho <scarvalhojr@users.noreply.github.com>
+#
+
+actions :create, :delete
+default_action :create
+
+attribute :name, :kind_of => String, :name_attribute => true
+
+# The total number of placement groups for the pool.
+attribute :pg_num, :kind_of => Integer, :required => true
+
+# Optional arguments for pool creation
+attribute :create_options, :kind_of => String
+
+# Forces a non-empty pool to be deleted.
+attribute :force, :kind_of => [TrueClass, FalseClass], :default => false
+
+attr_accessor :exists