starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

reindex manage command behaves unexpectedly #9910

New Issue
Closed
opened 2025-12-29 21:24:17 +01:00 by adam · 4 comments
adam commented 2025-12-29 21:24:17 +01:00
Owner
Copy Link

Originally created by @peteeckel on GitHub (Jun 27, 2024).

Originally assigned to: @peteeckel on GitHub.

Deployment Type

Self-hosted

NetBox Version

v4.0.6

Python Version

3.11

Steps to Reproduce

I was made aware of this by a question posted to the Slack channel.

A user asked whether the reindex management command deletes all search indexes except the ones for the application given as a parameter if reindex is used with an application name, for example

/opt/netbox/netbox/manage.py reindex netbox_dns

It turns out that this is in fact the case. The code for the management command always deletes all search indexes even if it was called with an application/plugin name as its parameters, but recreates only the ones for the given application or plugin.

First, I indexed the whole NetBox DNS inventory for all models:

/opt/netbox/netbox/manage.py reindex
Reindexing 82 models.
Clearing cached values... 467 entries deleted.
Indexing models
  netbox_dns.record... 365 entries cached.
  netbox_dns.view... 4 entries cached.
  netbox_dns.nameserver... 7 entries cached.
...
  wireless.wirelesslan... No objects found.
  wireless.wirelesslangroup... No objects found.
  wireless.wirelesslink... No objects found.
Completed. Total entries: 650

The followinig SQL query returns all application/model name pairs that are in the index:

(netbox) [root@dns netbox]# /opt/netbox/netbox/manage.py dbshell
psql (15.5)
Type "help" for help.

netbox=# SELECT DISTINCT (app_label, model) FROM django_content_type c INNER JOIN extras_cachedvalue v ON c.id=v.object_type_id;
           row           
-------------------------
 (core,datafile)
 (core,datasource)
 (dcim,device)
 (dcim,devicerole)
 (dcim,devicetype)
 (dcim,interface)
 (dcim,manufacturer)
 (dcim,site)
 (dcim,virtualchassis)
 (extras,customfield)
 (extras,webhook)
 (ipam,ipaddress)
 (ipam,prefix)
 (ipam,vlan)
 (ipam,vlangroup)
 (ipam,vrf)
 (netbox_dns,contact)
 (netbox_dns,nameserver)
 (netbox_dns,record)
 (netbox_dns,registrar)
 (netbox_dns,view)
 (netbox_dns,zone)
 (tenancy,tenant)
 (tenancy,tenantgroup)
 (vpn,ikepolicy)
 (vpn,ikeproposal)
 (vpn,ipsecpolicy)
 (vpn,ipsecprofile)
 (vpn,ipsecproposal)
(29 rows)

Now, reindex only the search indices for a given application:

(netbox) [root@dns netbox]# /opt/netbox/netbox/manage.py reindex netbox_dns
Reindexing 6 models.
Clearing cached values... 650 entries deleted.
Indexing models
  netbox_dns.record... 365 entries cached.
  netbox_dns.view... 4 entries cached.
  netbox_dns.nameserver... 7 entries cached.
  netbox_dns.zone... 78 entries cached.
  netbox_dns.contact... 10 entries cached.
  netbox_dns.registrar... 3 entries cached.
Completed. Total entries: 467

The same SQL query now shows that the indices for all other applications are missing:

netbox=# SELECT DISTINCT (app_label, model) FROM django_content_type c INNER JOIN extras_cachedvalue v ON c.id=v.object_type_id;
           row           
-------------------------
 (netbox_dns,contact)
 (netbox_dns,nameserver)
 (netbox_dns,record)
 (netbox_dns,registrar)
 (netbox_dns,view)
 (netbox_dns,zone)
(6 rows)

Deleting all other index can only be avoided by also specifying --lazy, but that option prevents the indices for a specific application or model to be recreated (i.e., deleted and then created again). There is currently no way to achieve this.

Expected Behavior

Only the search indexes for the specified applications/models are deleted, not all of them, and certainly not silently.

Observed Behavior

All indexes are deleted and only those for the specified application/model are (re-)created.

