From 9c72e470ff5c04fa208b9904eb78071dc1235495 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 5 Feb 2016 11:12:36 -0500 Subject: [PATCH] Add in information about the management node configuration during the install of the management node so that there is no need to repeat the same information in the admin guide later on in the documentation. --- .../install-guides/apt/prepare_mgmt_node.rst | 28 +++++++++++------ .../guides/install-guides/common_sections.rst | 11 ++----- .../install-guides/yum/prepare_mgmt_node.rst | 31 ++++++++++++++----- .../zypper/prepare_mgmt_node.rst | 23 +++++++++++--- 4 files changed, 63 insertions(+), 30 deletions(-) diff --git a/docs/source/guides/install-guides/apt/prepare_mgmt_node.rst b/docs/source/guides/install-guides/apt/prepare_mgmt_node.rst index f0ca608fb..f67fefc32 100644 --- a/docs/source/guides/install-guides/apt/prepare_mgmt_node.rst +++ b/docs/source/guides/install-guides/apt/prepare_mgmt_node.rst @@ -33,16 +33,24 @@ xCAT uses the apt package manager on Ubuntu Linux distributions to install and r gpgcheck=1 -Set up Network --------------- +Configure the Management Node +----------------------------- -The Management Node IP address should be set to a **static** IP address. +By setting properties on the Management Node before installing the xCAT software will allow xCAT to automatically configure key attributes in the xCAT ``site`` table during the install. -Modify the ``interfaces`` file in ``/etc/network`` and configure a static IP address. :: - - # The primary network interface - auto eth0 - iface eth0 inet static - address 10.3.31.11 - netmask 255.0.0.0 +#. Ensure a hostname is configured on the management node by issuing the ``hostname`` command. [*It's recommended to use a fully qualified domain name (FQDN) when setting the hostname*] + #. To set the hostname of *xcatmn.cluster.com*: :: + + hostname xcatmn.cluster.com + + #. Add the hostname to the ``/etc/hostname`` and ``/etc/hosts`` to persist the hostname on reboot. + + #. Reboot or run ``service hostname restart`` to allow the hostname to take effect and verify the hostname command returns correctly: + + * ``hostname`` + * ``hostname -d`` - should display the domain + +#. Reduce the risk of the Management Node IP address being lost by setting the interface IP to **STATIC** in the ``/etc/network/interfaces`` configuration file. + +#. Configure any domain search strings and nameservers using the ``resolvconf`` command. diff --git a/docs/source/guides/install-guides/common_sections.rst b/docs/source/guides/install-guides/common_sections.rst index be5e43d22..b4646a0cb 100644 --- a/docs/source/guides/install-guides/common_sections.rst +++ b/docs/source/guides/install-guides/common_sections.rst @@ -3,6 +3,9 @@ For the current list of operating systems supported and verified by the development team for the different releases of xCAT, see the :doc:`xCAT2 Release Notes `. +**Disclaimer** These instructions are intended to only be guidelines and specific details may differ slightly based on the operating system version. Always refer to the operating system documentation for the latest recommended procedures. + + .. END_see_release_notes .. BEGIN_install_os_mgmt_node @@ -26,14 +29,6 @@ The system requirements for your xCAT management node largely depend on the size .. END_install_os_mgmt_node -.. BEGIN_setup_mgmt_node_network - -The Management Node IP address should be set to a **static** IP address. - -Modify the ``ifcfg-`` file in ``/etc/sysconfig/network-scripts`` and configure a static IP address. - -.. END_setup_mgmt_node_network - .. BEGIN_install_xcat_introduction xCAT consists of two software packages: ``xcat-core`` and ``xcat-dep`` diff --git a/docs/source/guides/install-guides/yum/prepare_mgmt_node.rst b/docs/source/guides/install-guides/yum/prepare_mgmt_node.rst index d02ec031e..7dbc7d0d7 100644 --- a/docs/source/guides/install-guides/yum/prepare_mgmt_node.rst +++ b/docs/source/guides/install-guides/yum/prepare_mgmt_node.rst @@ -15,9 +15,8 @@ Configure the Base OS Repository xCAT uses the yum package manager on RHEL Linux distributions to install and resolve dependency packages provided by the base operating system. Follow this section to create the repository for the base operating system on the Management Node -#. Copy the DVD iso file to ``/tmp`` on the Management Node: :: - - # This example will use RHEL-LE-7.1-20150219.1-Server-ppc64le-dvd1.iso +#. Copy the DVD iso file to ``/tmp`` on the Management Node. + This example will use file ``RHEL-LE-7.1-20150219.1-Server-ppc64le-dvd1.iso`` #. Mount the iso to ``/mnt/iso/rhels7.1`` on the Management Node. :: @@ -33,10 +32,26 @@ xCAT uses the yum package manager on RHEL Linux distributions to install and res gpgcheck=1 -Set up Network --------------- +Configure the Management Node +----------------------------- -.. include:: ../common_sections.rst - :start-after: BEGIN_setup_mgmt_node_network - :end-before: END_setup_mgmt_node_network +By setting properties on the Management Node before installing the xCAT software will allow xCAT to automatically configure key attributes in the xCAT ``site`` table during the install. + +#. Ensure a hostname is configured on the management node by issuing the ``hostname`` command. [*It's recommended to use a fully qualified domain name (FQDN) when setting the hostname*] + + #. To set the hostname of *xcatmn.cluster.com*: :: + + hostname xcatmn.cluster.com + + #. Add the hostname to the ``/etc/sysconfig/network`` in order to persist the hostname on reboot. + + + #. Reboot the server and verify the hostname by running the following commands: + + * ``hostname`` + * ``hostname -d`` - should display the domain + +#. Reduce the risk of the Management Node IP address being lost by setting the IP to **STATIC** in the ``/etc/sysconfig/network-scripts/ifcfg-`` configuration files. + +#. Configure any domain search strings and nameservers to the ``/etc/resolv.conf`` file. diff --git a/docs/source/guides/install-guides/zypper/prepare_mgmt_node.rst b/docs/source/guides/install-guides/zypper/prepare_mgmt_node.rst index a795339b4..fce8dc660 100644 --- a/docs/source/guides/install-guides/zypper/prepare_mgmt_node.rst +++ b/docs/source/guides/install-guides/zypper/prepare_mgmt_node.rst @@ -33,10 +33,25 @@ xCAT uses the zypper package manager on SLES Linux distributions to install and gpgcheck=1 -Set up Network --------------- +Configure the Management Node +----------------------------- -The Management Node IP address should be set to a **static** IP address. +By setting properties on the Management Node before installing the xCAT software will allow xCAT to automatically configure key attributes in the xCAT ``site`` table during the install. -Modify the ``ifcfg-`` file in ``/etc/sysconfig/network/`` and configure a static IP address. +#. Ensure a hostname is configured on the management node by issuing the ``hostname`` command. [*It's recommended to use a fully qualified domain name (FQDN) when setting the hostname*] + #. To set the hostname of *xcatmn.cluster.com*: :: + + hostname xcatmn.cluster.com + + #. Add the hostname to the ``/etc/hostname`` in order to persist the hostname on reboot. + + + #. Reboot the server and verify the hostname by running the following commands: + + * ``hostname`` + * ``hostname -d`` - should display the domain + +#. Reduce the risk of the Management Node IP address being lost by setting the IP to **STATIC** in the ``/etc/sysconfig/network/ifcfg-`` configuration files. + +#. Configure any domain search strings and nameservers to the ``/etc/resolv.conf`` file.