mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Rename JOBRESULT_RETENTION to JOB_RETENTION

Browse Source
This commit is contained in:
jeremystretch
2023-03-27 12:10:59 -04:00
committed by Jeremy Stretch
parent 40572b543f
commit 7b258dc11f
6 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/administration/housekeeping.md
View File

@ -4,7 +4,7 @@ NetBox includes a `housekeeping` management command that should be run nightly.
* Clearing expired authentication sessions from the database
* Deleting changelog records older than the configured [retention time](../configuration/miscellaneous.md#changelog_retention)
* Deleting job result records older than the configured [retention time](../configuration/miscellaneous.md#jobresult_retention)
* Deleting job result records older than the configured [retention time](../configuration/miscellaneous.md#job_retention)
* Check for new NetBox releases (if [`RELEASE_CHECK_URL`](../configuration/miscellaneous.md#release_check_url) is set)
This command can be invoked directly, or by using the shell script provided at `/opt/netbox/contrib/netbox-housekeeping.sh`. This script can be linked from your cron scheduler's daily jobs directory (e.g. `/etc/cron.daily`) or referenced directly within the cron configuration file.

2
docs/configuration/index.md
View File

@ -26,7 +26,7 @@ Some configuration parameters are primarily controlled via NetBox's admin interf
* [`DEFAULT_USER_PREFERENCES`](./default-values.md#default_user_preferences)
* [`ENFORCE_GLOBAL_UNIQUE`](./miscellaneous.md#enforce_global_unique)
* [`GRAPHQL_ENABLED`](./miscellaneous.md#graphql_enabled)
* [`JOBRESULT_RETENTION`](./miscellaneous.md#jobresult_retention)
* [`JOB_RETENTION`](./miscellaneous.md#job_retention)
* [`MAINTENANCE_MODE`](./miscellaneous.md#maintenance_mode)
* [`MAPS_URL`](./miscellaneous.md#maps_url)
* [`MAX_PAGE_SIZE`](./miscellaneous.md#max_page_size)

8
docs/configuration/miscellaneous.md
View File

@ -87,14 +87,16 @@ Setting this to False will disable the GraphQL API.
---
## JOBRESULT_RETENTION
## JOB_RETENTION
!!! tip "Dynamic Configuration Parameter"
!!! note
This parameter was renamed from `JOBRESULT_RETENTION` in NetBox v3.5.
Default: 90
The number of days to retain job results (scripts and reports). Set this to `0` to retain
job results in the database indefinitely.
The number of days to retain job results (scripts and reports). Set this to `0` to retain job results in the database indefinitely.
!!! warning
If enabling indefinite job results retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity.

2
netbox/extras/admin.py
View File

@ -39,7 +39,7 @@ class ConfigRevisionAdmin(admin.ModelAdmin):
'fields': ('DEFAULT_USER_PREFERENCES',),
}),
('Miscellaneous', {
'fields': ('MAINTENANCE_MODE', 'GRAPHQL_ENABLED', 'CHANGELOG_RETENTION', 'JOBRESULT_RETENTION', 'MAPS_URL'),
'fields': ('MAINTENANCE_MODE', 'GRAPHQL_ENABLED', 'CHANGELOG_RETENTION', 'JOB_RETENTION', 'MAPS_URL'),
}),
('Config Revision', {
'fields': ('comment',),

8
netbox/extras/management/commands/housekeeping.py
View File

@ -67,10 +67,10 @@ class Command(BaseCommand):
# Delete expired Jobs
if options['verbosity']:
self.stdout.write("[*] Checking for expired jobs")
if config.JOBRESULT_RETENTION:
cutoff = timezone.now() - timedelta(days=config.JOBRESULT_RETENTION)
if config.JOB_RETENTION:
cutoff = timezone.now() - timedelta(days=config.JOB_RETENTION)
if options['verbosity'] >= 2:
self.stdout.write(f"\tRetention period: {config.JOBRESULT_RETENTION} days")
self.stdout.write(f"\tRetention period: {config.JOB_RETENTION} days")
self.stdout.write(f"\tCut-off time: {cutoff}")
expired_records = Job.objects.filter(created__lt=cutoff).count()
if expired_records:
@ -88,7 +88,7 @@ class Command(BaseCommand):
self.stdout.write("\tNo expired records found.", self.style.SUCCESS)
elif options['verbosity']:
self.stdout.write(
f"\tSkipping: No retention period specified (JOBRESULT_RETENTION = {config.JOBRESULT_RETENTION})"
f"\tSkipping: No retention period specified (JOB_RETENTION = {config.JOB_RETENTION})"
)
# Check for new releases (if enabled)

2
netbox/netbox/config/parameters.py
View File

@ -214,7 +214,7 @@ PARAMS = (
field=forms.IntegerField
),
ConfigParam(
name='JOBRESULT_RETENTION',
name='JOB_RETENTION',
label=_('Job result retention'),
default=90,
description=_("Days to retain job result history (set to zero for unlimited)"),