Merge pull request #2011 from pdlun92/go-xcat-doc

Modified xCAT install documentation to leverage go-xcat

docs/source/guides/install-guides/apt/automatic_install.rst

@@ -0,0 +1,6 @@
+Automatic Install Using ``go-xcat``
+===================================
+
+.. include:: ../common_sections.rst
+   :start-after: BEGIN_automatic_install
+   :end-before: END_automatic_install 

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

docs/source/guides/install-guides/apt/manual_install.rst

@@ -0,0 +1,16 @@
+Manual Install Using Software Repositories
+==========================================
+
+.. 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

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
+
+The following sections describe the different methods for installing xCAT.
+
+.. END_installation_methods
+
+.. BEGIN_automatic_install
+
+``go-xcat`` is a tool that can be used to fully install or update xCAT.  ``go-xcat`` will automatically download the correct package manager repository file from xcat.org and use the public repository to install xCAT.  If the xCAT management node does not have internet connectivity, use process described in the Manual Installation section of the guide.
+
+#. 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]**

docs/source/guides/install-guides/yum/automatic_install.rst

@@ -0,0 +1,6 @@
+Automatic Install Using ``go-xcat``
+===================================
+
+.. include:: ../common_sections.rst
+   :start-after: BEGIN_automatic_install
+   :end-before: END_automatic_install 

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

docs/source/guides/install-guides/yum/manual_install.rst

@@ -0,0 +1,16 @@
+Manual Install Using Software Repositories
+==========================================
+
+.. 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

docs/source/guides/install-guides/zypper/automatic_install.rst

@@ -0,0 +1,6 @@
+Automatic Install Using ``go-xcat``
+===================================
+
+.. include:: ../common_sections.rst
+   :start-after: BEGIN_automatic_install
+   :end-before: END_automatic_install 

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

docs/source/guides/install-guides/zypper/manual_install.rst

@@ -0,0 +1,16 @@
+Manual Install Using Software Repositories
+==========================================
+
+.. 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