Originally created by @peteeckel on GitHub (Jun 27, 2024). Originally assigned to: @peteeckel on GitHub. ### Deployment Type Self-hosted ### NetBox Version v4.0.6 ### Python Version 3.11 ### Steps to Reproduce I was made aware of this by a question posted to the Slack channel. A user asked whether the `reindex` management command deletes all search indexes except the ones for the application given as a parameter if `reindex` is used with an application name, for example ```bash /opt/netbox/netbox/manage.py reindex netbox_dns ``` It turns out that this is in fact the case. The code for the management command always deletes all search indexes even if it was called with an application/plugin name as its parameters, but recreates only the ones for the given application or plugin. First, I indexed the whole NetBox DNS inventory for all models: ``` /opt/netbox/netbox/manage.py reindex Reindexing 82 models. Clearing cached values... 467 entries deleted. Indexing models netbox_dns.record... 365 entries cached. netbox_dns.view... 4 entries cached. netbox_dns.nameserver... 7 entries cached. ... wireless.wirelesslan... No objects found. wireless.wirelesslangroup... No objects found. wireless.wirelesslink... No objects found. Completed. Total entries: 650 ``` The followinig SQL query returns all application/model name pairs that are in the index: ``` (netbox) [root@dns netbox]# /opt/netbox/netbox/manage.py dbshell psql (15.5) Type "help" for help. netbox=# SELECT DISTINCT (app_label, model) FROM django_content_type c INNER JOIN extras_cachedvalue v ON c.id=v.object_type_id; row ------------------------- (core,datafile) (core,datasource) (dcim,device) (dcim,devicerole) (dcim,devicetype) (dcim,interface) (dcim,manufacturer) (dcim,site) (dcim,virtualchassis) (extras,customfield) (extras,webhook) (ipam,ipaddress) (ipam,prefix) (ipam,vlan) (ipam,vlangroup) (ipam,vrf) (netbox_dns,contact) (netbox_dns,nameserver) (netbox_dns,record) (netbox_dns,registrar) (netbox_dns,view) (netbox_dns,zone) (tenancy,tenant) (tenancy,tenantgroup) (vpn,ikepolicy) (vpn,ikeproposal) (vpn,ipsecpolicy) (vpn,ipsecprofile) (vpn,ipsecproposal) (29 rows) ``` Now, reindex only the search indices for a given application: ``` (netbox) [root@dns netbox]# /opt/netbox/netbox/manage.py reindex netbox_dns Reindexing 6 models. Clearing cached values... 650 entries deleted. Indexing models netbox_dns.record... 365 entries cached. netbox_dns.view... 4 entries cached. netbox_dns.nameserver... 7 entries cached. netbox_dns.zone... 78 entries cached. netbox_dns.contact... 10 entries cached. netbox_dns.registrar... 3 entries cached. Completed. Total entries: 467 ``` The same SQL query now shows that the indices for all other applications are missing: ``` netbox=# SELECT DISTINCT (app_label, model) FROM django_content_type c INNER JOIN extras_cachedvalue v ON c.id=v.object_type_id; row ------------------------- (netbox_dns,contact) (netbox_dns,nameserver) (netbox_dns,record) (netbox_dns,registrar) (netbox_dns,view) (netbox_dns,zone) (6 rows) ``` Deleting all other index can only be avoided by also specifying `--lazy`, but that option prevents the indices for a specific application or model to be recreated (i.e., deleted and then created again). There is currently no way to achieve this. ### Expected Behavior Only the search indexes for the specified applications/models are deleted, not all of them, and certainly not silently. ### Observed Behavior All indexes are deleted and only those for the specified application/model are (re-)created.
adam added the type: bugstatus: acceptedseverity: low labels 2025-12-29 21:24:17 +01:00
adam closed this issue 2025-12-29 21:24:17 +01:00
adam commented 2025-12-29 21:24:18 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Jun 27, 2024):

This code looks like it clears all at start

        # Clear all cached values for the specified models (if not being lazy)
        if not kwargs['lazy']:
            self.stdout.write('Clearing cached values... ', ending='')
            self.stdout.flush()
            deleted_count = search_backend.clear()
            self.stdout.write(f'{deleted_count} entries deleted.')
@arthanson commented on GitHub (Jun 27, 2024): This code looks like it clears all at start ``` # Clear all cached values for the specified models (if not being lazy) if not kwargs['lazy']: self.stdout.write('Clearing cached values... ', ending='') self.stdout.flush() deleted_count = search_backend.clear() self.stdout.write(f'{deleted_count} entries deleted.') ```
adam commented 2025-12-29 21:24:18 +01:00
Author
Owner
Copy Link

@peteeckel commented on GitHub (Jun 27, 2024):

This code looks like it clears all at start

exactly. Which isn't a problem if you don't specify a list of applications/models, but if you do it does unexpected thinks.

You can assign it to me if that's OK for you.

@peteeckel commented on GitHub (Jun 27, 2024): > This code looks like it clears all at start exactly. Which isn't a problem if you don't specify a list of applications/models, but if you do it does unexpected thinks. You can assign it to me if that's OK for you.
adam commented 2025-12-29 21:24:19 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Jun 27, 2024):

@peteeckel assigning to you.

@arthanson commented on GitHub (Jun 27, 2024): @peteeckel assigning to you.
adam commented 2025-12-29 21:24:19 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 30, 2024):

Steps to reproduce

  1. Create a site named Foo
  2. Search for "foo" in the global search & verify that the site appears in search results
  3. Run the management command manage.py reindex ipam to reindex only IPAM models
  4. Search again for "Foo;" it no longer appears in the search results
@jeremystretch commented on GitHub (Jun 30, 2024): ### Steps to reproduce 1. Create a site named Foo 2. Search for "foo" in the global search & verify that the site appears in search results 3. Run the management command `manage.py reindex ipam` to reindex only IPAM models 4. Search again for "Foo;" it no longer appears in the search results
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label severity: low status: accepted type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9910
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?