Load custom fields when creating the container #39
Conversation
docker/docker-entrypoint.sh
Outdated
| for script in startup_scripts/*.py; do | ||
| ./manage.py shell --plain < $script | ||
| done | ||
|
|
There was a problem hiding this comment.
This opens a lot of possibilities for many customizations.
Dockerfile
Outdated
| @@ -29,6 +29,7 @@ WORKDIR /opt/netbox | |||
| RUN pip install -r requirements.txt | |||
|
|
|||
| COPY docker/configuration.docker.py /opt/netbox/netbox/netbox/configuration.py | |||
| COPY docker/startup_scripts /opt/netbox/netbox/startup_scripts | |||
There was a problem hiding this comment.
There are two ways to use this feature for our users, actually. But in order to be generally useful, having this in the Dockerfile seems to be the wrong way..
User can either base of the original image and build their own Docker container (see example Dockerfile below), or they can just mount such files into the container using docker-compose (or whatever mechanism; see the example further down).
So, something like the following should probably be added to the README, along with a short explanation of the feature.
FROM ninech/netbox
COPY docker/startup_scripts /opt/netbox/netbox/startup_scriptsAnd I think it would be nice to adjust the default docker-compose.yml file to include the following:
services:
netbox:
volumes:
- ./startup_scripts:/opt/netbox/netbox/startup_scripts
This would also require a .gitkeep file in the folder ./startup_scripts/.
| ) | ||
|
|
||
| nine_urn.obj_type.add(device) | ||
| nine_urn.obj_type.add(device_type) |
There was a problem hiding this comment.
This file seems to contain internal code, but it would suit as a good example as part of the README.md.
docker/docker-entrypoint.sh
Outdated
| @@ -39,6 +39,10 @@ if not User.objects.filter(username='${SUPERUSER_NAME}'): | |||
| Token.objects.create(user=u, key='${SUPERUSER_API_TOKEN}') | |||
| END | |||
|
|
|||
| for script in startup_scripts/*.py; do | |||
| ./manage.py shell --plain < $script | |||
There was a problem hiding this comment.
The files are launched every time the container starts, right?
There was a problem hiding this comment.
You should put quotation marks around $script, in case a file is saved with a space in the name:
"${script}"
born4new
force-pushed
the
seed_custom_fields
branch
2 times, most recently
from
ed3c341
to
759a2d5
Compare
README.md
Outdated
| description='My own custom field' | ||
| ) | ||
|
|
||
| my_custom_field.obj_type.add(device) |
There was a problem hiding this comment.
What impact does it have if the same obj_type is added over and over again with every start?
There was a problem hiding this comment.
Thanks to my out-of-this-world python skills and CustomField.objects.get_or_create, not much: it will first try to fetch it, and if not present, will create it.
born4new
force-pushed
the
seed_custom_fields
branch
from
759a2d5
to
8e98b8d
Compare
What's new?
This is a general mechanism to launch python scripts for Netbox: All the scripts put inside the
docker/startup_scriptsfolder will be executed.