Deleted metche.8.
ricola
18 years ago
| 0 | .\"Generated by db2man.xsl. Don't modify this, modify the source. | |
| 1 | .de Sh \" Subsection | |
| 2 | .br | |
| 3 | .if t .Sp | |
| 4 | .ne 5 | |
| 5 | .PP | |
| 6 | \fB\\$1\fR | |
| 7 | .PP | |
| 8 | .. | |
| 9 | .de Sp \" Vertical space (when we can't use .PP) | |
| 10 | .if t .sp .5v | |
| 11 | .if n .sp | |
| 12 | .. | |
| 13 | .de Ip \" List item | |
| 14 | .br | |
| 15 | .ie \\n(.$>=3 .ne \\$3 | |
| 16 | .el .ne 3 | |
| 17 | .IP "\\$1" \\$2 | |
| 18 | .. | |
| 19 | .TH "METCHE" 8 "" "" "" | |
| 20 | .SH NAME | |
| 21 | metche \- reducing root bus factor | |
| 22 | .SH "SYNOPSIS" | |
| 23 | .ad l | |
| 24 | .hy 0 | |
| 25 | .HP 7 | |
| 26 | \fBmetche\fR [\-h\ \fIhost\fR] {\fBcron\fR | \fBreport\ [{\fBstable\fR\ |\ \fBtesting\fR\ |\ \fBunstable\fR}\-\fIYYYYMMDDHHMM\fR]\fR | \fBlist\fR | \fBstabilize\ [testing\-\fIYYYYMMDDHHMM\fR]\fR} | |
| 27 | .ad | |
| 28 | .hy | |
| 29 | ||
| 30 | .SH "DESCRIPTION" | |
| 31 | ||
| 32 | .PP | |
| 33 | metche is a tool meant to facilitate collective sysadmin, by monitoring changes in the system configuration\&. At least \fBWATCHED_DIR\fR (default: \fI/etc\fR) is monitored ; optionally, metche can also monitor : | |
| 34 | ||
| 35 | .TP 3 | |
| 36 | \(bu | |
| 37 | system Changelog files located in \fI\fBCHANGELOG_DIR\fR/*/Changelog\fR (default:\fI/root/changelogs/*/Changelog\fR) | |
| 38 | .TP | |
| 39 | \(bu | |
| 40 | Debian packages states and versions | |
| 41 | .LP | |
| 42 | ||
| 43 | .PP | |
| 44 | \fBWATCHED_DIR\fR and \fBCHANGELOG_DIR\fR options can me customized in metche's configuration file, as well as a few other ones\&. | |
| 45 | ||
| 46 | .PP | |
| 47 | If \fB\-h\fR \fIHOST\fR is specified, \fI/etc/metche/HOST\&.conf\fR is used instead of \fI/etc/metche\&.conf\fR\&. This, along with the \fBVSERVER_EXEC_PREFIX\fR option, allows to monitor several vservers running on a system\&. | |
| 48 | ||
| 49 | .PP | |
| 50 | Anyway, one of the following commands has to be specified on the command line : | |
| 51 | ||
| 52 | .TP | |
| 53 | \fBreport\fR | |
| 54 | When run with the \fBreport\fR command, metche displays a report against a given saved state, if specified, or against the latest testing state, otherwise\&. This is useful when you have broken your system and want to know which changes have been made since a given, known working, system state\&. | |
| 55 | ||
| 56 | .TP | |
| 57 | \fBlist\fR | |
| 58 | When run with the \fBlist\fR command, metche displays the full saved states list\&. | |
| 59 | ||
| 60 | .TP | |
| 61 | \fBstabilize\fR | |
| 62 | When run with the \fBstabilize\fR command, metche turns the given "testing state", if specified, or the latest one, otherwise, into a "stable state"\&. | |
| 63 | ||
| 64 | .TP | |
| 65 | \fBcron\fR | |
| 66 | When run (usually by a cronjob) with the \fBcron\fR command, metche : | |
| 67 | ||
| 68 | .RS | |
| 69 | .TP 3 | |
| 70 | \(bu | |
| 71 | saves a "unstable", "testing", "stable" state, or none, as needed ; | |
| 72 | .TP | |
| 73 | \(bu | |
| 74 | sends you a report if needed (see metche's homepage: \fIhttps://poivron.org/dev/metche/\fR for an example) ; | |
| 75 | .LP | |
| 76 | .RE | |
| 77 | .IP | |
| 78 | The following algorithm is used to decide exactly what to do : | |
| 79 | ||
| 80 | .IP | |
| 81 | if (no change happened for TESTING_TIME) then | |
| 82 | if (something has changed since the last testing) then | |
| 83 | send a report against last testing | |
| 84 | save a new testing state | |
| 85 | delete all saved unstable states | |
| 86 | elif (no change happened for STABLE_TIME) then | |
| 87 | if (something has changed since the last stable) then | |
| 88 | save a new stable state and notify EMAIL_ADDRESS | |
| 89 | delete all saved testing states older than STABLE_TIME | |
| 90 | fi | |
| 91 | fi | |
| 92 | elif (last unstable exists) then | |
| 93 | if (something has changed since the last unstable) then | |
| 94 | save a new unstable state | |
| 95 | fi | |
| 96 | else | |
| 97 | save a new unstable state | |
| 98 | fi | |
| 99 | ||
| 100 | ||
| 101 | .SH "FILES" | |
| 102 | ||
| 103 | .PP | |
| 104 | \fI/etc/metche\&.conf\fR or \fI/etc/metche/*\&.conf\fR : configuration file(s) | |
| 105 | ||
| 106 | .PP | |
| 107 | \fI\fBCHANGELOG_DIR\fR/*/Changelog\fR (default : \fI/root/changelogs\fR), if Changelog monitoring is enabled : Changelog files location | |
| 108 | ||
| 109 | .PP | |
| 110 | \fI\fBBACKUP_DIR\fR\fR : directory containing the backups | |
| 111 | ||
| 112 | .SH "SECURITY" | |
| 113 | ||
| 114 | .PP | |
| 115 | metche is able to use GnuPG to encrypt the email it sends, but does not by default ; just enable the \fBENCRYPT_EMAIL\fR configuration option, and make sure \fBEMAIL_ADDRESS\fR' public key is in root's keyring, trusted enough to be used blindly by metche\&. | |
| 116 | ||
| 117 | .PP | |
| 118 | In its default setup (\fBENCRYPT_EMAIL\fR configuration option disabled) metche sends in \fIclear text email\fR the changes made to the watched directory\&.\&.\&. either make sure that the \fBTAR_OPTS\fR configuration variable prevents it to send sensitive information, or triple check that secure connections will be used end\-to\-end on the email path\&. If unsure, set \fBEMAIL_ADDRESS\fR configuration variable to a local mailbox\&. | |
| 119 | ||
| 120 | .PP | |
| 121 | metche stores, in \fBBACKUP_DIR\fR (default : \fI/var/lib/metche\fR), various backups of \fBWATCHED_DIR\fR\&. Make sure that this backup place is at least as secured as the source\&. | |
| 122 | ||
| 123 | .SH "BUGS" | |
| 124 | ||
| 125 | .PP | |
| 126 | See metche's ticket system: \fIhttps://poivron.org/dev/metche/\fR to see the bugs, missing features, and development road\-map\&. | |
| 127 | ||
| 128 | .SH "AUTHOR" | |
| 129 | ||
| 130 | .PP | |
| 131 | This manual page was written by Intri Geri <intrigeri@boum\&.org>\&. | |
| 132 |