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

[PR #6731] [MERGED] Fixes #6651: Add plugin's queueing system #13162

New Issue
Closed
opened 2025-12-29 22:25:44 +01:00 by adam · 0 comments
adam commented 2025-12-29 22:25:44 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/6731
Author: @maximumG
Created: 7/9/2021
Status: ✅ Merged
Merged: 7/9/2021
Merged by: @jeremystretch

Base: feature ← Head: 6651-plugins-rq-queues

📝 Commits (5)

  • 8b76db2 add: RQ queues for netbox core (high, default, low, check_release)
  • 995aa65 feat: Netbox plugin can defined their own RQ queues
  • dce3e07 chore: documentation about netbox plugin queueing system
  • a09e4bf chore: avoid the default RQ worker to listen to every queues by default and rather only listen to netbox core queues.
  • fd58eea Merge branch 'feature' into 6651-plugins-rq-queues

📊 Changes

6 files changed (+59 additions, -2 deletions)

View changed files

📝 contrib/netbox-rq.service (+1 -1)
📝 docs/plugins/development.md (+29 -1)
📝 netbox/extras/plugins/__init__.py (+3 -0)
📝 netbox/extras/tests/dummy_plugin/__init__.py (+5 -0)
📝 netbox/extras/tests/test_plugins.py (+8 -0)
📝 netbox/netbox/settings.py (+13 -0)

📄 Description

Fixes: #6651

  • Create Netbox core RQ queues : high, default and low. For now on, Netbox still uses the default queue for all background tasks (mainly webhooks).
  • Add plugin's dedicated queues: plugins can now define their own dedicated queues
  • Add some documentation in netbox-doc regarding core queues and plugin queues

Warning

Also note that netbox default RQ worker must explicitly specify the 3 core queues to listen to. Without this, the default RQ worker will listen to every queues, including plugin's dedicated queues.

I reflect this change in contrib/netbox-rq.service systemD unit file, but this should also be modified in the netbox-docker project

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/6731 **Author:** [@maximumG](https://github.com/maximumG) **Created:** 7/9/2021 **Status:** ✅ Merged **Merged:** 7/9/2021 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `feature` ← **Head:** `6651-plugins-rq-queues` --- ### 📝 Commits (5) - [`8b76db2`](https://github.com/netbox-community/netbox/commit/8b76db2bca5577a5b6c8c8e21526d7445a7274e1) add: RQ queues for netbox core (high, default, low, check_release) - [`995aa65`](https://github.com/netbox-community/netbox/commit/995aa65f16765e9ca6e54de60d600b7bae671522) feat: Netbox plugin can defined their own RQ queues - [`dce3e07`](https://github.com/netbox-community/netbox/commit/dce3e0763fcd94e687c72c2b68df0db4bebca3f5) chore: documentation about netbox plugin queueing system - [`a09e4bf`](https://github.com/netbox-community/netbox/commit/a09e4bf82a2a7ec02fbb4ca7267baed28d421caa) chore: avoid the default RQ worker to listen to every queues by default and rather only listen to netbox core queues. - [`fd58eea`](https://github.com/netbox-community/netbox/commit/fd58eeae1d82f2a3b69a9d812993d444153d3dd9) Merge branch 'feature' into 6651-plugins-rq-queues ### 📊 Changes **6 files changed** (+59 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `contrib/netbox-rq.service` (+1 -1) 📝 `docs/plugins/development.md` (+29 -1) 📝 `netbox/extras/plugins/__init__.py` (+3 -0) 📝 `netbox/extras/tests/dummy_plugin/__init__.py` (+5 -0) 📝 `netbox/extras/tests/test_plugins.py` (+8 -0) 📝 `netbox/netbox/settings.py` (+13 -0) </details> ### 📄 Description ### Fixes: #6651 * Create Netbox core RQ queues : *high*, *default* and *low*. For now on, Netbox still uses the *default* queue for all background tasks (mainly webhooks). * Add plugin's dedicated queues: plugins can now define their own dedicated queues * Add some documentation in netbox-doc regarding core queues and plugin queues ### Warning Also note that netbox default RQ worker must explicitly specify the 3 core queues to listen to. Without this, the default RQ worker will listen to every queues, including plugin's dedicated queues. I reflect this change in `contrib/netbox-rq.service` systemD unit file, but this should also be modified in the [netbox-docker](https://github.com/netbox-community/netbox-docker/blob/676ca798cd684ce30fca2692180e680d2becf76e/docker-compose.yml#L27) project --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 22:25:44 +01:00
adam closed this issue 2025-12-29 22:25:44 +01:00
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 pull-request
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#13162
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?