Merge pull request #562 from wyardley/strings

Move examples and params to puppet strings style docs

lib/puppet/type/rabbitmq_binding.rb

@@ -1,5 +1,42 @@
 Puppet::Type.newtype(:rabbitmq_binding) do
-  desc 'Native type for managing rabbitmq bindings'
+  desc <<-DESC
+Native type for managing rabbitmq bindings
+
+@example Create a rabbitmq_binding
+ rabbitmq_binding { 'myexchange@myqueue@myvhost':
+   user             => 'dan',
+   password         => 'bar',
+   destination_type => 'queue',
+   routing_key      => '#',
+   arguments        => {},
+   ensure           => present,
+ }
+
+@example Create bindings with same source / destination / vhost but different routing key using individual parameters
+rabbitmq_binding { 'binding 1':
+  ensure           => present,
+  source           => 'myexchange',
+  destination      => 'myqueue',
+  vhost            => 'myvhost',
+  user             => 'dan',
+  password         => 'bar',
+  destination_type => 'queue',
+  routing_key      => 'key1',
+  arguments        => {},
+}
+
+rabbitmq_binding { 'binding 2':
+  ensure           => present,
+  source           => 'myexchange',
+  destination      => 'myqueue',
+  vhost            => 'myvhost',
+  user             => 'dan',
+  password         => 'bar',
+  destination_type => 'queue',
+  routing_key      => 'key2',
+  arguments        => {},
+}
+DESC
 
   ensurable do
     defaultto(:present)

lib/puppet/type/rabbitmq_erlang_cookie.rb

@@ -1,5 +1,15 @@
 Puppet::Type.newtype(:rabbitmq_erlang_cookie) do
-  desc 'Type to manage the rabbitmq erlang cookie securely'
+  desc <<-DESC
+Type to manage the rabbitmq erlang cookie securely
+
+This is essentially a private type used by the rabbitmq::config class
+to manage the erlang cookie. It replaces the rabbitmq_erlang_cookie fact
+from earlier versions of this module. It manages the content of the cookie
+usually located at "${rabbitmq_home}/.erlang.cookie", which includes
+stopping the rabbitmq service and wiping out the database at
+"${rabbitmq_home}/mnesia" if the user agrees to it. We don't recommend using
+this type directly.
+DESC
 
   newparam(:path, namevar: true)
 

lib/puppet/type/rabbitmq_exchange.rb

@@ -1,5 +1,21 @@
 Puppet::Type.newtype(:rabbitmq_exchange) do
-  desc 'Native type for managing rabbitmq exchanges'
+  desc <<-DESC
+Native type for managing rabbitmq exchanges
+
+@example Create a rabbitmq_exchange
+ rabbitmq_exchange { 'myexchange@myvhost':
+   user        => 'dan',
+   password    => 'bar',
+   type        => 'topic',
+   ensure      => present,
+   internal    => false,
+   auto_delete => false,
+   durable     => true,
+   arguments   => {
+     hash-header => 'message-distribution-hash'
+   }
+ }
+DESC
 
   ensurable do
     defaultto(:present)

lib/puppet/type/rabbitmq_parameter.rb

@@ -1,5 +1,25 @@
 Puppet::Type.newtype(:rabbitmq_parameter) do
-  desc 'Type for managing rabbitmq parameters'
+  desc <<-DESC
+Type for managing rabbitmq parameters
+
+@example Create some rabbitmq_parameter resources
+   rabbitmq_parameter { 'documentumShovel@/':
+     component_name => '',
+     value          => {
+         'src-uri'    => 'amqp://',
+         'src-queue'  => 'my-queue',
+         'dest-uri'   => 'amqp://remote-server',
+         'dest-queue' => 'another-queue',
+     },
+   }
+   rabbitmq_parameter { 'documentumFed@/':
+     component_name => 'federation-upstream',
+     value          => {
+         'uri'     => 'amqp://myserver',
+         'expires' => '360000',
+     },
+   }
+DESC
 
   ensurable do
     defaultto(:present)

lib/puppet/type/rabbitmq_plugin.rb

@@ -1,5 +1,15 @@
 Puppet::Type.newtype(:rabbitmq_plugin) do
-  desc 'manages rabbitmq plugins'
+  desc <<-DESC
+manages rabbitmq plugins
+
+@example query all currently enabled plugins
+ $ puppet resource rabbitmq_plugin
+
+@example Ensure a rabbitmq_plugin resource
+ rabbitmq_plugin {'rabbitmq_stomp':
+   ensure => present,
+ }
+DESC
 
   ensurable do
     defaultto(:present)

lib/puppet/type/rabbitmq_policy.rb

@@ -1,5 +1,18 @@
 Puppet::Type.newtype(:rabbitmq_policy) do
-  desc 'Type for managing rabbitmq policies'
+  desc <<-DESC
+Type for managing rabbitmq policies
+
+@example Create a rabbitmq_policy
+ rabbitmq_policy { 'ha-all@myvhost':
+   pattern    => '.*',
+   priority   => 0,
+   applyto    => 'all',
+   definition => {
+     'ha-mode'      => 'all',
+     'ha-sync-mode' => 'automatic',
+   },
+ }
+DESC
 
   ensurable do
     defaultto(:present)

lib/puppet/type/rabbitmq_queue.rb

@@ -1,5 +1,20 @@
 Puppet::Type.newtype(:rabbitmq_queue) do
-  desc 'Native type for managing rabbitmq queue'
+  desc <<-DESC
+Native type for managing rabbitmq queue
+
+@example Create a rabbitmq_queue
+ rabbitmq_queue { 'myqueue@myvhost':
+   ensure      => present,
+   user        => 'dan',
+   password    => 'bar',
+   durable     => true,
+   auto_delete => false,
+   arguments   => {
+     x-message-ttl          => 123,
+     x-dead-letter-exchange => 'other'
+   },
+ }
+DESC
 
   ensurable do
     defaultto(:present)

lib/puppet/type/rabbitmq_user.rb

@@ -1,5 +1,24 @@
 Puppet::Type.newtype(:rabbitmq_user) do
-  desc 'Native type for managing rabbitmq users'
+  desc <<-DESC
+Native type for managing rabbitmq users
+
+@example query all current users
+ $ puppet resource rabbitmq_user
+
+@example Configure a user, dan
+ rabbitmq_user { 'dan':
+   admin    => true,
+   password => 'bar',
+ }
+
+@example Optional parameter tags will set further rabbitmq tags like monitoring, policymaker, etc.
+ To set the administrator tag use admin-flag.
+ rabbitmq_user { 'dan':
+   admin    => true,
+   password => 'bar',
+   tags     => ['monitoring', 'tag1'],
+ }
+DESC
 
   ensurable do
     defaultto(:present)

lib/puppet/type/rabbitmq_user_permissions.rb

@@ -1,5 +1,14 @@
 Puppet::Type.newtype(:rabbitmq_user_permissions) do
-  desc 'Type for managing rabbitmq user permissions'
+  desc <<-DESC
+Type for managing rabbitmq user permissions
+
+@example Define some rabbitmq_user_permissions
+ rabbitmq_user_permissions { 'dan@myvhost':
+   configure_permission => '.*',
+   read_permission      => '.*',
+   write_permission     => '.*',
+ }
+DESC
 
   ensurable do
     defaultto(:present)

lib/puppet/type/rabbitmq_vhost.rb

@@ -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)