diff --git a/docs/source/QA/index.rst b/docs/source/QA/index.rst index 00069abdd..0fb22ad3b 100644 --- a/docs/source/QA/index.rst +++ b/docs/source/QA/index.rst @@ -1,7 +1,7 @@ -Q/A list -======== +Questions & Answers +=================== .. toctree:: :maxdepth: 2 - makehosts_qa.rst + makehosts.rst diff --git a/docs/source/QA/makehosts_qa.rst b/docs/source/QA/makehosts.rst similarity index 85% rename from docs/source/QA/makehosts_qa.rst rename to docs/source/QA/makehosts.rst index f0c425b87..ba9755033 100644 --- a/docs/source/QA/makehosts_qa.rst +++ b/docs/source/QA/makehosts.rst @@ -1,10 +1,10 @@ -DNS,hostname and alias Q/A list -------------------------------- +DNS, Hostname, Alias +==================== Q: When there are multiple NICs, how to generate ``/etc/hosts`` records? -```````````````````````````````````````````````````````````````````````` +------------------------------------------------------------------------ -When there are multiple NICs, and you want to use ``confignetwork`` to configure these NICs, suggest to use ``hosts`` table to configure installnic and use ``nics`` table to configure secondary NICs. You can refer to the following best practice example to generate ``/etc/hosts`` records. +When there are multiple NICs, and you want to use ``confignetwork`` to configure these NICs, suggest to use ``hosts`` table to configure the installation NIC (``installnic``) and to use ``nics`` table to configure secondary NICs. Refer to the following example to generate ``/etc/hosts`` records. **Best practice example**: @@ -12,7 +12,7 @@ When there are multiple NICs, and you want to use ``confignetwork`` to configure * ``mgtnetwork`` is xCAT management network * There are 2 adapters in system node1: ``eth0`` and ``eth1`` * Add installnic ``eth0`` ``10.5.106.101`` record in ``/etc/hosts``, its alias is ``mgtnic`` - * hostnames ``node1-pub`` and ``node1.public.com`` are for nic ``eth1``, ip is ``192.168.30.101`` + * hostnames ``node1-pub`` and ``node1.public.com`` are for nic ``eth1``, IP is ``192.168.30.101`` **Steps**: @@ -21,7 +21,7 @@ When there are multiple NICs, and you want to use ``confignetwork`` to configure chdef -t network mgtnetwork net=10.0.0.0 mask=255.0.0.0 domain=cluster.com chdef -t network pubnetwork net=192.168.30.0 mask=255.255.255.0 domain=public.com - #. Create ``node1`` with installnic ip ``10.5.106.101``, its alias is ``mgtnic``: :: + #. Create ``node1`` with installnic IP ``10.5.106.101``, its alias is ``mgtnic``: :: chdef node1 ip=10.5.106.101 hostnames=mgtnic groups=all @@ -53,21 +53,22 @@ When there are multiple NICs, and you want to use ``confignetwork`` to configure 10.5.106.101 node1 node1.cluster.com mgtnic 192.168.30.101 node1-pub node1.public.com - #. Edit ``/etc/resolv.conf``, xCAT management node ip like ``10.5.106.2`` is nameserver: :: + #. Edit ``/etc/resolv.conf``, xCAT management node IP like ``10.5.106.2`` is nameserver: :: search cluster.com public.com nameserver 10.5.106.2 #. Execute ``makedns -n`` to configure DNS + Q: How to configure aliases? -```````````````````````````` +---------------------------- There are 3 methods to configure aliases: #. Use ``hostnames`` in ``hosts`` table to configure aliases for the installnic. -#. If you want to use script ``confignetwork`` to configure secondary NICs, suggest to use ``aliases`` in ``nics`` table to configure aliases, you can refer to :doc:`Configure Aliases <../guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_aliases>` -#. If you want to generate aliases records in ``/etc/hosts`` for secondary NICs, and don't want to use script ``confignetwork`` to configure these NICs, suggest to use ``otherinterfaces`` in ``hosts`` table to configure aliases. You can refer to following example: +#. If you want to use script ``confignetwork`` to configure secondary NICs, suggest to use ``aliases`` in ``nics`` table to configure aliases. Refer to :doc:`Configure Aliases <../guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_aliases>` +#. If you want to generate aliases records in ``/etc/hosts`` for secondary NICs and you don't want to use the script ``confignetwork`` to configure these NICs, suggest to use ``otherinterfaces`` in ``hosts`` table to configure aliases. Refer to following example: * If you want to add ``node1-hd`` ``20.1.1.1`` in ``hosts`` table, and don't use ``confignetwork`` to configure it, you can add ``otherinterfaces`` like this: :: @@ -80,7 +81,7 @@ There are 3 methods to configure aliases: **Note**: If suffixes or aliases for the same IP are configured in both ``hosts`` table and ``nics`` table, will cause conflicts. ``makehosts`` will use values from ``nics`` table. The values from ``nics`` table will over-write that from ``hosts`` table to create ``/etc/hosts`` records. Q: How to handle the same short hostname in different domains? -`````````````````````````````````````````````````````````````` +-------------------------------------------------------------- You can follow the best practice example. @@ -127,6 +128,6 @@ You can follow the best practice example. #. Execute ``makedns -n`` to configure DNS Q: When to use ``hosts`` table and ``nics`` table? -`````````````````````````````````````````````````` +-------------------------------------------------- ``hosts`` table is used to store IP addresses and hostnames of nodes. ``makehosts`` use these data to create ``/etc/hosts`` records. ``nics`` table is used to stores secondary NICs details. Some scripts like ``confignetwork`` use data from ``nics`` table to configure secondary NICs. ``makehosts`` also use these data to create ``/etc/hosts`` records for each NIC.