fixing some typos / removing comments
[certmaster.git] / docs / certmaster-sync.pod
1 =head1 NAME
2
3 certmaster-sync -- synchronize client certificates with Func.
4
5 =head1 SYNOPSIS
6
7 certmaster-sync [-f|--force]
8
9 =head1 DESCRIPTION
10
11 certmaster-sync synchronizes client certificates amongst certmaster clients via Func. It is assumed that the hosts who have requested certificates are reachable via Func for synchronization operations.
12
13 certmaster-sync by default is called as a post-sign and post-clean trigger. In order to enable synchronization you must set B<sync_certs> to B<True>, see B<CONFIGURATION VALUES> below.
14
15 The synchronization occurs by querying remote Func methods in B<certmastermod> on the minion hosts. This will gather information, copy any new certificates, and remove any certificates that have been cleaned.
16
17 =head1 OPTIONS
18
19 =over
20
21 =item -f, --force
22
23 Override the configuration value for B<sync_certs> in F</etc/certmaster/certmaster.conf>
24
25 =back
26
27 =head1 CONFIGURATION VALUES
28
29 =over
30
31 =item sync_certs
32
33 B<sync_certs> determines whether or not the script will actually synchronize or if it will exit with no operation. You can use -f|--force to override this configuration value. (Default: False)
34
35 =back
36
37 =head1 ADDITONAL RESOURCES
38
39 See https://fedorahosted.org/certmaster. It's a Wiki.
40 See also https://fedorahosted.org/func
41
42 =head1 AUTHOR
43
44 John Eckersberg <jeckersb@redhat.com>