External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-05-17 06:17:36 -02:30
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3856 from rooftopcellist/cleanup_sessions_refactor

Browse Source 
Cleanup Sessions & Tokens System Jobs

Reviewed-by: https://github.com/softwarefactory-project-zuul[bot]
This commit is contained in:
softwarefactory-project-zuul[bot]
2019-05-22 20:50:48 +00:00
committed by GitHub
parent 1d328134fd 8ca0c1b992
commit 98c923a715
9 changed files with 247 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
awx/api/templates/api/_schedule_detail.md
View File

@@ -5,7 +5,7 @@ The following lists the expected format and details of our rrules:
* INTERVAL is required * INTERVAL is required
* SECONDLY is not supported * SECONDLY is not supported
* TZID is not supported * TZID is not supported
* RRULE must preceed the rule statements * RRULE must precede the rule statements
* BYDAY is supported but not BYDAY with a numerical prefix * BYDAY is supported but not BYDAY with a numerical prefix
* BYYEARDAY and BYWEEKNO are not supported * BYYEARDAY and BYWEEKNO are not supported
* Only one rrule statement per schedule is supported * Only one rrule statement per schedule is supported

2
awx/api/templates/api/system_job_template_launch.md
View File

@@ -3,7 +3,7 @@ Launch a Job Template:
Make a POST request to this resource to launch the system job template. Make a POST request to this resource to launch the system job template.
Variables specified inside of the parameter `extra_vars` are passed to the Variables specified inside of the parameter `extra_vars` are passed to the
system job task as command line parameters. These tasks can be ran manually system job task as command line parameters. These tasks can be run manually
on the host system via the `awx-manage` command. on the host system via the `awx-manage` command.
For example on `cleanup_jobs` and `cleanup_activitystream`: For example on `cleanup_jobs` and `cleanup_activitystream`:

2
awx/main/management/commands/cleanup_activitystream.py
View File

@@ -59,7 +59,7 @@ class Command(BaseCommand):
if len(pks_to_delete): if len(pks_to_delete):
ActivityStream.objects.filter(pk__in=pks_to_delete).delete() ActivityStream.objects.filter(pk__in=pks_to_delete).delete()
n_deleted_items += len(pks_to_delete) n_deleted_items += len(pks_to_delete)
self.logger.log(99, "Removed %d items", n_deleted_items) self.logger.info("Removed {} items".format(n_deleted_items))
def handle(self, *args, **options): def handle(self, *args, **options):
self.verbosity = int(options.get('verbosity', 1)) self.verbosity = int(options.get('verbosity', 1))

25
awx/main/management/commands/cleanup_sessions.py Normal file
View File

@@ -0,0 +1,25 @@
import logging
from django.core import management
from django.core.management.base import BaseCommand
from django.contrib.sessions.models import Session
class Command(BaseCommand):
def init_logging(self):
log_levels = dict(enumerate([logging.ERROR, logging.INFO,
logging.DEBUG, 0]))
self.logger = logging.getLogger('awx.main.commands.cleanup_sessions')
self.logger.setLevel(log_levels.get(self.verbosity, 0))
handler = logging.StreamHandler()
handler.setFormatter(logging.Formatter('%(message)s'))
self.logger.addHandler(handler)
self.logger.propagate = False
def execute(self, *args, **options):
self.verbosity = int(options.get('verbosity', 1))
self.init_logging()
total_sessions = Session.objects.all().count()
management.call_command('clearsessions')
self.logger.info("Expired Sessions deleted {}".format(total_sessions - Session.objects.all().count()))

28
awx/main/management/commands/cleanup_tokens.py Normal file
View File

@@ -0,0 +1,28 @@
import logging
from django.core import management
from django.core.management.base import BaseCommand
from awx.main.models import OAuth2AccessToken
from oauth2_provider.models import RefreshToken
class Command(BaseCommand):
def init_logging(self):
log_levels = dict(enumerate([logging.ERROR, logging.INFO,
logging.DEBUG, 0]))
self.logger = logging.getLogger('awx.main.commands.cleanup_tokens')
self.logger.setLevel(log_levels.get(self.verbosity, 0))
handler = logging.StreamHandler()
handler.setFormatter(logging.Formatter('%(message)s'))
self.logger.addHandler(handler)
self.logger.propagate = False
def execute(self, *args, **options):
self.verbosity = int(options.get('verbosity', 1))
self.init_logging()
total_accesstokens = OAuth2AccessToken.objects.all().count()
total_refreshtokens = RefreshToken.objects.all().count()
management.call_command('cleartokens')
self.logger.info("Expired OAuth 2 Access Tokens deleted: {}".format(total_accesstokens - OAuth2AccessToken.objects.all().count()))
self.logger.info("Expired OAuth 2 Refresh Tokens deleted: {}".format(total_refreshtokens - RefreshToken.objects.all().count()))

29
awx/main/migrations/0078_v360_clear_sessions_tokens_jt.py Normal file
View File

