summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMichael DeHaan <mdehaan@mdehaan.rdu.redhat.com>2007-09-27 18:37:08 -0400
committerMichael DeHaan <mdehaan@mdehaan.rdu.redhat.com>2007-09-27 18:37:08 -0400
commitf45db33f393ba171fa8fe8b53a348e25d14b5e6c (patch)
treeba80ea605593559358f01b83799a3cae9099d049 /docs
parent7fe6283c49670bc7f4e99afaec03d759e5fedca1 (diff)
downloadthird_party-func-f45db33f393ba171fa8fe8b53a348e25d14b5e6c.zip
third_party-func-f45db33f393ba171fa8fe8b53a348e25d14b5e6c.tar.gz
third_party-func-f45db33f393ba171fa8fe8b53a348e25d14b5e6c.tar.xz
Updated wiki pages to mention one another, plus some miscellaneous cleanup and elaboration.
Most of the content still lives on the Wiki as we expect it will change rather rapidly for a while.
Diffstat (limited to 'docs')
-rw-r--r--docs/certmaster-ca.pod17
-rw-r--r--docs/certmaster.pod2
-rw-r--r--docs/func.pod26
-rw-r--r--docs/funcd.pod6
4 files changed, 41 insertions, 10 deletions
diff --git a/docs/certmaster-ca.pod b/docs/certmaster-ca.pod
index c818ef0..5251fd2 100644
--- a/docs/certmaster-ca.pod
+++ b/docs/certmaster-ca.pod
@@ -1,6 +1,6 @@
=head1 NAME
-certmaster-ca -- signs certificates and makes them available to remote processes.
+certmaster-ca -- signs certificate requests gathered by certmaster.
=head1 SYNOPSIS
@@ -12,19 +12,28 @@ certmaster-ca --sign machine.example.org
"certmaster-ca --list"
-The list command prints all certificates that have been requested but not yet signed.
+The list command prints all certificates that have been requested from certmaster by a remote
+service (such as funcd) but are not yet signed.
+
func commands can't be sent to a remote machine until the certificates have been signed.
-If manual signing is not desirable, edit /etc/func/certmaster.conf to enable auto-signing.
"certmaster-ca --sign [hostname]"
This command is used to sign a certificate and send it back to the requester.
-Neither this command, nor list, is needed when autosigning is enabled.
+
+=head1 AUTO-SIGNING
+
+The certmaster can be configured to make this command unneccessary; all incoming
+requests can be signed automatically by certmaster.
+
+To configure this, edit /etc/func/certmaster.conf.
=head1 ADDITONAL RESOURCES
See https://hosted.fedoraproject.org/projects/func/. It's a Wiki.
+See also the manpages for "func", "funcd", and "certmaster".
+
=head1 AUTHOR
Various. See https://hosted.fedoraproject.org/projects/func
diff --git a/docs/certmaster.pod b/docs/certmaster.pod
index 7c6df0b..ce25a52 100644
--- a/docs/certmaster.pod
+++ b/docs/certmaster.pod
@@ -20,6 +20,8 @@ Certmaster is configured by /etc/func/certmaster.conf
See https://hosted.fedoraproject.org/projects/func/. It's a Wiki.
+See also the manpages for "func", "funcd", "certmaster-ca".
+
=head1 AUTHOR
Various. See https://hosted.fedoraproject.org/projects/func
diff --git a/docs/func.pod b/docs/func.pod
index 50e4221..b73bcf9 100644
--- a/docs/func.pod
+++ b/docs/func.pod
@@ -10,21 +10,39 @@ func "webserver1;mailserver2" module command [args ...] [--verbose]
=head1 DESCRIPTION
-Func allows remote control of machines running funcd that are set
-to obey this machine.
+"func" allows remote control of machines running funcd (called "minions")
+that are set to obey this machine (called the "overlord"). This includes
+performing various remote operations and gathering data.
-Func can address multiple machines at the same time by specifying
+"func" can address multiple machines at the same time by specifying
their names with globs, which follow shell glob syntax.
+See the project homepage (below) for a list of modules available
+and a more in-depth description of what each of them do.
+
+=head1 LISTING REMOTE MODULES AVAILABLE
+
+func target.example.org system list_modules
+
+=head1 LISTING REMOTE FUNCTIONS AVAILABLE IN A MODULE
+
+func target.example.org modulename list_methods
+
+=head1 CALLING A REMOTE COMMAND
+
+func target.example.org modulename methodname
+
=head1 EXIT_STATUS
Func commands have return values that vary based on the module being
-called.
+called. See the project page (linked below) for more information.
=head1 ADDITONAL RESOURCES
See https://hosted.fedoraproject.org/projects/func/ for more information, including information on scripting func from Python.
+See also the manpages for "funcd", "certmaster", and "certmaster-ca".
+
=head1 AUTHOR
Various. See https://hosted.fedoraproject.org/projects/func
diff --git a/docs/funcd.pod b/docs/funcd.pod
index d4bdc44..da4ec75 100644
--- a/docs/funcd.pod
+++ b/docs/funcd.pod
@@ -8,14 +8,16 @@ funcd (it's a daemon and takes no arguments)
=head1 DESCRIPTION
-funcd registers itself to a server listed in /etc/func/minion.conf and takes orders from it. See /etc/func/minion.conf for other configuration options.
+funcd registers itself to a certificate server (certmaster) listed in /etc/func/minion.conf and takes orders from the command line func when that program is run from that certificate server. See /etc/func/minion.conf for other configuration options.
-Modules and capabilities are specified at https://hosted.fedoraproject.org/projects/func/
+Modules and capabilities provided by funcd are specified at https://hosted.fedoraproject.org/projects/func/
=head1 ADDITONAL RESOURCES
See https://hosted.fedoraproject.org/projects/func/. It's a Wiki.
+See also the manpages for "func", "certmaster", and "certmaster-ca".
+
=head1 AUTHOR
Various. See https://hosted.fedoraproject.org/projects/func