diff --git a/docs/source/advanced/hamn/setup_xcat_high_available_management_node_in_softlayer.rst b/docs/source/advanced/hamn/setup_xcat_high_available_management_node_in_softlayer.rst index 995cbcf43..d8c41342d 100644 --- a/docs/source/advanced/hamn/setup_xcat_high_available_management_node_in_softlayer.rst +++ b/docs/source/advanced/hamn/setup_xcat_high_available_management_node_in_softlayer.rst @@ -165,7 +165,7 @@ Execute steps on xCAT MN rhmn1 "4.8",,,"litetree",,,,"allow",, "6","hpcpeadmin",,,,,,"allow",, -#. Make sure xCAT commands are in the user's path :: +#. Make sure xCAT commands are in the users path :: # su - hpcpeadmin $ echo $PATH | grep xcat diff --git a/docs/source/advanced/webservices/set_up_ws.rst b/docs/source/advanced/webservices/set_up_ws.rst index 40c11ce16..663bad13a 100644 --- a/docs/source/advanced/webservices/set_up_ws.rst +++ b/docs/source/advanced/webservices/set_up_ws.rst @@ -122,7 +122,7 @@ Create new user and setup the password and policy rules. :: Note: in the tabch command above you can put the salted password (from /etc/shadow) in the xCAT passwd table instead of the clear text password, if you prefer. -Create the SSL certificate under that user's home directory so that user can be authenticated to xCAT. This is done by running the following command on the Management node as root: :: +Create the SSL certificate under that users home directory so that user can be authenticated to xCAT. This is done by running the following command on the Management node as root: :: /opt/xcat/share/xcat/scripts/setup-local-client.sh diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst index ca1b80f7f..c005d5a2f 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst @@ -33,7 +33,7 @@ Below is an example of osimage definitions created by ``copycds``: :: In these osimage definitions shown above -* **--install-compute** is the default osimage definition used for diskfull installation +* **--install-compute** is the default osimage definition used for diskful installation * **--netboot-compute** is the default osimage definition used for diskless installation * **--install-service** is the default osimage definition used for service node deployment which shall be used in hierarchical environment diff --git a/docs/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst b/docs/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst index dff4eacd5..166bba9fc 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst @@ -1,9 +1,22 @@ Parallel Commands ================= -xCAT delivers a set of commands that can be run remote commands (ssh,scp,rsh,rcp,rsync,ping,cons) in parallel on multiple nodes. In addition the command have the capability of formatting the output from the commands, so the results are easier to process. These commands will make it much easier to administer your large cluster. +xCAT provides a set of commands that can run common remote commands (``ssh, scp, rsh, rcp, rsync, ping, cons``) in parallel on xCAT managed nodes. The xCAT commands will format the output making the results easier to parse and help administrators manage large clusters. + +The following commands are provided: + + * ``pcons`` - runs a command on the noderange using the out-of-band console + * ``pping`` - parallel ping + * ``ppping`` - parallel ping between nodes in a cluster + * ``prsync`` - parallel rsync + * ``pscp`` - parallel remote copy ( supports scp and not hierarchy) + * ``psh`` - parallel remote shell ( supports ssh and not hierarchy) + * ``pasu`` - parallel ASU utility + * ``xdcp`` - concurrently copies files too and from multiple nodes. ( scp/rcp and hierarchy) + * ``xdsh`` - concurrently runs commands on multiple nodes. ( supports ssh/rsh and hierarchy) + * ``xdshbak`` - formats the output of the xdsh command + * ``xcoll`` - Formats command output of the psh, xdsh, rinv command -For a list of the Parallel Commands and their man pages doc `parallel commands`_. Examples for xdsh ----------------- diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst deleted file mode 100644 index d786c1d07..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -Hardware Management -=================== - -.. toctree:: - :maxdepth: 2 - - rpower.rst - rspconfig.rst - reventlog.rst - rbeacon.rst - rcons.rst - rinv.rst - rvitals.rst - rflash.rst - renergy.rst - diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst deleted file mode 100644 index 77f805231..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../common/management/rbeacon.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst deleted file mode 100644 index e031077b4..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../common/management/rcons.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst deleted file mode 100644 index afa4dd21e..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../common/management/renergy.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst deleted file mode 100644 index d6054710a..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../common/management/reventlog.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst deleted file mode 100644 index 93c688150..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../common/management/rflash.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst deleted file mode 100644 index 3392765a8..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../common/management/rinv.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst deleted file mode 100644 index 2ecf9f22a..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../common/management/rpower.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst deleted file mode 100644 index 88f19f51b..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../common/management/rspconfig.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst deleted file mode 100644 index 87880aa2e..000000000 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../common/management/rvitals.rst diff --git a/docs/source/guides/install-guides/apt/configure_xcat.rst b/docs/source/guides/install-guides/apt/configure_xcat.rst new file mode 100644 index 000000000..435b57ba9 --- /dev/null +++ b/docs/source/guides/install-guides/apt/configure_xcat.rst @@ -0,0 +1,38 @@ +Configure xCAT Software Repository +================================== + +xCAT software and repo files can be obtained from: ``_ + +Internet Repository +------------------- + +**[xcat-core]** + +From the xCAT download page, find the build you want to install and add to ``/etc/apt/sources.list``. + +To configure the xCAT development build, add the following line to ``/etc/apt/sources.list``: :: + + deb http://xcat.org/files/xcat/repos/apt/devel/core-snap trusty main + + +**[xcat-dep]** + +To configure the xCAT deps online repository, add the following line to ``/etc/apt/sources.list``: :: + + deb http://xcat.org/files/xcat/repos/apt/xcat-dep trusty main + + +If using internet repositories, continue to the next step to install xCAT. + +Local Repository +---------------- + +.. xcat-core +.. include:: ../common_sections.rst + :start-after: BEGIN_configure_xcat_local_repo_xcat-core_DEBIAN + :end-before: END_configure_xcat_local_repo_xcat-core_DEBIAN + +.. xcat-dep +.. include:: ../common_sections.rst + :start-after: BEGIN_configure_xcat_local_repo_xcat-dep_DEBIAN + :end-before: END_configure_xcat_local_repo_xcat-dep_DEBIAN diff --git a/docs/source/guides/install-guides/apt/index.rst b/docs/source/guides/install-guides/apt/index.rst index ede05d007..1f2014b7b 100644 --- a/docs/source/guides/install-guides/apt/index.rst +++ b/docs/source/guides/install-guides/apt/index.rst @@ -7,3 +7,4 @@ For the list of currently supported Ubuntu LTS operatin systems, see :ref:`ubunt :maxdepth: 2 prepare_mgmt_node.rst + install.rst diff --git a/docs/source/guides/install-guides/apt/install.rst b/docs/source/guides/install-guides/apt/install.rst new file mode 100644 index 000000000..06a597a7e --- /dev/null +++ b/docs/source/guides/install-guides/apt/install.rst @@ -0,0 +1,16 @@ +Installing xCAT +=============== + +.. include:: ../common_sections.rst + :start-after: BEGIN_install_xcat_introduction + :end-before: END_install_xcat_introduction + +xCAT is installed by configuring software repositories for ``xcat-core`` and ``xcat-dep`` and using apt-get package manager. The repositories can be publically hosted or locally hosted. + +.. toctree:: + :maxdepth: 2 + + configure_xcat.rst + install_xcat.rst + verify_xcat.rst + update_xcat.rst diff --git a/docs/source/guides/install-guides/apt/install_xcat.rst b/docs/source/guides/install-guides/apt/install_xcat.rst new file mode 100644 index 000000000..ab6ab5741 --- /dev/null +++ b/docs/source/guides/install-guides/apt/install_xcat.rst @@ -0,0 +1,7 @@ +Install xCAT +------------ + +.. include:: ../common_sections.rst + :start-after: BEGIN_installing_xcat + :end-before: END_installing_xcat + 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 c5211a093..3b7ca7c9e 100644 --- a/docs/source/guides/install-guides/apt/prepare_mgmt_node.rst +++ b/docs/source/guides/install-guides/apt/prepare_mgmt_node.rst @@ -8,9 +8,9 @@ Install an OS on the Management Node Install one of the supported operating systems :ref:`ubuntu-os-support-label` on to your target management node - .. include:: ../common/install_guide.rst - :start-after: BEGIN_install_os_mgmt_node - :end-before: END_install_os_mgmt_node +.. include:: ../common_sections.rst + :start-after: BEGIN_install_os_mgmt_node + :end-before: END_install_os_mgmt_node Configure the Base OS Repository -------------------------------- @@ -20,7 +20,6 @@ Configure the Base OS Repository Set up Network -------------- -The management node IP address should be set to a **static** ip address. - -Modify the ``ifcfg-`` file under ``/etc/sysconfig/network-scripts`` and configure a static IP address. - +.. include:: ../common_sections.rst + :start-after: BEGIN_setup_mgmt_node_network + :end-before: END_setup_mgmt_node_network diff --git a/docs/source/guides/install-guides/apt/update_xcat.rst b/docs/source/guides/install-guides/apt/update_xcat.rst new file mode 100644 index 000000000..60c184b6a --- /dev/null +++ b/docs/source/guides/install-guides/apt/update_xcat.rst @@ -0,0 +1,6 @@ +Updating xCAT +============= + +.. include:: ../common_sections.rst + :start-after: BEGIN_update_xcat + :end-before: END_update_xcat diff --git a/docs/source/guides/install-guides/apt/verify_xcat.rst b/docs/source/guides/install-guides/apt/verify_xcat.rst new file mode 100644 index 000000000..d2d09c535 --- /dev/null +++ b/docs/source/guides/install-guides/apt/verify_xcat.rst @@ -0,0 +1,6 @@ +Verify xCAT Installation +======================== + +.. include:: ../common_sections.rst + :start-after: BEGIN_verifying_xcat + :end-before: END_verifying_xcat diff --git a/docs/source/guides/install-guides/common/install_guide.rst b/docs/source/guides/install-guides/common/install_guide.rst deleted file mode 100644 index 5402f2fec..000000000 --- a/docs/source/guides/install-guides/common/install_guide.rst +++ /dev/null @@ -1,20 +0,0 @@ - -.. BEGIN_install_os_mgmt_node - - -The system requirements for your xCAT management node largely depends on the size of the cluster you plan to manage and the type of provisioning used (diskful, diskless, system clones, etc). The majority of system load comes during cluster provisioning time. - -**Memory Requirements:** - -+--------------+-------------+ -| Cluster Size | Memory (GB) | -+==============+=============+ -| Small (< 16) | 4-6 | -+--------------+-------------+ -| Medium | 6-8 | -+--------------+-------------+ -| Large | > 16 | -+--------------+-------------+ - - -.. END_install_os_mgmt_node diff --git a/docs/source/guides/install-guides/common_sections.rst b/docs/source/guides/install-guides/common_sections.rst new file mode 100644 index 000000000..0a2c4a6ee --- /dev/null +++ b/docs/source/guides/install-guides/common_sections.rst @@ -0,0 +1,234 @@ + +.. BEGIN_install_os_mgmt_node + + +The system requirements for your xCAT management node largely depends on the size of the cluster you plan to manage and the type of provisioning used (diskful, diskless, system clones, etc). The majority of system load comes during cluster provisioning time. + +**Memory Requirements:** + ++--------------+-------------+ +| Cluster Size | Memory (GB) | ++==============+=============+ +| Small (< 16) | 4-6 | ++--------------+-------------+ +| Medium | 6-8 | ++--------------+-------------+ +| Large | > 16 | ++--------------+-------------+ + + +.. 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`` + +#. **xcat-core** xCAT's main software package and is provided in one of the following options: + + * **Latest Release (Stable) Builds** + + *This is the latest GA (Generally Availability) build that has been tested throughly* + + * **Latest Snapshot Builds** + + *This is the latest snapshot of the GA version build that may contain bug fixes but has not yet been tested throughly* + + * **Development Builds** + + *This is the snapshot builds of the new version of xCAT in development. This version has not been released yet, use as your own risk* + +#. **xcat-dep** xCAT's dependency package. This package is provided as a convenience for the user and contains dependency packages required by xCAT that are not provided by the operating system. + + +.. END_install_xcat_introduction + +.. BEGIN_configure_xcat_local_repo_xcat-core_RPM + +**[xcat-core]** + +#. Download xcat-core: :: + + # downloading the latest development build, core-rpms-snap.tar.bz2 + mkdir -p ~/xcat + cd ~/xcat/ + wget http://xcat.org/files/xcat/xcat-core/devel/Linux/core-snap/core-rpms-snap.tar.bz2 + + +#. Extract xcat-core: :: + + tar jxvf core-rpms-snap.tar.bz2 + +#. Configure the local repository for xcat-core by running ``mklocalrepo.sh`` script in the ``xcat-core`` directory: :: + + cd ~/xcat/xcat-core + ./mklocalrepo.sh + + +.. END_configure_xcat_local_repo_xcat-core_RPM + +.. BEGIN_configure_xcat_local_repo_xcat-core_DEBIAN + +**[xcat-core]** + +#. Download xcat-core: :: + + # downloading the latest development build, core-rpms-snap.tar.bz2 + mkdir -p ~/xcat + cd ~/xcat/ + wget http://xcat.org/files/xcat/xcat-core/devel/Ubuntu/core-snap/core-debs-snap.tar.bz2 + + +#. Extract xcat-core: :: + + tar jxvf core-debs-snap.tar.bz2 + +#. Configure the local repository for xcat-core by running ``mklocalrepo.sh`` script in the ``xcat-core`` directory: :: + + cd ~/xcat/xcat-core + ./mklocalrepo.sh + + +.. END_configure_xcat_local_repo_xcat-core_DEBIAN + +.. BEGIN_configure_xcat_local_repo_xcat-dep_RPM + +**[xcat-dep]** + +Unless you are downloading ``xcat-dep`` to match a specific package tested with a GA release, it's recommended to download the latest version of xcat-dep. + + +#. Download xcat-dep: :: + + # if downloading xcat-dep from June 11, 2015, xcat-dep-201506110324.tar.bz2 + mkdir -p ~/xcat/ + cd ~/xcat + wget http://xcat.org/files/xcat/xcat-dep/2.x_Linux/xcat-dep-201506110324.tar.bz2 + +#. Extract xcat-dep: :: + + tar jxvf xcat-dep-201506110324.tar.bz2 + +#. Configure the local repository for xcat-dep by switching to the architecture and os subdirectory of the node you are installing on, then run the ``mklocalrepo.sh`` script: :: + + cd ~/xcat/xcat-dep/ + # Example, on redhat 7.1 ppc64le: cd rh7/ppc64le + cd / + ./mklocalrepo.sh + +.. END_configure_xcat_local_repo_xcat-dep_RPM + +.. BEGIN_configure_xcat_local_repo_xcat-dep_DEBIAN + +**[xcat-dep]** + +Unless you are downloading ``xcat-dep`` to match a specific package tested with a GA release, it's recommended to download the latest version of xcat-dep. + + +#. Download xcat-dep: :: + + # if downloading xcat-dep from June 11, 2015, xcat-dep-ubuntu-snap20150611.tar.bz + mkdir -p ~/xcat/ + cd ~/xcat + wget http://xcat.org/files/xcat/xcat-dep/2.x_Ubuntu/xcat-dep-ubuntu-snap20150611.tar.bz + +#. Extract xcat-dep: :: + + tar jxvf xcat-dep-ubuntu-snap20150611.tar.bz + +#. Configure the local repository for xcat-dep by running the ``mklocalrepo.sh`` script: :: + + cd ~/xcat/xcat-dep/ + ./mklocalrepo.sh + +.. END_configure_xcat_local_repo_xcat-dep_DEBIAN + +.. BEGIN_installing_xcat + +Install xCAT with the following command: :: + + yum clean all (optional) + yum install xCAT + + +**Note:** During the install, you must accept the *xCAT Security Key* to continue: :: + + Retrieving key from file:///root/xcat/xcat-dep/rh6/ppc64/repodata/repomd.xml.key + Importing GPG key 0xC6565BC9: + Userid: "xCAT Security Key " + From : /root/xcat/xcat-dep/rh6/ppc64/repodata/repomd.xml.key + Is this ok [y/N]: + +.. END_installing_xcat + + +.. BEGIN_verifying_xcat + +Quick verification of the xCAT Install can be done running the following steps: + +#. Source the profile to add xCAT Commands to your path: :: + + source /etc/profile.d/xcat.sh + +#. Check the xCAT version: :: + + lsxcatd -a + +#. Check to verify that the xCAT database is initialized by dumping out the site table: :: + + tabdump site + + The output should be similar to the following: :: + + #key,value,comments,disable + "blademaxp","64",, + "domain","pok.stglabs.ibm.com",, + "fsptimeout","0",, + "installdir","/install",, + "ipmimaxp","64",, + "ipmiretries","3",, + ... + +Starting and Stopping +--------------------- + +xCAT is started automatically after the installation, but the following commands can be used to start, stop, restart, and check xCAT status. + +* start xCAT: :: + + service xcatd start + [systemd] systemctl xcatd.service start + +* stop xCAT: :: + + service xcatd stop + [systemd] systemctl xcatd.service stop + +* restart xCAT: :: + + service xcatd restart + [systemd] systemctl xcatd.service restart + +* check xCAT status: :: + + service xcatd status + [systemd] systemctl xcatd.service status + + +.. END_verifying_xcat + +.. BEGIN_update_xcat + +If at a later date you want to update xCAT, first, update the software repositories and then run: :: + + yum clean metadata # or, yum clean all + yum update '*xCAT*' + +.. END_update_xcat diff --git a/docs/source/guides/install-guides/yum/configure_xcat.rst b/docs/source/guides/install-guides/yum/configure_xcat.rst index fbed460e4..b57380ae2 100644 --- a/docs/source/guides/install-guides/yum/configure_xcat.rst +++ b/docs/source/guides/install-guides/yum/configure_xcat.rst @@ -1,2 +1,31 @@ -Configure xCAT -============== +Configure xCAT Software Repository +================================== + +xCAT software and repo files can be obtained from: ``_ + +Internet Repository +------------------- + +**[xcat-core]** + +For the xCAT build you want to install, download the ``xCAT-core.repo`` file and copy to ``/etc/yum.repos.d`` + +**[xcat-dep]** + +From the `xCAT-dep Online Repository `_, navigate to the correct subdirectory for the target machine and download the ``xCAT-dep.repo`` file and copy to ``/etc/yum.repos.d``. + +If using internet repositories, continue to the next step to install xCAT. + +Local Repository +---------------- + +.. xcat-core +.. include:: ../common_sections.rst + :start-after: BEGIN_configure_xcat_local_repo_xcat-core_RPM + :end-before: END_configure_xcat_local_repo_xcat-core_RPM + +.. xcat-dep +.. include:: ../common_sections.rst + :start-after: BEGIN_configure_xcat_local_repo_xcat-dep_RPM + :end-before: END_configure_xcat_local_repo_xcat-dep_RPM + diff --git a/docs/source/guides/install-guides/yum/index.rst b/docs/source/guides/install-guides/yum/index.rst index 3fdf1f985..7bc46861b 100644 --- a/docs/source/guides/install-guides/yum/index.rst +++ b/docs/source/guides/install-guides/yum/index.rst @@ -7,5 +7,4 @@ For the list of currently supported RHEL operating systems, see :ref:`rhels-os-s :maxdepth: 2 prepare_mgmt_node.rst - install_xcat.rst - configure_xcat.rst + install.rst diff --git a/docs/source/guides/install-guides/yum/install.rst b/docs/source/guides/install-guides/yum/install.rst new file mode 100644 index 000000000..f21dddef4 --- /dev/null +++ b/docs/source/guides/install-guides/yum/install.rst @@ -0,0 +1,16 @@ +Installing xCAT +=============== + +.. include:: ../common_sections.rst + :start-after: BEGIN_install_xcat_introduction + :end-before: END_install_xcat_introduction + +xCAT is installed by configuring software repositories for ``xcat-core`` and ``xcat-dep`` and using yum package manager. The repositories can be publically hosted or locally hosted. + +.. toctree:: + :maxdepth: 2 + + configure_xcat.rst + install_xcat.rst + verify_xcat.rst + update_xcat.rst diff --git a/docs/source/guides/install-guides/yum/install_xcat.rst b/docs/source/guides/install-guides/yum/install_xcat.rst index 73726d840..ab6ab5741 100644 --- a/docs/source/guides/install-guides/yum/install_xcat.rst +++ b/docs/source/guides/install-guides/yum/install_xcat.rst @@ -1,163 +1,7 @@ -Install xCAT -============ - -xCAT consists of two software packages: - -#. **xcat-core** xCAT's main software package. - - The xcat-core package is provided in one of the following options: - - * **Latest Release (Stable) Builds** - - *This is the latest GA (Generally Availability) build that has been tested throughly* - - * **Latest Snapshot Builds** - - *This is the latest snapshot of the GA version build that may contain bug fixes but has not yet been tested throughly* - - * **Development Builds** - - *This is the snapshot builds of the new version of xCAT in development. This version has not been released yet, use as your own risk* - -#. **xcat-dep** xCAT's dependency package. This is provided as a convenience for the user and contains dependency packages required by xCAT that are not provided by the operating system. - -xCAT is installed by configuring software repositories for ``xcat-core`` and ``xcat-dep`` and using yum package manager. The software repositoreies can publically hosted (requires internet connectivity) or locally configured. - -Configure xCAT Software Repository ----------------------------------- - -Public Internet Repository -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -TODO: Need to fill this out - -Locally Configured Repository -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -From the xCAT software download page: ``_, download ``xcat-core`` and ``xcat-dep``. - -xcat-core -^^^^^^^^^ - -#. Download xcat-core, if downloading the latest devepment build: :: - - cd /root - mkdir -p ~/xcat - cd ~/xcat/ - wget http://sourceforge.net/projects/xcat/files/yum/devel/core-rpms-snap.tar.bz2 - - -#. Extract xcat-core: :: - - cd ~/xcat - tar jxvf core-rpms-snap.tar.bz - -#. Configure the local repository, by runnin the ``mklocalrepo.sh`` script: :: - - cd ~/xcat/xcat-core/ - ./mklocalrepo.sh - - -xcat-dep -^^^^^^^^ - -Unless you are downloading ``xcat-dep`` for a specific GA version of xCAT, select the package with the latest timestamp. - - -#. Download xcat-dep, if downloading xcat-dep from June 11, 2015, for Linux: :: - - mkdir -p ~/xcat/ - cd ~/xcat - wget http://sourceforge.net/projects/xcat/files/xcat-dep/2.x_Linux/xcat-dep-201506110324.tar.bz2 - -#. Extract xcat-dep: :: - - cd ~/xcat/ - tar jxvf xcat-dep-201506110324.tar.bz2 - -#. Configure the local repository by switching to the architecture and os of the system you are installing on , and running the ``mklocalrepo.sh`` script: :: - - cd ~/xcat/xcat-dep/ - # for redhat 6.5 on ppc64... - cd rh6/ppc64 - ./mklocalrepo.sh - Install xCAT ------------ -Install xCAT with the following command: :: +.. include:: ../common_sections.rst + :start-after: BEGIN_installing_xcat + :end-before: END_installing_xcat - yum clean all (optional) - yum install xCAT - - -**Note:** During the install, you will need to accept the *xCAT Security Key* to proceed: :: - - Retrieving key from file:///root/xcat/xcat-dep/rh6/ppc64/repodata/repomd.xml.key - Importing GPG key 0xC6565BC9: - Userid: "xCAT Security Key " - From : /root/xcat/xcat-dep/rh6/ppc64/repodata/repomd.xml.key - Is this ok [y/N]: - - -Verify xCAT Installation ------------------------- - -Quick verificaiton can be done with the following steps: - -#. Source the profile to add xCAT Commands to your path: :: - - source /etc/profile.d/xcat.sh - -#. Check the xCAT Install version: :: - - lsxcatd -a - -#. Check to see the database is initialized by dumping the site table: :: - - tabdump site - - The output should similar to the following: :: - - #key,value,comments,disable - "blademaxp","64",, - "domain","pok.stglabs.ibm.com",, - "fsptimeout","0",, - "installdir","/install",, - "ipmimaxp","64",, - "ipmiretries","3",, - ... - -Starting and Stopping ---------------------- - -You can easily start, stop, restart, and check xCAT status using Linux systemd or systemctl: - -* start xCAT: :: - - service xcatd start - systemctl xcatd.service start - -* stop xCAT: :: - - service xcatd stop - systemctl xcatd.service stop - -* restart xCAT: :: - - service xcatd restart - systemctl xcatd.service restart - -* check xCAT status: :: - - service xcatd status - systemctl xcatd.service status - - -Updating xCAT -------------- - -If at a later date you want to update xCAT, simply update the software repository and run: :: - - yum clean metadata (or, yum clean all) - yum update '*xCAT*' 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 c9b3655a4..2715f174e 100644 --- a/docs/source/guides/install-guides/yum/prepare_mgmt_node.rst +++ b/docs/source/guides/install-guides/yum/prepare_mgmt_node.rst @@ -6,36 +6,31 @@ These steps prepare the Management Node or xCAT Installation Install an OS on the Management Node ------------------------------------ -Install one of the supported operating systems :ref:`rhels-os-support-label` on to your target management node +Install one of the supported operating systems :ref:`rhels-os-support-label` on to your target Management Node - .. include:: ../common/install_guide.rst - :start-after: BEGIN_install_os_mgmt_node - :end-before: END_install_os_mgmt_node +.. include:: ../common_sections.rst + :start-after: BEGIN_install_os_mgmt_node + :end-before: END_install_os_mgmt_node Configure the Base OS Repository -------------------------------- -xCAT uses the yum package manager on RHEL Linux distributions to install and resolve dependency packages provded by the base operating system. Follow this section to create the repository for the base operating system on the management node +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 onto the management node: :: +#. Copy the DVD iso file to ``/tmp`` on the Management Node: :: - mkdir -p /tmp/iso - scp @:/images/iso/rhels7.1/ppc64le/RHEL-LE-7.1-20150219.1-Server-ppc64le-dvd1.iso /tmp/iso + # This example will use RHEL-LE-7.1-20150219.1-Server-ppc64le-dvd1.iso -#. Mount the dvd iso to a directory on the management node. :: +#. Mount the iso to ``/mnt/iso/rhels7.1`` on the Management Node. :: - # - # Assuming we are mounting at /mnt/iso/rhels7.1 - # mkdir -p /mnt/iso/rhels7.1 - mount -o loop /tmp/iso/RHEL-LE-7.1-20150219.1-Server-ppc64le-dvd1.iso /mnt/iso/rhels7.1 + mount -o loop /tmp/RHEL-LE-7.1-20150219.1-Server-ppc64le-dvd1.iso /mnt/iso/rhels7.1 -#. Create the local repository configuration file pointing to mounted iso image. :: +#. Create a yum repository file ``/etc/yum.repos.d/rhels71-dvd.repo`` that points to the locally mounted iso image from the above step. The file contents should appear as the following: :: - cat /etc/yum/yum.repos.d/rhels71-base.repo - [rhel-7-server] + [rhel-7.1-dvd-server] name=RHEL 7 SERVER packages - baseurl=file:///mnt/iso/rhels71/Server + baseurl=file:///mnt/iso/rhels7.1/Server enabled=1 gpgcheck=1 @@ -43,7 +38,7 @@ xCAT uses the yum package manager on RHEL Linux distributions to install and res Set up Network -------------- -The management node IP address should be set to a **static** ip address. - -Modify the ifcfg- file under ``/etc/sysconfig/network-scripts`` and configure a static IP address. +.. include:: ../common_sections.rst + :start-after: BEGIN_setup_mgmt_node_network + :end-before: END_setup_mgmt_node_network diff --git a/docs/source/guides/install-guides/yum/update_xcat.rst b/docs/source/guides/install-guides/yum/update_xcat.rst new file mode 100644 index 000000000..60c184b6a --- /dev/null +++ b/docs/source/guides/install-guides/yum/update_xcat.rst @@ -0,0 +1,6 @@ +Updating xCAT +============= + +.. include:: ../common_sections.rst + :start-after: BEGIN_update_xcat + :end-before: END_update_xcat diff --git a/docs/source/guides/install-guides/yum/verify_xcat.rst b/docs/source/guides/install-guides/yum/verify_xcat.rst new file mode 100644 index 000000000..d2d09c535 --- /dev/null +++ b/docs/source/guides/install-guides/yum/verify_xcat.rst @@ -0,0 +1,6 @@ +Verify xCAT Installation +======================== + +.. include:: ../common_sections.rst + :start-after: BEGIN_verifying_xcat + :end-before: END_verifying_xcat diff --git a/docs/source/guides/install-guides/zypper/configure_xcat.rst b/docs/source/guides/install-guides/zypper/configure_xcat.rst new file mode 100644 index 000000000..7728ef7ff --- /dev/null +++ b/docs/source/guides/install-guides/zypper/configure_xcat.rst @@ -0,0 +1,30 @@ +Configure xCAT Software Repository +================================== + +xCAT software and repo files can be obtained from: ``_ + +Internet Repository +------------------- + +**[xcat-core]** + +For the xCAT build you want to install, download the ``xCAT-core.repo`` file and copy to ``/etc/zypp/repos.d`` + +**[xcat-dep]** + +From the `xCAT-dep Online Repository `_, navigate to the correct subdirectory for the target machine and download the ``xCAT-dep.repo`` file and copy to ``/etc/zypp/repos.d``. + +If using internet repositories, continue to the next step to install xCAT. + +Local Repository +---------------- + +.. xcat-core +.. include:: ../common_sections.rst + :start-after: BEGIN_configure_xcat_local_repo_xcat-core_RPM + :end-before: END_configure_xcat_local_repo_xcat-core_RPM + +.. xcat-dep +.. include:: ../common_sections.rst + :start-after: BEGIN_configure_xcat_local_repo_xcat-dep_RPM + :end-before: END_configure_xcat_local_repo_xcat-dep_RPM diff --git a/docs/source/guides/install-guides/zypper/index.rst b/docs/source/guides/install-guides/zypper/index.rst index 74d6acd2b..8f3a65c59 100644 --- a/docs/source/guides/install-guides/zypper/index.rst +++ b/docs/source/guides/install-guides/zypper/index.rst @@ -7,5 +7,4 @@ For the list of currently supported SLES operating systems, see :ref:`sles-os-su :maxdepth: 2 prepare_mgmt_node.rst -.. install_xcat.rst -.. configure_xcat.rst + install.rst diff --git a/docs/source/guides/install-guides/zypper/install.rst b/docs/source/guides/install-guides/zypper/install.rst new file mode 100644 index 000000000..fc8a46235 --- /dev/null +++ b/docs/source/guides/install-guides/zypper/install.rst @@ -0,0 +1,17 @@ +Installing xCAT +=============== + +.. include:: ../common_sections.rst + :start-after: BEGIN_install_xcat_introduction + :end-before: END_install_xcat_introduction + +xCAT is installed by configuring software repositories for ``xcat-core`` and ``xcat-dep`` and using zypper package manager. The repositories can be publically hosted or locally hosted. + + +.. toctree:: + :maxdepth: 2 + + configure_xcat.rst + install_xcat.rst + verify_xcat.rst + update_xcat.rst diff --git a/docs/source/guides/install-guides/zypper/install_xcat.rst b/docs/source/guides/install-guides/zypper/install_xcat.rst new file mode 100644 index 000000000..ab6ab5741 --- /dev/null +++ b/docs/source/guides/install-guides/zypper/install_xcat.rst @@ -0,0 +1,7 @@ +Install xCAT +------------ + +.. include:: ../common_sections.rst + :start-after: BEGIN_installing_xcat + :end-before: END_installing_xcat + 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 0374ac77c..78f194405 100644 --- a/docs/source/guides/install-guides/zypper/prepare_mgmt_node.rst +++ b/docs/source/guides/install-guides/zypper/prepare_mgmt_node.rst @@ -6,33 +6,28 @@ These steps prepare the Management Node or xCAT Installation Install an OS on the Management Node ------------------------------------ -Install one of the supported operating systems :ref:`sles-os-support-label` on to your target management node +Install one of the supported operating systems :ref:`sles-os-support-label` on to your target Management Node - .. include:: ../common/install_guide.rst - :start-after: BEGIN_install_os_mgmt_node - :end-before: END_install_os_mgmt_node +.. include:: ../common_sections.rst + :start-after: BEGIN_install_os_mgmt_node + :end-before: END_install_os_mgmt_node Configure the Base OS Repository -------------------------------- -xCAT uses the zypper package manager on SLES Linux distributions to install and resolve dependency packages provded by the base operating system. Follow this section to create the repository for the base operating system on the management node +xCAT uses the zypper package manager on SLES 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 onto the management node: :: +#. Copy the DVD iso file to ``/tmp`` on the Management Node: :: - mkdir -p /tmp/iso - scp @:/images/iso/sles12/ppc64le/SLE-12-Server-DVD-ppc64le-GM-DVD1.iso /tmp/iso + # This example will use SLE-12-Server-DVD-ppc64le-GM-DVD1.iso -#. Mount the dvd iso to a directory on the management node. :: +#. Mount the iso to ``/mnt/iso/sles12`` on the Management Node. :: - # - # Assuming we are mounting at /mnt/iso/sles12 - # mkdir -p /mnt/iso/sles12 - mount -o loop /tmp/iso/SLE-12-Server-DVD-ppc64le-GM-DVD1.iso /mnt/iso/sles12 + mount -o loop /tmp/SLE-12-Server-DVD-ppc64le-GM-DVD1.iso /mnt/iso/sles12 -#. Create the local repository configuration file pointing to mounted iso image. :: +#. Create a zypper repository file ``/etc/zypp/repos.d/sles12le-base.repo`` that points to the locally mounted iso image from the above step. The file contents should appear as the following: :: - cat /etc/zypp/repos.d/sles12le-base.repo [sles-12-le-server] name=SLES 12 ppc64le Server Packages baseurl=file:///mnt/iso/sles12/suse @@ -43,7 +38,6 @@ xCAT uses the zypper package manager on SLES Linux distributions to install and Set up Network -------------- -The management node IP address should be set to a **static** ip address. - -Modify the ifcfg- file under ``/etc/sysconfig/network`` and configure a static IP address. - +.. include:: ../common_sections.rst + :start-after: BEGIN_setup_mgmt_node_network + :end-before: END_setup_mgmt_node_network diff --git a/docs/source/guides/install-guides/zypper/update_xcat.rst b/docs/source/guides/install-guides/zypper/update_xcat.rst new file mode 100644 index 000000000..60c184b6a --- /dev/null +++ b/docs/source/guides/install-guides/zypper/update_xcat.rst @@ -0,0 +1,6 @@ +Updating xCAT +============= + +.. include:: ../common_sections.rst + :start-after: BEGIN_update_xcat + :end-before: END_update_xcat diff --git a/docs/source/guides/install-guides/zypper/verify_xcat.rst b/docs/source/guides/install-guides/zypper/verify_xcat.rst new file mode 100644 index 000000000..d2d09c535 --- /dev/null +++ b/docs/source/guides/install-guides/zypper/verify_xcat.rst @@ -0,0 +1,6 @@ +Verify xCAT Installation +======================== + +.. include:: ../common_sections.rst + :start-after: BEGIN_verifying_xcat + :end-before: END_verifying_xcat diff --git a/docs/source/overview/index.rst b/docs/source/overview/index.rst index ea0588f0e..d1b1b9b29 100644 --- a/docs/source/overview/index.rst +++ b/docs/source/overview/index.rst @@ -14,4 +14,3 @@ xCAT is known for exceptional scaling, wide variety of supported hardware and op architecture.rst quick_start.rst xcat2_release.rst -