Hey guys,
I'd heard that y'all needed some manpage love when it came to
func-build-map, so here ya go:
From 03b0aed99e45bf7066ab4342beafa21b343a4c86 Mon Sep 17 00:00:00 2001
From: Steve Salevan <ssalevan@xxxxxxxxxxxxxxxxxxxxxxxx>
Date: Tue, 3 Mar 2009 16:25:12 -0500
Subject: [PATCH] Adding manpage for func-build-map
---
docs/func-build-map.pod | 39 +++++++++++++++++++++++++++++++++++++++
1 files changed, 39 insertions(+), 0 deletions(-)
create mode 100644 docs/func-build-map.pod
diff --git a/docs/func-build-map.pod b/docs/func-build-map.pod
new file mode 100644
index 0000000..9556ab8
--- /dev/null
+++ b/docs/func-build-map.pod
@@ -0,0 +1,39 @@
+=head1 NAME
+
+func-build-map -- Builds/augments delegation map of all available minions
+
+=head1 SYNOPSIS
+
+func-build-map [--append] [--onlyalive] [--verbose]
+
+=head1 DESCRIPTION
+
+Func's delegation feature allows an overlord to execute commands
through proxies (minions which also run as overlords) to reduce XMLRPC
overhead and the amount of time required to execute commands over large
Func networks.
+
+To accomplish this task, Func needs to know where each proxy and minion
sits in the Func network, and for the sake of expediency, this data is
stored within a map file on the overlord.
+
+func-build-map, when run on an overlord, recursively probes through
one's Func network, discovering its topology. When complete, it stores
a mapfile, encoded in YAML, in /var/lib/func/map.
+
+If you utilize delegation frequently, we recommend running this tool as
a cron job to ensure that your mapfile remains up to date with changes
in your Func network topology.
+
+=head1 --append
+
+Combines new Func network topology data with data from the old map
file, performing a tree merge. If this merge fails, it replaces the old
mapfile with a fresh version.
+
+=head1 --onlyalive
+
+Pings all minions and proxies and returns a map containing those which
return those pings. Useful for Func network diagnostics and for those
who maintain networks where minions are frequently switched on and off.
+
+=head1 --verbose
+
+Gives additional information as to what func-build-map is doing
+
+=head1 ADDITIONAL RESOURCES
+
+See https://fedorahosted.org/func/ for more information.
+
+For feature-specific info, visit
https://fedorahosted.org/func/wiki/DelegationModule.
+
+=head1 AUTHOR
+
+Steve Salevan <ssalevan@xxxxxxxxxx>
--
1.5.5.1
>From 03b0aed99e45bf7066ab4342beafa21b343a4c86 Mon Sep 17 00:00:00 2001
From: Steve Salevan <ssalevan@xxxxxxxxxxxxxxxxxxxxxxxx>
Date: Tue, 3 Mar 2009 16:25:12 -0500
Subject: [PATCH] Adding manpage for func-build-map
---
docs/func-build-map.pod | 39 +++++++++++++++++++++++++++++++++++++++
1 files changed, 39 insertions(+), 0 deletions(-)
create mode 100644 docs/func-build-map.pod
diff --git a/docs/func-build-map.pod b/docs/func-build-map.pod
new file mode 100644
index 0000000..9556ab8
--- /dev/null
+++ b/docs/func-build-map.pod
@@ -0,0 +1,39 @@
+=head1 NAME
+
+func-build-map -- Builds/augments delegation map of all available minions
+
+=head1 SYNOPSIS
+
+func-build-map [--append] [--onlyalive] [--verbose]
+
+=head1 DESCRIPTION
+
+Func's delegation feature allows an overlord to execute commands through proxies (minions which also run as overlords) to reduce XMLRPC overhead and the amount of time required to execute commands over large Func networks.
+
+To accomplish this task, Func needs to know where each proxy and minion sits in the Func network, and for the sake of expediency, this data is stored within a map file on the overlord.
+
+func-build-map, when run on an overlord, recursively probes through one's Func network, discovering its topology. When complete, it stores a mapfile, encoded in YAML, in /var/lib/func/map.
+
+If you utilize delegation frequently, we recommend running this tool as a cron job to ensure that your mapfile remains up to date with changes in your Func network topology.
+
+=head1 --append
+
+Combines new Func network topology data with data from the old map file, performing a tree merge. If this merge fails, it replaces the old mapfile with a fresh version.
+
+=head1 --onlyalive
+
+Pings all minions and proxies and returns a map containing those which return those pings. Useful for Func network diagnostics and for those who maintain networks where minions are frequently switched on and off.
+
+=head1 --verbose
+
+Gives additional information as to what func-build-map is doing
+
+=head1 ADDITIONAL RESOURCES
+
+See https://fedorahosted.org/func/ for more information.
+
+For feature-specific info, visit https://fedorahosted.org/func/wiki/DelegationModule.
+
+=head1 AUTHOR
+
+Steve Salevan <ssalevan@xxxxxxxxxx>
--
1.5.5.1
_______________________________________________
Func-list mailing list
Func-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/func-list
