From bf6e84f5e56b82c14d91d2e987666e339cc24a18 Mon Sep 17 00:00:00 2001 From: Patrick Lundgren Date: Fri, 21 Oct 2016 17:26:01 -0400 Subject: [PATCH] Modified xCAT install documentation to leverage go-xcat --- .../install-guides/apt/automatic_install.rst | 6 +++++ .../guides/install-guides/apt/install.rst | 12 ++++------ .../install-guides/apt/manual_install.rst | 16 ++++++++++++++ .../guides/install-guides/common_sections.rst | 22 +++++++++++++++++++ docs/source/guides/install-guides/index.rst | 2 +- .../install-guides/yum/automatic_install.rst | 6 +++++ .../guides/install-guides/yum/install.rst | 12 ++++------ .../install-guides/yum/manual_install.rst | 16 ++++++++++++++ .../zypper/automatic_install.rst | 6 +++++ .../guides/install-guides/zypper/install.rst | 13 ++++------- .../install-guides/zypper/manual_install.rst | 16 ++++++++++++++ 11 files changed, 101 insertions(+), 26 deletions(-) create mode 100644 docs/source/guides/install-guides/apt/automatic_install.rst create mode 100644 docs/source/guides/install-guides/apt/manual_install.rst create mode 100644 docs/source/guides/install-guides/yum/automatic_install.rst create mode 100644 docs/source/guides/install-guides/yum/manual_install.rst create mode 100644 docs/source/guides/install-guides/zypper/automatic_install.rst create mode 100644 docs/source/guides/install-guides/zypper/manual_install.rst diff --git a/docs/source/guides/install-guides/apt/automatic_install.rst b/docs/source/guides/install-guides/apt/automatic_install.rst new file mode 100644 index 000000000..63b17e7cc --- /dev/null +++ b/docs/source/guides/install-guides/apt/automatic_install.rst @@ -0,0 +1,6 @@ +Automatically Installing xCAT +============================= + +.. include:: ../common_sections.rst + :start-after: BEGIN_automatic_install + :end-before: END_automatic_install diff --git a/docs/source/guides/install-guides/apt/install.rst b/docs/source/guides/install-guides/apt/install.rst index 06a597a7e..0396dd0ba 100644 --- a/docs/source/guides/install-guides/apt/install.rst +++ b/docs/source/guides/install-guides/apt/install.rst @@ -2,15 +2,11 @@ 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. + :start-after: BEGIN_installation_methods + :end-before: END_installation_methods .. toctree:: :maxdepth: 2 - configure_xcat.rst - install_xcat.rst - verify_xcat.rst - update_xcat.rst + automatic_install.rst + manual_install.rst diff --git a/docs/source/guides/install-guides/apt/manual_install.rst b/docs/source/guides/install-guides/apt/manual_install.rst new file mode 100644 index 000000000..b811708a2 --- /dev/null +++ b/docs/source/guides/install-guides/apt/manual_install.rst @@ -0,0 +1,16 @@ +Manually 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 publicly 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/common_sections.rst b/docs/source/guides/install-guides/common_sections.rst index 840532675..c40a27df2 100644 --- a/docs/source/guides/install-guides/common_sections.rst +++ b/docs/source/guides/install-guides/common_sections.rst @@ -52,6 +52,28 @@ xCAT consists of two software packages: ``xcat-core`` and ``xcat-dep`` .. END_install_xcat_introduction +.. BEGIN_installation_methods + +There are two methods for installing xCAT. The first method, automatic install, leverages a tool named `go-xcat` to automatically install xCAT and its components. The second method is to manually install xCAT through the provided repositories. + +.. END_installation_methods + +.. BEGIN_automatic_install + +`go-xcat` is a tool that can be used to fully install or update xCAT + +#. Download the `go-xcat` tool using `wget`: :: + + wget http:xcat.org/files/go-xcat -O - >/tmp/go-xcat + chmod +x /tmp/go-xcat + +#. Run the `go-xcat` tool: :: + + /tmp/go-xcat install # installs the latest stable version of xCAT + /tmp/go-xcat -x devel install # installs the latest development version of xCAT + +.. END_automatic_install + .. BEGIN_configure_xcat_local_repo_xcat-core_RPM **[xcat-core]** diff --git a/docs/source/guides/install-guides/index.rst b/docs/source/guides/install-guides/index.rst index 09a92b510..a284f704a 100644 --- a/docs/source/guides/install-guides/index.rst +++ b/docs/source/guides/install-guides/index.rst @@ -4,7 +4,7 @@ Install Guides ============== .. toctree:: - :maxdepth: 2 + :maxdepth: 2 yum/index.rst zypper/index.rst diff --git a/docs/source/guides/install-guides/yum/automatic_install.rst b/docs/source/guides/install-guides/yum/automatic_install.rst new file mode 100644 index 000000000..63b17e7cc --- /dev/null +++ b/docs/source/guides/install-guides/yum/automatic_install.rst @@ -0,0 +1,6 @@ +Automatically Installing xCAT +============================= + +.. include:: ../common_sections.rst + :start-after: BEGIN_automatic_install + :end-before: END_automatic_install diff --git a/docs/source/guides/install-guides/yum/install.rst b/docs/source/guides/install-guides/yum/install.rst index e5d1fab50..0396dd0ba 100644 --- a/docs/source/guides/install-guides/yum/install.rst +++ b/docs/source/guides/install-guides/yum/install.rst @@ -2,15 +2,11 @@ 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 publicly hosted or locally hosted. + :start-after: BEGIN_installation_methods + :end-before: END_installation_methods .. toctree:: :maxdepth: 2 - configure_xcat.rst - install_xcat.rst - verify_xcat.rst - update_xcat.rst + automatic_install.rst + manual_install.rst diff --git a/docs/source/guides/install-guides/yum/manual_install.rst b/docs/source/guides/install-guides/yum/manual_install.rst new file mode 100644 index 000000000..b811708a2 --- /dev/null +++ b/docs/source/guides/install-guides/yum/manual_install.rst @@ -0,0 +1,16 @@ +Manually 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 publicly 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/automatic_install.rst b/docs/source/guides/install-guides/zypper/automatic_install.rst new file mode 100644 index 000000000..63b17e7cc --- /dev/null +++ b/docs/source/guides/install-guides/zypper/automatic_install.rst @@ -0,0 +1,6 @@ +Automatically Installing xCAT +============================= + +.. include:: ../common_sections.rst + :start-after: BEGIN_automatic_install + :end-before: END_automatic_install diff --git a/docs/source/guides/install-guides/zypper/install.rst b/docs/source/guides/install-guides/zypper/install.rst index 2bea4105f..0396dd0ba 100644 --- a/docs/source/guides/install-guides/zypper/install.rst +++ b/docs/source/guides/install-guides/zypper/install.rst @@ -2,16 +2,11 @@ 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 publicly hosted or locally hosted. - + :start-after: BEGIN_installation_methods + :end-before: END_installation_methods .. toctree:: :maxdepth: 2 - configure_xcat.rst - install_xcat.rst - verify_xcat.rst - update_xcat.rst + automatic_install.rst + manual_install.rst diff --git a/docs/source/guides/install-guides/zypper/manual_install.rst b/docs/source/guides/install-guides/zypper/manual_install.rst new file mode 100644 index 000000000..b811708a2 --- /dev/null +++ b/docs/source/guides/install-guides/zypper/manual_install.rst @@ -0,0 +1,16 @@ +Manually 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 publicly hosted or locally hosted. + +.. toctree:: + :maxdepth: 2 + + configure_xcat.rst + install_xcat.rst + verify_xcat.rst + update_xcat.rst