The Marionette Collective AKA MCollective is a framework to build server orchestration and parallel job execution systems. You can use it as a means of programmatic execution of Systems Administration actions on clusters of servers. In this regard it operates in the same space as tools like Func, Fabric or Capistrano.
MCollective use modern tools like Publish Subscribe Middleware and modern philosophies like real time discovery of network resources using meta data and not hostnames. Delivering a very scalable and very fast parallel execution environment. For a better sense of what this looks like, check out some of the videos on the Screencasts page and then keep reading below for further info and links. You can also grab an Amazon EC2 based demo where you can launch as many instances as you want to see how it behaves first hand.
What is MCollective and what does it allow you to do?
- Interact with small to very large clusters of servers.
- Use a broadcast paradigm for request distribution. All servers get all requests at the same time, requests have filters attached and only servers matching the filter will act on requests. There is no central asset database to go out of sync, the network is the only source of truth.
- Break free from ever more complex naming conventions for hostnames as a means of identity. Use a very rich set of meta data provided by each machine to address them. Meta data comes from Puppet, Facter, Ohai or plugins you provide yourself.
- Comes with simple to use command line tools to call remote agents.
- Ability to write custom reports about your infrastructure.
- A number of agents to manage packages, services and other common components are available from the community.
- Allows you to write simple RPC style agents, clients and Web UIs in an easy to understand language - Ruby.
- Extremely pluggable and adaptable to local needs.
- Middleware systems already have rich authentication and authorization models, leverage these as a first line of control. Include fine grained Authentication, Authorization and Auditing of requests.
- Re-use the ability of middleware to do clustering, routing and network isolation to realize secure and scalable setups.
We aim to provide a stable core framework that allows you to build it out into a system that meets your own needs, we are pluggable in the following areas:
- Replace our choice of middleware - STOMP compliant middleware - with your own like AMQP based.
- Replace our authorization system with one that suits your local needs.
- Replace our serialization - Ruby Marshal and YAML based - with your own like JSONSchema that is cross language.
- We support additional Puppet data sources. You can provide a plugin to give us access to your tools data. The community have ones for Facter and Ohai already.
- Create a central inventory of services leveraging MCollective as transport that can run and distribute inventory data on a regular basis.
MCollective is licensed under the Apache 2 license.
Next Steps and Further Reading
Introductory and Tutorial Pages:
- Watch our Screencasts.
- Read the GettingStarted and Configuration guides for installation instructions.
- Read the Terminology page if you see any words where the meaning in the context of MCollective is not clear.
- Learn how to write basic reports for your servers - NodeReports.
- Learn how to write simple Agents and Clients using our Simple RPC Framework.
- The MCollective documentation contains a list of agents and clients here.
- The author has written several blog posts about mcollective.
- Subscribe and post questions to the mailing list.
Internal References and Developer Docs
- Finding it hard to do something complex with Simple RPC? See WritingAgents for what lies underneath.
- Role based security, authentication and authorization using ActiveMQ.
- Structure of Request and Reply messages.