From d2a2383c928aaa846127b61020e420744730dafe Mon Sep 17 00:00:00 2001 From: Jarrod Johnson Date: Fri, 16 Dec 2022 09:44:52 -0500 Subject: [PATCH] Add man page for confluent2hosts --- confluent_client/doc/man/confluent2hosts.ronn | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 confluent_client/doc/man/confluent2hosts.ronn diff --git a/confluent_client/doc/man/confluent2hosts.ronn b/confluent_client/doc/man/confluent2hosts.ronn new file mode 100644 index 00000000..8e0784e3 --- /dev/null +++ b/confluent_client/doc/man/confluent2hosts.ronn @@ -0,0 +1,28 @@ +confluent2hosts(8) -- Generate /etc/hosts entries for nodes +======================================================== + +## SYNOPSIS + +`confluent2hosts -i -n ` +`confluent2hosts -a ` + +## DESCRIPTION + +`confluent2hosts` can be used to help generate /etc/hosts entries for a +noderange. There are two general approaches. + +It can be used ad-hoc, using -i and -n to specificy the address and name portions respectively. This accepts the standard confluent expression syntax, allowing for things like 172.30.1.{n1} or {node}.{dns.domain} or {bmc}. + +It can also read from the confluent db, using `-a`. In this mode, each net.. group is pulled together into hosts lines. ipv4_address and ipv6_address fields are associated with the corresponding hostname attributes. + +## EXAMPLES + +* Generate /etc/hosts entries ad-hoc using default name + `# confluent2hosts -i 10.2.3.{n1} d9-d12` + +* Generate /etc/hosts entries ad-hoc using alternative name + `# confluent2hosts -i 10.2.3.{n1} -n "{node}-alt {node}-alt.{dns.domain}" d9-d12` + +* Generate /etc/hosts entries using the confluent DB as a reference + `# confluent2hosts -a d9-d12` +