AUTH_LDAP_MIRROR_GROUPS ldap_config tweak

[ryanmerolle]

Related Issue: Fixes #445

New Behavior

If AUTH_LDAP_MIRROR_GROUPS not set in environment variables, it will not be set in ldap_config.py, allowing for ldap config shown in the new example configuration\ldap\extra.py

Contrast to Current Behavior

If AUTH_LDAP_MIRROR_GROUPS not set in environment variables, it is set to empty in ldap_config.py

Discussion: Benefits and Drawbacks

See #445

Changes to the Wiki

TBD, likely will suggest something with regards to language around the #343 function and the example configuration\ldap\extra.py file included.

Proposed Release Note Entry

• Tweaked ldap_config.py to allow for a AUTH_LDAP_MIRROR_GROUPS list of groups to be specified.

Double Check

• I have read the comments and followed the PR template.
• I have explained my PR according to the information in the comments.
• My PR targets the develop branch.

[cimnine]

I like the example file!

[cimnine]

Meant to click Comment, not Approve.

Clicked wrong button.

[ryanmerolle]

I'll build from develop locally and test when I get a chance since #450 is only in develop at this point. Give me a day or two.

[cimnine]

Do you think you have a chance to look into this anytime soon*ish? No hurry, I just want to know whether I should wait for it or otherwise postpone this change to the next release.

[ryanmerolle]

I will have this tested today or tomorrow since this directly is tied to a new deployment I have to have in place by tomorrow evening.

[ryanmerolle]

I tested as you suggested by mounting the volume to pull in the develop version of docker/configuration.docker.py from #450

The extra.py still works as it did before. IE if I do not comment out the variables set in ldap.py that overlap with what I declare in extra.py, the settings declared in extra.py that overlap do not take. All the other non-overlapping variables take no matter which file they are declared in.

[ryanmerolle]

I say bump my PRs to the next release. No need to further hold up here.

[tobiasge]

I tested as you suggested by mounting the volume to pull in the develop version of docker/configuration.docker.py from #450

The extra.py still works as it did before. IE if I do not comment out the variables set in ldap.py that overlap with what I declare in extra.py, the settings declared in extra.py that overlap do not take. All the other non-overlapping variables take no matter which file they are declared in.

If you still have this problem you can do some more tests like this:
Mount modified versions of the configurations files into the container (with docker-compose.override.yml):

version: '3.4'
services:
  netbox:
    ports:
      - "8000:8080"
    volumes:
      - ./docker/configuration.docker.py:/opt/netbox/netbox/netbox/configuration.py:z,ro
      - ./docker/ldap_config.docker.py:/opt/netbox/netbox/netbox/ldap_config.py:z,ro

Modify the method __getattr__(name) in docker/configuration.docker.py and docker/ldap_config.docker.py to this:

def __getattr__(name):
    for config in _loaded_configurations:
        try:
            attr = getattr(config, name)
            print(f"Returning '{name}' from '{config}'")
            return attr
        except:
            print(f"'{name}' not found in '{config}'")
            pass
    raise AttributeError

This will produce lines (a lot, basically for every settings access) like these:

netbox_1         | 'MAINTENANCE_MODE' not found in '<module '' from '/etc/netbox/config/extra.py'>'
netbox_1         | Returning 'MAINTENANCE_MODE' from '<module '' from '/etc/netbox/config/configuration.py'>'

Then you can see from where the values are loaded.

[cimnine]

@ryanmerolle , just checking what's the status here, as I lost track 🙈

[ryanmerolle]

I was quite distracted the past month with the birth of my daughter. I plan to dig this back up along with some of my other netbox-docker items in the next week.

[cimnine]

Congratulations, I hope she and your family are all well! There's no rush, just good to know that you're still on it.

[ryanmerolle]

instead of making a feature branch in my fork I developed in the develop branch. Once this PR gets merged or rejected I will tackle #461

[ryanmerolle]

Apologies. I forgot to commit my changes. This should be fixed now @cimnine

[cimnine]

Apologies. I forgot to commit my changes. This should be fixed now @cimnine

Happens to all of us 😅