Beer Garden is a Framework that provides a standardized interface for Command and Control of systems through the use of plugins or services. In general, Beer Garden Services should be stateless (or as stateless as it can be) and should operate in terms of requests, systems and commands.
If you would like to run your own Beer Garden, you may follow these steps. If you are a Beer Garden Developer, you may want to check out the Developer Wiki for some helpful hints on how to set up your environment.
- Python2.7 or 3.6
- pip
- MongoDB Server - (Tested on 2.4.13)
- Rabbitmq-Server - (Tested on 3.1.5)
or
- docker
- docker-compose
We are going to use docker and docker-compose to install and run beer-garden.
The first step is to clone the git repository that contains the docker-compose.yml file:
git clone git@github.com:beer-garden/beer-garden.git
cd beer-garden/docker/docker-compose/version_2
Opne up the conf/bartender-config.json file and find the line that looks like this:
"amq_publish_host": "CHANGE_ME_PLEASE"
Change CHANGE_ME_PLEASE to the external IP address of your system. If you use something like localhost or 127.0.0.1 that will be fine for plugins running on your machine, but only your machine.
Run this command to start beer-garden:
docker-compose up -d
This will create the necessary docker containers and then run them in the background. Run the folloing command to see the log output from the containers starting:
docker-compose logs -f
Look for a line that says "Bartender started" - once you see that beer-garden is up and running. Use ctrl-C to exit.
beer-garden starts by default on port 2337, so point a browser at http://<IP-ADDRESS>:2337. You'll see a message saying beer-garden couldn't find any systems. You're ready to start writing plugins!
The Rest services beer-garden provides is documented by swagger which will come installed by default on the server you stood up. Go to the About section and click on Rest API Documentation for more information.
cd beer-gardennosetests
cd beer-garden./bin/generate_coverage.shOpen Firefox- Navigate to:
file:///path/to/beer-garden/cover/index.html