├── templates └── default │ └── rabbitmq.config.erb ├── metadata.rb ├── attributes └── default.rb ├── recipes ├── default.rb └── setup.rb ├── README.md └── LICENSE /templates/default/rabbitmq.config.erb: -------------------------------------------------------------------------------- 1 | %%% 2 | %% Generated by Chef 3 | %%% 4 | 5 | [ 6 | {kernel, [ 7 | {inet_dist_listen_min, <%= node[:rabbitmq_cluster][:inet_dist_listen_min] %>}, 8 | {inet_dist_listen_max, <%= node[:rabbitmq_cluster][:inet_dist_listen_max] %>} 9 | ] 10 | }, 11 | {rabbit, [ 12 | {cluster_nodes, {[<%= node[:rabbitmq_cluster][:cluster_disk_nodes].map{|node| "\'#{node}\'"}.join(',') %>], disc}} ] 13 | } 14 | ]. 15 | 16 | -------------------------------------------------------------------------------- /metadata.rb: -------------------------------------------------------------------------------- 1 | maintainer "Coroutine, LLC [Daniel Pritchett]" 2 | maintainer_email "dpritchett@coroutine.com" 3 | license "Apache 2.0" 4 | description "Recipes to build a RabbitMQ Cluster" 5 | long_description IO.read(File.join(File.dirname(__FILE__), 'README.md')) 6 | version "0.1.7" 7 | 8 | recipe "rabbitmq_cluster", "Creates a RabbitMQ Cluster" 9 | recipe "rabbitmq_cluster::default", "Creates a RabbitMQ Cluster" 10 | recipe "rabbitmq_cluster::setup", "Sets up RabbitMQ Vhosts, Users, and Permissions" 11 | 12 | depends "rabbitmq" 13 | 14 | %w{ ubuntu debian }.each do |os| 15 | supports os 16 | end 17 | -------------------------------------------------------------------------------- /attributes/default.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook Name:: rabbitmq_cluster 3 | # Attributes:: default 4 | # 5 | # Copyright 2012, Coroutine LLC 6 | # 7 | # Licensed under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, software 14 | # distributed under the License is distributed on an "AS IS" BASIS, 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | # See the License for the specific language governing permissions and 17 | # limitations under the License. 18 | # 19 | 20 | 21 | # The access (user/vhost) configs for a RabbitMQ 22 | # node. This should be a list of items stored in 23 | # the `rabbitmq` data bag 24 | 25 | default[:rabbitmq_setup_items] = [] 26 | 27 | # Specify the ports used for Erlang distributed node protocol. 28 | # See: http://www.rabbitmq.com/clustering.html#firewall 29 | default[:rabbitmq][:inet_dist_listen_min] = nil 30 | default[:rabbitmq][:inet_dist_listen_max] = nil 31 | -------------------------------------------------------------------------------- /recipes/default.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook Name:: rabbitmq_cluster 3 | # Recipe:: default 4 | # 5 | # Copyright 2012, Coroutine LLC 6 | # 7 | # Licensed under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, software 14 | # distributed under the License is distributed on an "AS IS" BASIS, 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | # See the License for the specific language governing permissions and 17 | # limitations under the License. 18 | # 19 | 20 | # NOTE: all queue nodes need to know each other by 21 | # their short names! You can add entries in /etc/hosts 22 | # to make this happen. 23 | 24 | # Make sure RabbitMQ is installed 25 | include_recipe "rabbitmq::default" 26 | 27 | # Make sure rabbitmq-server is NOT running before 28 | # attempting to use the rabbitmq::cluster recipe, since 29 | # changing the .erlang.cookie will prevent you from 30 | # stopping/starting the service in the future. 31 | service "rabbitmq-server" do 32 | stop_command "service rabbitmq-server stop" 33 | action :stop 34 | only_if 'service rabbitmq-server status' 35 | end 36 | 37 | # Replace the upstream rabbitmq.config with one that includes the 38 | # kernel-level inet_dist_listen port directives. 39 | template "/etc/rabbitmq/rabbitmq.config" do 40 | source "rabbitmq.config.erb" 41 | owner "root" 42 | group "root" 43 | mode 0644 44 | end 45 | 46 | # Blow away the mnesia database. This is necessary so the nodes 47 | # in the cluster will be able to recognize each other (this 48 | # should only happen once... the first time we install RabbitMQ) 49 | bash "Reset mnesia" do 50 | user "root" 51 | cwd "/var/lib/rabbitmq" 52 | code <<-EOH 53 | rm -rf mnesia/ 54 | touch .reset_mnesia_database 55 | EOH 56 | not_if do 57 | File.exists?("/var/lib/rabbitmq/.reset_mnesia_database") 58 | end 59 | end 60 | 61 | # Restart the server. 62 | bash "Restart RabbitMQ" do 63 | user "root" 64 | code <<-EOH 65 | service rabbitmq-server restart 66 | EOH 67 | end 68 | -------------------------------------------------------------------------------- /recipes/setup.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook Name:: rabbitmq_cluster 3 | # Recipe:: setup 4 | # 5 | # Copyright 2012, Coroutine LLC 6 | # 7 | # Licensed under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, software 14 | # distributed under the License is distributed on an "AS IS" BASIS, 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | # See the License for the specific language governing permissions and 17 | # limitations under the License. 18 | # 19 | 20 | 21 | # Pulls the appropriate configs from the "rabbitmq" data bag. 22 | # These should be specified in a role. 23 | node['rabbitmq_setup_items'].each do |item_name| 24 | search(:rabbitmq, "id:#{item_name}") do |config| 25 | 26 | # Create a Vhosts 27 | config['vhosts'].each do |vhost| 28 | rabbitmq_vhost vhost do 29 | action :add 30 | end 31 | Chef::Log.info "Created RabbitMQ vhost: #{vhost}" 32 | end 33 | 34 | # Create Users 35 | config['users'].each do |user| 36 | rabbitmq_user user['name'] do 37 | password user['password'] 38 | action :add 39 | end 40 | Chef::Log.info "Created RabbitMQ user: #{user['name']}" 41 | 42 | # Assign permissions 43 | user['permissions'].each do |perms| 44 | rabbitmq_user user['name'] do 45 | if not perms['vhost'].empty? 46 | vhost perms['vhost'] 47 | end 48 | permissions perms['permissions'] 49 | action :set_permissions 50 | Chef::Log.info "Set RabbitMQ permissions for #{user['name']} on #{perms['vhost']}" 51 | end 52 | end 53 | end 54 | 55 | # Delete or update the default guest account 56 | if config['delete_guest'] 57 | rabbitmq_user "guest" do 58 | action :delete 59 | end 60 | Chef::Log.info "Deleted RabbitMQ guest account" 61 | elsif not config['guest_password'].empty? 62 | bash "reset guest password" do 63 | user "root" 64 | code <<-EOH 65 | rabbitmqctl change_password guest #{config['guest_password']} 66 | EOH 67 | end 68 | Chef::Log.info "Reset password for RabbitMQ guest account" 69 | end 70 | 71 | end 72 | end 73 | 74 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Description 2 | =========== 3 | This cookbook defines recipes to configure a RabbitMQ Cluster and setup 4 | up users/permissions/vhosts. 5 | 6 | Requirements 7 | ============ 8 | This cookbook requires the following Opscode cookbooks: 9 | 10 | * [rabbitmq](https://github.com/opscode/cookbooks/tree/master/rabbitmq) 11 | 12 | Attributes 13 | ========== 14 | This cookbook defines the following attribute for RabbitMQ: 15 | 16 | node[:rabbitmq_setup_items] = [] 17 | 18 | Override this in a role, and include a list of items from the `rabbitmq` data bag. These will define the vhosts, users, and permissions that get created in RabbitMQ. (Read the recipe info below for an example). 19 | 20 | The Opscode rabbitmq cookbooks use the attributes defined by the Opscode cookbook. Specifically, information for clustering should be provided. So, you may include something like the following in a Role: 21 | 22 | override_attributes( 23 | "rabbitmq" => { 24 | "cluster" => "yes", 25 | "cluster_config" => "/etc/rabbitmq/rabbitmq.config", 26 | "erlang_cookie" => "REPLACETHISWITHYOUROWN", 27 | "cluster_disk_nodes" => ['node01', 'node02'] 28 | }, 29 | "rabbitmq_setup_items" => ['node01_permissions', 'node02_permissions'] 30 | ) 31 | 32 | Note that the elements of `cluster_disk_nodes` are Chef node names. Each of these nodes must also have entries in `/etc/hosts` (see the [chef-hosts](https://github.com/coroutine/chef-hosts) cookbook). 33 | 34 | Usage 35 | ===== 36 | The following recipes are defined: 37 | 38 | * `default` - Installs RabbitMQ (using the Opscode recipe), and sets up a cluster 39 | * `setup` - Create vhosts, users, and permissions based on items from the `rabbitmq` data bag 40 | 41 | `default` 42 | --------- 43 | Setting up a RabbitMQ cluster is a little tricky. First you have bootstrap the nodes that will participate in the cluster, and they must all be able to communicate with each other using a host alias. Therefore, this is a multi-step process: 44 | 45 | 1. Boostrap the nodes, making sure they can talk to each other. 46 | 2. After the nodes are live, re-run `chef-client` (`knife ssh name:NODENAME -a ipaddress -x USER -P PASSWORD "sudo chef-client"`) to make sure `/etc/hosts` is complete. Verify with something like `knife ssh name:NODENAME -a ipaddress -x USER -P PASSWORD "cat /etc/hosts"` 47 | 3. Create a role that includes the `rabbitmq_cluster` recipe. This role should override the attributes (see the `rabbitmq` attributes listed above) for each node that participates in the cluster. Add this role to each node using `knife node run_list add NODENAME "role[ROLENAME]"`, then re-run `chef-client` on each node. 48 | 4. At this point, the cluster should be configured. You can verify this by running the `rabbitmqctl cluster_status` command on each node. 49 | 50 | `setup` 51 | ------- 52 | This recipe creates users, vhosts, and sets permissions for RabbitMQ. It reads data from the `rabbitmq` data bag. Each item in the data bag should define `vhosts`, `users` and any permissions a user should have for each `vhost`. 53 | 54 | Additionally, you can specify a `guest_password` which will change the password for the default `guest` account, OR you can set `delete_guest` to `true` and the default account will be removed. 55 | 56 | An item in the `rabbitmq` data bag (`example_item.json`) would look something like this: 57 | 58 | { 59 | "id": "example_item", 60 | "delete_guest": true, 61 | "guest_password": "", 62 | "vhosts": [ 63 | "/sample_vhost" 64 | ], 65 | "users": [ 66 | { 67 | "name":"user_one", 68 | "password":"secret-thing-here", 69 | "permissions": [ 70 | { 71 | "vhost":"/sample_vhost", 72 | "permissions":"\".*\" \".*\" \".*\"" 73 | } 74 | ] 75 | } 76 | ] 77 | } 78 | 79 | Then, to apply this data to a node, you would create a role (e.g. `rabbitmq_setup`) that looked something like the following: 80 | 81 | name "rabbitmq_setup" 82 | description "Vhost and User config for RabbitMQ" 83 | run_list( 84 | "recipe[rabbitmq_cluster::setup]" 85 | ) 86 | default_attributes( 87 | "rabbitmq_setup_items" => ['example_item', ] 88 | ) 89 | 90 | 91 | License and Author 92 | ================== 93 | 94 | Author:: Brad Montgomery () 95 | 96 | Copyright 2012, Coroutine LLC 97 | 98 | Licensed under the Apache License, Version 2.0 (the "License"); 99 | you may not use this file except in compliance with the License. 100 | You may obtain a copy of the License at 101 | 102 | http://www.apache.org/licenses/LICENSE-2.0 103 | 104 | Unless required by applicable law or agreed to in writing, software 105 | distributed under the License is distributed on an "AS IS" BASIS, 106 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 107 | See the License for the specific language governing permissions and 108 | limitations under the License. 109 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------