@@ -0,0 +1,29 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.11.20 on 2019-05-08 14:51
from __future__ import unicode_literals
from django.db import migrations, models
from awx.main.migrations._create_system_jobs import create_clearsessions_jt, create_cleartokens_jt
class Migration(migrations.Migration):
dependencies = [
('main', '0077_v360_add_default_orderings'),
]
operations = [
# Schedule Analytics System Job Template
migrations.RunPython(create_clearsessions_jt, migrations.RunPython.noop),
migrations.RunPython(create_cleartokens_jt, migrations.RunPython.noop),
migrations.AlterField(
model_name='systemjob',
name='job_type',
field=models.CharField(blank=True, choices=[('cleanup_jobs', 'Remove jobs older than a certain number of days'), ('cleanup_activitystream', 'Remove activity stream entries older than a certain number of days'), ('clearsessions', 'Removes expired browser sessions from the database'), ('cleartokens', 'Removes expired OAuth 2 access tokens and refresh tokens')], default='', max_length=32),
),
migrations.AlterField(
model_name='systemjobtemplate',
name='job_type',
field=models.CharField(blank=True, choices=[('cleanup_jobs', 'Remove jobs older than a certain number of days'), ('cleanup_activitystream', 'Remove activity stream entries older than a certain number of days'), ('clearsessions', 'Removes expired browser sessions from the database'), ('cleartokens', 'Removes expired OAuth 2 access tokens and refresh tokens')], default='', max_length=32),
),
]

82
awx/main/migrations/_create_system_jobs.py Normal file
View File

@@ -0,0 +1,82 @@
import random
import logging
from django.db import migrations, models
from django.utils.timezone import now, timedelta
logger = logging.getLogger('awx.main.migrations')
__all__ = ['create_collection_jt', 'create_clearsessions_jt', 'create_cleartokens_jt']
'''
These methods are called by migrations to create various system job templates
Create default system job templates if not present. Create default schedules
only if new system job templates were created (i.e. new database).
'''
def create_clearsessions_jt(apps, schema_editor):
SystemJobTemplate = apps.get_model('main', 'SystemJobTemplate')
Schedule = apps.get_model('main', 'Schedule')
ContentType = apps.get_model('contenttypes', 'ContentType')
sjt_ct = ContentType.objects.get_for_model(SystemJobTemplate)
now_dt = now()
schedule_time = now_dt.strftime('%Y%m%dT%H%M%SZ')
sjt, created = SystemJobTemplate.objects.get_or_create(
job_type='cleanup_sessions',
defaults=dict(
name='Cleanup Expired Sessions',
description='Cleans out expired browser sessions',
polymorphic_ctype=sjt_ct,
created=now_dt,
modified=now_dt,
),
)
if created:
sched = Schedule(
name='Cleanup Expired Sessions',
rrule='DTSTART:%s RRULE:FREQ=WEEKLY;INTERVAL=1;COUNT=1' % schedule_time,
description='Cleans out expired browser sessions',
enabled=True,
created=now_dt,
modified=now_dt,
extra_data={},
)
sched.unified_job_template = sjt
sched.save()
def create_cleartokens_jt(apps, schema_editor):
SystemJobTemplate = apps.get_model('main', 'SystemJobTemplate')
Schedule = apps.get_model('main', 'Schedule')
ContentType = apps.get_model('contenttypes', 'ContentType')
sjt_ct = ContentType.objects.get_for_model(SystemJobTemplate)
now_dt = now()
schedule_time = now_dt.strftime('%Y%m%dT%H%M%SZ')
sjt, created = SystemJobTemplate.objects.get_or_create(
job_type='cleanup_tokens',
defaults=dict(
name='Cleanup Expired OAuth 2 Tokens',
description='Cleanup expired OAuth 2 access and refresh tokens',
polymorphic_ctype=sjt_ct,
created=now_dt,
modified=now_dt,
),
)
if created:
sched = Schedule(
name='Cleanup Expired OAuth 2 Tokens',
rrule='DTSTART:%s RRULE:FREQ=WEEKLY;INTERVAL=1;COUNT=1' % schedule_time,
description='Removes expired OAuth 2 access and refresh tokens',
enabled=True,
created=now_dt,
modified=now_dt,
extra_data={},
)
sched.unified_job_template = sjt
sched.save()

3
awx/main/models/jobs.py
View File

@@ -1139,7 +1139,8 @@ class SystemJobOptions(BaseModel):
SYSTEM_JOB_TYPE = [ SYSTEM_JOB_TYPE = [
('cleanup_jobs', _('Remove jobs older than a certain number of days')), ('cleanup_jobs', _('Remove jobs older than a certain number of days')),
('cleanup_activitystream', _('Remove activity stream entries older than a certain number of days')), ('cleanup_activitystream', _('Remove activity stream entries older than a certain number of days')),
('cleanup_facts', _('Purge and/or reduce the granularity of system tracking data')), ('clearsessions', _('Removes expired browser sessions from the database')),
('cleartokens', _('Removes expired OAuth 2 access tokens and refresh tokens'))
] ]
class Meta: class Meta:

