Update README
This commit is contained in:
parent
5692d6fd6d
commit
fbc69bfb5d
25
README.md
25
README.md
|
@ -5,10 +5,31 @@
|
|||
**Notice:** This software is not ready for use in production environments.
|
||||
Here be dragons.
|
||||
|
||||
## Design
|
||||
|
||||
A single queen bee (master node) manages any number of worker bees (worker nodes).
|
||||
|
||||
Tasks/jobs are currently submitted by inserting directly into the database the
|
||||
queen bee is connected to. An API for manipulating tasks is planned to be added.
|
||||
|
||||
Worker bees communicate only with the queen bee. They perform tasks as
|
||||
instructed by the queen bee and do not have a database of their own. All
|
||||
metadata that allows worker bees to track deployments is stored within the
|
||||
files of each deployment.
|
||||
|
||||
Containers are managed by [Docker Compose](https://docs.docker.com/compose/).
|
||||
Beehive copies and interpolates deployment files while Docker Compose takes care
|
||||
of the rest.
|
||||
|
||||
## Festoons
|
||||
|
||||
Festoons are available [here](https://code.rocketnine.space/tslocum/festoons).
|
||||
Beehive deployment packages are called festoons. They always include a
|
||||
[Docker Compose file](https://docs.docker.com/compose/compose-file/05-services/)
|
||||
defining at least one service. If a `data` directory is present, it is copied to
|
||||
each target deployment directory.
|
||||
|
||||
Example festoons are available [here](https://code.rocketnine.space/tslocum/festoons).
|
||||
|
||||
## Support
|
||||
|
||||
Please share issues and suggestions [here](https://code.rocketnine.space/tslocum/beehive/issues).
|
||||
Please share issues and suggestions [here](https://code.rocketnine.space/tslocum/beehive/issues).
|
||||
|
|
Loading…
Reference in New Issue