A powerful plugin framework for converting your functions into composable, discoverable, production-ready services with minimal overhead.

Imagine if writing composable software services was as easy as writing a class in your favorite language with your favorite text editor. And sharing was as easy as running your main method.

It can be.

That’s the main idea behind Beer Garden. So much of software development is tangled in the weeds of standing up services, getting messages from one component to another, creating UIs, writing documentation, and concurrently supporting multiple versions. We want to change that.

Beer Garden makes it easy to turn your functions into REST interfaces that are ready for production use, in a way that’s accessible to anyone that can write a function. It creates all the boilerplate and infrastructure needed to turn that function into a type-safe, discoverable REST interface and an easy-to-use webform-based UI.

If that sounds interesting go ahead and check out the Quickstart section!

Look at me!

Preview Plugin to HTML Form Screenshot

Further Reading

  • If you’re still not quite sure what Beer Garden is or what it can do for you there’s more information in What is Beer Garden?

  • If you’re trying to get up and running as quickly as possible then the Quickstart section is for you

  • If you’re interested in administering a Beer Garden the Installation Guides will be helpful in getting started, and the Configuration Guide will help with configuration

  • If you’re looking for guidance on writing plugins check out the Plugin Developer Guide for a detailed rundown

  • If you’d like to better understand how to interact with Beer Garden (and learn the magic behind the Python bindings) take a look at the API Guide

  • If you want to understand how the different components of Beer Garden work and interact then the Architecture Guide is the place to look

  • To learn about additional cool things Beer Garden can do explore the User Manual

  • For documentation on the Python bindings head over to Read the Docs

Getting Help

We want Beer Garden to make your life easier. If there’s anything that’s unclear or difficult (or broken!) we want to know about it! Here are the best ways to get in touch with us:

Contributing

Beer Garden is open-source, and in the spirit of open-source software everyone is encouraged to help improve this project. If you discover errors or omissions in the source code, documentation, or website content please don’t hesitate to submit an issue or open a merge request. New contributors are always welcome!

Check out the Contributing guide to get started.

Here are some ways you can contribute:

  • Use the pre-release (development) versions

  • Report bugs

  • Suggest new features

  • Write or edit the documentation

  • Write code - No patch is too small:

    • Fix typos

    • Add comments

    • Clean up whitespace

    • Write tests

    • Fix issues

    • Refactor

Credits

A huge shout-out to the Asciidoctor Project. This website is built with AsciiDoctor and was heavily influenced by the Asciidoctor website. It really is the best way to write documentation and we highly recommend you check it out!

This website is hosted by GitHub Pages. It makes deployment easy and cheap. You can use it for blogs or documentation like this. Definitely take a look!

Free use of this software is granted under the terms of the MIT License. See the LICENSE file for details.