-
Notifications
You must be signed in to change notification settings - Fork 18
/
auter.help2man-sections
117 lines (84 loc) · 4.26 KB
/
auter.help2man-sections
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
[Directories]
Default Directory locations are listed below; custom paths can be specified in the config file. The use of additional, non-default, config files is required when running more than one auter profile.
.SS
Pre/Post Hooks
If any scripts in the pre/post hook directories are not executable, they will be skipped by auter and a warning containing the filename will be logged. If any scripts in the pre/post hook directories exit with a non-zero exit code an error will be logged with the filename and exit code, and auter will abort.
.TP
.I /etc/auter/pre-prep.d
Directory containing scripts to be executed before downloading updates
.TP
.I /etc/auter/post-prep.d
Directory containing scripts to be executed after downloading updates
.TP
.I /etc/auter/pre-apply.d
Directory containing scripts to be executed before applying updates
.TP
.I /etc/auter/post-apply.d
Directory containing scripts to be executed after applying updates
.TP
.I /etc/auter/pre-reboot.d
Directory containing scripts to be executed before rebooting
.TP
.I /etc/auter/post-reboot.d
Directory containing scripts to be executed after rebooting
There is a hard coded delay of 5 minutes post-reboot to allow the system to become fully ready before the post-reboot scripts are executed.
.SS Hook Execution Order
Files in the pre/post script directories are parsed in sorted lexical order. That is, /etc/auter/pre-apply.d/01_first will be parsed before /etc/auter/pre-apply.d/10_second. Be aware that because the sorting is lexical, not numeric, /etc/auter/pre-apply.d/1_whoops would be loaded after /etc/pre-apply.d/10_second. Using a consistent number of leading zeroes in the file names can be used to avoid such problems. For example the following execution order would occur for pre-apply scripts:
.RS
.nf
pre-apply.d/00-first.sh
pre-apply.d/99-second.sh
pre-apply.d/AA-fourth.sh
pre-apply.d/aa-third.sh
pre-apply.d/zz-fifth.sh
pre-apply.d/ZZ-sixth.sh
.RE
Note that the ordering is case-insensitive so AA-fourth.sh will be run before aa-third.sh.
[files]
.TP
.I /etc/auter/auter.conf
Default config file location. Use the --config option to pass an alternative config file to use within /etc/auter.
.TP
.I /etc/cron.d/auter
The default cron file with examples
.TP
.I /usr/bin/auter
The main auter script which contains linux generic code
.TP
.I /usr/lib/auter/auter.module
The auter module for the relevant package manager
.TP
.I /usr/share/doc/auter-0.11/LICENSE
The Apache License
.TP
.I /usr/share/doc/auter-0.11/MAINTAINERS.md
A list of maintainers and mailing list
.TP
.I /usr/share/doc/auter-0.11/NEWS
The NEWS file and changelog for auter
[Enable/Disable]
To provide an easy way to switch on/off all auter jobs, use auter --enable or auter --disable to set the lockfile /var/lib/auter/enabled. Auter will check for the presence of this file before running.
This is also the correct method for cleaning up an unused pidfile.
[Rebooting]
Rebooting is an essential part of applying updates, in order to ensure the updated packages are in use. An update to the kernel will always need a reboot. Some application updates, for example Apache, will restart the service. However often libraries are updated, such as openssl, which don't force a reboot of services that use them. Rebooting guarantees that every update is in use by running services. You can either enable AUTOREBOOT=yes in the config file (the default is AUTOREBOOT=no), to reboot after --apply, or you can schedule a separate schedule for --reboot via a second cronjob. A 2 minute warning is emitted before the server is rebooted, and this can be cancelled by a superuser with shutdown -c.
[Exit Codes]
0 = updates successful / no updates available
3 = issue related to yum / dnf / apt-get command
4 = auter disabled via lockfile
5 = script not run as root / DATADIR does not exist / config file does not exist
6 = auter is already running / PIDFILE exists
7 = yum, dnf or apt-get was not found
8 = a pre/post hook exited with a non-zero error code
[Authors]
.TP
This documentation was primarily written by:
Paolo Gigante
Piers Cornwell
Cameron Beere
[Reporting Bugs]
.TP
Please report any bugs by raising an issue against the github page or email us at:
https://github.com/rackerlabs/auter/issues
[see also]
auter.conf(5), cron(8), crontab(5)