From 67650af830e6fe43e4e3c0dddf16b467155fdfec Mon Sep 17 00:00:00 2001 From: Mark Gurevich Date: Thu, 21 Jan 2021 16:42:08 -0500 Subject: [PATCH] Fix link and formatting for makedns man page --- .../admin-guides/references/man8/makedns.8.rst | 15 +++++++-------- xCAT-client/pods/man8/makedns.8.pod | 15 +++++++-------- 2 files changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man8/makedns.8.rst b/docs/source/guides/admin-guides/references/man8/makedns.8.rst index a97c1401a..37e266219 100644 --- a/docs/source/guides/admin-guides/references/man8/makedns.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makedns.8.rst @@ -33,7 +33,7 @@ DESCRIPTION \ **makedns**\ configures a DNS server on the system you run it on, which is typically the xCAT management node. -The list of nodes to include comes from either the \ **noderange**\ provided on the command line or the entries in the local /etc/hosts files. +The list of nodes to include comes from either the \ **noderange**\ provided on the command line or the entries in the local \ */etc/hosts*\ files. There are several bits of information that must be included in the xCAT database before running this command. @@ -45,12 +45,11 @@ An xCAT \ **network**\ definition must be defined for each network used in the A network \ **domain**\ and \ **nameservers**\ values must be provided either in the \ **network**\ definition corresponding to the node or in the \ **site**\ definition. -Only entries in /etc/hosts or the hosts specified by \ **noderange**\ that have a corresponding xCAT network definition will be added to DNS. +Only entries in \ */etc/hosts*\ or the hosts specified by \ **noderange**\ that have a corresponding xCAT network definition will be added to DNS. -By default, \ **makedns**\ sets up the \ **named**\ service and updates the DNS records on the local system (management node). If the -e flag is specified, it will also update the DNS records on any external DNS server that is listed in the /etc/resolv.conf on the management node. (Assuming the external DNS server can recognize the xCAT key as authentication.) +By default, \ **makedns**\ sets up the \ **named**\ service and updates the DNS records on the local system (management node). If the \ **-e**\ flag is specified, it will also update the DNS records on any external DNS server that is listed in the \ */etc/resolv.conf*\ on the management node. (Assuming the external DNS server can recognize the xCAT key as authentication.) -For more information on Cluster Name Resolution: -Cluster_Name_Resolution +For more information on Cluster Name Resolution see https://xcat-docs.readthedocs.io/en/stable/advanced/domain_name_resolution/domain_name_resolution.html ******* @@ -79,13 +78,13 @@ OPTIONS \ **-e | -**\ **-external**\ - Update DNS records to the external DNS server listed in /etc/resolv.conf. + Update DNS records to the external DNS server listed in \ */etc/resolv.conf*\ . - Enabling the site attribute \ *externaldns*\ means use 'external' DNS by default. If setting \ *externaldns*\ to 1, you need NOT use \ **-e**\ flag in every makedns call. + Enabling the site attribute \ *externaldns*\ means use 'external' DNS by default. If setting \ *externaldns*\ to 1, you need NOT use \ **-e**\ flag in every \ **makedns**\ call. -\ **noderange**\ +\ *noderange*\ A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats. diff --git a/xCAT-client/pods/man8/makedns.8.pod b/xCAT-client/pods/man8/makedns.8.pod index 047adc2fe..b6a46014e 100644 --- a/xCAT-client/pods/man8/makedns.8.pod +++ b/xCAT-client/pods/man8/makedns.8.pod @@ -14,7 +14,7 @@ B [B<-V>|B<--verbose>] [B<-e>|B<--external>] [B<-d>|B<--delete> I configures a DNS server on the system you run it on, which is typically the xCAT management node. -The list of nodes to include comes from either the B provided on the command line or the entries in the local /etc/hosts files. +The list of nodes to include comes from either the B provided on the command line or the entries in the local I files. There are several bits of information that must be included in the xCAT database before running this command. @@ -26,12 +26,11 @@ An xCAT B definition must be defined for each network used in the clust A network B and B values must be provided either in the B definition corresponding to the node or in the B definition. -Only entries in /etc/hosts or the hosts specified by B that have a corresponding xCAT network definition will be added to DNS. +Only entries in I or the hosts specified by B that have a corresponding xCAT network definition will be added to DNS. -By default, B sets up the B service and updates the DNS records on the local system (management node). If the -e flag is specified, it will also update the DNS records on any external DNS server that is listed in the /etc/resolv.conf on the management node. (Assuming the external DNS server can recognize the xCAT key as authentication.) +By default, B sets up the B service and updates the DNS records on the local system (management node). If the B<-e> flag is specified, it will also update the DNS records on any external DNS server that is listed in the I on the management node. (Assuming the external DNS server can recognize the xCAT key as authentication.) -For more information on Cluster Name Resolution: -Cluster_Name_Resolution +For more information on Cluster Name Resolution see https://xcat-docs.readthedocs.io/en/stable/advanced/domain_name_resolution/domain_name_resolution.html =head1 OPTIONS @@ -51,11 +50,11 @@ Remove the DNS records. =item B<-e>|B<--external> -Update DNS records to the external DNS server listed in /etc/resolv.conf. +Update DNS records to the external DNS server listed in I. -Enabling the site attribute I means use 'external' DNS by default. If setting I to 1, you need NOT use B<-e> flag in every makedns call. +Enabling the site attribute I means use 'external' DNS by default. If setting I to 1, you need NOT use B<-e> flag in every B call. -=item B +=item I A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats.