Skip to content

Latest commit

 

History

History
98 lines (70 loc) · 3.25 KB

Broodlord.rst

File metadata and controls

98 lines (70 loc) · 3.25 KB
Raw

Auto-scaling with Broodlord mode

Broodlord (taken from Starcraft, like :doc:`Zerg` mode) is a way for a vassal to ask for "reinforcements" to the Emperor. "Reinforcements" are new vassals spawned on demand generally bound on the same socket. Broodlord mode alone is not very useful. However, when combined with :doc:`Zerg`, :doc:`Idle` and :doc:`Emperor` it can be used to implement auto-scaling for your apps.

WARNING: If you are looking for a way to dynamically adapt the number of workers of an instance, check the :doc:`Cheaper` mode, Broodlord mode is for spawning totally new instances.

A 'simple' example

We'll start apps with a single worker, adding resources on demand. Broodlord mode expects an additional stanza in your config file to be used for zergs.

[uwsgi]
socket = :3031
master = true
vassal-sos-backlog = 10
module = werkzeug.testapp:test_app
processes = 1
zerg-server = /tmp/broodlord.sock
disable-logging = true

[zerg]
zerg = /tmp/broodlord.sock
master = true
module = werkzeug.testapp:test_app
processes = 1
disable-logging = true
idle = 30
die-on-idle = true

The vassal-sos-backlog option (supported only on Linux and TCP sockets) will ask the Emperor for zergs when the listen queue is higher than the given value. By default the value is 10. More "vassal-sos-" options will be added in the future to allow for more specific detect-overload systems.

The [zerg] stanza is the config the Emperor will run when a vassal requires resources. The die-on-idle option will completely destroy the zerg when inactive for more than 30 seconds. This configuration shows how to combine the various uWSGI features to implement different means of scaling. To run the Emperor we need to specify how many zerg instances can be run:

uwsgi --emperor /etc/vassals --emperor-broodlord 40

This will allow you to run up to 40 additional zerg workers for your apps.

--vassal-sos

Note

This flag has been added in 2.0.7.

--vassal-sos allows the vassal to ask for reinforcement as soon as all of its workers are busy.

The option takes an integer value, the number of seconds to wait between asking for a new reinforcements.

Manually asking for reinforcement

You can use the master FIFO's "B" command to force an instance to ask for reinforcements from the Emperor.

echo B > /var/run/master.fifo

Under the hood (or: hacking broodlord mode)

Technically broodlord mode is a simple message sent by a vassal to "force" the Emperor to spawn another vassal with a ':zerg' suffix in the instance name.

Even if the suffix is ':zerg' this does not mean you need to use Zerg mode. A 'zerg' instance could be a completely independent one that simply subscribes to a router, or binds to a SO_REUSEPORT socket.

This is an example with subscription system.

[uwsgi]
socket = 127.0.0.1:0
subscribe2 = server=127.0.0.1:4040,key=foobar.it
psgi = app.pl
processes = 4
vassal-sos = 3

[zerg]
socket = 127.0.0.1:0
subscribe2 = server=127.0.0.1:4040,key=foobar.it
psgi = app.pl
idle = 60
processes = 1