134
awx/ui/client/src/management-jobs/card/card.controller.js
View File

@@ -45,69 +45,91 @@ export default
}); });
}; };
var launchManagementJob = function (defaultUrl){
var data = {};
Rest.setUrl(defaultUrl);
Rest.post(data)
.then(({data}) => {
Wait('stop');
$state.go('output', { id: data.system_job, type: 'system' }, { reload: true });
})
.catch(({data, status}) => {
let template_id = $scope.job_template_id;
template_id = (template_id === undefined) ? "undefined" : i18n.sprintf("%d", template_id);
ProcessErrors($scope, data, status, null, { hdr: i18n._('Error!'),
msg: i18n.sprintf(i18n._('Failed updating job %s with variables. POST returned: %d'), template_id, status) });
});
};
$scope.submitJob = function (id, name) { $scope.submitJob = function (id, name) {
Wait('start'); Wait('start');
defaultUrl = GetBasePath('system_job_templates')+id+'/launch/'; defaultUrl = GetBasePath('system_job_templates')+id+'/launch/';
CreateDialog({ var noModalJobs = ['Cleanup Expired Sessions', 'Cleanup Expired OAuth 2 Tokens'];
id: 'prompt-for-days' , if (noModalJobs.includes(name)) {
title: name, launchManagementJob(defaultUrl, name);
scope: $scope, } else {
width: 500,
height: 300, CreateDialog({
minWidth: 200, id: 'prompt-for-days',
callback: 'PromptForDays', title: name,
resizable: false, scope: $scope,
onOpen: function(){ width: 500,
$scope.$watch('prompt_for_days_form.$invalid', function(invalid) { height: 300,
if (invalid === true) { minWidth: 200,
$('#prompt-for-days-launch').prop("disabled", true); callback: 'PromptForDays',
} else { resizable: false,
$('#prompt-for-days-launch').prop("disabled", false); onOpen: function(){
} $scope.$watch('prompt_for_days_form.$invalid', function(invalid) {
}); if (invalid === true) {
$('#prompt-for-days-launch').prop("disabled", true);
} else {
$('#prompt-for-days-launch').prop("disabled", false);
}
});
let fieldScope = $scope.$parent; let fieldScope = $scope.$parent;
fieldScope.days_to_keep = 30; fieldScope.days_to_keep = 30;
$scope.prompt_for_days_form.$setPristine(); $scope.prompt_for_days_form.$setPristine();
$scope.prompt_for_days_form.$invalid = false; $scope.prompt_for_days_form.$invalid = false;
}, },
buttons: [ buttons: [
{ {
"label": "Cancel", "label": "Cancel",
"onClick": function() { "onClick": function() {
$(this).dialog('close'); $(this).dialog('close');
},
"class": "btn btn-default",
"id": "prompt-for-days-cancel"
}, },
"class": "btn btn-default", {
"id": "prompt-for-days-cancel" "label": "Launch",
}, "onClick": function() {
{ const extra_vars = {"days": $scope.days_to_keep },
"label": "Launch", data = {};
"onClick": function() { data.extra_vars = JSON.stringify(extra_vars);
const extra_vars = {"days": $scope.days_to_keep },
data = {};
data.extra_vars = JSON.stringify(extra_vars);
Rest.setUrl(defaultUrl); Rest.setUrl(defaultUrl);
Rest.post(data) Rest.post(data)
.then(({data}) => { .then(({data}) => {
Wait('stop'); Wait('stop');
$("#prompt-for-days").dialog("close"); $("#prompt-for-days").dialog("close");
// $("#configure-dialog").dialog('close'); // $("#configure-dialog").dialog('close');
$state.go('output', { id: data.system_job, type: 'system' }, { reload: true }); $state.go('output', { id: data.system_job, type: 'system' }, { reload: true });
}) })
.catch(({data, status}) => { .catch(({data, status}) => {
let template_id = $scope.job_template_id; let template_id = $scope.job_template_id;
template_id = (template_id === undefined) ? "undefined" : i18n.sprintf("%d", template_id); template_id = (template_id === undefined) ? "undefined" : i18n.sprintf("%d", template_id);
ProcessErrors($scope, data, status, null, { hdr: i18n._('Error!'), ProcessErrors($scope, data, status, null, { hdr: i18n._('Error!'),
msg: i18n.sprintf(i18n._('Failed updating job %s with variables. POST returned: %d'), template_id, status) }); msg: i18n.sprintf(i18n._('Failed updating job %s with variables. POST returned: %d'), template_id, status) });
}); });
}, },
"class": "btn btn-primary", "class": "btn btn-primary",
"id": "prompt-for-days-launch" "id": "prompt-for-days-launch"
} }
] ]
}); });
}
if ($scope.removePromptForDays) { if ($scope.removePromptForDays) {
$scope.removePromptForDays(); $scope.removePromptForDays();