Update rabbitmq module
[mirror/dsa-puppet.git] / 3rdparty / modules / rabbitmq / lib / puppet / type / rabbitmq_vhost.rb
index 1349be6..8e9407e 100644 (file)
@@ -1,5 +1,15 @@
 Puppet::Type.newtype(:rabbitmq_vhost) do
-  desc 'manages rabbitmq vhosts'
+  desc <<-DESC
+Native type for managing rabbitmq vhosts
+
+@example query all current vhosts
+ $ puppet resource rabbitmq_vhost`
+
+@example Create a rabbitmq_vhost
+ rabbitmq_vhost { 'myvhost':
+   ensure => present,
+ }
+DESC
 
   ensurable do
     defaultto(:present)
@@ -13,9 +23,8 @@ Puppet::Type.newtype(:rabbitmq_vhost) do
 
   autorequire(:service) { 'rabbitmq-server' }
 
-  newparam(:name, :namevar => true) do
-    'name of the vhost to add'
-    newvalues(/^\S+$/)
+  newparam(:name, namevar: true) do
+    desc 'The name of the vhost to add'
+    newvalues(%r{^\S+$})
   end
-
 end