Puppet Class: nova::cron::purge_shadow_tables

Inherits:
nova::params
Defined in:
manifests/cron/purge_shadow_tables.pp

Overview

Copyright © 2018 Red Hat

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Class: nova::cron::purge_shadow_tables

Clean shadow tables

Parameters

[*minute*]
  (optional) Defaults to '0'.

[*hour*]
  (optional) Defaults to '5'.

[*monthday*]
  (optional) Defaults to '*'.

[*month*]
  (optional) Defaults to '*'.

[*weekday*]
  (optional) Defaults to '*'.

[*user*]
  (optional) User with access to nova files.
  Defaults to $::nova::params::user.

[*destination*]
  (optional) Path to file to which rows should be archived
  Defaults to '/var/log/nova/nova-rowspurge.log'.

[*age*]
  (optional) Adds a retention policy when purging the shadow tables
  Defaults to 14.

[*all_cells*]
  (optional) Adds --all-cells to the purge command
  Defaults to false.

[*verbose*]
  (optional) Adds --verbose to the purge command
  If specified, will print information about the purged rows.
  Defaults to false.

[*maxdelay*]
  (optional) In Seconds. Should be a positive integer.
  Induces a random delay before running the cronjob to avoid running
  all cron jobs at the same time on all hosts this job is configured.
  Defaults to 0.

[*ensure*]
  (optional) Ensure cron jobs present or absent
  Defaults to present.

Parameters:

  • minute (Any) (defaults to: 0)
  • hour (Any) (defaults to: 5)
  • monthday (Any) (defaults to: '*')
  • month (Any) (defaults to: '*')
  • weekday (Any) (defaults to: '*')
  • user (Any) (defaults to: $::nova::params::user)
  • destination (Any) (defaults to: '/var/log/nova/nova-rowspurge.log')
  • age (Any) (defaults to: 14)
  • all_cells (Any) (defaults to: false)
  • verbose (Any) (defaults to: false)
  • maxdelay (Any) (defaults to: 0)
  • ensure (Enum['present', 'absent']) (defaults to: 'present')


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'manifests/cron/purge_shadow_tables.pp', line 68

class nova::cron::purge_shadow_tables (
  $minute       = 0,
  $hour         = 5,
  $monthday     = '*',
  $month        = '*',
  $weekday      = '*',
  $user         = $::nova::params::user,
  $destination  = '/var/log/nova/nova-rowspurge.log',
  $age          = 14,
  $all_cells    = false,
  $verbose      = false,
  $maxdelay     = 0,
  Enum['present', 'absent'] $ensure = 'present',
) inherits nova::params {

  include nova::deps
  include nova::params

  if $verbose {
    $verbose_real = ' --verbose'
  }
  else {
    $verbose_real = ''
  }

  if $all_cells {
    $all_cells_real = ' --all-cells'
  }
  else {
    $all_cells_real = ''
  }

  if $maxdelay == 0 {
    $delay_cmd = ''
  } else {
    $delay_cmd = "sleep `expr \${RANDOM} \\% ${maxdelay}`; "
  }

  $cron_cmd = 'nova-manage db purge'

  cron { 'nova-manage db purge':
    ensure      => $ensure,
    # lint:ignore:140chars
    command     => "${delay_cmd}${cron_cmd} --before `date --date='today - ${age} days' +\\%D`${verbose_real}${all_cells_real} >>${destination} 2>&1",
    # lint:endignore
    environment => 'PATH=/bin:/usr/bin:/usr/sbin SHELL=/bin/sh',
    user        => $user,
    minute      => $minute,
    hour        => $hour,
    monthday    => $monthday,
    month       => $month,
    weekday     => $weekday,
    require     => Anchor['nova::dbsync::end']
  }
}