~ov+gtm-integration/openvista-gtm-integration/mainline

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
.TH ovbackup 1 "06 Mar 2012" Linux "User Manuals"
.SH NAME
ovbackup \- back up routines and globals of an OpenVista instance
.SH SYNOPSIS
.B ovbackup
.RB [ -c
.IR compression_type ]
[\fB-f\fR] [\fB-q\fR] [\fB-o\fR]
.RB [ -t
.IR tempdir_location ]
.I instance_name
.br
.B ovbackup -h
.br
.B ovbackup -V
.SH DESCRIPTION
Each invocation of
.B ovbackup
creates a consistent snapshot of the routines and globals of an OpenVista
instance.  The 
.I mumps.gld 
global directory file in the 
.I globals 
directory of the instance is also included in the backup, as is the 
.I env 
file in the 
.I etc
directory of the instance, if it exists.  If any of these files or directories
are symlinks, the symlink targets are backed up instead of the symlinks
themselves.  Backups are compressed with tar/bzip2 and stored in the 
.I backups
directory of an OpenVista instance.  The md5 checksum of the compressed backup
file is computed and stored in a separate file.
.PP
After a successful backup, backups beyond the configured number of backups to
keep are purged.  The number of backups to keep can be configured on a
per-instance basis in the 
.I etc/backups.conf
file in the instance's root directory.
.PP
By default, the
.I /etc/cron.daily/openvista
cron job runs
.B ovbackup
on each OpenVista instance once each day.  An OpenVista instance can "opt-out"
by setting backup_daily to "no" in the 
.I etc/backups.conf
file in the instance's root directory.  Backups can be set to run on a custom
schedule by adding an entry to the 
.I /etc/cron.d/openvista
file.
.PP
Root privileges are not required to run
.B ovbackup
\- anyone who can access GT.M and the OpenVista instance can request a backup.
.PP
Depending on the size of the database being backed up and the speed of the
hardware,
.B ovbackup
may take several hours to complete.  By default, dated status messages are
printed to stderr.  To suppress this behavior, use the 
.B -q
flag.  All backup operations are also logged to syslog.
.SH OPTIONS
.TP
.B -h
display help text and exit
.TP
.B -V
display version information and exit
.TP
.BI "-c " compression_type
choose auto (the default), bzip2, pbzip2, or none.  The 'auto' option will use pbzip2 if available, otherwise bzip2, and this is the default behavior if the -c option is not used.  The difference between bzip2 and pbzip2 is that pbzip2 will utilize all available processors on a multiple-processor system when compressing the archive.  Since this processing is done with a 'nice' level of 10, it will only use spare processing capacity that is not being used by other ordinary processes.  Still, specifying bzip2 limits the compression process to one processor.  If 'none' is specified, the backup archive will be an uncompressed tar file, which is not recommended except for special uses.
.TP
.B -f
fast integ; use the fast option (indexes only) for the integrity check
.TP
.B -q
quiet; suppress status messages
.TP
.B -o
output the backup filename
.TP
.BI "-t " tempdir_location
temporary directory location; an existing directory in which the temporary
directory will be made.  The default, if this option is not specified, is to
make the temporary directory within the backups subdirectory of the instance.
.SH FILES
.I /opt/openvista/INSTANCE_NAME/etc/backups.conf
.RS
Specifies how many backups to keep in the 
.I backups
directory.
.SH "EXIT VALUES"
.IP 0
Success
.IP 1
Unspecified error
.IP 2
Invalid or excess argument(s)
.IP 4
User had insufficient privilege
.SH "REPORTING BUGS"
Please report any bugs you encounter at
.PP
https://bugs.launchpad.net/openvista-gtm-integration
.SH AUTHORS
Jonathan Tai (original)
.br
Derek Veit <derek.veit@medsphere.com>
.SH "SEE ALSO"
.BR ovpurgejournals (1)
.BR ovrestore (8)