de-ibh/b3lb

BigBlueButton Load Balancer

B3LB - BigBlueButton Load Balancer

B3LB is a open source BigBlueButton API load balancer similar to Scalelite. B3LB is based on the Django Python Web framework and is designed to work in large scale-out deployments with 100+ BigBlueButton nodes and high attendee join rates. The project started at IBH IT-Service GmbH in the fall 2020 and has been published in February 2021 during the second COVID-19 lock down in Germany.

More...

This project uses BigBlueButton and is not endorsed or certified by BigBlueButton Inc. BigBlueButton and the BigBlueButton Logo are trademarks of BigBlueButton Inc.

b3lb's Issues

api: add tenant and secret attendee soft limit

Implement a tenant and secret attendee soft limit. A secret will not be able to create new meetings If the secrets or the overall tenant attendee limit has been already reached. On-going meetings should always allow attendees to join.

bug: http 500 error when adding parameters with an empty value

It seems that an empty value field is not handled when adding instances of the Parameters model:

Traceback (most recent call last):
  File "/usr/local/lib/python3.10/site-packages/django/core/handlers/exception.py", line 38, in inner
    response = await get_response(request)
  File "/usr/local/lib/python3.10/site-packages/django/core/handlers/base.py", line 233, in _get_response_async
    response = await wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/usr/lib/python3.10/concurrent/futures/thread.py", line 58, in run
    result = self.fn(*self.args, **self.kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/contrib/admin/options.py", line 616, in wrapper
    return self.admin_site.admin_view(view)(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/utils/decorators.py", line 130, in _wrapped_view
    response = view_func(request, *args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/views/decorators/cache.py", line 44, in _wrapped_view_func
    response = view_func(request, *args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/contrib/admin/sites.py", line 232, in inner
    return view(request, *args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/contrib/admin/options.py", line 1657, in add_view
    return self.changeform_view(request, None, form_url, extra_context)
  File "/usr/local/lib/python3.10/site-packages/django/utils/decorators.py", line 43, in _wrapper
    return bound_method(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/utils/decorators.py", line 130, in _wrapped_view
    response = view_func(request, *args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/django/contrib/admin/options.py", line 1540, in changeform_view
    return self._changeform_view(request, object_id, form_url, extra_context)
  File "/usr/local/lib/python3.10/site-packages/django/contrib/admin/options.py", line 1579, in _changeform_view
    form_validated = form.is_valid()
  File "/usr/local/lib/python3.10/site-packages/django/forms/forms.py", line 175, in is_valid
    return self.is_bound and not self.errors
  File "/usr/local/lib/python3.10/site-packages/django/forms/forms.py", line 170, in errors
    self.full_clean()
  File "/usr/local/lib/python3.10/site-packages/django/forms/forms.py", line 374, in full_clean
    self._post_clean()
  File "/usr/local/lib/python3.10/site-packages/django/forms/models.py", line 413, in _post_clean
    self.instance.full_clean(exclude=exclude, validate_unique=False)
  File "/usr/local/lib/python3.10/site-packages/django/db/models/base.py", line 1229, in full_clean
    self.clean_fields(exclude=exclude)
  File "/usr/src/app/rest/models.py", line 1315, in clean_fields
    if not match(self.PARAMETER_REGEXES[self.parameter], self.value):
  File "/usr/lib/python3.10/re.py", line 190, in match
    return _compile(pattern, flags).match(string)

Exception Type: TypeError at /admin/rest/parameter/add/
Exception Value: expected string or bytes-like object
Request information:
USER: XXXXXXXX

GET: No GET data

POST:
csrfmiddlewaretoken = 'XXXXXXXX'
mode = 'SET'
parameter = 'disabledFeatures'
tenant = 'XXXXXXXX'
value = ''
_save = 'Sichern'

api: support multi-tenancy using a single domain name

Add support for multi-tenancy using a single domain name by embedding the tenant slug into the path component. This makes it easier to deploy b3lb using one single X.509 certificate.

This is how BBB@Scale provides it's multi-tenancy API.

settings: refactor settings variable names

B3LB specific settings should be prefixed w/ B3LB_.

feature: improve end meeting callback handling

B3LB should use the meta_endCallbackUrl create parameter to get a callback from bbb if a meetings has ended. When the callback arrives the meeting state can be updated immediately. The callback should be protected by a nonce.

In case the original meeting creator has passed a meta_endCallbackUrl B3LB needs to call it by proxy.

assets: store logo and slide assets as db blobs

Drop the requirement to put logo an slide assets on the file system using docker volumes. Storing them in the database would allow to use Django's caching framework and does not require to synchronize them if multiple frontend nodes are used.

Somehow related to #13

Show all secrets when running "manage.py gettenantsecrets" command

api: add support for HTML5 player customization

See also: Passing custom parameters to the client on joinAnchor link for: passing custom parameters to the client on join

Enable support for redis sentinal

redis sentinel is a fairly easy way to make redis high available.

django-cacheops has actual inbuilt support for this operation mode.

CACHEOPS_SENTINEL = {
    'locations': [('localhost', 26379)], # sentinel locations, required
    'service_name': 'mymaster',          # sentinel service name, required
    'socket_timeout': 0.1,               # connection timeout in seconds, optional
    'db': 0                              # redis database, default: 0
    ...                                  # everything else is passed to Sentinel()
}

Can this be implemented as well? Probably somewhere in /b3lb/loadbalancer/settings.py.

Or is a HA redis not necessary for b3lb?

metrics: add counter for limit hits

Add per secret counters for attendee and meeting limit hits.

feature: add search to Django Admin

Improve UX in Django Admin by adding search fields to list screens, i.e.:

• nodes: by name
• meetings: by name
• tenant: by name

Add new parameters for BBB Version 2.4

feature: add a link to api-mate in Django Admin

Add a (configurable) link to api-mate to the secrets list in Django Admin. It should be possible to configure if the multi or single domain name is used in the server parameter.

Support for BBB API 2.7

Updates for new API Parameters

feature: add recording support

Add recording support requires:

• add B3LB backend API with dedicated backend secrets for each node
• add a post script uploading the recordings using the node's secret (push only)
• add some processing storing the recordings into an object storage (S3 like?) and store recording meta data in B3LB models
• implement recording related APIs
• make recording support optional per tenant/secret
• add meta_bbb-recording-ready-url by proxy support

api: do not add css url on join requests if no `custom_css` is available

b3lb/b3lb/rest/b3lb/endpoints.py

Lines 135 to 136 in 2521615

	if Parameter.USERDATA_BBB_CUSTOM_STYLE_URL not in params:
	params[Parameter.USERDATA_BBB_CUSTOM_STYLE_URL] = secret.tenant.asset.custom_css_url

Results in http 500 codes for tenants with empty custom_css assets.

Make meetings bijective

• It's not possible to use the same meeting ID for two different secrets.
• Also send a error if meeting id is too long (+ 100 chars)

api: prevent oversized create calls

BBB API create calls should not trigger http 413 errors (Request Entity Too Large) in the backend. Might be triggered by large startup slides.

feature: show available nodes stats for clusters Django Admin

Improve UX: show cluster and cluster group node statistics by adding column to Django Admin showing the count of available/maintenance/erroneous nodes and a average/percentile node load (ignoring any nodes in maintenance/error state).

We could use html highlighting and add a links to the nodes list view like in this article.

Problem with greenlight and b3lb

Hello everyone
I encountered a bidard problem between greenlight and b3lb,
I installed and configure greenlight on a vps server everything works well I connected greenlight api with b3lb server and it works well.
My problem is when I start a meeting for the first time it works but when one person wants to join the meeting I have the error message 500 displayed by greenlight.
I changed the server by the bigbluebutton test server I did not have this problem it works well
b3lb works with moodle
So I don’t know where the problem is.

Support for BBB v2.6

Upgrading b3lb for bigbluebutton v2.6 compatibility and parameter adjustments: BBB-API

settings: support configuration via environment

Enable B3LB settings to be configured using environment variables based on django-environ.

Depends on #11 .

admin: add Django admin actions to allow to change the maintenance status of all nodes of a cluster

If using separate clusters for blue-green-deployments it allows easily to maintain the maintenance status of each group of hosts.

upgrade to Django 4.2 + switch to full asyncio implementation

• Django 4.2+ has asyncio DRM support

Too long titles leads to error

To long Meeting titles leads to erroneous answers by B3LB

DataError at /bigbluebutton/api/create
value too long for type character varying(100)

-> Need a fix

api: failed to join meetings for tenants without Asset object

The api triggers a http 500 code while attendees are trying to join a meeting if a Tenant has no associated Asset object.

Workaround: create at least a Asset object with empty assets

models: make Node default domain configurable

The default value of Node.domain should not be hard-coded to bbbconf.de.

Make the default value configurable using a callback returning a django setting value.

tenants: make create parameter overrides more generic

We already support overriding logo and startup slide. This should be more generic using another Model allowing to override more settings. It should be possible to block, set or override settings. Parameter candidates:

• bannerText
• bannerColor
• muteOnStart
• logoutURL
• maxParticipants
• welcome
• duration

feature: add filters to Django Admin

Improve UX in Django Admin by adding filters to list screens, i.e.:

• nodes: cluster
• parameters: tenant
• secrets: tenant
• stats: tenant
• tenants: cluster groups
• meeting: tenant

BBB plugins in (Next|Own)Cloud not working

NC/OC are encoding spaces in the query string by %20 rather than +. Although the BBB API suggests to use + BBB also accepts %20.

B3lb rejects those requests due how the checksum validation is implemented.

Assets: add AssetStyle to be used with userdata-bbb_custom_style_url join parameter

Add another asset class AssetStyle for uploading a css file per tenant. If a css file is uploaded the userdata-bbb_custom_style_url parameter should be provided on join requests, like we already did for slides and logos.