Netbox-branching getting to work?

[basn]

anyone able to get it to work?
i cant get it to build the updated container.

Tried coping in the settings but it keeps not working.´

[teixemf]

I am on the same boat as you are.
It is not possible to build a new image with the plugin netbox-branching.

The issue is on the run of manage.py collectstatic and the the 2nd line of the python file local_settings.py that is said on the plugin instructions to include.
The manage.py collectstatic doesn't this import here from .configuration import DATABASE causing the error:
ImportError: attempted relative import with no known parent package

I tried to buid the image without the running manage.py collectstatic and I try to execute the command directly on the running netbox container but that way I get permission denied errors:
PermissionError: [Errno 13] Permission denied: '/opt/netbox/netbox/static/debug_toolbar'

Maybe an Issue should be opened.

[tobiasge]

I just tried building an images with the plugin and it worked with these files:

Dockerfile/Containerfile

FROM quay.io/netboxcommunity/netbox:v4.1

COPY plugins.py /etc/netbox/config/plugins.py
COPY local_settings.py /opt/netbox/netbox/netbox/local_settings.py
RUN /opt/netbox/venv/bin/pip install netboxlabs-netbox-branching
RUN SECRET_KEY="dummyKeyWithMinimumLength-------------------------" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input

plugins.py

PLUGINS = [
    'netbox_branching',
]

local_settings.py

from netbox_branching.utilities import DynamicSchemaDict
from .configuration import DATABASE

# Wrap DATABASES with DynamicSchemaDict for dynamic schema support
DATABASES = DynamicSchemaDict({
    'default': DATABASE,
})

# Employ our custom database router
DATABASE_ROUTERS = [
    'netbox_branching.database.BranchAwareRouter',
]

[basn]

Just because i said it i got it to work to... (moved local_settings from configuration/)

[mrlnbllmnn]

I had my local_settings.py in the configuration folder which prevented the netbox container from starting.

  File "/etc/netbox/config/local_settings.py", line 2, in <module>
    from .configuration import DATABASE
ImportError: attempted relative import with no known parent package

After moving the local_settings.py for branching in the parent directory and adjusting my Dockerfile-Plugins for the next build process, netbox started without issues.

[teixemf]

@mrlnbllmnn That was happening because of

netbox-docker/docker-compose.yml

Line 16 in 5add31e

- ./configuration:/etc/netbox/config:z,ro

That overrides the content of the config directory when you run the container.

Overall, the confusion rises because the plugin documentation says to had the file to where configuration.py is.
https://github.com/netboxlabs/netbox-branching/blob/develop/docs/index.md#4-configuration
But to make it work with netbox-docker you need to add it to another location.

COPY local_settings.py /opt/netbox/netbox/netbox/local_settings.py

Honestly I don't understand yet how
/opt/netbox/netbox/netbox/
And
/etc/netbox/config/
Play together in netbox-docker.

[Sulray]

I just tried building an images with the plugin and it worked with these files:

Dockerfile/Containerfile

FROM quay.io/netboxcommunity/netbox:v4.1

COPY plugins.py /etc/netbox/config/plugins.py
COPY local_settings.py /opt/netbox/netbox/netbox/local_settings.py
RUN /opt/netbox/venv/bin/pip install netboxlabs-netbox-branching
RUN SECRET_KEY="dummyKeyWithMinimumLength-------------------------" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input

plugins.py

PLUGINS = [
    'netbox_branching',
]

local_settings.py

from netbox_branching.utilities import DynamicSchemaDict
from .configuration import DATABASE

# Wrap DATABASES with DynamicSchemaDict for dynamic schema support
DATABASES = DynamicSchemaDict({
    'default': DATABASE,
})

# Employ our custom database router
DATABASE_ROUTERS = [
    'netbox_branching.database.BranchAwareRouter',
]

I wanted to update my Netbox local instance version and to update netbox branching to 0.5.6 and i'm running some issues, is this still working ?

[joeladria]

I too am stuck still with this. The proposals do not seem to be working. I keep getting

0.507     DATABASES = DynamicSchemaDict({
0.507                 ^^^^^^^^^^^^^^^^^
0.507 NameError: name 'DynamicSchemaDict' is not defined

[netgab]

Hi team,
I guess there is overall confusion, because the necessary config changes differs between NetBox v4.2 and Earlier and NetBox v4.3 and Later

Beginning with NetBox 4.3 the configuration changes must be performed directly in the configuration.py file in the DATABASE section.

There is no longer the local_settings.py approach from my point of view

The up to date plugin docs are here: https://github.com/netboxlabs/netbox-branching/

So I got this to work by doing the changes in the configuration.py and copy the local configuration.py to the new container:

FROM netboxcommunity/netbox:latest

COPY ./plugin_requirements.txt /opt/netbox/
RUN /usr/local/bin/uv pip install -r /opt/netbox/plugin_requirements.txt

# These lines are only required if your plugin has its own static files.
COPY configuration/configuration.py /etc/netbox/config/configuration.py

RUN DEBUG="true" SECRET_KEY="dummydummydummydummydummydummydummydummydummydummy" \
    /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input

Everything else is correct (plugin_requirements.txt, configuration/plugins.py ...)

However, this is a dirty hack, because the configuration.py is part of the netbox-docker repository and when doing upgrades, there will be annoying merge conflicts I guess (or your local changes will get overriddden afaik).

I guess a good approach would be, that the netbox-docker team considers this in the repository configuration.py with an environment variable DB_DYNAMIC_SCHEMA_SUPPORT, which will be checked in an if block in the configuration.py. Any thought on this?