From c252393f4ab3aeb15c91736daa9850e0b4294798 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 16 Jul 2015 15:29:16 -0400 Subject: [PATCH 01/57] Preparing files to be merged from xcat_doctest to xcat-docs --- Makefile | 192 +++++++++++ make.bat | 263 +++++++++++++++ source/advanced/confetty/confetty.rst | 53 +++ source/advanced/confetty/index.rst | 9 + source/advanced/confluent/confluent.rst | 146 +++++++++ source/advanced/confluent/index.rst | 15 + source/advanced/docker/index.rst | 7 + source/advanced/index.rst | 10 + source/advanced/mixed_cluster.rst | 87 +++++ source/conf.py | 292 +++++++++++++++++ source/developers/git.rst | 3 + source/developers/index.rst | 10 + source/guides/admin-guides/index.rst | 7 + .../large_clusters/databases/index.rst | 40 +++ .../databases/mysql_configure.rst | 2 + .../databases/mysql_install.rst | 2 + .../databases/postgres_configure.rst | 9 + .../databases/postgres_install.rst | 34 ++ .../databases/postgres_tips.rst | 53 +++ .../admin-guides/large_clusters/index.rst | 7 + source/guides/install-guides/apt/index.rst | 9 + .../install-guides/common/install_guide.rst | 20 ++ .../common/prepare_mgmt_node.rst | 76 +++++ source/guides/install-guides/index.rst | 9 + .../install-guides/yum/configure_xcat.rst | 2 + source/guides/install-guides/yum/index.rst | 11 + .../install-guides/yum/install_xcat.rst | 162 ++++++++++ .../install-guides/yum/prepare_mgmt_node.rst | 29 ++ .../guides/install-guides/yum/yum_common.rst | 42 +++ source/guides/install-guides/zypper/index.rst | 11 + .../guides/install-guides/zypper/sles_support | 2 + source/help.rst | 5 + source/index.rst | 37 +++ source/notes/hw_mgmt/hmc/index.rst | 19 ++ source/notes/hw_mgmt/hmc/new_profile.rst | 122 +++++++ source/notes/hw_mgmt/hmc/vioserver.rst | 306 ++++++++++++++++++ source/notes/hw_mgmt/index.rst | 8 + source/notes/hw_mgmt/ipmi/index.rst | 9 + source/notes/index.rst | 9 + source/xcat2_support_list.rst | 33 ++ 40 files changed, 2162 insertions(+) create mode 100644 Makefile create mode 100644 make.bat create mode 100644 source/advanced/confetty/confetty.rst create mode 100644 source/advanced/confetty/index.rst create mode 100644 source/advanced/confluent/confluent.rst create mode 100644 source/advanced/confluent/index.rst create mode 100644 source/advanced/docker/index.rst create mode 100644 source/advanced/index.rst create mode 100644 source/advanced/mixed_cluster.rst create mode 100644 source/conf.py create mode 100644 source/developers/git.rst create mode 100644 source/developers/index.rst create mode 100644 source/guides/admin-guides/index.rst create mode 100644 source/guides/admin-guides/large_clusters/databases/index.rst create mode 100644 source/guides/admin-guides/large_clusters/databases/mysql_configure.rst create mode 100644 source/guides/admin-guides/large_clusters/databases/mysql_install.rst create mode 100644 source/guides/admin-guides/large_clusters/databases/postgres_configure.rst create mode 100644 source/guides/admin-guides/large_clusters/databases/postgres_install.rst create mode 100644 source/guides/admin-guides/large_clusters/databases/postgres_tips.rst create mode 100644 source/guides/admin-guides/large_clusters/index.rst create mode 100644 source/guides/install-guides/apt/index.rst create mode 100644 source/guides/install-guides/common/install_guide.rst create mode 100644 source/guides/install-guides/common/prepare_mgmt_node.rst create mode 100644 source/guides/install-guides/index.rst create mode 100644 source/guides/install-guides/yum/configure_xcat.rst create mode 100644 source/guides/install-guides/yum/index.rst create mode 100644 source/guides/install-guides/yum/install_xcat.rst create mode 100644 source/guides/install-guides/yum/prepare_mgmt_node.rst create mode 100644 source/guides/install-guides/yum/yum_common.rst create mode 100644 source/guides/install-guides/zypper/index.rst create mode 100644 source/guides/install-guides/zypper/sles_support create mode 100644 source/help.rst create mode 100644 source/index.rst create mode 100644 source/notes/hw_mgmt/hmc/index.rst create mode 100644 source/notes/hw_mgmt/hmc/new_profile.rst create mode 100644 source/notes/hw_mgmt/hmc/vioserver.rst create mode 100644 source/notes/hw_mgmt/index.rst create mode 100644 source/notes/hw_mgmt/ipmi/index.rst create mode 100644 source/notes/index.rst create mode 100644 source/xcat2_support_list.rst diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..c03d22370 --- /dev/null +++ b/Makefile @@ -0,0 +1,192 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/xCAT3.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/xCAT3.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/xCAT3" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/xCAT3" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/make.bat b/make.bat new file mode 100644 index 000000000..90b208149 --- /dev/null +++ b/make.bat @@ -0,0 +1,263 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source +set I18NSPHINXOPTS=%SPHINXOPTS% source +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + echo. coverage to run coverage check of the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +REM Check if sphinx-build is available and fallback to Python version if any +%SPHINXBUILD% 2> nul +if errorlevel 9009 goto sphinx_python +goto sphinx_ok + +:sphinx_python + +set SPHINXBUILD=python -m sphinx.__init__ +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +:sphinx_ok + + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\xCAT3.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\xCAT3.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "coverage" ( + %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage + if errorlevel 1 exit /b 1 + echo. + echo.Testing of coverage in the sources finished, look at the ^ +results in %BUILDDIR%/coverage/python.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/source/advanced/confetty/confetty.rst b/source/advanced/confetty/confetty.rst new file mode 100644 index 000000000..2ff9555f4 --- /dev/null +++ b/source/advanced/confetty/confetty.rst @@ -0,0 +1,53 @@ + + +Starting the confetty client +============================ + +As the root user, running ``/opt/confluent/bin/confetty`` will open the confetty prompt :: + + [root@c910f02c05p03 ~]# /opt/confluent/bin/confetty + / -> + +Creating a non root user +======================== + +It's recommenteed to create a non root user to use to connect to confetty + +#. Create a non-root user on the management node: :: + + useradd -m vhu + +#. As root, create a non-root user in confetty: :: + + /opt/confluent/bin/confetty create users/vhu + +#. Set the password for the non-root user: :: + + /opt/confluent/bin/confetty set users/vhu password="mynewpassword" + password="********" + + +Connecting to a remote server +============================= + + +In order to do remote sessions, keys must first be added to ``/etc/confluent`` + +* /etc/confluent/privkey.pem - private key +* /etc/confluent/srvcert.pem - server cert + +If you want to use the xCAT Keys, you can simple copy them into ``/etc/confluent`` :: + + cp /etc/xcat/cert/server-key.pem /etc/confluent/privkey.pem + cp /etc/xcat/cert/server-cert.pem /etc/confluent/srvcert.pem + + +Start confetty, specify the server IP address: :: + + confetty -s 127.0.0.1 + + + +TODO: Add text for exporting user/pass into environment + + diff --git a/source/advanced/confetty/index.rst b/source/advanced/confetty/index.rst new file mode 100644 index 000000000..ff9cf2779 --- /dev/null +++ b/source/advanced/confetty/index.rst @@ -0,0 +1,9 @@ +Confetty +========= + +Confetty is a client to confluent server + +.. toctree:: + :maxdepth: 2 + + confetty.rst diff --git a/source/advanced/confluent/confluent.rst b/source/advanced/confluent/confluent.rst new file mode 100644 index 000000000..050996772 --- /dev/null +++ b/source/advanced/confluent/confluent.rst @@ -0,0 +1,146 @@ +Getting Started +--------------- + +For xCAT 2.9.1 and later, confluent is intended to be used in conjunction with xCAT. +The following documentation assumes that xCAT is already installed and configured on the management node. + +Download +-------- + +confluent +^^^^^^^^^ + +The latest confluent rpms are built and provided for your convenience: `confluent rpms `_ + +The following example downloads the confluent tar package and creates a local repository on your management node:: + + mkdir ~/confluent + cd ~/confluent + wget https://path-to-confluent/confluent-X.X-repo.tbz2 + tar jxvf confluent-X.X-repo.tbz2 + cd confluent-X.X + ./mklocalrepo.sh + + +confluent-dep +^^^^^^^^^^^^^ + +The latest confluent dependency packages are provided for your convenience: `confluent-deps `_ + +The following example describes the steps for **rhels7.1** on **ppc64le**:: + + mkdkir ~/confluent + cd ~/confluent + wget https://path/to/confluent-dep/rh7/ppc64le/confluent-dep-rh7-ppc64le.tar.bz2 + tar -jxvf confluent-dep-rh7-ppc64le.tar.bz2 + cd confluent-dep-rh7-ppc64le/ + ./mklocalrepo.sh + +**Note:** If the OS/architecture you are looking for is not provided under confluent-dep, +please send an email to the xcat-users mailing list: xcat-users@lists.sourceforge.net + + +Install +------- + +*confluent and confluent-deps must be downloaded to the management node before installing* + +xCAT 2.9.1 began shipping a new rpm ``xCAT-confluent``. + +Installing ``xCAT-confluent`` via yum will pull in the confluent dependencies:: + + yum install xCAT-confluent + +You may find it helpful to add the confluent paths into your system path:: + + CONFLUENTROOT=/opt/confluent + export PATH=$CONFLUENTROOT/bin:$PATH + export MANPATH=$CONFLUENTROOT/share/man:$MANPATH + +Configuration +------------- + +Starting/Stopping confluent +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To start confluent:: + + service confluent start + +To stop confluent:: + + service confluent stop + +If you want confluent daemon to start automatically at bootup, add confluent service to ``chkconfig``:: + + chkconfig --add confluent + +Replacing conserver with confluent +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A new keyword, ``consoleservice``, has been added to the xCAT site table to allow the system administrator to control between **conserver** and **confluent**. If ``consoleservice`` is not set, default behavior is to use **conserver**. + +Set the consoleservice to confluent:: + + chdef -t site consoleservice='confluent' + +Run ``makeconfluentcfg`` to create the confluent configuration files:: + + makeconfluentcfg + +Use ``rcons`` as before to start the console session.:: + + rcons + + # If using confluent, a timestamp will be shown on the + # console title next to the node name + [15:05] + + + +Web Browser access +------------------ + +Confluent-api and confluent-consoles are able to be accessed from the browser. +It is **highly** recommended that you create a non-root user to access the sessions:: + + Create the non-root user on the management node + # useradd -m vhu + + Create a non-root user in confetty + # /opt/confluent/bin/confetty create users/vhu + + Set the password for the non-root user + # /opt/confluent/bin/confetty set users/vhu password="mynewpassword" + password="********" + +Rest Explorer +^^^^^^^^^^^^^ + +TODO: some intro text + +Configure the httpd configuration for confluent-api by creating a ``confluent.conf`` file under ``/etc/httpd/conf.d/`` directory:: + + The example uses server ip: 10.2.5.3 and port 4005 + + cat /etc/httpd/conf.d/confluent.conf + LoadModule proxy_http_module modules/mod_proxy_http.so + + ProxyPass http://10.2.5.3:4005 + + + #restart httpd + service httpd restart + +Now point your browser to: ``http://:`` and log in with the non-root user and password created above. + +Confluent consoles +^^^^^^^^^^^^^^^^^^ + +confluent-web is provided in a subdirectory under the confluent project `confluent_web `_ + +Download the content of that directory to ``/var/www/html/confluent`` and point your browser to:: + + http:///confluent/consoles.html + + diff --git a/source/advanced/confluent/index.rst b/source/advanced/confluent/index.rst new file mode 100644 index 000000000..cf9981ad5 --- /dev/null +++ b/source/advanced/confluent/index.rst @@ -0,0 +1,15 @@ +Confluent +========= + +Confluent is a new codebase with a few goals in mind: + +* Augment xCAT 2.X series +* Potentially serve in place of xCAT-server for the next generation of xCAT + +**Disclaimer:** *Confluent code in conjunction with xCAT 2.X is currently BETA, use at your own risk* + + +.. toctree:: + :maxdepth: 2 + + confluent.rst diff --git a/source/advanced/docker/index.rst b/source/advanced/docker/index.rst new file mode 100644 index 000000000..803bb1fee --- /dev/null +++ b/source/advanced/docker/index.rst @@ -0,0 +1,7 @@ +Docker +====== + +Placeholder for Docker related topics + +.. toctree:: + :maxdepth: 2 diff --git a/source/advanced/index.rst b/source/advanced/index.rst new file mode 100644 index 000000000..492e1d0d8 --- /dev/null +++ b/source/advanced/index.rst @@ -0,0 +1,10 @@ +Advanced Topics +=============== + +.. toctree:: + :maxdepth: 2 + + confluent/index + confetty/index + docker/index + mixed_cluster diff --git a/source/advanced/mixed_cluster.rst b/source/advanced/mixed_cluster.rst new file mode 100644 index 000000000..de53a6455 --- /dev/null +++ b/source/advanced/mixed_cluster.rst @@ -0,0 +1,87 @@ +Mixed Cluster Management +======================== + +ppc64 mgmt node +--------------- + +Provision x86_64 (bare metal) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In order to provision x86_64 ipmi-based machines from xCAT management node (ppc64), there are a few required xCAT dependency RPMs that must be installed: + +* ``elilo-xcat`` +* ``xnba-undi`` +* ``syslinux-xcat`` + +Install these RPMs using the following command: :: + + yum install elilo-xcat xnba-undi syslinux-xcat + +On the ppc64 management node, obtain an x86_64 operating system ISO and add it into the xCAT osimage table by using the copycds command: :: + + copycds /tmp/RHEL-6.6-20140926.0-Server-x86_64-dvd1.iso + +Create a node definition for the x86_64 compute node, here is a sample: :: + + lsdef -z c910f04x42 + # + + c910f04x42: + objtype=node + arch=x86_64 + bmc=10.4.42.254 + bmcpassword=PASSW0RD + bmcusername=USERID + chain=runcmd=bmcsetup,shell + cons=ipmi + groups=all + initrd=xcat/osimage/rhels6.6-x86_64-install-compute/initrd.img + installnic=mac + kcmdline=quiet repo=http://!myipfn!:80/install/rhels6.6/x86_64 ks=http://!myipfn!:80/install/autoinst/c910f04x42 ksdevice=34:40:b5:b9:c0:18 cmdline console=tty0 console=ttyS0,115200n8r + kernel=xcat/osimage/rhels6.6-x86_64-install-compute/vmlinuz + mac=34:40:b5:b9:c0:18 + mgt=ipmi + netboot=xnba + nodetype=osi + os=rhels6.6 + profile=compute + provmethod=rhels6.6-x86_64-install-compute + serialflow=hard + serialport=0 + serialspeed=115200 + +Provision the node using the following commands: :: + + # The following prepares the kickstart file in /install/autoinst + nodeset c910f04x42 osimage=rhels6.6-x86_64-install-compute + + # Tells the BIOS to network boot on the next power on + rsetboot c910f04x42 net + + # Reboots the node + rpower c910f04x42 boot + + + +Provision x86_64 (diskless) +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Troubleshooting +^^^^^^^^^^^^^^^ + +**Error:** The following Error message comes out when running nodeset: :: + + Error: Unable to find pxelinux.0 at /opt/xcat/share/xcat/netboot/syslinux/pxelinux.0 + +**Resolution:** + +The syslinux network booting files are missing. +Install the sylinux-xcat package provided in the xcat-deps repository: ``yum -y install syslinux-xcat`` + + + +x86_64 mgmt node +---------------- + +Provision ppc64 compute nodes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 000000000..0883698a2 --- /dev/null +++ b/source/conf.py @@ -0,0 +1,292 @@ +# -*- coding: utf-8 -*- +# +# xCAT documentation build configuration file, created by +# sphinx-quickstart on Thu May 28 14:34:34 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'xCAT' +copyright = u'2015, IBM Corporation' +author = u'IBM Corporation' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.0.1' +# The full version, including alpha/beta/rc tags. +release = '0.0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +import os +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' +if on_rtd: + html_theme = 'default' +else: + # some of the popular themes: alabaster, sphinx_rtd_theme, classic, nature + html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'xCAT3doc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'xCAT3.tex', u'xCAT3 Documentation', + u'IBM Corporation', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'xcat3', u'xCAT3 Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'xCAT3', u'xCAT3 Documentation', + author, 'xCAT3', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/source/developers/git.rst b/source/developers/git.rst new file mode 100644 index 000000000..dfbe1dac6 --- /dev/null +++ b/source/developers/git.rst @@ -0,0 +1,3 @@ +Git +=== + diff --git a/source/developers/index.rst b/source/developers/index.rst new file mode 100644 index 000000000..1c5a3fd99 --- /dev/null +++ b/source/developers/index.rst @@ -0,0 +1,10 @@ +Developers +========== + +This page is for developers interested in working with xCAT. + + +.. toctree:: + :maxdepth: 2 + + git diff --git a/source/guides/admin-guides/index.rst b/source/guides/admin-guides/index.rst new file mode 100644 index 000000000..c0e92c003 --- /dev/null +++ b/source/guides/admin-guides/index.rst @@ -0,0 +1,7 @@ +Admin Guide +=========== + +.. toctree:: + :maxdepth: 1 + + large_clusters/index.rst diff --git a/source/guides/admin-guides/large_clusters/databases/index.rst b/source/guides/admin-guides/large_clusters/databases/index.rst new file mode 100644 index 000000000..30bb788e7 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/index.rst @@ -0,0 +1,40 @@ +Databases +========= + +xCAT Supports the following databases to be used by xCAT on the Management node + +* SQLite +* MySQL/MariaDB +* PostgreSQL +* DB2 + + +SQLite +------ + +SQLite database is the default database used by xCAT and is initialized when xCAT is installed on the management node. + +SQLite is a small, light-weight, daemon-less database that requires no configuration or maintenance. This database is sufficient for small to moderate size systems ( < 1000 nodes ) when xCAT hierarchy (*service nodes*) is not being used. The SQLite database cannot be used for hierarchy because service nodes requires remote access to the database and SQLite does not support remote access. + +For hierarchy, you will need to use one of the following alternate databases. + +MySQL/MariaDB +------------- + +.. toctree:: + :maxdepth: 2 + + mysql_install.rst + mysql_configure.rst + + + +PostgreSQL +---------- + +.. toctree:: + :maxdepth: 2 + + postgres_install.rst + postgres_configure.rst + postgres_tips.rst diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst b/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst new file mode 100644 index 000000000..d607489a1 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst @@ -0,0 +1,2 @@ +Configure MySQL +=============== diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_install.rst b/source/guides/admin-guides/large_clusters/databases/mysql_install.rst new file mode 100644 index 000000000..fb6187306 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/mysql_install.rst @@ -0,0 +1,2 @@ +Install MySQL +============= diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst b/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst new file mode 100644 index 000000000..ad28bd8dd --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst @@ -0,0 +1,9 @@ +Migrate xCAT to use PostgreSQL +============================== + +A utility is provided to migrate an existing xCAT database from SQLite to PostgreSQL. :: + + pgsqlsetup -i -V + +**While not recommended**, if you wish to manually migrate your xCAT database, see the following documentation: +`Manually set up PostgreSQL `_ diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_install.rst b/source/guides/admin-guides/large_clusters/databases/postgres_install.rst new file mode 100644 index 000000000..14671d7f1 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/postgres_install.rst @@ -0,0 +1,34 @@ +Install PostgreSQL +================== + +PostgreSQL packages are shipped as part of most Linux Distributions. + + +Redhat Enterprise Linux +----------------------- + +Using yum, install the requires postgres rpms: :: + + yum install postgresql-libs-* postgresql-server-* postgresql-* + yum install perl-DBD-Pg* + + +Suse Linux Enterprise Server +---------------------------- + +**Note:** On SLES, ``perl-DBD`` packages are provided on the SDK iso images. + +Using zyppr, install the requires postgres rpms: :: + + zyppr install postgresql-libs-* postgresql-server-* postgresql-* + zyppr install perl-DBD-Pg* + + +Debian/Ubuntu +------------- + +Using apt, install the requires postgres packages: :: + + apt install postgresql libdbd-pg-perl + + diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_tips.rst b/source/guides/admin-guides/large_clusters/databases/postgres_tips.rst new file mode 100644 index 000000000..82df8ac42 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/postgres_tips.rst @@ -0,0 +1,53 @@ +PostgreSQL tips +=============== + +Using PostgreSQL +---------------- + +* Connect to the database + +Use the psql command line utility to connect to the PostgreSQL database: :: + + su - postgres + psql -h -U xcatadm -d xcatdb + + +Useful Commands +--------------- + +* Show create statement for a table, for example prescripts table. :: + + /usr/bin/pg_dump xcatdb -U xcatadm -t prescripts + +* Clean up the xcatdb completely from PostgreSQL: :: + + su - postgres + + # drop the xcatdb + dropdb xcatdb + + # remove the xcatadm database owner + dropuser xcatadm + + # clean up the postgresql files (necessary if you want to re-create the database) + cd /var/lib/pgsql/data + rm -rf * + +* List databases: :: + + su - postgres + psql -l + +* Access the database: :: + + su - postgres + psql xcatdb + SELECT * FROM "pg_user"; Select all users + SELECT * FROM "site"; Select the site table + SELECT MAX(recid) from "auditlog"; + SELECT MIN(recid) from "auditlog"; + drop table zvm; Removes a table + \dt Select all tables + \? help + \q exit + diff --git a/source/guides/admin-guides/large_clusters/index.rst b/source/guides/admin-guides/large_clusters/index.rst new file mode 100644 index 000000000..c3c0633e4 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/index.rst @@ -0,0 +1,7 @@ +Managing Large Clusters +======================= + +.. toctree:: + :maxdepth: 2 + + databases/index.rst diff --git a/source/guides/install-guides/apt/index.rst b/source/guides/install-guides/apt/index.rst new file mode 100644 index 000000000..e68d9b3cc --- /dev/null +++ b/source/guides/install-guides/apt/index.rst @@ -0,0 +1,9 @@ +Installation Guide for Ubuntu Server LTS +======================================== + +For the list of currently supported Ubuntu LTS operatin systems, see :ref:`ubuntu-os-support-label`. + +.. toctree:: + :maxdepth: 2 + + ../common/prepare_mgmt_node diff --git a/source/guides/install-guides/common/install_guide.rst b/source/guides/install-guides/common/install_guide.rst new file mode 100644 index 000000000..5402f2fec --- /dev/null +++ b/source/guides/install-guides/common/install_guide.rst @@ -0,0 +1,20 @@ + +.. 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/source/guides/install-guides/common/prepare_mgmt_node.rst b/source/guides/install-guides/common/prepare_mgmt_node.rst new file mode 100644 index 000000000..50935396e --- /dev/null +++ b/source/guides/install-guides/common/prepare_mgmt_node.rst @@ -0,0 +1,76 @@ +Prepare the Management Node for xCAT Installation +================================================= + +These steps prepare the Management Node or xCAT Installation + +Install an OS on the Management Node +------------------------------------ + +The hardware requirements for your xCAT management node largely depends on the size of the cluster you plan to manage and the type of provisioning being used (diskful, diskless, system clones, etc). The majority of system load comes during cluster provisioning. + +**Memory Recommendations:** + ++--------------+-------------+ +| Cluster size | Memory (GB) | ++==============+=============+ +| small (< 16) | 4-6 | ++--------------+-------------+ +| medium | 6-8 | ++--------------+-------------+ +| large | > 16 | ++--------------+-------------+ + +Install any flavor of the supported operating system onto the management node. + +The xCAT software RPMs will attempt to automatially install any base software provided by the Operating System if they are not already installed onto the machine. In order for this to succeed, the node must have a repository set up providing the base operating system packages. + +Configure the Base OS Repository +-------------------------------- + +xCAT uses Linux Package Managers (yum, zypper, apt, etc) 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 + +#. Copy the dvd .iso file onto 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 + +#. Mount the dvd iso to a directory on the management node. :: + + # + # [rhel] 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 + + # + # [sles] 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 + +#. Create the local repository configuration file pointing to mounted iso image. :: + + # + # [rhel] + # + vi /etc/yum/yum.repos.d/rhels71-base.repo + + # + # [sles] + # + vi /etc/zypp/repos.d/sles12-base.repo + + + +# Setting up OS Repository on Mgmt Node + +Disable system services +----------------------- + +Disable the Firewall + + +* Set up Network +* Configure Network Interface Cards (NICs) +* Install the Management Node OS +* Supported OS and Hardware diff --git a/source/guides/install-guides/index.rst b/source/guides/install-guides/index.rst new file mode 100644 index 000000000..773fe4f5a --- /dev/null +++ b/source/guides/install-guides/index.rst @@ -0,0 +1,9 @@ +Install Guides +============== + +.. toctree:: + :maxdepth: 1 + + yum/index + zypper/index + apt/index diff --git a/source/guides/install-guides/yum/configure_xcat.rst b/source/guides/install-guides/yum/configure_xcat.rst new file mode 100644 index 000000000..fbed460e4 --- /dev/null +++ b/source/guides/install-guides/yum/configure_xcat.rst @@ -0,0 +1,2 @@ +Configure xCAT +============== diff --git a/source/guides/install-guides/yum/index.rst b/source/guides/install-guides/yum/index.rst new file mode 100644 index 000000000..ee957176a --- /dev/null +++ b/source/guides/install-guides/yum/index.rst @@ -0,0 +1,11 @@ +Installation Guide for Red Hat Enterprise Linux +=============================================== + +For the list of currently supported RHEL operating systems, see :ref:`rhels-os-support-label`. + +.. toctree:: + :maxdepth: 2 + + prepare_mgmt_node + install_xcat + configure_xcat diff --git a/source/guides/install-guides/yum/install_xcat.rst b/source/guides/install-guides/yum/install_xcat.rst new file mode 100644 index 000000000..b522d4872 --- /dev/null +++ b/source/guides/install-guides/yum/install_xcat.rst @@ -0,0 +1,162 @@ +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: :: + + 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",, + ... + +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/source/guides/install-guides/yum/prepare_mgmt_node.rst b/source/guides/install-guides/yum/prepare_mgmt_node.rst new file mode 100644 index 000000000..356774071 --- /dev/null +++ b/source/guides/install-guides/yum/prepare_mgmt_node.rst @@ -0,0 +1,29 @@ +Prepare the Management Node +=========================== + +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 + + .. include:: ../common/install_guide.rst + :start-after: BEGIN_install_os_mgmt_node + :end-before: END_install_os_mgmt_node + +Configure the Base OS Repository +-------------------------------- + + .. include:: yum_common.rst + :start-after: BEGIN_configure_base_os_repository + :end-before: END_configure_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. + diff --git a/source/guides/install-guides/yum/yum_common.rst b/source/guides/install-guides/yum/yum_common.rst new file mode 100644 index 000000000..8cc72e702 --- /dev/null +++ b/source/guides/install-guides/yum/yum_common.rst @@ -0,0 +1,42 @@ +.. BEGIN_configure_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 + +#. Copy the dvd .iso file onto 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 + +#. Mount the dvd iso to a directory 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 + +#. Create the local repository configuration file pointing to mounted iso image. :: + + cat /etc/yum/yum.repos.d/rhels71-base.repo + [rhel-7-server] + name=RHEL 7 SERVER packages + baseurl=file:///mnt/iso/rhels71/Server + enabled=1 + gpgcheck=1 + + +.. END_configure_base_os_repository + + + + +.. BEGIN_disable_firewall +.. DEPRECATED: Firewall instructions is not applicable after xCAT 2.8 + +The management node provides many services to the cluster nodes. Running a firewall on the management node can interfere with these services. +If your cluster is running on a secure network, the easiest thing to do is disable the firewall on the management node:: + + service iptables stop + service ip6tables stop + +.. END_disable_firewall diff --git a/source/guides/install-guides/zypper/index.rst b/source/guides/install-guides/zypper/index.rst new file mode 100644 index 000000000..d759b76f7 --- /dev/null +++ b/source/guides/install-guides/zypper/index.rst @@ -0,0 +1,11 @@ +Installation Guide for SUSE Linux Enterprise Server +=================================================== + +For the list of currently supported SLES operating systems, see :ref:`sles-os-support-label`. + +.. toctree:: + :maxdepth: 2 + + prepare_mgmt_node + install_xcat + configure_xcat diff --git a/source/guides/install-guides/zypper/sles_support b/source/guides/install-guides/zypper/sles_support new file mode 100644 index 000000000..1972fdce9 --- /dev/null +++ b/source/guides/install-guides/zypper/sles_support @@ -0,0 +1,2 @@ +SLES 11 +SLES 12 LE diff --git a/source/help.rst b/source/help.rst new file mode 100644 index 000000000..a3d59a030 --- /dev/null +++ b/source/help.rst @@ -0,0 +1,5 @@ +Need Help +========= + +If you're having trouble, please email the xcat users mailing list: xcat-user@list.sourceforge.net + diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 000000000..182c78371 --- /dev/null +++ b/source/index.rst @@ -0,0 +1,37 @@ +xCAT stands for E\ **x**\ treme **C**\ loud/\ **C**\ luster **A**\ dministration **T**\ oolkit. + +xCAT offers complete management of clouds, clusters (HPC), grids, datacenters, +renderfarms, online gaming infrastructure, and whatever tomorrows next buzzword may be. + +xCAT enables the administrator to: + + #. provision operating systems on physical (“bare metal”) or virtual machines. + #. provision machines using scripted install, stateless, statelite, iSCSI, or cloning. + #. remotely manage systems (lights out management, remote console support, distributed shell support). + #. quickly configure and control management nodes services: dns, http, dhcp, tftp, nfs, etc. + +**xCAT** is an open source project hosted on `SourceForge `_ and currently mirrored on `GitHub `_. (We hope to be natively hosted on GitHub in the near future) + +Enjoy! + +Content +======= + +.. toctree:: + :maxdepth: 2 + + guides/install-guides/index + guides/admin-guides/index + developers/index + advanced/index + help + notes/index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/source/notes/hw_mgmt/hmc/index.rst b/source/notes/hw_mgmt/hmc/index.rst new file mode 100644 index 000000000..f4db4c3ad --- /dev/null +++ b/source/notes/hw_mgmt/hmc/index.rst @@ -0,0 +1,19 @@ +IBM HMC +======= + +IBM HMC stands for **IBM Hardware Management Console**. + +Details about IBM Hardware Management console can be found on the following links: + +* ``_ +* ``_ + +Blah Blah.... + +**Topics:** + + +.. toctree:: + :maxdepth: 2 + + vioserver diff --git a/source/notes/hw_mgmt/hmc/new_profile.rst b/source/notes/hw_mgmt/hmc/new_profile.rst new file mode 100644 index 000000000..00fc985ba --- /dev/null +++ b/source/notes/hw_mgmt/hmc/new_profile.rst @@ -0,0 +1,122 @@ +$ lspv +NAME PVID VG STATUS +hdisk0 00f60e589feeb90a rootvg active +hdisk1 00f60e58afa65a6e vdiskvg active +hdisk2 00f60e58286f497c vdisk2vg active +hdisk3 00f60e5828740e18 vdisk3vg active +hdisk4 00f60e5828755bf1 vdisk4vg active +hdisk5 00f60e582875fcbd vdisk5vg active +hdisk6 none None +hdisk7 none None + +Create AIX cluster (cluster 4) + +Cluster 1: + c910f02c06p02 - RHELS 6.6 + ... + c910f02c06p08 + +Cluster 2: + c910f02c06p09 - SLES 11.3 + ... + c910f02c06p15 + +Cluster 3: + c910f02c06p16 - RHELS 7.1 + ... + c910f02c06p22 + +c910f02c06p23 - 29 +1 mgmt node +2 service node +4 compute + + +AIX DISK: + +SVSA Physloc Client Partition ID +--------------- -------------------------------------------- ------------------ +vhost21 U8233.E8B.100E58P-V1-C23 0x00000017 + +VTD vtdisk_p23 +Status Available +LUN 0x8100000000000000 +Backing device vg5lv1 +Physloc +Mirrored N/A + +LINUX DISK: + +$ mkvg -help +Usage: mkvg [-f] [-vg VolumeGroup] PhysicalVolume ... + + The mkvg command creates a new volume group, using the physical + volumes represented by the PhysicalVolume parameter. + + -f Forces the volume group to be created on the specified + physical volume + + -vg Specifies the volume group name rather than + having the name generated automatically. + +$ mkvg -vg vdisk6vg hdisk6 +vdisk6vg +0516-1254 mkvg: Changing the PVID in the ODM. + +$ lspv +NAME PVID VG STATUS +hdisk0 00f60e589feeb90a rootvg active +hdisk1 00f60e58afa65a6e vdiskvg active +hdisk2 00f60e58286f497c vdisk2vg active +hdisk3 00f60e5828740e18 vdisk3vg active +hdisk4 00f60e5828755bf1 vdisk4vg active +hdisk5 00f60e582875fcbd vdisk5vg active +hdisk6 00f60e586479d7ec vdisk6vg active +hdisk7 none None + +Create a logical volume of 1GB using 400PP + +$ mklv -help +Usage: mklv [-mirror] [-lv LogicalVolume | -prefix Prefix] + [-type Type] VolumeGroup Size [PhysicalVolume ...] + + Creates a logical volume. + + -mirror Turns on mirroring. + + -lv Specifies the logical volume name to use instead of + using a system-generated name. + + -prefix Specifies the Prefix to use instead of the prefix + in a system-generated name for the new logical + volume. + + -type Sets the logical volume type. + +$ mklv -lv vg6p23 vdisk6vg 400 +vg6p23 + +$ lsvg -lv vdisk6vg +vdisk6vg: +LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT +vg6p23 jfs 400 400 1 closed/syncd N/A + + + +Went into VIOSERVER profile +- create new virtual adapter, and save the profile, number 32 + +Go to the LPAR profile, Virtual Adapter +- duplicated the AIX to Linux +- increased the max virtual adapter to 20 +- assigned the CLIENT SCSI to 12, and set the adapter to 32, which was the new virtual adapter ID created in the virtual server + +Back in the vioserver profile, -> virtual adapter + +- Only selected client partition can connect, select client partition p23 and give it client adapter 12 + +Select "this adapter is required for partition activition" so the "required=yes" + + +lsdev -virtual + diff --git a/source/notes/hw_mgmt/hmc/vioserver.rst b/source/notes/hw_mgmt/hmc/vioserver.rst new file mode 100644 index 000000000..b4751dd32 --- /dev/null +++ b/source/notes/hw_mgmt/hmc/vioserver.rst @@ -0,0 +1,306 @@ +Virtual I/O Server (vioserver) +============================== + +Expand the space of a logical volume +------------------------------------ + +#. SSH into the VIO server: :: + + ssh padmin@ # Default password is padmin + + # If you need to get to the root user, once logged in: + $ oem_setup_env + +#. List out the physical volumes: ``lspv`` :: + + $ lspv + NAME PVID VG STATUS + hdisk0 00f60e599ff13987 rootvg active + hdisk1 00f60e59afa94070 vdiskvg active + +#. List out the volume groups: ``lsvg`` :: + + $ lsvg + rootvg + vdiskvg + +#. Get more information about a specific volume group: ``lsvg `` :: + + $ lsvg vdiskvg + VOLUME GROUP: vdiskvg VG IDENTIFIER: 00f60e5900004c0000000147afa9411f + VG STATE: active PP SIZE: 256 megabyte(s) + VG PERMISSION: read/write TOTAL PPs: 546 (139776 megabytes) + MAX LVs: 256 FREE PPs: 10 (2560 megabytes) + LVs: 29 USED PPs: 536 (137216 megabytes) + OPEN LVs: 29 QUORUM: 2 (Enabled) + TOTAL PVs: 1 VG DESCRIPTORS: 2 + STALE PVs: 0 STALE PPs: 0 + ACTIVE PVs: 1 AUTO ON: yes + MAX PPs per VG: 32512 + MAX PPs per PV: 1016 MAX PVs: 32 + LTG size (Dynamic): 1024 kilobyte(s) AUTO SYNC: no + HOT SPARE: no BB POLICY: relocatable + PV RESTRICTION: none INFINITE RETRY: no + DISK BLOCK SIZE: 512 CRITICAL VG: no + +#. List out the volume groups using the -lv option on lsvg: ``lsvg -lv `` :: + + $ lsvg -lv vdiskvg + vdiskvg: + LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT + vdisk00n02 jfs 160 160 1 open/syncd N/A + vdisk00n03 jfs 160 160 1 open/syncd N/A + vdisk00n04 jfs 40 40 1 open/syncd N/A + vdisk00n05 jfs 40 40 1 open/syncd N/A + vdisk00n06 jfs 40 40 1 open/syncd N/A + vdisk00n07 jfs 4 4 1 open/syncd N/A + vdisk00n08 jfs 4 4 1 open/syncd N/A + vdisk00n09 jfs 4 4 1 open/syncd N/A + vdisk00n10 jfs 4 4 1 open/syncd N/A + .... + vdisk00n29 jfs 4 4 1 open/syncd N/A + vdisk00n30 jfs 4 4 1 open/syncd N/A + +#. The lsvg command shows how many PPs there are in the volume group. + +#. Remove a LV vdev to change from open/syncd to closed/syncd: ``rmvdev -vdev `` :: + + $ rmvdev -vdev vdisk00n30 + vtscsi28 deleted + + $ lsvg -lv vdiskvg + vdiskvg: + LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT + vdisk00n02 jfs 160 160 1 open/syncd N/A + vdisk00n03 jfs 160 160 1 open/syncd N/A + vdisk00n04 jfs 40 40 1 open/syncd N/A + ... + ... + vdisk00n29 jfs 4 4 1 open/syncd N/A + vdisk00n30 jfs 4 4 1 closed/syncd N/A + +#. Now remove the lv using rmlv to free up the PP: ``rmlv `` :: + + $ lsvg vdiskvg | grep FREE + MAX LVs: 256 FREE PPs: 10 (2560 megabytes) + + $ rmlv vdisk00n30 + Warning, all data contained on logical volume vdisk00n30 will be destroyed. + rmlv: Do you wish to continue? y(es) n(o)? y + rmlv: Logical volume vdisk00n30 is removed. + + $ lsvg vdiskvg | grep FREE + MAX LVs: 256 FREE PPs: 14 (3584 megabytes) + + +#. Extend the Logical Volume: :: + + $ extendlv vdisk00n07 40 + + $ lsvg -lv vdiskvg + vdiskvg: + LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT + vdisk00n02 jfs 160 160 1 open/syncd N/A + ... + vdisk00n07 jfs 44 44 1 open/syncd N/A + ... + + +Add a physical volume into a volume group +----------------------------------------- + +#. List out the physical volumes: ``lspv`` :: + + $ lspv + NAME PVID VG STATUS + hdisk0 00f60e599ff13987 rootvg active + hdisk1 00f60e59afa94070 vdiskvg active + hdisk2 none None + hdisk3 none None + hdisk4 none None + hdisk5 none None + hdisk6 none None + hdisk7 none None + +#. Get details for a volume group (VG) using: ``lsvg `` :: + + $ lsvg vdiskvg + VOLUME GROUP: vdiskvg VG IDENTIFIER: 00f60e5900004c0000000147afa9411f + VG STATE: active PP SIZE: 256 megabyte(s) + VG PERMISSION: read/write TOTAL PPs: 546 (139776 megabytes) + MAX LVs: 256 FREE PPs: 18 (4608 megabytes) + LVs: 7 USED PPs: 528 (135168 megabytes) + OPEN LVs: 7 QUORUM: 2 (Enabled) + TOTAL PVs: 1 VG DESCRIPTORS: 2 + STALE PVs: 0 STALE PPs: 0 + ACTIVE PVs: 1 AUTO ON: yes + MAX PPs per VG: 32512 + MAX PPs per PV: 1016 MAX PVs: 32 + LTG size (Dynamic): 1024 kilobyte(s) AUTO SYNC: no + HOT SPARE: no BB POLICY: relocatable + PV RESTRICTION: none INFINITE RETRY: no + DISK BLOCK SIZE: 512 CRITICAL VG: no + +#. Extend the volume group: ``extendvg `` :: + + $ extendvg vdiskvg hdisk2 + Changing the PVID in the ODM. + + Unable to add at least one of the specified physical volumes to the + volume group. The maximum number of physical partitions (PPs) supported + by the volume group must be increased. Use the lsvg command to display + the current maximum number of physical partitions (MAX PPs per PV:) and + chvg -factor to change the value. + + extendvg: Unable to extend volume group. + + $ lspv + NAME PVID VG STATUS + hdisk0 00f60e599ff13987 rootvg active + hdisk1 00f60e59afa94070 vdiskvg active + hdisk2 00f60e59529c77f2 None + hdisk3 none None + hdisk4 none None + hdisk5 none None + hdisk6 none None + hdisk7 none None + + +#. now what?.... +$ lsvg vdiskvg +... +MAX PPs per PV: 1016 MAX PVs: 32 + +$ chvg -factor 2 vdiskvg +$ lsvg vdiskvg +... +MAX PPs per PV: 2032 MAX PVs: 16 + +Now let's take a look at doing the extend... + +$ lsvg vdiskvg +... + +VG PERMISSION: read/write TOTAL PPs: 546 (139776 megabytes) +MAX LVs: 256 FREE PPs: 18 (4608 megabytes) +LVs: 7 USED PPs: 528 (135168 megabytes) + +$ extendvg vdiskvg hdisk2 + +$ lsvg vdiskvg +VG PERMISSION: read/write TOTAL PPs: 1663 (425728 megabytes) +MAX LVs: 256 FREE PPs: 1135 (290560 megabytes) <=== SUCCESS! +LVs: 7 USED PPs: 528 (135168 megabytes) + + +$ lsvg -lv vdiskvg +vdiskvg: +LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT +vdisk00n02 jfs 160 160 1 open/syncd N/A +vdisk00n03 jfs 160 160 1 open/syncd N/A +vdisk00n04 jfs 40 40 1 open/syncd N/A +vdisk00n05 jfs 40 40 1 open/syncd N/A +vdisk00n06 jfs 80 80 1 open/syncd N/A +vdisk00n07 jfs 44 44 1 open/syncd N/A +vdisk00n11 jfs 4 4 1 open/syncd N/A +$ extendlv vdisk00n06 270 + + +Some error messages may contain invalid information +for the Virtual I/O Server environment. + +0516-622 extendlv: Warning, cannot write lv control block data. +0516-622 extendlv: Warning, cannot write lv control block data. +$ lsvg -lv vdiskvg +vdiskvg: +LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT +vdisk00n02 jfs 160 160 1 open/syncd N/A +vdisk00n03 jfs 160 160 1 open/syncd N/A +vdisk00n04 jfs 40 40 1 open/syncd N/A +vdisk00n05 jfs 40 40 1 open/syncd N/A +vdisk00n06 jfs 350 350 2 open/syncd N/A <============ +vdisk00n07 jfs 44 44 1 open/syncd N/A +vdisk00n11 jfs 4 4 1 open/syncd N/A + + +Create multiple SCSI profile for an LPAR +---------------------------------------- + +In this scenario, we are going to create another virtual SCSI profile for our management node ``c910f02c06p23`` so that we are able to switch profiles between AIX and Linux. + +#. The current vhost for the server holding the AIX partition is: :: + + SVSA Physloc Client Partition ID + --------------- -------------------------------------------- ------------------ + vhost21 U8233.E8B.100E58P-V1-C23 0x00000017 + + VTD vtdisk_p23 + Status Available + LUN 0x8100000000000000 + Backing device vg5lv1 + Physloc + Mirrored N/A + +#. Locate a physical volume to create the new volume group for LINUX. :: + + $ lspv + NAME PVID VG STATUS + hdisk0 00f60e589feeb90a rootvg active + hdisk1 00f60e58afa65a6e vdiskvg active + hdisk2 00f60e58286f497c vdisk2vg active + hdisk3 00f60e5828740e18 vdisk3vg active + hdisk4 00f60e5828755bf1 vdisk4vg active + hdisk5 00f60e582875fcbd vdisk5vg active + hdisk6 none None + hdisk7 none None + + Will be using ``hdisk6`` to create the volume group + + +#. Create the new volume group using the ``mkvg`` command: :: + + $ mkvg -vg vdisk6vg hdisk6 + vdisk6vg + 0516-1254 mkvg: Changing the PVID in the ODM. + + Verify the volume group was created: :: + + $ lspv + NAME PVID VG STATUS + hdisk0 00f60e589feeb90a rootvg active + ... + hdisk6 00f60e586479d7ec vdisk6vg active + hdisk7 none None + +#. Create a logical volume of 1GB using 400PP: :: + + $ mklv -lv vg6p23 vdisk6vg 400 + vg6p23 + + $ lsvg -lv vdisk6vg + vdisk6vg: + LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT + vg6p23 jfs 400 400 1 closed/syncd N/A + + + +#. From the HMC GUI: + + +Went into VIOSERVER profile +- create new virtual adapter, and save the profile, number 32 + +Go to the LPAR profile, Virtual Adapter +- duplicated the AIX to Linux +- increased the max virtual adapter to 20 +- assigned the CLIENT SCSI to 12, and set the adapter to 32, which was the new virtual adapter ID created in the virtual server + +Back in the vioserver profile, -> virtual adapter + +- Only selected client partition can connect, select client partition p23 and give it client adapter 12 + +Select "this adapter is required for partition activition" so the "required=yes" + + +lsdev -virtual + diff --git a/source/notes/hw_mgmt/index.rst b/source/notes/hw_mgmt/index.rst new file mode 100644 index 000000000..2ee84fb04 --- /dev/null +++ b/source/notes/hw_mgmt/index.rst @@ -0,0 +1,8 @@ +Hardware Management +=================== + +.. toctree:: + :maxdepth: 2 + + hmc/index + ipmi/index diff --git a/source/notes/hw_mgmt/ipmi/index.rst b/source/notes/hw_mgmt/ipmi/index.rst new file mode 100644 index 000000000..b34542058 --- /dev/null +++ b/source/notes/hw_mgmt/ipmi/index.rst @@ -0,0 +1,9 @@ +IPMI +==== + +IPMI stands for **Intelligent Platform Management Interface**. + + +.. toctree:: + :maxdepth: 2 + diff --git a/source/notes/index.rst b/source/notes/index.rst new file mode 100644 index 000000000..4e4883ebf --- /dev/null +++ b/source/notes/index.rst @@ -0,0 +1,9 @@ +Notes +===== + +This section contains my own personal notes + +.. toctree:: + :maxdepth: 2 + + hw_mgmt/index diff --git a/source/xcat2_support_list.rst b/source/xcat2_support_list.rst new file mode 100644 index 000000000..3ff00cd58 --- /dev/null +++ b/source/xcat2_support_list.rst @@ -0,0 +1,33 @@ +Supported Architectures +======================= + +ppc64 +ppc64le +x86_64 + +Supported Operating Systems +=========================== + +.. _rhels-os-support-label: + +Red Hat Enterprise Linux (RHEL) operating systems +------------------------------------------------- + +* rhels 6.X +* rhels 7.1 (little endian) + +.. _sles-os-support-label: + +Suse Linux Enterprise Server (SLES) operating systems +----------------------------------------------------- + +* sles 11.3 +* sles 12.X + +.. _ubuntu-os-support-label: + +Ubuntu Server LTS +----------------- + +* ubuntu 14.04.1 (ppc64le) +* ubuntu 14.04.2 (ppc64le) From 300de27c3a05291f8081fe8aa5aa26cff7b4d1d7 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 16 Jul 2015 15:30:30 -0400 Subject: [PATCH 02/57] Merge branch 'master' of xcat_doctest From 3a001ce6c8a5dd98f542d94535233e523fb76665 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 16 Jul 2015 15:39:01 -0400 Subject: [PATCH 03/57] Remote the notes section which are more of my own notes for record --- source/index.rst | 1 - source/notes/hw_mgmt/hmc/index.rst | 19 -- source/notes/hw_mgmt/hmc/new_profile.rst | 122 --------- source/notes/hw_mgmt/hmc/vioserver.rst | 306 ----------------------- source/notes/hw_mgmt/index.rst | 8 - source/notes/hw_mgmt/ipmi/index.rst | 9 - source/notes/index.rst | 9 - 7 files changed, 474 deletions(-) delete mode 100644 source/notes/hw_mgmt/hmc/index.rst delete mode 100644 source/notes/hw_mgmt/hmc/new_profile.rst delete mode 100644 source/notes/hw_mgmt/hmc/vioserver.rst delete mode 100644 source/notes/hw_mgmt/index.rst delete mode 100644 source/notes/hw_mgmt/ipmi/index.rst delete mode 100644 source/notes/index.rst diff --git a/source/index.rst b/source/index.rst index 182c78371..5bc6cd81a 100644 --- a/source/index.rst +++ b/source/index.rst @@ -25,7 +25,6 @@ Content developers/index advanced/index help - notes/index Indices and tables diff --git a/source/notes/hw_mgmt/hmc/index.rst b/source/notes/hw_mgmt/hmc/index.rst deleted file mode 100644 index f4db4c3ad..000000000 --- a/source/notes/hw_mgmt/hmc/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -IBM HMC -======= - -IBM HMC stands for **IBM Hardware Management Console**. - -Details about IBM Hardware Management console can be found on the following links: - -* ``_ -* ``_ - -Blah Blah.... - -**Topics:** - - -.. toctree:: - :maxdepth: 2 - - vioserver diff --git a/source/notes/hw_mgmt/hmc/new_profile.rst b/source/notes/hw_mgmt/hmc/new_profile.rst deleted file mode 100644 index 00fc985ba..000000000 --- a/source/notes/hw_mgmt/hmc/new_profile.rst +++ /dev/null @@ -1,122 +0,0 @@ -$ lspv -NAME PVID VG STATUS -hdisk0 00f60e589feeb90a rootvg active -hdisk1 00f60e58afa65a6e vdiskvg active -hdisk2 00f60e58286f497c vdisk2vg active -hdisk3 00f60e5828740e18 vdisk3vg active -hdisk4 00f60e5828755bf1 vdisk4vg active -hdisk5 00f60e582875fcbd vdisk5vg active -hdisk6 none None -hdisk7 none None - -Create AIX cluster (cluster 4) - -Cluster 1: - c910f02c06p02 - RHELS 6.6 - ... - c910f02c06p08 - -Cluster 2: - c910f02c06p09 - SLES 11.3 - ... - c910f02c06p15 - -Cluster 3: - c910f02c06p16 - RHELS 7.1 - ... - c910f02c06p22 - -c910f02c06p23 - 29 -1 mgmt node -2 service node -4 compute - - -AIX DISK: - -SVSA Physloc Client Partition ID ---------------- -------------------------------------------- ------------------ -vhost21 U8233.E8B.100E58P-V1-C23 0x00000017 - -VTD vtdisk_p23 -Status Available -LUN 0x8100000000000000 -Backing device vg5lv1 -Physloc -Mirrored N/A - -LINUX DISK: - -$ mkvg -help -Usage: mkvg [-f] [-vg VolumeGroup] PhysicalVolume ... - - The mkvg command creates a new volume group, using the physical - volumes represented by the PhysicalVolume parameter. - - -f Forces the volume group to be created on the specified - physical volume - - -vg Specifies the volume group name rather than - having the name generated automatically. - -$ mkvg -vg vdisk6vg hdisk6 -vdisk6vg -0516-1254 mkvg: Changing the PVID in the ODM. - -$ lspv -NAME PVID VG STATUS -hdisk0 00f60e589feeb90a rootvg active -hdisk1 00f60e58afa65a6e vdiskvg active -hdisk2 00f60e58286f497c vdisk2vg active -hdisk3 00f60e5828740e18 vdisk3vg active -hdisk4 00f60e5828755bf1 vdisk4vg active -hdisk5 00f60e582875fcbd vdisk5vg active -hdisk6 00f60e586479d7ec vdisk6vg active -hdisk7 none None - -Create a logical volume of 1GB using 400PP - -$ mklv -help -Usage: mklv [-mirror] [-lv LogicalVolume | -prefix Prefix] - [-type Type] VolumeGroup Size [PhysicalVolume ...] - - Creates a logical volume. - - -mirror Turns on mirroring. - - -lv Specifies the logical volume name to use instead of - using a system-generated name. - - -prefix Specifies the Prefix to use instead of the prefix - in a system-generated name for the new logical - volume. - - -type Sets the logical volume type. - -$ mklv -lv vg6p23 vdisk6vg 400 -vg6p23 - -$ lsvg -lv vdisk6vg -vdisk6vg: -LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT -vg6p23 jfs 400 400 1 closed/syncd N/A - - - -Went into VIOSERVER profile -- create new virtual adapter, and save the profile, number 32 - -Go to the LPAR profile, Virtual Adapter -- duplicated the AIX to Linux -- increased the max virtual adapter to 20 -- assigned the CLIENT SCSI to 12, and set the adapter to 32, which was the new virtual adapter ID created in the virtual server - -Back in the vioserver profile, -> virtual adapter - -- Only selected client partition can connect, select client partition p23 and give it client adapter 12 - -Select "this adapter is required for partition activition" so the "required=yes" - - -lsdev -virtual - diff --git a/source/notes/hw_mgmt/hmc/vioserver.rst b/source/notes/hw_mgmt/hmc/vioserver.rst deleted file mode 100644 index b4751dd32..000000000 --- a/source/notes/hw_mgmt/hmc/vioserver.rst +++ /dev/null @@ -1,306 +0,0 @@ -Virtual I/O Server (vioserver) -============================== - -Expand the space of a logical volume ------------------------------------- - -#. SSH into the VIO server: :: - - ssh padmin@ # Default password is padmin - - # If you need to get to the root user, once logged in: - $ oem_setup_env - -#. List out the physical volumes: ``lspv`` :: - - $ lspv - NAME PVID VG STATUS - hdisk0 00f60e599ff13987 rootvg active - hdisk1 00f60e59afa94070 vdiskvg active - -#. List out the volume groups: ``lsvg`` :: - - $ lsvg - rootvg - vdiskvg - -#. Get more information about a specific volume group: ``lsvg `` :: - - $ lsvg vdiskvg - VOLUME GROUP: vdiskvg VG IDENTIFIER: 00f60e5900004c0000000147afa9411f - VG STATE: active PP SIZE: 256 megabyte(s) - VG PERMISSION: read/write TOTAL PPs: 546 (139776 megabytes) - MAX LVs: 256 FREE PPs: 10 (2560 megabytes) - LVs: 29 USED PPs: 536 (137216 megabytes) - OPEN LVs: 29 QUORUM: 2 (Enabled) - TOTAL PVs: 1 VG DESCRIPTORS: 2 - STALE PVs: 0 STALE PPs: 0 - ACTIVE PVs: 1 AUTO ON: yes - MAX PPs per VG: 32512 - MAX PPs per PV: 1016 MAX PVs: 32 - LTG size (Dynamic): 1024 kilobyte(s) AUTO SYNC: no - HOT SPARE: no BB POLICY: relocatable - PV RESTRICTION: none INFINITE RETRY: no - DISK BLOCK SIZE: 512 CRITICAL VG: no - -#. List out the volume groups using the -lv option on lsvg: ``lsvg -lv `` :: - - $ lsvg -lv vdiskvg - vdiskvg: - LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT - vdisk00n02 jfs 160 160 1 open/syncd N/A - vdisk00n03 jfs 160 160 1 open/syncd N/A - vdisk00n04 jfs 40 40 1 open/syncd N/A - vdisk00n05 jfs 40 40 1 open/syncd N/A - vdisk00n06 jfs 40 40 1 open/syncd N/A - vdisk00n07 jfs 4 4 1 open/syncd N/A - vdisk00n08 jfs 4 4 1 open/syncd N/A - vdisk00n09 jfs 4 4 1 open/syncd N/A - vdisk00n10 jfs 4 4 1 open/syncd N/A - .... - vdisk00n29 jfs 4 4 1 open/syncd N/A - vdisk00n30 jfs 4 4 1 open/syncd N/A - -#. The lsvg command shows how many PPs there are in the volume group. - -#. Remove a LV vdev to change from open/syncd to closed/syncd: ``rmvdev -vdev `` :: - - $ rmvdev -vdev vdisk00n30 - vtscsi28 deleted - - $ lsvg -lv vdiskvg - vdiskvg: - LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT - vdisk00n02 jfs 160 160 1 open/syncd N/A - vdisk00n03 jfs 160 160 1 open/syncd N/A - vdisk00n04 jfs 40 40 1 open/syncd N/A - ... - ... - vdisk00n29 jfs 4 4 1 open/syncd N/A - vdisk00n30 jfs 4 4 1 closed/syncd N/A - -#. Now remove the lv using rmlv to free up the PP: ``rmlv `` :: - - $ lsvg vdiskvg | grep FREE - MAX LVs: 256 FREE PPs: 10 (2560 megabytes) - - $ rmlv vdisk00n30 - Warning, all data contained on logical volume vdisk00n30 will be destroyed. - rmlv: Do you wish to continue? y(es) n(o)? y - rmlv: Logical volume vdisk00n30 is removed. - - $ lsvg vdiskvg | grep FREE - MAX LVs: 256 FREE PPs: 14 (3584 megabytes) - - -#. Extend the Logical Volume: :: - - $ extendlv vdisk00n07 40 - - $ lsvg -lv vdiskvg - vdiskvg: - LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT - vdisk00n02 jfs 160 160 1 open/syncd N/A - ... - vdisk00n07 jfs 44 44 1 open/syncd N/A - ... - - -Add a physical volume into a volume group ------------------------------------------ - -#. List out the physical volumes: ``lspv`` :: - - $ lspv - NAME PVID VG STATUS - hdisk0 00f60e599ff13987 rootvg active - hdisk1 00f60e59afa94070 vdiskvg active - hdisk2 none None - hdisk3 none None - hdisk4 none None - hdisk5 none None - hdisk6 none None - hdisk7 none None - -#. Get details for a volume group (VG) using: ``lsvg `` :: - - $ lsvg vdiskvg - VOLUME GROUP: vdiskvg VG IDENTIFIER: 00f60e5900004c0000000147afa9411f - VG STATE: active PP SIZE: 256 megabyte(s) - VG PERMISSION: read/write TOTAL PPs: 546 (139776 megabytes) - MAX LVs: 256 FREE PPs: 18 (4608 megabytes) - LVs: 7 USED PPs: 528 (135168 megabytes) - OPEN LVs: 7 QUORUM: 2 (Enabled) - TOTAL PVs: 1 VG DESCRIPTORS: 2 - STALE PVs: 0 STALE PPs: 0 - ACTIVE PVs: 1 AUTO ON: yes - MAX PPs per VG: 32512 - MAX PPs per PV: 1016 MAX PVs: 32 - LTG size (Dynamic): 1024 kilobyte(s) AUTO SYNC: no - HOT SPARE: no BB POLICY: relocatable - PV RESTRICTION: none INFINITE RETRY: no - DISK BLOCK SIZE: 512 CRITICAL VG: no - -#. Extend the volume group: ``extendvg `` :: - - $ extendvg vdiskvg hdisk2 - Changing the PVID in the ODM. - - Unable to add at least one of the specified physical volumes to the - volume group. The maximum number of physical partitions (PPs) supported - by the volume group must be increased. Use the lsvg command to display - the current maximum number of physical partitions (MAX PPs per PV:) and - chvg -factor to change the value. - - extendvg: Unable to extend volume group. - - $ lspv - NAME PVID VG STATUS - hdisk0 00f60e599ff13987 rootvg active - hdisk1 00f60e59afa94070 vdiskvg active - hdisk2 00f60e59529c77f2 None - hdisk3 none None - hdisk4 none None - hdisk5 none None - hdisk6 none None - hdisk7 none None - - -#. now what?.... -$ lsvg vdiskvg -... -MAX PPs per PV: 1016 MAX PVs: 32 - -$ chvg -factor 2 vdiskvg -$ lsvg vdiskvg -... -MAX PPs per PV: 2032 MAX PVs: 16 - -Now let's take a look at doing the extend... - -$ lsvg vdiskvg -... - -VG PERMISSION: read/write TOTAL PPs: 546 (139776 megabytes) -MAX LVs: 256 FREE PPs: 18 (4608 megabytes) -LVs: 7 USED PPs: 528 (135168 megabytes) - -$ extendvg vdiskvg hdisk2 - -$ lsvg vdiskvg -VG PERMISSION: read/write TOTAL PPs: 1663 (425728 megabytes) -MAX LVs: 256 FREE PPs: 1135 (290560 megabytes) <=== SUCCESS! -LVs: 7 USED PPs: 528 (135168 megabytes) - - -$ lsvg -lv vdiskvg -vdiskvg: -LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT -vdisk00n02 jfs 160 160 1 open/syncd N/A -vdisk00n03 jfs 160 160 1 open/syncd N/A -vdisk00n04 jfs 40 40 1 open/syncd N/A -vdisk00n05 jfs 40 40 1 open/syncd N/A -vdisk00n06 jfs 80 80 1 open/syncd N/A -vdisk00n07 jfs 44 44 1 open/syncd N/A -vdisk00n11 jfs 4 4 1 open/syncd N/A -$ extendlv vdisk00n06 270 - - -Some error messages may contain invalid information -for the Virtual I/O Server environment. - -0516-622 extendlv: Warning, cannot write lv control block data. -0516-622 extendlv: Warning, cannot write lv control block data. -$ lsvg -lv vdiskvg -vdiskvg: -LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT -vdisk00n02 jfs 160 160 1 open/syncd N/A -vdisk00n03 jfs 160 160 1 open/syncd N/A -vdisk00n04 jfs 40 40 1 open/syncd N/A -vdisk00n05 jfs 40 40 1 open/syncd N/A -vdisk00n06 jfs 350 350 2 open/syncd N/A <============ -vdisk00n07 jfs 44 44 1 open/syncd N/A -vdisk00n11 jfs 4 4 1 open/syncd N/A - - -Create multiple SCSI profile for an LPAR ----------------------------------------- - -In this scenario, we are going to create another virtual SCSI profile for our management node ``c910f02c06p23`` so that we are able to switch profiles between AIX and Linux. - -#. The current vhost for the server holding the AIX partition is: :: - - SVSA Physloc Client Partition ID - --------------- -------------------------------------------- ------------------ - vhost21 U8233.E8B.100E58P-V1-C23 0x00000017 - - VTD vtdisk_p23 - Status Available - LUN 0x8100000000000000 - Backing device vg5lv1 - Physloc - Mirrored N/A - -#. Locate a physical volume to create the new volume group for LINUX. :: - - $ lspv - NAME PVID VG STATUS - hdisk0 00f60e589feeb90a rootvg active - hdisk1 00f60e58afa65a6e vdiskvg active - hdisk2 00f60e58286f497c vdisk2vg active - hdisk3 00f60e5828740e18 vdisk3vg active - hdisk4 00f60e5828755bf1 vdisk4vg active - hdisk5 00f60e582875fcbd vdisk5vg active - hdisk6 none None - hdisk7 none None - - Will be using ``hdisk6`` to create the volume group - - -#. Create the new volume group using the ``mkvg`` command: :: - - $ mkvg -vg vdisk6vg hdisk6 - vdisk6vg - 0516-1254 mkvg: Changing the PVID in the ODM. - - Verify the volume group was created: :: - - $ lspv - NAME PVID VG STATUS - hdisk0 00f60e589feeb90a rootvg active - ... - hdisk6 00f60e586479d7ec vdisk6vg active - hdisk7 none None - -#. Create a logical volume of 1GB using 400PP: :: - - $ mklv -lv vg6p23 vdisk6vg 400 - vg6p23 - - $ lsvg -lv vdisk6vg - vdisk6vg: - LV NAME TYPE LPs PPs PVs LV STATE MOUNT POINT - vg6p23 jfs 400 400 1 closed/syncd N/A - - - -#. From the HMC GUI: - - -Went into VIOSERVER profile -- create new virtual adapter, and save the profile, number 32 - -Go to the LPAR profile, Virtual Adapter -- duplicated the AIX to Linux -- increased the max virtual adapter to 20 -- assigned the CLIENT SCSI to 12, and set the adapter to 32, which was the new virtual adapter ID created in the virtual server - -Back in the vioserver profile, -> virtual adapter - -- Only selected client partition can connect, select client partition p23 and give it client adapter 12 - -Select "this adapter is required for partition activition" so the "required=yes" - - -lsdev -virtual - diff --git a/source/notes/hw_mgmt/index.rst b/source/notes/hw_mgmt/index.rst deleted file mode 100644 index 2ee84fb04..000000000 --- a/source/notes/hw_mgmt/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Hardware Management -=================== - -.. toctree:: - :maxdepth: 2 - - hmc/index - ipmi/index diff --git a/source/notes/hw_mgmt/ipmi/index.rst b/source/notes/hw_mgmt/ipmi/index.rst deleted file mode 100644 index b34542058..000000000 --- a/source/notes/hw_mgmt/ipmi/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -IPMI -==== - -IPMI stands for **Intelligent Platform Management Interface**. - - -.. toctree:: - :maxdepth: 2 - diff --git a/source/notes/index.rst b/source/notes/index.rst deleted file mode 100644 index 4e4883ebf..000000000 --- a/source/notes/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Notes -===== - -This section contains my own personal notes - -.. toctree:: - :maxdepth: 2 - - hw_mgmt/index From 262da200ac0763ef6e76d2245fde5c5a52aa8dc5 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 16 Jul 2015 15:53:27 -0400 Subject: [PATCH 04/57] Added some more documentation into the SLES install guide --- source/guides/install-guides/zypper/index.rst | 4 +- .../zypper/prepare_mgmt_node.rst | 29 +++++++++++++ .../install-guides/zypper/zypper_common.rst | 43 +++++++++++++++++++ 3 files changed, 74 insertions(+), 2 deletions(-) create mode 100644 source/guides/install-guides/zypper/prepare_mgmt_node.rst create mode 100644 source/guides/install-guides/zypper/zypper_common.rst diff --git a/source/guides/install-guides/zypper/index.rst b/source/guides/install-guides/zypper/index.rst index d759b76f7..cd3a61a46 100644 --- a/source/guides/install-guides/zypper/index.rst +++ b/source/guides/install-guides/zypper/index.rst @@ -7,5 +7,5 @@ For the list of currently supported SLES operating systems, see :ref:`sles-os-su :maxdepth: 2 prepare_mgmt_node - install_xcat - configure_xcat +.. install_xcat +.. configure_xcat diff --git a/source/guides/install-guides/zypper/prepare_mgmt_node.rst b/source/guides/install-guides/zypper/prepare_mgmt_node.rst new file mode 100644 index 000000000..0ec91c7ea --- /dev/null +++ b/source/guides/install-guides/zypper/prepare_mgmt_node.rst @@ -0,0 +1,29 @@ +Prepare the Management Node +=========================== + +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 + + .. include:: ../common/install_guide.rst + :start-after: BEGIN_install_os_mgmt_node + :end-before: END_install_os_mgmt_node + +Configure the Base OS Repository +-------------------------------- + + .. include:: zypper_common.rst + :start-after: BEGIN_configure_base_os_repository + :end-before: END_configure_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. + diff --git a/source/guides/install-guides/zypper/zypper_common.rst b/source/guides/install-guides/zypper/zypper_common.rst new file mode 100644 index 000000000..1a4678f47 --- /dev/null +++ b/source/guides/install-guides/zypper/zypper_common.rst @@ -0,0 +1,43 @@ +.. BEGIN_configure_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 + +#. Copy the dvd .iso file onto the management node: :: + + mkdir -p /tmp/iso + scp @:/images/iso/sles12/ppc64le/SLE-12-Server-DVD-ppc64le-GM-DVD1.iso /tmp/iso + +#. Mount the dvd iso to a directory 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 + +#. Create the local repository configuration file pointing to mounted iso image. :: + + cat /etc/zypp/repos.d/sles12le-base.repo + [sles-12-le-server] + name=SLES 12 ppc64le Server Packages + baseurl=file:///mnt/iso/sles12/suse + enabled=1 + gpgcheck=1 + + +.. END_configure_base_os_repository + + + + +.. BEGIN_disable_firewall +.. DEPRECATED: Firewall instructions is not applicable after xCAT 2.8 + +The management node provides many services to the cluster nodes. Running a firewall on the management node can interfere with these services. +If your cluster is running on a secure network, the easiest thing to do is disable the firewall on the management node:: + + service iptables stop + service ip6tables stop + +.. END_disable_firewall + From afa1dcbfb64c03a6b096a01226bb6a1a478c646e Mon Sep 17 00:00:00 2001 From: WangXiaoPeng Date: Fri, 17 Jul 2015 03:09:05 -0400 Subject: [PATCH 05/57] add a mini-design entry in the toc --- source/developers/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/developers/index.rst b/source/developers/index.rst index 1c5a3fd99..54053cae3 100644 --- a/source/developers/index.rst +++ b/source/developers/index.rst @@ -8,3 +8,4 @@ This page is for developers interested in working with xCAT. :maxdepth: 2 git + mini-design From f985cc38143b17a77bb55631e81df3b9926f31c0 Mon Sep 17 00:00:00 2001 From: WangXiaoPeng Date: Fri, 17 Jul 2015 03:12:58 -0400 Subject: [PATCH 06/57] add mini-design page --- source/developers/mini-design.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 source/developers/mini-design.rst diff --git a/source/developers/mini-design.rst b/source/developers/mini-design.rst new file mode 100644 index 000000000..9db2513c7 --- /dev/null +++ b/source/developers/mini-design.rst @@ -0,0 +1,16 @@ +The **Design Document** for certain feature. + +**NOTE** +======= + +The documents displayed in this page are not official guides for user to reference. They are just design documents that describe how to implement certain feature. And sometimes they are not updated with the current implementation. + +2.11 +======= + +.. toctree:: + :maxdepth: 2 + + mini-design/2.11/docker + mini-design/2.11/docker-swarm + From 7472d5d1992ffa2936448cd599dafa16bbd968f9 Mon Sep 17 00:00:00 2001 From: WangXiaoPeng Date: Fri, 17 Jul 2015 03:24:42 -0400 Subject: [PATCH 07/57] fix format error --- source/developers/mini-design.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/source/developers/mini-design.rst b/source/developers/mini-design.rst index 9db2513c7..d170ecaff 100644 --- a/source/developers/mini-design.rst +++ b/source/developers/mini-design.rst @@ -1,12 +1,15 @@ +Mini-Design +=========== + The **Design Document** for certain feature. -**NOTE** -======= +NOTE +---- The documents displayed in this page are not official guides for user to reference. They are just design documents that describe how to implement certain feature. And sometimes they are not updated with the current implementation. 2.11 -======= +---- .. toctree:: :maxdepth: 2 From d840538674f8859cabbd09bbba426f612c08c375 Mon Sep 17 00:00:00 2001 From: WangXiaoPeng Date: Fri, 17 Jul 2015 03:28:47 -0400 Subject: [PATCH 08/57] add more for mini-design page --- source/developers/mini-design.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/source/developers/mini-design.rst b/source/developers/mini-design.rst index d170ecaff..3f0b396bb 100644 --- a/source/developers/mini-design.rst +++ b/source/developers/mini-design.rst @@ -3,9 +3,7 @@ Mini-Design The **Design Document** for certain feature. -NOTE ----- - +**NOTE** The documents displayed in this page are not official guides for user to reference. They are just design documents that describe how to implement certain feature. And sometimes they are not updated with the current implementation. 2.11 @@ -17,3 +15,9 @@ The documents displayed in this page are not official guides for user to referen mini-design/2.11/docker mini-design/2.11/docker-swarm +2.10 +---- +.. toctree:: + :maxdepth: 2 + + mini-design/2.10/xcatdebugmode From f4c97b357b372cc88425803a1a5e97b5cc867cae Mon Sep 17 00:00:00 2001 From: WangXiaoPeng Date: Fri, 17 Jul 2015 03:37:37 -0400 Subject: [PATCH 09/57] add more for mini-design page --- source/developers/mini-design.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/developers/mini-design.rst b/source/developers/mini-design.rst index 3f0b396bb..6d81d0c95 100644 --- a/source/developers/mini-design.rst +++ b/source/developers/mini-design.rst @@ -4,7 +4,8 @@ Mini-Design The **Design Document** for certain feature. **NOTE** -The documents displayed in this page are not official guides for user to reference. They are just design documents that describe how to implement certain feature. And sometimes they are not updated with the current implementation. + +*The documents displayed in this page are not official guides for user to reference. They are just design documents that describe how to implement certain feature. And sometimes they are not updated with the current implementation.* 2.11 ---- From b458c037348e02cfcd6d011ddd6c0aced7d9b326 Mon Sep 17 00:00:00 2001 From: WangXiaoPeng Date: Fri, 17 Jul 2015 03:39:41 -0400 Subject: [PATCH 10/57] Add first mini-design doc --- source/developers/mini-design/2.11/docker.rst | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 source/developers/mini-design/2.11/docker.rst diff --git a/source/developers/mini-design/2.11/docker.rst b/source/developers/mini-design/2.11/docker.rst new file mode 100644 index 000000000..39485fa87 --- /dev/null +++ b/source/developers/mini-design/2.11/docker.rst @@ -0,0 +1,33 @@ +Mini-design for Docker Support +============================== + +Overview +======== + +Docker technology is very hot recently, xCAT plans to support it as a way to deploy applictions. + +Interface +========= + +General Command Line +-------------------- + +Will add several new commands to support docker. + +- docker create + + - Create Only + - Start after creating + +- docker stop + +Rest API +-------- + +Add xCAT Rest API to support docker. + +- docker create + +URI - /xcatws//start + + From 52a6b8d5061339f63f9d25c45381d04ceff49a8c Mon Sep 17 00:00:00 2001 From: WangXiaoPeng Date: Fri, 17 Jul 2015 03:53:24 -0400 Subject: [PATCH 11/57] change docker.rst --- source/developers/mini-design.rst | 4 ++-- source/developers/mini-design/2.11/docker.rst | 22 +++++++++++-------- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/source/developers/mini-design.rst b/source/developers/mini-design.rst index 6d81d0c95..b44dd295f 100644 --- a/source/developers/mini-design.rst +++ b/source/developers/mini-design.rst @@ -11,7 +11,7 @@ The **Design Document** for certain feature. ---- .. toctree:: - :maxdepth: 2 + :maxdepth: 1 mini-design/2.11/docker mini-design/2.11/docker-swarm @@ -19,6 +19,6 @@ The **Design Document** for certain feature. 2.10 ---- .. toctree:: - :maxdepth: 2 + :maxdepth: 1 mini-design/2.10/xcatdebugmode diff --git a/source/developers/mini-design/2.11/docker.rst b/source/developers/mini-design/2.11/docker.rst index 39485fa87..054308196 100644 --- a/source/developers/mini-design/2.11/docker.rst +++ b/source/developers/mini-design/2.11/docker.rst @@ -2,31 +2,35 @@ Mini-design for Docker Support ============================== Overview -======== +-------- Docker technology is very hot recently, xCAT plans to support it as a way to deploy applictions. Interface -========= +--------- General Command Line --------------------- +^^^^^^^^^^^^^^^^^^^^ Will add several new commands to support docker. -- docker create +* docker create - - Create Only - - Start after creating + * Create Only + * Start after creating -- docker stop +* docker stop + +Stop the docker container + +* docker remove Rest API --------- +^^^^^^^^ Add xCAT Rest API to support docker. -- docker create +* docker create URI - /xcatws//start From 16b23e6d6a13b779db5d23920e9bd4429edbdc6b Mon Sep 17 00:00:00 2001 From: WangXiaoPeng Date: Fri, 17 Jul 2015 04:23:14 -0400 Subject: [PATCH 12/57] Add a table --- source/developers/mini-design/2.11/docker.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/source/developers/mini-design/2.11/docker.rst b/source/developers/mini-design/2.11/docker.rst index 054308196..128aaf6db 100644 --- a/source/developers/mini-design/2.11/docker.rst +++ b/source/developers/mini-design/2.11/docker.rst @@ -34,4 +34,16 @@ Add xCAT Rest API to support docker. URI - /xcatws//start +:: + #curl + #wget +Add a Table +^^^^^^^^^^^ ++-----------+------------+-------------+ +|Operation |Params |Result | ++===========+============+=============+ +|GET |node |on/off | ++-----------+------------+-------------+ +|PUT |node |on/off | ++-----------+------------+-------------+ From 4d3925462667b64c00353f2921e2e42698dfb10d Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 17 Jul 2015 12:02:36 -0400 Subject: [PATCH 13/57] Added instructions for building confluent_server/confluent_client from source code. Used GitHub is the repository host since we are talking about moving confluent project to be hosted natively on GitHub. --- source/advanced/confluent/confluent.rst | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/source/advanced/confluent/confluent.rst b/source/advanced/confluent/confluent.rst index 050996772..6ce3bce15 100644 --- a/source/advanced/confluent/confluent.rst +++ b/source/advanced/confluent/confluent.rst @@ -8,9 +8,12 @@ Download -------- confluent -^^^^^^^^^ +~~~~~~~~~ -The latest confluent rpms are built and provided for your convenience: `confluent rpms `_ +rpms +^^^^ + +The latest confluent rpms are built and provided for your convenience: `confluent rpms `_. However, the rpms are not built on a regular release schedule. To use the latest code base, consider building the rpms from :ref:`label_confluent_source`. The following example downloads the confluent tar package and creates a local repository on your management node:: @@ -21,9 +24,25 @@ The following example downloads the confluent tar package and creates a local re cd confluent-X.X ./mklocalrepo.sh +.. _label_confluent_source: + +source +^^^^^^ + +To build from source, ensure your development machine has the correct development packages to create rpms, then execute hte following: + + * Clone the git repo: :: + + git clone https://github.com/xcat2/confluent.git + + * Build the ``confluent-server`` and ``confluent-client`` packages: :: + + cd confluent/confluent_server ; ./buildrpm ; cd - + cd confluent/confluent_client ; ./buildrpm ; cd - + confluent-dep -^^^^^^^^^^^^^ +~~~~~~~~~~~~~ The latest confluent dependency packages are provided for your convenience: `confluent-deps `_ From 1533afc0bf04126761890f050020788786dd95a6 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 17 Jul 2015 15:02:23 -0400 Subject: [PATCH 14/57] fix some small wording --- source/advanced/confluent/confluent.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/advanced/confluent/confluent.rst b/source/advanced/confluent/confluent.rst index 6ce3bce15..11c641e6d 100644 --- a/source/advanced/confluent/confluent.rst +++ b/source/advanced/confluent/confluent.rst @@ -29,7 +29,7 @@ The following example downloads the confluent tar package and creates a local re source ^^^^^^ -To build from source, ensure your development machine has the correct development packages to create rpms, then execute hte following: +To build from source, ensure your machine has the correct development packages to build rpms, then execute hte following: * Clone the git repo: :: From 4411de887e4061cd8bce88c6ee0256ce92d69fdd Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 17 Jul 2015 15:02:23 -0400 Subject: [PATCH 15/57] fix some small wording --- source/advanced/confluent/confluent.rst | 2 +- .../install-guides/yum/install_xcat.rst | 47 ++++++++++--------- 2 files changed, 25 insertions(+), 24 deletions(-) diff --git a/source/advanced/confluent/confluent.rst b/source/advanced/confluent/confluent.rst index 6ce3bce15..11c641e6d 100644 --- a/source/advanced/confluent/confluent.rst +++ b/source/advanced/confluent/confluent.rst @@ -29,7 +29,7 @@ The following example downloads the confluent tar package and creates a local re source ^^^^^^ -To build from source, ensure your development machine has the correct development packages to create rpms, then execute hte following: +To build from source, ensure your machine has the correct development packages to build rpms, then execute hte following: * Clone the git repo: :: diff --git a/source/guides/install-guides/yum/install_xcat.rst b/source/guides/install-guides/yum/install_xcat.rst index b522d4872..73726d840 100644 --- a/source/guides/install-guides/yum/install_xcat.rst +++ b/source/guides/install-guides/yum/install_xcat.rst @@ -1,27 +1,27 @@ Install xCAT ============ -xCAT consists of two software packages: +xCAT consists of two software packages: + +#. **xcat-core** xCAT's main software package. -#. **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. +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 ---------------------------------- @@ -29,7 +29,7 @@ Configure xCAT Software Repository Public Internet Repository ~~~~~~~~~~~~~~~~~~~~~~~~~~ -TODO: Need to fill this out +TODO: Need to fill this out Locally Configured Repository ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -39,13 +39,13 @@ From the xCAT software download page: ` Date: Mon, 20 Jul 2015 15:38:30 +0800 Subject: [PATCH 16/57] fixe docker.rsct fix a typo --- source/developers/mini-design/2.11/docker.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/developers/mini-design/2.11/docker.rst b/source/developers/mini-design/2.11/docker.rst index 128aaf6db..fe9589fbc 100644 --- a/source/developers/mini-design/2.11/docker.rst +++ b/source/developers/mini-design/2.11/docker.rst @@ -16,7 +16,7 @@ Will add several new commands to support docker. * docker create - * Create Only + * Create only * Start after creating * docker stop From 771531161eeed4f99df05242721804d84131c790 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 21 Jul 2015 13:13:26 -0400 Subject: [PATCH 17/57] Rearrange the confluent related pages to be under one topic Under Advanced topics, confluent was split to two separate topics: - confluent - confetty To keep things together better, create a main confluent bullet, underneath: confluent -> confluent_server confetty -> confluent_client --- source/advanced/confetty/index.rst | 9 ------- .../client/confluent_client.rst} | 1 - source/advanced/confluent/client/index.rst | 7 +++++ source/advanced/confluent/index.rst | 3 ++- .../confluent_server.rst} | 27 ++++++++++--------- source/advanced/confluent/server/index.rst | 8 ++++++ source/advanced/index.rst | 1 - 7 files changed, 31 insertions(+), 25 deletions(-) delete mode 100644 source/advanced/confetty/index.rst rename source/advanced/{confetty/confetty.rst => confluent/client/confluent_client.rst} (99%) create mode 100644 source/advanced/confluent/client/index.rst rename source/advanced/confluent/{confluent.rst => server/confluent_server.rst} (96%) create mode 100644 source/advanced/confluent/server/index.rst diff --git a/source/advanced/confetty/index.rst b/source/advanced/confetty/index.rst deleted file mode 100644 index ff9cf2779..000000000 --- a/source/advanced/confetty/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Confetty -========= - -Confetty is a client to confluent server - -.. toctree:: - :maxdepth: 2 - - confetty.rst diff --git a/source/advanced/confetty/confetty.rst b/source/advanced/confluent/client/confluent_client.rst similarity index 99% rename from source/advanced/confetty/confetty.rst rename to source/advanced/confluent/client/confluent_client.rst index 2ff9555f4..1c1bfe5b2 100644 --- a/source/advanced/confetty/confetty.rst +++ b/source/advanced/confluent/client/confluent_client.rst @@ -1,5 +1,4 @@ - Starting the confetty client ============================ diff --git a/source/advanced/confluent/client/index.rst b/source/advanced/confluent/client/index.rst new file mode 100644 index 000000000..8058d7437 --- /dev/null +++ b/source/advanced/confluent/client/index.rst @@ -0,0 +1,7 @@ +confluent-client +================ + +.. toctree:: + :maxdepth: 2 + + confluent_client.rst diff --git a/source/advanced/confluent/index.rst b/source/advanced/confluent/index.rst index cf9981ad5..dc8bb7737 100644 --- a/source/advanced/confluent/index.rst +++ b/source/advanced/confluent/index.rst @@ -12,4 +12,5 @@ Confluent is a new codebase with a few goals in mind: .. toctree:: :maxdepth: 2 - confluent.rst + server/index.rst + client/index.rst diff --git a/source/advanced/confluent/confluent.rst b/source/advanced/confluent/server/confluent_server.rst similarity index 96% rename from source/advanced/confluent/confluent.rst rename to source/advanced/confluent/server/confluent_server.rst index 11c641e6d..abda9882f 100644 --- a/source/advanced/confluent/confluent.rst +++ b/source/advanced/confluent/server/confluent_server.rst @@ -1,17 +1,18 @@ + Getting Started ---------------- +=============== For xCAT 2.9.1 and later, confluent is intended to be used in conjunction with xCAT. The following documentation assumes that xCAT is already installed and configured on the management node. Download --------- +======== confluent -~~~~~~~~~ +--------- rpms -^^^^ +~~~~ The latest confluent rpms are built and provided for your convenience: `confluent rpms `_. However, the rpms are not built on a regular release schedule. To use the latest code base, consider building the rpms from :ref:`label_confluent_source`. @@ -27,7 +28,7 @@ The following example downloads the confluent tar package and creates a local re .. _label_confluent_source: source -^^^^^^ +~~~~~~ To build from source, ensure your machine has the correct development packages to build rpms, then execute hte following: @@ -42,7 +43,7 @@ To build from source, ensure your machine has the correct development packages t confluent-dep -~~~~~~~~~~~~~ +------------- The latest confluent dependency packages are provided for your convenience: `confluent-deps `_ @@ -60,7 +61,7 @@ please send an email to the xcat-users mailing list: xcat-users@lists.sourceforg Install -------- +======= *confluent and confluent-deps must be downloaded to the management node before installing* @@ -77,10 +78,10 @@ You may find it helpful to add the confluent paths into your system path:: export MANPATH=$CONFLUENTROOT/share/man:$MANPATH Configuration -------------- +============= Starting/Stopping confluent -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +--------------------------- To start confluent:: @@ -95,7 +96,7 @@ If you want confluent daemon to start automatically at bootup, add confluent ser chkconfig --add confluent Replacing conserver with confluent -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---------------------------------- A new keyword, ``consoleservice``, has been added to the xCAT site table to allow the system administrator to control between **conserver** and **confluent**. If ``consoleservice`` is not set, default behavior is to use **conserver**. @@ -118,7 +119,7 @@ Use ``rcons`` as before to start the console session.:: Web Browser access ------------------- +================== Confluent-api and confluent-consoles are able to be accessed from the browser. It is **highly** recommended that you create a non-root user to access the sessions:: @@ -134,7 +135,7 @@ It is **highly** recommended that you create a non-root user to access the sessi password="********" Rest Explorer -^^^^^^^^^^^^^ +============= TODO: some intro text @@ -154,7 +155,7 @@ Configure the httpd configuration for confluent-api by creating a ``confluent.co Now point your browser to: ``http://:`` and log in with the non-root user and password created above. Confluent consoles -^^^^^^^^^^^^^^^^^^ +================== confluent-web is provided in a subdirectory under the confluent project `confluent_web `_ diff --git a/source/advanced/confluent/server/index.rst b/source/advanced/confluent/server/index.rst new file mode 100644 index 000000000..4af5f08c1 --- /dev/null +++ b/source/advanced/confluent/server/index.rst @@ -0,0 +1,8 @@ +confluent-server +================ + + +.. toctree:: + :maxdepth: 2 + + confluent_server.rst diff --git a/source/advanced/index.rst b/source/advanced/index.rst index 492e1d0d8..390ccab1f 100644 --- a/source/advanced/index.rst +++ b/source/advanced/index.rst @@ -5,6 +5,5 @@ Advanced Topics :maxdepth: 2 confluent/index - confetty/index docker/index mixed_cluster From 7f7bbf39f411a2616ce31279858709927051c806 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 21 Jul 2015 14:47:38 -0400 Subject: [PATCH 18/57] Clean up some wording in postgres install page --- .../guides/admin-guides/large_clusters/databases/index.rst | 6 ++++-- .../large_clusters/databases/postgres_install.rst | 6 +++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/source/guides/admin-guides/large_clusters/databases/index.rst b/source/guides/admin-guides/large_clusters/databases/index.rst index 30bb788e7..f89770eac 100644 --- a/source/guides/admin-guides/large_clusters/databases/index.rst +++ b/source/guides/admin-guides/large_clusters/databases/index.rst @@ -14,9 +14,11 @@ SQLite SQLite database is the default database used by xCAT and is initialized when xCAT is installed on the management node. -SQLite is a small, light-weight, daemon-less database that requires no configuration or maintenance. This database is sufficient for small to moderate size systems ( < 1000 nodes ) when xCAT hierarchy (*service nodes*) is not being used. The SQLite database cannot be used for hierarchy because service nodes requires remote access to the database and SQLite does not support remote access. +SQLite is a small, light-weight, daemon-less database that requires no configuration or maintenance. This database is sufficient for small to moderate size systems ( < 1000 nodes ) -For hierarchy, you will need to use one of the following alternate databases. +**The SQLite database can NOT be used for xCAT hierarchy support because service nodes requires remote access to the database and SQLite does NOT support remote access.** + +For xCAT hierarchy, you will need to use one of the following alternate databases: MySQL/MariaDB ------------- diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_install.rst b/source/guides/admin-guides/large_clusters/databases/postgres_install.rst index 14671d7f1..cf26bbc6d 100644 --- a/source/guides/admin-guides/large_clusters/databases/postgres_install.rst +++ b/source/guides/admin-guides/large_clusters/databases/postgres_install.rst @@ -7,7 +7,7 @@ PostgreSQL packages are shipped as part of most Linux Distributions. Redhat Enterprise Linux ----------------------- -Using yum, install the requires postgres rpms: :: +Using yum, install the following rpms: :: yum install postgresql-libs-* postgresql-server-* postgresql-* yum install perl-DBD-Pg* @@ -18,7 +18,7 @@ Suse Linux Enterprise Server **Note:** On SLES, ``perl-DBD`` packages are provided on the SDK iso images. -Using zyppr, install the requires postgres rpms: :: +Using zyppr, install the following rpms: :: zyppr install postgresql-libs-* postgresql-server-* postgresql-* zyppr install perl-DBD-Pg* @@ -27,7 +27,7 @@ Using zyppr, install the requires postgres rpms: :: Debian/Ubuntu ------------- -Using apt, install the requires postgres packages: :: +Using apt, install the following packages: :: apt install postgresql libdbd-pg-perl From 6139856fdd6d6dbb8cb963b2f90b337720dfae9a Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 21 Jul 2015 16:50:24 -0400 Subject: [PATCH 19/57] Refactor the mini-design directory area Put the mini-design.rst to an index.rst under mini-design directory create a skeleton page for docker-swarm as a placeholder --- source/developers/index.rst | 2 +- source/developers/mini-design/2.11/docker-swarm.rst | 2 ++ .../developers/{mini-design.rst => mini-design/index.rst} | 6 +++--- 3 files changed, 6 insertions(+), 4 deletions(-) create mode 100644 source/developers/mini-design/2.11/docker-swarm.rst rename source/developers/{mini-design.rst => mini-design/index.rst} (80%) diff --git a/source/developers/index.rst b/source/developers/index.rst index 54053cae3..d2fc91a32 100644 --- a/source/developers/index.rst +++ b/source/developers/index.rst @@ -8,4 +8,4 @@ This page is for developers interested in working with xCAT. :maxdepth: 2 git - mini-design + mini-design/index.rst diff --git a/source/developers/mini-design/2.11/docker-swarm.rst b/source/developers/mini-design/2.11/docker-swarm.rst new file mode 100644 index 000000000..dc44c4c66 --- /dev/null +++ b/source/developers/mini-design/2.11/docker-swarm.rst @@ -0,0 +1,2 @@ +Mini-design for Docker Swarm Support +==================================== diff --git a/source/developers/mini-design.rst b/source/developers/mini-design/index.rst similarity index 80% rename from source/developers/mini-design.rst rename to source/developers/mini-design/index.rst index b44dd295f..35b63f803 100644 --- a/source/developers/mini-design.rst +++ b/source/developers/mini-design/index.rst @@ -13,12 +13,12 @@ The **Design Document** for certain feature. .. toctree:: :maxdepth: 1 - mini-design/2.11/docker - mini-design/2.11/docker-swarm + 2.11/docker.rst + 2.11/docker-swarm.rst 2.10 ---- .. toctree:: :maxdepth: 1 - mini-design/2.10/xcatdebugmode + 2.10/xcatdebugmode.rst From b80d9104fec881fd5755abbb32049a791dc15159 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 21 Jul 2015 17:15:42 -0400 Subject: [PATCH 20/57] Adding more content into configure postgres instructions --- .../databases/postgres_configure.rst | 28 ++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst b/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst index ad28bd8dd..ad4f75d77 100644 --- a/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst +++ b/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst @@ -1,5 +1,8 @@ +Configure PostgreSQL +==================== + Migrate xCAT to use PostgreSQL -============================== +------------------------------ A utility is provided to migrate an existing xCAT database from SQLite to PostgreSQL. :: @@ -7,3 +10,26 @@ A utility is provided to migrate an existing xCAT database from SQLite to Postgr **While not recommended**, if you wish to manually migrate your xCAT database, see the following documentation: `Manually set up PostgreSQL `_ + +Setting up the Service Nodes +---------------------------- + +For service nodes, add the IP address of each service nodes to the postgres configuration file: ``/var/lib/pgsql/data/pg_hba.conf`` + +If you had the following two service nodes: :: + + sn10 192.168.1.10 + sn11 192.168.1.11 + +You would add the following to ``/var/lib/pgsql/data/pg_hba.conf`` :: + + host all all 11.16.1.230/32 md5 + host all all 11.16.2.230/32 md5 + +Restart PostgreSQL after editing the file: :: + + service postgresql restart + + +For more information about changing the ``pg_hab.conf`` file and ``postgresql.conf`` files, see the following documentation: +`Setup the PostgreSQL Configuraion Files `_ From c7fb87853edfb5958e41e0685d01a31b5b51fd55 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 21 Jul 2015 17:22:09 -0400 Subject: [PATCH 21/57] Fix the IP address in the sample text --- .../large_clusters/databases/postgres_configure.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst b/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst index ad4f75d77..52db88e00 100644 --- a/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst +++ b/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst @@ -18,13 +18,14 @@ For service nodes, add the IP address of each service nodes to the postgres conf If you had the following two service nodes: :: - sn10 192.168.1.10 - sn11 192.168.1.11 + + sn10, ip: 192.168.1.10 with netmask 255.255.255.0 + sn11, ip: 192.168.1.11 with netmask 255.255.255.0 You would add the following to ``/var/lib/pgsql/data/pg_hba.conf`` :: - host all all 11.16.1.230/32 md5 - host all all 11.16.2.230/32 md5 + host all all 192.168.1.10/24 md5 + host all all 192.168.1.11/24 md5 Restart PostgreSQL after editing the file: :: From 8c0ccb40b960b5312f3b524efe473538f5c48c77 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Wed, 22 Jul 2015 15:48:09 -0400 Subject: [PATCH 22/57] Add the contributor and maintainer license pages into the new documentation Initial pass of creating the license agreements for working on xcat project. Content taken from: https://sourceforge.net/p/xcat/wiki/XCAT_Developer_Guide/#contributor-and-maintainer-agreements references are changed to reflect a GitHub based development environment --- source/developers/git.rst | 3 - source/developers/git/index.rst | 14 +++ source/developers/index.rst | 3 +- .../license/contributor_license_agreement.rst | 9 ++ source/developers/license/index.rst | 52 +++++++++ .../xcat-project-maintainer-agreement.pdf | Bin 0 -> 10298 bytes ...orporate_contributor_license_agreement.rst | 100 ++++++++++++++++++ ...dividual_contributor_license_agreement.rst | 68 ++++++++++++ .../xcat_maintainer_license_agreement.rst | 68 ++++++++++++ 9 files changed, 313 insertions(+), 4 deletions(-) delete mode 100644 source/developers/git.rst create mode 100644 source/developers/git/index.rst create mode 100644 source/developers/license/contributor_license_agreement.rst create mode 100644 source/developers/license/index.rst create mode 100644 source/developers/license/xcat-project-maintainer-agreement.pdf create mode 100644 source/developers/license/xcat_corporate_contributor_license_agreement.rst create mode 100644 source/developers/license/xcat_individual_contributor_license_agreement.rst create mode 100644 source/developers/license/xcat_maintainer_license_agreement.rst diff --git a/source/developers/git.rst b/source/developers/git.rst deleted file mode 100644 index dfbe1dac6..000000000 --- a/source/developers/git.rst +++ /dev/null @@ -1,3 +0,0 @@ -Git -=== - diff --git a/source/developers/git/index.rst b/source/developers/git/index.rst new file mode 100644 index 000000000..6569733ad --- /dev/null +++ b/source/developers/git/index.rst @@ -0,0 +1,14 @@ +Git +=== + +xCAT uses git for source code version control. There are many resources and documentation available to help you learn git. A great place to start would be: http://git-scm.com/doc + +* https://training.github.com/kit/downloads/github-git-cheat-sheet.pdf + + + + +.. toctree:: + :maxdepth: 1 + + diff --git a/source/developers/index.rst b/source/developers/index.rst index d2fc91a32..67fe4b126 100644 --- a/source/developers/index.rst +++ b/source/developers/index.rst @@ -7,5 +7,6 @@ This page is for developers interested in working with xCAT. .. toctree:: :maxdepth: 2 - git + license/index.rst + git/index.rst mini-design/index.rst diff --git a/source/developers/license/contributor_license_agreement.rst b/source/developers/license/contributor_license_agreement.rst new file mode 100644 index 000000000..1c9ffcaa2 --- /dev/null +++ b/source/developers/license/contributor_license_agreement.rst @@ -0,0 +1,9 @@ +.. _xcat-contributor-license-label: + +xCAT Contributor License Agreement +================================== + +For **one** of the following agreements, print it, fill it out, sign it, scan it, and email it to: xcat-legal@lists.sourceforge.net. + +* :ref:`xcat-individual-contributor-license-label` +* :ref:`xcat-corporate-contributor-license-label` diff --git a/source/developers/license/index.rst b/source/developers/license/index.rst new file mode 100644 index 000000000..824edd3b0 --- /dev/null +++ b/source/developers/license/index.rst @@ -0,0 +1,52 @@ +Contributor and Maintainer Agreements +===================================== + +xCAT 2 is licensed under the `Eclipse Public License `_. All contributions to xCAT must be licensed to xCAT pursuant to the referenced :ref:`xcat-contributor-license-label`. + +Contributor +----------- + +We welcome new developers willing to contribute to the xCAT code to make it better. In order to do that, you need to: + + * License your contribution(s) pursuant to the :ref:`xcat-contributor-license-label`. + * Decide if you want to sign the contributor license agreement as an individual or as a corporate. The **individual license agreement** allows the individual contributor to submit contributions to the xCAT community. The **corporate contributor license agreement** allows an entity (the "Corporation") to submit contributions to the xCAT Community. + * Print the :ref:`xcat-individual-contributor-license-label` or :ref:`xcat-corporate-contributor-license-label`, fill it out, sign it, scan it, then email it to: xcat-legal@lists.sourceforge.net. + * After submitting the signed license agreement, you can fork the xcat project, make changes, and submit pull requests so they can be integrated into the xCAT code stream. + * If you are an experienced xCAT user and plan to contribute to the xCAT code regularly, request to become a Maintainer with Git push access. See the section below for details. + +Maintainer +---------- + +If you are an experienced xCAT user and plan to contribute to the xCAT code regularly, you can request to become an xCAT Maintainer (which includes git push access) by posting to the xCAT mailing list. + +If you are approved to become an xCAT maintainer, you must print the agreement :download:`xCAT Maintainer License Agreement `, fill it out and sign it, scan it in, and email it to xcat-legal@lists.sourceforge.net . + +The roles and responsibilities of the maintainers are: + + * set the direction for the xCAT project, including architectural and design decisions + * commit code (new function or fixes) to the xCAT GitHub repository (either their own code, or on behalf of another contributor - see below) + * review requests for xCAT members to become maintainers (All such requests will be subject to a vote of current maintainers. Consensus of current maintainers is required for approval.) + * review and help resolve technical concerns or problems regarding the project + +All decisions by the maintainers are made by consensus. + +When a maintainer pushes code to the xCAT GitHub repository for another contributor (i.e. **not** your own code), they must: + + * Require that each code contributor sign the :ref:`xcat-individual-contributor-license-label` or :ref:`xcat-corporate-contributor-license-label` and email it to xcat-legal@lists.sourceforge.net . + * Require that all code be contributed under the EPL. + * Create a log entry with intellectual property information about the contribution & contributor. Each log entry should contain the information below, and should be posted to xcat-legal@lists.sourceforge.net: :: + + Maintainer Name: (the person who committed the code to the xCAT GitHub repository) + Maintainer Sourceforge Id: + Contributor Name: (the author of the code) + Contributor's Organization or Employer (if the contribution was made on the organization's/employer's behalf): + Contributor Sourceforge Id: + GitHub Id of This Code PUSH: + Date Code was Committed: + Purpose/Description of New/Changed Code: + Approximate Number of Lines of Code Added/Changed/Removed by This Commit: + Additional Authors of the Contributed Code: + License Used (if other than EPL, need approval from the xCAT Maintainers): + Code Reviewed By (usually the maintainer who commits it): + + diff --git a/source/developers/license/xcat-project-maintainer-agreement.pdf b/source/developers/license/xcat-project-maintainer-agreement.pdf new file mode 100644 index 0000000000000000000000000000000000000000..045704a4e685af9f95db07c3cb45f6e527368020 GIT binary patch literal 10298 zcmc(F2|QG7`#(uScG*HxvLwvD$-eKqB*b7amKn{AEr~375-pa8vOZCi5?LcekxE6@ zlr5q}C`&5(pF^IfGVlBT-p}X%`}}4;XU=`D`?~Jy`d;@r_wqd>ZK0#52vvVZAt(c zXa{Oca;G^!kYIC8ke}^9(FQvpKq?WiTZ_<&NTUQ$-H0^6zaE852TyRwT4;I*2p()y zO%19WOxL%j6X-;sUf&uE!Gdz2goEIIXjo7wZq`J)0~AOU)P@*LhZ_0;nb2B0X|J6O z!T6w>WHN;gL<|RWXa#|5x|0Z6lwb#-76w7%(Mm`J1c!nv;So*{05q8n zginK@Kx3#rl@j0&1hv`)s~1pfs121srul;~-9n(+)=(W{AjyqrrLP4zw;{OF0F|}Q zSW5*B0{b~@V8iQK(7~cBS_7lJ?A0K72GpG}eCDNwqPjawnDYGCNy$;Lm~W_i8G~J$qKB z8+0e@Ih3g1zedo$KMFm&bF#)N;HGDbqTGi_FNZ53%T7q+_3zBsPM&|dY7s#gl`{pu&M=e5ID+R3=|hP?ZiWn!q7VnSDMWZY<+Z!6g= zxjok&gYjm~eH|i7)wp~8K3-vTpboEIvpf=A^)9ihO8jwS3vU2(N@;#B!aW5Ax3J$F z_~yjbvQK>)8DD)O2Tw#zx5sZ{Q$O$N~w_xWpmgq09fLD|+8#+T+1QRP>~;nSkbaqL>bPi}P1? zI?MIfgWTKAy^G^f*@e8R=2j^P0r{|}XhitweG;<{M#^$*!|u8KAJ2Ul+I4~Hk#m>e zc^|=G%#_Ouf-AJ6$Ull38Cb)2n2r6Li}$;pPo?$dQr;!*I2-xZ^No35s#)jtONsZk60;PoyuJpUeyv*5F=`EZ2ygqTe-`9fOL(zVZ zDmO>FzA{dg5w+nkB*nS;^v7}M`uca9$rLo{w#aBCKqD@~{X{$GhJ3zz-apGFa_z+; z8~rQaORHVG71VH1#lDy;wfUp-(M|OY^WLW%YYvB<=ncLDx43cTY`B*Gb@uCD^ky_8 z2M>K(NH9uBIdR#iEe>ytw|2^Sd>zeWm+v*d!$5we@rw5O6jt3N2Oid`f#?30ChuP; zWV@|XDwR?tA~>t0t%Z#lwG_Q_TXg~1EPpyrJjf`_-BfV=jqk2Wg#%sM9ed)99AX|@ zG<76yY8C8CkP>g>4HO=Z;?>uKQ02>$=F^XCjlYcAQxOS2yj4#%NEbHI(6i#KF_O{( zA1K--XZ^-~aHQU8M}dN31NT01g9Mc&Ed4=0OSH{m%%ArL{O_HeC5zqC9xTg$byZ5DX8-1GMk{iq!avs5R8E9>q`zy(uCjp{) zc^26vXW)KNNibBQ^0K`^n$M#J)M>3|GZv)NRui{As>?(}%ef=tvH@F|X)E`?sO^@nuIk#^8P>cCZ}a1&lMgMD9z04qKTJ%za6I{H z4~nm_`ijY(j$Tf;$0Y@+O&qy-URi{@XB?hvtu@Qs{r36vksiXMJoCckSp(|b5Rdnm@X+1Wp!lRo)#Q$7~ z>WN;ysOD)k^DrazS!^xd4?daD&=Y0f#??eR4@=M|+>aO7H4#)E`}L7rpFZ2s{u{DK z4u%`p>J3`!1bj_UqrU$twNx7vm4&(0`2Cfm^u_TU1)`AN?He%%D!0oy1hScz?48hv z__mbSL65CzR;oT2 zNqV#jc_rjSF(=zQI=m1K+c~qyCJqa9)z5w5QTcC{EhD)D5VB`flb^7PzTb1@nn2f% zfIFrKHCc}4rm77ieZuM!VRqIs+7QKWD+dQztwq1#Yr4{# zE<{=@hSD-7%JTcdw9itch`F8Ra73dH6b^Sdb%`Dpeh2QIc}nJzT{%tA!-~cF(U}C1 zm+wD}YaA+|ara4PRu>qklAM(Hy+CoDZtWH=7Qd8taH7ya((;C`RI$~#d_rb^*TZ;@ zE6X>m0^$aaed;Y^gRp(-Z46G!t8n)zCeGg9Tq12GQ|fg)LJ_#leA}Zk?aOu>d1qC& zy-#qltK{B!?8}9lRq>@Vf$xGTg|K4wIp)90DC&+=_<-siUt99KrN^xbT6e-6EX#%- z91^q#aq(vhF$?qebj{Dct%+7I<%m@Q+wdD*vpZ7a~cQ4d{t}D);NpSkA(}~ zzmrkL!*?5^MBHV5J>)d6=QbfHALU!6)-PLjo%&pG(h~V-&lbN5MNPEWeB5;L+}+WV zXjfW<6_01*(y8JX6HL*Nqx*zw8&?A4&y0J$JFNI(s=md)gV`u{I4E-FbPeX=Xhq?h z2;+lkDRJ!ASsY)DLDle+IHR)eIaAeuYjpPAz$uBS1<3bShvf;V#$YU^jMp`WK!fu8(!av{_MK9kGW33uFOup z?m%)W&qbURkmbSAo6%*V#BfL0sOr#0`=*Q62^s*`h3B_gV!_F+jc>HAO& z;?ELWM<3+3O~bpfzMpjMPl%kxk^S3kTPPtUN_)Uo3D0eXFrVuSTwh|hM!!py3NOJ` z`}1_E`kjjsQNPan^}&tf7pR3vU;mhye;9V3#Pi5Cv-M3_bT1C4Zt7O;Da~}K({5tZ zwIeBz-1ja5J@2wClg=DPVS0907IBljbHlycgC6Xv=}K61348$YFsf%WwqN#nRN2`q zh{ls~8E$&)Hn__-9;4;z$GnBiIZQEQ;l|~`J#14Fv?xPS~i(;8$ zRXF19@K~uNSaGvo3nJxiwzsz1HC|v-P&WG{>7YJGgv4L+b7IJMyUk{^F5v~)gDyiy zpACKxRdtV1zy4+L%R6&PJiOt}r6Vo+)gcMh_$oU81N*f5j6Jj0K9#Fg>*k73O=yOKRd zv{P_w;zU9bj7_|EuIywHEBB^}cI}nH2$pazuMfODtWQEc&s<>V9O?99N;OuLME_-c z*)UCo&>mb;bNX~Mt0arsWAlWo<}AG9JMGGv*|T1W@`%UQ6&8(IruiE`?;=RvT;gLJ zIp>;nRSkg5aeK)lcVg(ubmm_U7MmxwcTahhyg0Ex?xUxtpxcDq6S?N<_fINYmI$TN zu`tuDa(mh}UT^86AH{Qf)7047Ez^X$b2VGNVgcgC(&X$jmKd-KPkHYB`&3XNo01PiSZs?=7M*I<7e;n`;A|& zkQ;5Sh2FFJ&Z;Y;g#NOPl-{OJ@b1hdLN=#i*2 zy0#aA3PBS815l0DlS!ARs(xpbJBQ zWFom~l0AKi5ExXG<_1zZco-VsIM&LF2sjMjqWlerBu_6o1dG5yH3L0YgMpy1cz|RI zUb{eGfGQA^-49I|40`Z~6#@+dcn$)X1_%-fkR?RF1Az6ay4ET+qX<|-Kwl693Q?4{y*+* z04PW|{j2Uq{N3HFoYv2vRxLLK_%Hh#<#64?i8MRcPB#3WJ)iw5oxEI{A^cgyMti$W@)K{`*%8X)iNKmrb`2SGtK z*Qq>BH#&(z28cRaD?{**^CJLM97Q?UjX+oQC3+HkHGD}lI!$SfzVx6_J&8(WB7HAN zF#b&L{d%*ka*h8cRx})p6@x(o(Lqpfgc25l!NHZ_|5d17bh*kI|(MgtPoI2txWxcVr z5iqVv*0W*ew@wZU#dk6jAV--;gfd#hzUCMlG8Jl-`+O?f3Lh;dx>;BVC3-(boumul z4DHtBc30+o>+%e*-J2+>pxpaODMEIJLyCJLGB$&`A*cOBYoE4~Rz!SD)z)(?ZM&mX&O%KWdw)JACnJp>4ncCl%GQE^l$ko6SM#3w6p%TJwW8 znf>SD5I3Fcj~$7QYq@HWVsn7UG$^Nh`%NFoOtO5^I+BsP`wm3*^O_+rr9<{@xtxak@5_ujarknQQ#mJd#jf4rKwWOLQc`VEij z1>=<0HdkNRNJtn5A2{#OhFzYw7E0-8Vs856%kAi^7}j#pk`{*>KlABO=aOK-F^)2o z?jqbAQHkxSRh;JnR9`ClD(B@rUJb>G!lf|wNylzK2dZX)bVOy|aw{d%9{L-f*6WbngHI|0md1_|*;K{vAiJM0{UI!a4Hzl5tmM~VvjP<6C z)X`O-$`!ABmraEXp6v>$C#j=(W)Z?HS~x#!Z9-2qDdJ1w);QGU zKvu7#W+quo_zjUl*`F=+E<>1chC)GZ7 zm8Nqr^0)2=Eo9MGB~_l0FWFnvujJQ%8UAofuc;C#%fNYQZpzg8{#>S! z^V#pYo1N=E^EeO0@iJWQt}ZTDr!xl#0t+sm7=MvSBX8qu`ntq^_P00@cS0*bLM`pTAvcA_ZuHP(sg3`-DmJeqB#?e)7;UG_($j&+%74$j6?z8h! zC)@F38QbI{*=5f~sR#}UJ{{tdw>U|wisY<{=I_km5UO&CVv+1@h-DJv)!f>{t1Upz z;Zl67#dg%6GpH?=ttysTrGb}Uq(MYxW}9_d17|CN`6{>UD}#dbPZxN?HARdVKH9-l zq6ZfT4Cq|o_s0jk`_O148Uog=%Yf$){6NTm%isuL8~nQrd|rN&q3|1IC^Q_{PyMQg z!r*|%=r*3}g)Y7r_7r0vK~Pw8sDkf&mUB z0~|;OIDr3LZ14e$DH~-BZ~%AcMm+{NkPL7j8Q?%Nz=2|b1H}LbiUAH30~{y@I8Y35 zpcvplF~EUhfCI$<2buv6Gy@#KJ-#8QXa+dY3~-W060S*iU z92f>TFbr^D7~lZLmklvv7~lZs1&f94haMQcPFiDt_S?j>c_kY literal 0 HcmV?d00001 diff --git a/source/developers/license/xcat_corporate_contributor_license_agreement.rst b/source/developers/license/xcat_corporate_contributor_license_agreement.rst new file mode 100644 index 000000000..36ed4df9a --- /dev/null +++ b/source/developers/license/xcat_corporate_contributor_license_agreement.rst @@ -0,0 +1,100 @@ +.. _xcat-corporate-contributor-license-label: + +The xCAT Community Software Grant and Corporate Contributor License Agreement ("Agreement") +------------------------------------------------------------------------------------------- + +In order to clarify the intellectual property license granted with Contributions from any person or entity made for the benefit of the xCAT Community, a Contributor License Agreement (CLA) must be on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of the xCAT Community and its users; it does not change your rights to use your own Contributions for any other purpose. + +This version of the Agreement allows an entity (the "Corporation") to submit Contributions to the xCAT Community, to authorize Contributions submitted by its designated employees to the xCAT Community, and to grant copyright and patent licenses thereto. + +If you have not already done so, please print this form, complete it, sign it, and send a scanned copy via email to **xcat-legal@lists.sourceforge.net** . Please read this document carefully before signing and keep a copy for your records. + + Corporation name: ___________________________________________________ + + + Corporation address: ________________________________________________ + + + ________________________________________________ + + + Point of Contact: ___________________________________________________ + + + E-Mail: _____________________________________________________________ + + + Telephone: __________________________ Fax: __________________________ + + +You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the xCAT Community. Except for the license granted herein to the xCAT Community, You reserve all right, title, and interest in and to Your Contributions. + + +1\. Definitions. + +"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + +"Contribution" shall mean the code, documentation or other original works of authorship expressly identified in Schedule B, as well as any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the xCAT Community for inclusion in, or documentation of, any of the products owned or managed by members of the xCAT Community (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to members of the xCAT Community, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the xCAT Community for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." + +“xCAT Community” shall mean International Business Machines Corporation and other users of xCAT. Accepted Contributions will be made available to the xCAT Community at large through sourceforge.net or other open source community. + + +2\. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to the xCAT Community a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. + + +3\. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to the xCAT Community a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) were submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that Your Contribution, or the Work to which You have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. + + +4\. You represent that You are legally entitled to grant the above license. You represent further that each employee of the Corporation designated on Schedule A below (or in a subsequent written modification to that Schedule) is authorized to submit Contributions on behalf of the Corporation. + + +5\. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). + + +6\. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. + + +7\. Should You wish to submit work that is not Your original creation, You may submit it to the xCAT Community separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which You are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". + + +8\. It is Your responsibility to notify the xCAT Community (xcat-legal@lists.sourceforge.net) when any change is required to the list of designated employees authorized to submit Contributions on behalf of the Corporation, or to the Corporation's Point of Contact with the xCAT Community. + + +9\. You agree that your signature, as received by e-mail, will constitute an “original” signature of this Agreement. + + + + + + + Please sign: __________________________________ Date: _______________ + + + Title: __________________________________ + + + Corporation: __________________________________ + + + + + + + + +Schedule A + + +[Initial list of designated employees. NB: authorization is not tied to particular Contributions.] + + + + + + + +Schedule B + + +[Identification of optional concurrent software grant. Would be left blank or omitted if there is no concurrent software grant.] + diff --git a/source/developers/license/xcat_individual_contributor_license_agreement.rst b/source/developers/license/xcat_individual_contributor_license_agreement.rst new file mode 100644 index 000000000..2b1ac0c79 --- /dev/null +++ b/source/developers/license/xcat_individual_contributor_license_agreement.rst @@ -0,0 +1,68 @@ +.. _xcat-individual-contributor-license-label: + +The xCAT Community Individual Contributor License Agreement ("Agreement") +========================================================================= + +In order to clarify the intellectual property license granted with Contributions from any person or entity made for the benefit of the xCAT Community, a Contributor License Agreement ("CLA") must be on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of the xCAT Community and its users; it does not change your rights to use your own Contributions for any other purpose. If you have not already done so, please print this form, complete it, sign it, and send a scanned copy via email to **xcat-legal@lists.sourceforge.net**. + + + + Full name: _______________________________ E-Mail: ______________________ + + + Mailing Address: _________________________ Telephone: ______________________ + + + __________________________________________ Facsimile: ______________________ + + + __________________________________________ Country: ______________________ + + + +You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the xCAT Community. Except for the license granted herein to the xCAT Community, You reserve all right, title, and interest in and to Your Contributions. + + +1\. Definitions. + +"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + +"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the xCAT Community for inclusion in, or documentation of, any of the products owned or managed by members of the xCAT Community (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to members of the xCAT Community, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the xCAT Community for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." + + +“xCAT Community” shall mean International Business Machines Corporation and other users of xCAT. Accepted Contributions will be made available to the xCAT Community at large through sourceforge.net or other open source community. + + +2\. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to the xCAT Community a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. + + +3\. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to the xCAT Community a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which You have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. + + +4\. You represent that You are legally entitled to grant the above license. If Your employer(s) has rights to intellectual property that You create that includes Your Contributions, You represent + +that You have received permission to make Contributions on behalf of that employer, that Your employer has waived such rights for Your Contributions to the xCAT Community, or that Your employer has executed a separate Corporate CLA with the xCAT Community. + + +5\. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which You are personally aware and which are associated with any part of Your Contributions. + + +6\. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. + + +7\. Should You wish to submit work that is not Your original creation, You may submit it to the xCAT Community separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which You are personally aware, and conspicuously marking the work as + +"Submitted on behalf of a third-party: [named here]". + + +8\. You agree to notify the xCAT Community (xcat-legal@lists.sourceforge.net) of any facts or circumstances of which You become aware that would make these representations inaccurate in any respect. + + +9\. You agree that your signature, as received by e-mail, will constitute an “original” signature of this Agreement. + + + + + Please sign: __________________________________ Date: ________________ + + diff --git a/source/developers/license/xcat_maintainer_license_agreement.rst b/source/developers/license/xcat_maintainer_license_agreement.rst new file mode 100644 index 000000000..b736fbf63 --- /dev/null +++ b/source/developers/license/xcat_maintainer_license_agreement.rst @@ -0,0 +1,68 @@ +.. _xcat-maintainer-license-label: + +The xCAT Community Individual Contributor License Agreement ("Agreement") +========================================================================= + +In order to clarify the intellectual property license granted with Contributions from any person or entity made for the benefit of the xCAT Community, a Contributor License Agreement ("CLA") must be on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of the xCAT Community and its users; it does not change your rights to use your own Contributions for any other purpose. If you have not already done so, please print this form, complete it, sign it, and send a scanned copy via email to **xcat-legal@lists.sourceforge.net**. + + + + Full name: _______________________________ E-Mail: ______________________ + + + Mailing Address: _________________________ Telephone: ______________________ + + + __________________________________________ Facsimile: ______________________ + + + __________________________________________ Country: ______________________ + + + +You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the xCAT Community. Except for the license granted herein to the xCAT Community, You reserve all right, title, and interest in and to Your Contributions. + + +1\. Definitions. + +"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + +"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the xCAT Community for inclusion in, or documentation of, any of the products owned or managed by members of the xCAT Community (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to members of the xCAT Community, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the xCAT Community for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." + + +“xCAT Community” shall mean International Business Machines Corporation and other users of xCAT. Accepted Contributions will be made available to the xCAT Community at large through sourceforge.net or other open source community. + + +2\. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to the xCAT Community a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. + + +3\. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to the xCAT Community a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which You have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. + + +4\. You represent that You are legally entitled to grant the above license. If Your employer(s) has rights to intellectual property that You create that includes Your Contributions, You represent + +that You have received permission to make Contributions on behalf of that employer, that Your employer has waived such rights for Your Contributions to the xCAT Community, or that Your employer has executed a separate Corporate CLA with the xCAT Community. + + +5\. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which You are personally aware and which are associated with any part of Your Contributions. + + +6\. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. + + +7\. Should You wish to submit work that is not Your original creation, You may submit it to the xCAT Community separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which You are personally aware, and conspicuously marking the work as + +"Submitted on behalf of a third-party: [named here]". + + +8\. You agree to notify the xCAT Community (xcat-legal@lists.sourceforge.net) of any facts or circumstances of which You become aware that would make these representations inaccurate in any respect. + + +9\. You agree that your signature, as received by e-mail, will constitute an “original” signature of this Agreement. + + + + + Please sign: __________________________________ Date: ________________ + + From 1cebf5fe0a20f5c296a909d9de43e1fee3172050 Mon Sep 17 00:00:00 2001 From: wangxiaopeng Date: Mon, 27 Jul 2015 07:45:59 -0400 Subject: [PATCH 23/57] Add mini-design for xcat debug mode --- source/developers/mini-design/2.10/xcatdebugmode.rst | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 source/developers/mini-design/2.10/xcatdebugmode.rst diff --git a/source/developers/mini-design/2.10/xcatdebugmode.rst b/source/developers/mini-design/2.10/xcatdebugmode.rst new file mode 100644 index 000000000..2958fc9af --- /dev/null +++ b/source/developers/mini-design/2.10/xcatdebugmode.rst @@ -0,0 +1,5 @@ +Mini-design for xCAT Debug Mode +=============================== + +Overview +-------- From 6979a8df73b54e6328d054cfd8de5ab4d0de2c80 Mon Sep 17 00:00:00 2001 From: ligc Date: Mon, 3 Aug 2015 02:41:59 -0400 Subject: [PATCH 24/57] add the first page for hamn --- .../hamn/high_available_management_node.rst | 72 +++++++++++++++++++ source/advanced/hamn/index.rst | 4 ++ source/advanced/index.rst | 1 + 3 files changed, 77 insertions(+) create mode 100644 source/advanced/hamn/high_available_management_node.rst create mode 100644 source/advanced/hamn/index.rst diff --git a/source/advanced/hamn/high_available_management_node.rst b/source/advanced/hamn/high_available_management_node.rst new file mode 100644 index 000000000..e6577dfd0 --- /dev/null +++ b/source/advanced/hamn/high_available_management_node.rst @@ -0,0 +1,72 @@ +======== +Overview +======== + + +The xCAT management node plays an important role in the cluster, if the management node is down for whatever reason, the administrators will lose the management capability for the whole cluster, until the management node is back up and running. In some configuration, like the Linux nfs-based statelite in a non-hierarchy cluster, the compute nodes may not be able to run at all without the management node. So, it is important to consider the high availability for the management node. + +The goal of the HAMN(High Availability Management Node) configuration is, when the primary xCAT management node fails, the standby management node can take over the role of the management node, either through automatic failover or through manual procedure performed by the administrator, and thus avoid long periods of time during which your cluster does not have active cluster management function available. + +============================ +Configuration considerations +============================ + + +xCAT provides several configuration options for the HAMN, you can select one of the option based on your failover requirements and hardware configuration, the following configuration considerations should be able to help you to make the decision. + +****************************** +Data synchronization mechanism +****************************** + +The data synchronization is important for any high availability configuration. When the xCAT management node failover occurs, the xCAT data needs to be exactly the same before failover, and some of the operating system configuration should also be synchronized between the two management nodes. To be specific, the following data should be synchronized between the two management nodes to make the xCAT HAMN work: + +* xCAT database +* xCAT configuration files, like /etc/xcat, ~/.xcat, /opt/xcat +* The configuration files for the services that are required by xCAT, like named, DHCP, apache, nfs, ssh, etc. +* The operating systems images repository and users customization data repository, the /install directory contains these repositories in most cases. + +There are a lot of ways for data syncronization, but considering the specific xCAT HAMN requirements, only several of the data syncronziation options are practical for xCAT HAMN. + +**1\. Move physical disks between the two management nodes**: if we could physically move the hard disks from the failed management node to the backup management node, and bring up the backup management node, then both the operating system and xCAT data will be identical between the new management node the failed management node. RAID1 or disk mirroring could be used to avoid the disk be a single point of failure. + +**2\. Shared data**: the two management nodes use the single copy of xCAT data, no matter which management node is the primary MN, the cluster management capability is running on top of the single data copy. The acess to the data could be done through various ways like shared storage, NAS, NFS, samba etc. Based on the protocol being used, the data might be accessable only on one management node at a time or be accessable on both management nodes in parellel. If the data could only be accessed from one management node, the failover process need to take care of the data access transition; if the data could be accessed on both management nodes, the failover does not need to consider the data access transition, it usually means the failover process could be faster. + +Warning: Running database through network file system has a lot of potential problems and is not practical, however, most of the database system provides database replication feature that can be used to synronize the database between the two management nodes. + +**3\. Mirroring**: each of the management node has its own copy of the xCAT data, and the two copies of data are syncronized through mirroring mechanism. DRBD is used widely in the high availability configuration scenarios, to provide data replication by mirroring a whole block device via network. If we put all the important data for xCAT onto the DRBD devices, then it could assure the data is synchronized between the two management nodes. Some parallel file system also provides capability to mirror data through network. + +************************************* +Manual failover VS automatic failover +************************************* + +When the primary management node fails, the backup management node could automatically take over, or the administrator has to perform some manual procedure to finish the failover. In general, the automatic failover takes less time to detect the failure and perform and failover, comparing with the manual failover, but the automatic failover requires more complex configuration. We could not say the automatic failover is better than the manual failover in all cases, the following factors should be considered when deciding the manual failover or automatic failover: + +**1\. How long the cluster could survive if the management node is down?** + +If the cluster could not survive for more than several minutes, then the automatic failover might be the only option; if the compute nodes could run without the management node, at least for a while, then the manual failover could be an option. + +From xCAT perspective, if the management node needs to provide network services like DHCP, named, ntp or nfs to the compute nodes, then the cluster probably could not survive too long if the management node is down; if the management node only performs hardware control and some other management capabilities, then the failed management node may not cause too much trouble for the cluster. xCAT provides various options for configuring if the compute nodes rely on the network services on the management node. + +**2\. Configuration complexity** + +The configuration for the high availability applications is usually complex, it may take a long time to configure, debug and stablize the high availability configuration. + +**3\. Maintenance effort** + +The automatic failover brings in several high availability applications, after the initial configuration is done, additional maintenance effort will be needed. For example, taking care of the high availability applications during cluster update, the updates for the high availability applications themselves, trouble shooting any problems with the high availability applications. A simple question may be able to help you to decide: could you get technical support if some of the high availability applications run into problems? All software has bugs ... + +********************* +Configuration Options +********************* + +The combinations of data synchronization mechanism and manual/automatic failover indicates different HAMN configuration options, the table below list all the combinations (the bold numbers are the combinations xCAT has documented and tested): + ++-------------------+-------------------------+-----------------+--------------+ +|# | **Move physical disks** | **Shared data** | **Mirroring**| ++-------------------+-------------------------+-----------------+--------------+ +|Manual Failover | **1** | **2** | 3 | ++-------------------+-------------------------+-----------------+--------------+ +|Automatic Failover | 4 | 5 | **6** | ++-------------------+-------------------------+-----------------+--------------+ + + diff --git a/source/advanced/hamn/index.rst b/source/advanced/hamn/index.rst new file mode 100644 index 000000000..7d5183829 --- /dev/null +++ b/source/advanced/hamn/index.rst @@ -0,0 +1,4 @@ +.. toctree:: + :maxdepth: 2 + + high_available_management_node.rst diff --git a/source/advanced/index.rst b/source/advanced/index.rst index 390ccab1f..fb9534388 100644 --- a/source/advanced/index.rst +++ b/source/advanced/index.rst @@ -6,4 +6,5 @@ Advanced Topics confluent/index docker/index + hamn/index mixed_cluster From 2304cddbbaf375c5cf5e571403364e763f59d254 Mon Sep 17 00:00:00 2001 From: ligc Date: Mon, 3 Aug 2015 02:49:04 -0400 Subject: [PATCH 25/57] update hamn/index.rst file --- source/advanced/hamn/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/advanced/hamn/index.rst b/source/advanced/hamn/index.rst index 7d5183829..ded16df58 100644 --- a/source/advanced/hamn/index.rst +++ b/source/advanced/hamn/index.rst @@ -1,3 +1,6 @@ +High Available Management Node +============================== + .. toctree:: :maxdepth: 2 From f260553e9f26a7e96d5bf20a0350e25ce409a956 Mon Sep 17 00:00:00 2001 From: ligc Date: Mon, 3 Aug 2015 02:51:06 -0400 Subject: [PATCH 26/57] fix a heading issue in high_available_management_node.rst --- source/advanced/hamn/high_available_management_node.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/advanced/hamn/high_available_management_node.rst b/source/advanced/hamn/high_available_management_node.rst index e6577dfd0..33359eaf5 100644 --- a/source/advanced/hamn/high_available_management_node.rst +++ b/source/advanced/hamn/high_available_management_node.rst @@ -55,9 +55,9 @@ The configuration for the high availability applications is usually complex, it The automatic failover brings in several high availability applications, after the initial configuration is done, additional maintenance effort will be needed. For example, taking care of the high availability applications during cluster update, the updates for the high availability applications themselves, trouble shooting any problems with the high availability applications. A simple question may be able to help you to decide: could you get technical support if some of the high availability applications run into problems? All software has bugs ... -********************* +===================== Configuration Options -********************* +===================== The combinations of data synchronization mechanism and manual/automatic failover indicates different HAMN configuration options, the table below list all the combinations (the bold numbers are the combinations xCAT has documented and tested): From f0c4b712c26dc1b429ed7dfdab8591fab7d70a31 Mon Sep 17 00:00:00 2001 From: wangxiaopeng Date: Wed, 5 Aug 2015 22:38:43 -0400 Subject: [PATCH 27/57] add a table --- Makefile | 2 +- source/developers/mini-design/2.10/xcatdebugmode.rst | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index c03d22370..0db6165f2 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -BUILDDIR = build +BUILDDIR = ../../xcatdoc_build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) diff --git a/source/developers/mini-design/2.10/xcatdebugmode.rst b/source/developers/mini-design/2.10/xcatdebugmode.rst index 2958fc9af..276f12631 100644 --- a/source/developers/mini-design/2.10/xcatdebugmode.rst +++ b/source/developers/mini-design/2.10/xcatdebugmode.rst @@ -3,3 +3,10 @@ Mini-design for xCAT Debug Mode Overview -------- + + ++--------+----------+ +| Name | Age | ++========+==========+ +| Wang | 20 | ++--------+----------+ From 054ce5d2a7e93ca612b485ae1ae645900ca0bf35 Mon Sep 17 00:00:00 2001 From: zet809 Date: Thu, 6 Aug 2015 10:42:37 +0800 Subject: [PATCH 28/57] Update xcatdebugmode.rst Modify doc on-line --- source/developers/mini-design/2.10/xcatdebugmode.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/developers/mini-design/2.10/xcatdebugmode.rst b/source/developers/mini-design/2.10/xcatdebugmode.rst index 276f12631..9528ac312 100644 --- a/source/developers/mini-design/2.10/xcatdebugmode.rst +++ b/source/developers/mini-design/2.10/xcatdebugmode.rst @@ -10,3 +10,5 @@ Overview +========+==========+ | Wang | 20 | +--------+----------+ +| Zhao | 18 | ++--------+----------+ From c74e3ea6c7b0aeea72f0e333fa3e3c5f6c1a8d0d Mon Sep 17 00:00:00 2001 From: bybai Date: Thu, 6 Aug 2015 00:45:51 -0400 Subject: [PATCH 29/57] create doc for ubuntu/debian cluster --- source/guides/admin-guides/index.rst | 1 + source/guides/admin-guides/ubuntu_clusters/index.rst | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 source/guides/admin-guides/ubuntu_clusters/index.rst diff --git a/source/guides/admin-guides/index.rst b/source/guides/admin-guides/index.rst index c0e92c003..950f00faf 100644 --- a/source/guides/admin-guides/index.rst +++ b/source/guides/admin-guides/index.rst @@ -5,3 +5,4 @@ Admin Guide :maxdepth: 1 large_clusters/index.rst + ubuntu_clusters/index.rst diff --git a/source/guides/admin-guides/ubuntu_clusters/index.rst b/source/guides/admin-guides/ubuntu_clusters/index.rst new file mode 100644 index 000000000..33ad3472d --- /dev/null +++ b/source/guides/admin-guides/ubuntu_clusters/index.rst @@ -0,0 +1,11 @@ +Managing Ubuntu/Debian Clusters +======================= + +* xCAT on Ubuntu Server +* Preparing the Management Node +* Installing xCAT +* Configure xCAT +* Deploying Nodes +* Advanced Topics +* Known Issues + From b7dd9be9779a026efb370cb4a15c9a939727030b Mon Sep 17 00:00:00 2001 From: bybai Date: Thu, 6 Aug 2015 01:23:50 -0400 Subject: [PATCH 30/57] Add xCAT_on_Ubuntu_Server.rst --- .../guides/admin-guides/ubuntu_clusters/index.rst | 13 ++++++------- .../ubuntu_clusters/xCAT_on_Ubuntu_Server.rst | 3 +++ 2 files changed, 9 insertions(+), 7 deletions(-) create mode 100644 source/guides/admin-guides/ubuntu_clusters/xCAT_on_Ubuntu_Server.rst diff --git a/source/guides/admin-guides/ubuntu_clusters/index.rst b/source/guides/admin-guides/ubuntu_clusters/index.rst index 33ad3472d..9491dbd9c 100644 --- a/source/guides/admin-guides/ubuntu_clusters/index.rst +++ b/source/guides/admin-guides/ubuntu_clusters/index.rst @@ -1,11 +1,10 @@ Managing Ubuntu/Debian Clusters ======================= -* xCAT on Ubuntu Server -* Preparing the Management Node -* Installing xCAT -* Configure xCAT -* Deploying Nodes -* Advanced Topics -* Known Issues +.. toctree:: + :maxdepth: 2 + + + xCAT_on_Ubuntu_Server + ../../install-guides/common/prepare_mgmt_node diff --git a/source/guides/admin-guides/ubuntu_clusters/xCAT_on_Ubuntu_Server.rst b/source/guides/admin-guides/ubuntu_clusters/xCAT_on_Ubuntu_Server.rst new file mode 100644 index 000000000..ae275b1e8 --- /dev/null +++ b/source/guides/admin-guides/ubuntu_clusters/xCAT_on_Ubuntu_Server.rst @@ -0,0 +1,3 @@ +xCAT on Ubuntu Server +===================== + From 95df91095572499ac619b5ce12d9e93ca0afc08f Mon Sep 17 00:00:00 2001 From: penguhyang Date: Thu, 6 Aug 2015 16:21:23 +0800 Subject: [PATCH 31/57] add kdump add Kdump over Ethernet or HFI for Linux diskless nodes --- source/guides/admin-guides/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/guides/admin-guides/index.rst b/source/guides/admin-guides/index.rst index 950f00faf..c9851015f 100644 --- a/source/guides/admin-guides/index.rst +++ b/source/guides/admin-guides/index.rst @@ -6,3 +6,4 @@ Admin Guide large_clusters/index.rst ubuntu_clusters/index.rst + Kdump over Ethernet or HFI for Linux diskless nodes/index.rst From 6c30576c7f18b012e028118a33e82b31870f6a26 Mon Sep 17 00:00:00 2001 From: penguhyang Date: Thu, 6 Aug 2015 18:30:41 +0800 Subject: [PATCH 32/57] edit the index.rst using kdump word --- source/guides/admin-guides/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/guides/admin-guides/index.rst b/source/guides/admin-guides/index.rst index c9851015f..f93f21a24 100644 --- a/source/guides/admin-guides/index.rst +++ b/source/guides/admin-guides/index.rst @@ -6,4 +6,4 @@ Admin Guide large_clusters/index.rst ubuntu_clusters/index.rst - Kdump over Ethernet or HFI for Linux diskless nodes/index.rst + Kdump/index.rst From 9222319fe9c91b9d8f6231e33930cc93062d8025 Mon Sep 17 00:00:00 2001 From: huweihua Date: Mon, 10 Aug 2015 02:45:58 -0400 Subject: [PATCH 33/57] for test --- source/guides/admin-guides/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/guides/admin-guides/index.rst b/source/guides/admin-guides/index.rst index f93f21a24..f9d9a3820 100644 --- a/source/guides/admin-guides/index.rst +++ b/source/guides/admin-guides/index.rst @@ -7,3 +7,4 @@ Admin Guide large_clusters/index.rst ubuntu_clusters/index.rst Kdump/index.rst + advanced_topics/index.rst From cbd89ccc8cd99174b11ddc17dd412b7768b176c1 Mon Sep 17 00:00:00 2001 From: WangXiaoPeng Date: Mon, 10 Aug 2015 20:58:09 -0400 Subject: [PATCH 34/57] Roll back the change that changed the location of build --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 0db6165f2..c03d22370 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -BUILDDIR = ../../xcatdoc_build +BUILDDIR = build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) From cf2da529eef3d7bcd5ce22bec627ce870488c3c7 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 11 Aug 2015 14:08:42 -0400 Subject: [PATCH 35/57] Set up the basic skeleton for the large cluster support documentation --- .../large_clusters/databases/index.rst | 30 ++++++++++--------- .../admin-guides/large_clusters/index.rst | 17 +++++++++-- .../service_nodes/define_service_nodes.rst | 2 ++ .../service_nodes/provision_service_nodes.rst | 11 +++++++ .../service_nodes/service_nodes101.rst | 3 ++ .../admin-guides/large_clusters/tips.rst | 5 ++++ 6 files changed, 52 insertions(+), 16 deletions(-) create mode 100644 source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst create mode 100644 source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst create mode 100644 source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst create mode 100644 source/guides/admin-guides/large_clusters/tips.rst diff --git a/source/guides/admin-guides/large_clusters/databases/index.rst b/source/guides/admin-guides/large_clusters/databases/index.rst index f89770eac..615b9ebf5 100644 --- a/source/guides/admin-guides/large_clusters/databases/index.rst +++ b/source/guides/admin-guides/large_clusters/databases/index.rst @@ -1,24 +1,24 @@ -Databases -========= +Configure a Database +==================== -xCAT Supports the following databases to be used by xCAT on the Management node +xCAT requires a database to hold persistent information and currently supports the following: -* SQLite -* MySQL/MariaDB -* PostgreSQL -* DB2 + * SQLite + * MySQL/MariaDB + * PostgreSQL + * DB2 SQLite ------ -SQLite database is the default database used by xCAT and is initialized when xCAT is installed on the management node. +The SQLite database (https://www.sqlite.org/) is the default database used by xCAT and is initialized when xCAT is installed on the management node. +SQLite is a small, light-weight, daemon-less database that requires very little configuration and maintenance. This database is sufficient for smarll to moderately sized systems (typeically < 1000 nodes). -SQLite is a small, light-weight, daemon-less database that requires no configuration or maintenance. This database is sufficient for small to moderate size systems ( < 1000 nodes ) +xCAT Hierarchy (Service Nodes) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**The SQLite database can NOT be used for xCAT hierarchy support because service nodes requires remote access to the database and SQLite does NOT support remote access.** - -For xCAT hierarchy, you will need to use one of the following alternate databases: +The SQLite datacase **CAN NOT** be used when using xCAT hierarchy support because the xCAT service nodes require remote access to the database. This is one reason you would need to configure one of the alternative databases listed below: MySQL/MariaDB ------------- @@ -28,7 +28,8 @@ MySQL/MariaDB mysql_install.rst mysql_configure.rst - + mysql_using.rst + mysql_remove.rst PostgreSQL @@ -39,4 +40,5 @@ PostgreSQL postgres_install.rst postgres_configure.rst - postgres_tips.rst + postgres_using.rst + postgres_remove.rst diff --git a/source/guides/admin-guides/large_clusters/index.rst b/source/guides/admin-guides/large_clusters/index.rst index c3c0633e4..4a0acb99c 100644 --- a/source/guides/admin-guides/large_clusters/index.rst +++ b/source/guides/admin-guides/large_clusters/index.rst @@ -1,7 +1,20 @@ -Managing Large Clusters -======================= +Large Clusters +============== + +When managing large clusters, it is recommended to have more than one node (Management Node, "MN") handling the installation and management of all the compute nodes. These additional "helper" nodes are called **Service Nodes** ("SN"). The Management Node can delegate all management operational needs for a compute node to the Service Node responsible for that compute node. There can be one or more Service Nodes configured to install/manage a group of compute nodes. + +The following configurations are supported by xCAT: + + * Each Service Node installs/manages a specific set of compute nodes + * Having a pool of Service Nodes in which any can respond to an installation request from a compute node + * A hybrid of the above, where each specific set of compute nodes have 2 or more Service Nodes in a pool + .. toctree:: :maxdepth: 2 + service_nodes/service_nodes101.rst databases/index.rst + service_nodes/define_service_nodes.rst + service_nodes/provision_service_nodes.rst + tips.rst diff --git a/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst b/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst new file mode 100644 index 000000000..d3b33911b --- /dev/null +++ b/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst @@ -0,0 +1,2 @@ +Define Service Nodes +==================== diff --git a/source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst b/source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst new file mode 100644 index 000000000..b3cb3b497 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst @@ -0,0 +1,11 @@ +Provision Service Nodes +======================= + +Diskful +------- + +Diskless +-------- + +Verfication +----------- diff --git a/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst b/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst new file mode 100644 index 000000000..c97b510f2 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst @@ -0,0 +1,3 @@ +Service Nodes 101 +================= + diff --git a/source/guides/admin-guides/large_clusters/tips.rst b/source/guides/admin-guides/large_clusters/tips.rst new file mode 100644 index 000000000..680808ba0 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/tips.rst @@ -0,0 +1,5 @@ +Tips/Tuning/Suggestions +======================= + +TODO: Content from: https://sourceforge.net/p/xcat/wiki/Hints_and_Tips_for_Large_Scale_Clusters/ + From 477ad8bf6b78f912e6b16f1210c21015d7130d49 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 11 Aug 2015 14:33:59 -0400 Subject: [PATCH 36/57] Update the database documentation for mysql and postgres --- .../databases/mysql_configure.rst | 26 +++++- .../databases/mysql_install.rst | 87 ++++++++++++++++++- .../large_clusters/databases/mysql_remove.rst | 2 + .../large_clusters/databases/mysql_using.rst | 2 + .../databases/postgres_remove.rst | 44 ++++++++++ .../databases/postgres_using.rst | 39 +++++++++ 6 files changed, 196 insertions(+), 4 deletions(-) create mode 100644 source/guides/admin-guides/large_clusters/databases/mysql_remove.rst create mode 100644 source/guides/admin-guides/large_clusters/databases/mysql_using.rst create mode 100644 source/guides/admin-guides/large_clusters/databases/postgres_remove.rst create mode 100644 source/guides/admin-guides/large_clusters/databases/postgres_using.rst diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst b/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst index d607489a1..f8134d8f5 100644 --- a/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst +++ b/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst @@ -1,2 +1,24 @@ -Configure MySQL -=============== +Configure MySQL/MariaDB +======================= + +Migrate xCAT to use MySQL/MariaDB +--------------------------------- + +The following utility is provided to migrate an existing xCAT database from SQLite to MySQL/MariaDB. :: + + mysqlsetup -i + + +If you need to update the database at a later time to give access to your service nodes, you can use the ``mysqlsetup -u -f`` command. A file needs to be provided with all the hostnames and/or IP addresses of the servers that need to access the database on the Management node. Wildcards can be used. :: + + TODO: Show an example here of file1 + + mysqlsetup -u -f /path/to/file1 + +**While not recommended**, if you wish to manually migrate your xCAT database, see the following documentation: +`Manually set up MySQL `_ + +Granting/Revoking access to the database for Service Node Clients +----------------------------------------------------------------- + +https://sourceforge.net/p/xcat/wiki/Setting_Up_MySQL_as_the_xCAT_DB/#granting-or-revoking-access-to-the-mysql-database-to-service-node-clients diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_install.rst b/source/guides/admin-guides/large_clusters/databases/mysql_install.rst index fb6187306..30eb3f7dc 100644 --- a/source/guides/admin-guides/large_clusters/databases/mysql_install.rst +++ b/source/guides/admin-guides/large_clusters/databases/mysql_install.rst @@ -1,2 +1,85 @@ -Install MySQL -============= +Install MySQL/MariaDB +===================== + +The MySQL database is supported by xCAT since xCAT 2.1. MariaDB is a fork of the MySQL project which was released around 2009 and is a drop-in replacement for MySQL. MariaDB support within xCAT started in version 2.8.5 and is currently fully supported moving forward. + ++------------+------------+------------+ +| Database | MySQL | MariaDB | ++============+============+============+ +| xCAT 2.1+ | Yes | No | ++------------+------------+------------+ +| xCAT 2.8.5 | Yes | RHEL 7 | ++------------+------------+------------+ +| xCAT 2.9 | Yes | SLES 12 | ++------------+------------+------------+ +| xCAT 2.10+ | Yes | Yes | ++------------+------------+------------+ + +MySQL/MariaDB packages are shipped as part of most Linux Distributions. + + +Redhat Enterprise Linux +----------------------- + +* MySQL - Using ``yum``, ensure that the following packages are installed on the management node: :: + + perl-DBD-MySQL* + mysql-server-5.* + mysql-5.* + mysql-devel-5.* + mysql-bench-5.* + mysql-connector-odbc-* + +* MariaDB - Using ``yum``, ensure that the following packages are installed on the management node: :: + + mariadb-devel-5.* + mariadb-libs-5.* + mariadb-server-5.* + mariadb-bench-5.* + mariadb-5.* + perl-DBD-MySQL* + mysql-connector-odbc-* + unixODBC* + +Suse Linux Enterprise Server +---------------------------- + +* MySQL - Using ``yum``, ensure that the following packages are installed on the management node: :: + + mysql-client-5* + libmysqlclient_r15* + libqt4-sql-mysql-4* + libmysqlclient15-5* + perl-DBD-mysql-4* + mysql-5* + +* MariaDB - Using ``yum``, ensure that the following packages are installed on the management node: :: + + mariadb-client-10.* + mariadb-10.* + mariadb-errormessages-10.* + libqt4-sql-mysql-* + libmysqlclient18-* + perl-DBD-mysql-* + + +Debian/Ubuntu +------------- + +* MySQL - Using ``apt-get``, ensure that the following packages are installed on the management node: :: + + mysql-server + mysql-common + libdbd-mysql-perl + libmysqlclient18 + mysql-client-5* + mysql-client-core-5* + mysql-server-5* + mysql-server-core-5* + +* MariaDB - Using ``apt-get``, ensure that the following packages are installed on the management node: :: + + libmariadbclient18 + mariadb-client + mariadb-common + mariadb-server diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_remove.rst b/source/guides/admin-guides/large_clusters/databases/mysql_remove.rst new file mode 100644 index 000000000..c8531a8c1 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/mysql_remove.rst @@ -0,0 +1,2 @@ +Removing ``xcatdb`` from MySQL/MariaDB +====================================== diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_using.rst b/source/guides/admin-guides/large_clusters/databases/mysql_using.rst new file mode 100644 index 000000000..7d80b15ed --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/mysql_using.rst @@ -0,0 +1,2 @@ +Using MySQL/MariaDB +=================== diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_remove.rst b/source/guides/admin-guides/large_clusters/databases/postgres_remove.rst new file mode 100644 index 000000000..16807d1d2 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/postgres_remove.rst @@ -0,0 +1,44 @@ +Removing ``xcatdb`` from PostgreSQL +=================================== + +To remove ``xcatdb`` completely from the PostgreSQL database: + +#. Run a backup of the database to save any information that is needed: :: + + mkdir -p ~/xcat-dbback + dumpxCATdb -p ~/xcat-dbback + +#. Stop the ``xcatd`` daemon on the management node. + **Note:** If you are using *xCAT Hierarchy (service nodes)* and removing ``xcatdb`` from postgres, hierarchy will no longer work. You will need to configure another database which supports remote database access to continue using the hierarchy feature. :: + + service xcatd stop + +#. Remove the ``xatdb`` from PostgreSQL: :: + + su - postgres + + drop the xcatdb: :: + + dropdb xcatdb + + remove the xcatadm database owner : :: + + dropuser xcatadm + + clean up the postgresql files (necessary if you want to re-create the database): :: + + cd /var/lib/pgsql/data + rm -rf * + +#. Move, or remove, the ``/etc/xcat/cfglog`` file as it points xCAT to PostgreSQL. (without this file, xCAT defaults to SQLite): :: + + mv /etc/xcat/cfgloc /etc/xcat/cfglog.postgres + +#. Restore the PostgreSQL database into SQLite: :: + + XCATBYPASS=1 restorexCATdb -p ~/xcat-dbback + +#. Restart ``xcatd``: :: + + service xcatd start + diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_using.rst b/source/guides/admin-guides/large_clusters/databases/postgres_using.rst new file mode 100644 index 000000000..b757333c9 --- /dev/null +++ b/source/guides/admin-guides/large_clusters/databases/postgres_using.rst @@ -0,0 +1,39 @@ +Using PostgreSQL +================ + +Refer to ``_ for the latest documentation. + + +Using ``psql``, connect to the xcat database: :: + + su - postgres + psql -h -U xcatadm -d xcatdb (default pw: cluster) + +list the xCAT tables: :: + + xcatdb=> \dt + +show the entries in the nodelist table: :: + + xcatdb=> select * from nodelist; + +quit postgres: :: + + xcatdb=> \q + + +Useful Commands +--------------- + +Show the SQL create statement for a table: :: + + /usr/bin/pg_dump_xcatdb -U xcatadm -t + + # example, for prescripts table: + /usr/bin/pg_dump xcatdb -U xcatadm -t prescripts + +List all databases in postgres: :: + + su - postgres + psql -l + From fd2b0aa4b097965caa461b97c5f453caeb1099e4 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 11 Aug 2015 14:36:00 -0400 Subject: [PATCH 37/57] Remove reference to DB2 in the database documentation --- source/guides/admin-guides/large_clusters/databases/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/guides/admin-guides/large_clusters/databases/index.rst b/source/guides/admin-guides/large_clusters/databases/index.rst index 615b9ebf5..605959b74 100644 --- a/source/guides/admin-guides/large_clusters/databases/index.rst +++ b/source/guides/admin-guides/large_clusters/databases/index.rst @@ -6,7 +6,6 @@ xCAT requires a database to hold persistent information and currently supports t * SQLite * MySQL/MariaDB * PostgreSQL - * DB2 SQLite From e765d12566b487d365d3fd1f8c87915056005d4a Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 11 Aug 2015 17:35:37 -0400 Subject: [PATCH 38/57] Added sections for - service node 101 - defining service nodes --- .../large_clusters/databases/index.rst | 23 ++---- .../admin-guides/large_clusters/index.rst | 16 ++-- .../service_nodes/define_service_nodes.rst | 79 +++++++++++++++++++ .../service_nodes/service_nodes101.rst | 6 ++ 4 files changed, 101 insertions(+), 23 deletions(-) diff --git a/source/guides/admin-guides/large_clusters/databases/index.rst b/source/guides/admin-guides/large_clusters/databases/index.rst index 605959b74..e7e1d6520 100644 --- a/source/guides/admin-guides/large_clusters/databases/index.rst +++ b/source/guides/admin-guides/large_clusters/databases/index.rst @@ -1,27 +1,16 @@ Configure a Database ==================== -xCAT requires a database to hold persistent information and currently supports the following: +xCAT uses the SQLite database (https://www.sqlite.org/) as the default database and it is initialized during xCAT installation of the Management Node. If using Service Nodes, SQLite **cannot** be used because Service Nodes require remote access to the xCAT database. One of the following databases should be used: - * SQLite - * MySQL/MariaDB - * PostgreSQL + * :ref:`mysql_reference_label` + * :ref:`postgresql_reference_label` -SQLite ------- - -The SQLite database (https://www.sqlite.org/) is the default database used by xCAT and is initialized when xCAT is installed on the management node. -SQLite is a small, light-weight, daemon-less database that requires very little configuration and maintenance. This database is sufficient for smarll to moderately sized systems (typeically < 1000 nodes). - -xCAT Hierarchy (Service Nodes) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The SQLite datacase **CAN NOT** be used when using xCAT hierarchy support because the xCAT service nodes require remote access to the database. This is one reason you would need to configure one of the alternative databases listed below: +.. _mysql_reference_label: MySQL/MariaDB ------------- - .. toctree:: :maxdepth: 2 @@ -31,9 +20,10 @@ MySQL/MariaDB mysql_remove.rst +.. _postgresql_reference_label: + PostgreSQL ---------- - .. toctree:: :maxdepth: 2 @@ -41,3 +31,4 @@ PostgreSQL postgres_configure.rst postgres_using.rst postgres_remove.rst + diff --git a/source/guides/admin-guides/large_clusters/index.rst b/source/guides/admin-guides/large_clusters/index.rst index 4a0acb99c..fb9912e9c 100644 --- a/source/guides/admin-guides/large_clusters/index.rst +++ b/source/guides/admin-guides/large_clusters/index.rst @@ -1,14 +1,16 @@ -Large Clusters -============== +Large Cluster Support +===================== -When managing large clusters, it is recommended to have more than one node (Management Node, "MN") handling the installation and management of all the compute nodes. These additional "helper" nodes are called **Service Nodes** ("SN"). The Management Node can delegate all management operational needs for a compute node to the Service Node responsible for that compute node. There can be one or more Service Nodes configured to install/manage a group of compute nodes. +xCAT supports management of very large sized cluster through the use of **xCAT Hierarchy** or **xCAT Service Nodes**. -The following configurations are supported by xCAT: +When dealing with large clusters, to balance the load, it is recommended to have more than one node (Management Node, "MN") handling the installation and management of the compute nodes. These additional *helper* nodes are referred to as **xCAT Service Nodes** ("SN"). The Management Node can delegate all management operational needs to the Service Node responsible for a set of compute node. - * Each Service Node installs/manages a specific set of compute nodes - * Having a pool of Service Nodes in which any can respond to an installation request from a compute node - * A hybrid of the above, where each specific set of compute nodes have 2 or more Service Nodes in a pool +The following configurations are supported: + * Each service node installs/manages a specific set of compute nodes + * Having a pool of service nodes, any of which can respond to an installation request from a compute node (*Requires service nodes to be aligned with networks broadcast domains, compute node chooses service nodes based on who responds to DHCP request first.*) + * A hybrid of the above, where each specific set of compute nodes have 2 or more service nodes in a pool +The following documentation assumes an xCAT cluster has already been configured and covers the additional steps needed to suport xCAT Hierarchy via Service Nodes. .. toctree:: :maxdepth: 2 diff --git a/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst b/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst index d3b33911b..95958d102 100644 --- a/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst +++ b/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst @@ -1,2 +1,81 @@ Define Service Nodes ==================== + +This next part shows how to configure a xCAT Hierarchy and provision xCAT service nodes from an existing xCAT cluster. + +*The document assumes that the compute nodes part of your cluster have already been defined into the xCAT database and you have successfully provisioned the compute nodes using xCAT* + + +The following table illustrates the cluster being used in this example: + ++----------------------+----------------------+ +| Operating System | rhels7.1 | ++----------------------+----------------------+ +| Architecture | ppc64le | ++----------------------+----------------------+ +| xCAT Management Node | xcat01 | ++----------------------+----------------------+ +| Compute Nodes | r1n01 | +| (group=rack1) | r1n02 | +| | r1n03 | +| | ... | +| | r1n10 | ++----------------------+----------------------+ +| Compute Nodes | r2n01 | +| (group=rack1) | r2n02 | +| | r2n03 | +| | ... | +| | r2n10 | ++----------------------+----------------------+ + +#. Select the compute nodes that will become service nodes + + The first node in each rack, ``r1n01 and r2n01``, is selected to become the xCAT service nodes and manage the compute nodes in that rack + + +#. Change the attributes for the compute node to make them part of the **service** group: :: + + chdef -t node -o r1n01,r2n01 groups=service,all + +#. When ``copycds`` was run against the ISO image, several osimages are created into the ``osimage`` table. The ones containing "service" are provided to help easily provision xCAT service nodes. :: + + # lsdef -t osimage | grep rhels7.1 + rhels7.1-ppc64le-install-compute (osimage) + rhels7.1-ppc64le-install-service (osimage) <====== + rhels7.1-ppc64le-netboot-compute (osimage) + +#. Add the service nodes to the ``servicenode`` table: :: + + chdef -t group -o service setupnfs=1 setupdhcp=1 setuptftp=1 setupnameserver=1 setupconserver=1 + + **Tips/Hint** + * Even if you do not want xCAT to configure any services, you must define the service nodes in the ``servicenode`` table with at least one attribute, set to 0, otherwise xCAT will not recognize the node as a service node** + * See the ``setup*`` attributes in the node definition man page for the list of available services: ``man node`` + * For clusters with subnetted management networks, you might want to set ``setupupforward=1`` + +#. Add additional postscripts for Service Nodes (optional) + + By default, xCAT will execute the ``servicenode`` postscript when installed or diskless booted. This postscript will set up the necessary credentials and installs the xCAT software on the Service Nodes. If you have additional postscripts that you want to execute on the service nodes, copy to ``/install/postscripts`` and run the following: :: + + chdef -t group -o service -p postscripts= + +#. Assigning Compute Nodes to their Service Nodes + + The node attributes ``servicenode`` and ``xcatmaster``, define which Service node will serve the particular compute node. + + * ``servicenode`` - defines which Service Node the **Management Node** should send commands to (e.g ``xdsh``) and should be set to the hostname or IP address of the service node that the management node can conttact it by. + * ``xcatmaster`` - defines which Service Node the **Compute Node** should boot from and should be set to the hostname or IP address of the service node that the compute node can contact it by. + + You must set both ``servicenode`` and ``xcatmaster`` regardless of whether or not you are using service node pools, for most scenarios, the value will be identical. :: + + chdef -t group -o rack1 servicenode=r1n01 xcatmaster=r1n01 + chdef -t group -o rack2 servicenode=r2n01 xcatmaster=r2n01 + +#. Set the conserver and monserver attributes + + Set which service node should run the conserver (console) and monserver (monitoring) daemon for the nodes in the group. The most typical setup is to have the service node also ad as it's conserver and monserver. :: + + chdef -t group -o rack1 conserver=r1n01 monserver=r1n01 + chdef -t group -o rack2 conserver=r2n01 monserver=r2n01 + + diff --git a/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst b/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst index c97b510f2..324858f6a 100644 --- a/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst +++ b/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst @@ -1,3 +1,9 @@ Service Nodes 101 ================= +Service Nodes are similar to the xCAT Management Node in that each service Nodes runs an instance of the xCAT daemon: ``xcatd``. ``xcatd``'s communicate with each other using the same XML/SSL protocol that the xCAT client uses to communicate with ``xcatd`` on the Management Node. + +The Service Nodes need to communicate with the xCAT database running on the Management Node. This is done using the remote client capabilities of the database. This is why the default SQLite database cannot be used. + +The xCAT Service Nodes are installed with a special xCAT package ``xCATsn`` which tells ``xcatd`` running on the node to behave as a Service Node and not the Management Node. + From 5cf54f61c21e62c84e0923aa39a668919430f901 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Wed, 12 Aug 2015 11:36:43 -0400 Subject: [PATCH 39/57] Sync up the toctree entries to have maxdepth:2 and specify the .rst extensions --- source/advanced/index.rst | 8 ++++---- source/developers/git/index.rst | 2 +- source/developers/mini-design/index.rst | 4 ++-- source/guides/admin-guides/index.rst | 2 +- source/guides/admin-guides/ubuntu_clusters/index.rst | 5 ++--- source/guides/install-guides/apt/index.rst | 2 +- source/guides/install-guides/index.rst | 8 ++++---- source/guides/install-guides/yum/index.rst | 6 +++--- source/guides/install-guides/zypper/index.rst | 6 +++--- source/index.rst | 10 +++++----- 10 files changed, 26 insertions(+), 27 deletions(-) diff --git a/source/advanced/index.rst b/source/advanced/index.rst index fb9534388..4f04f4bea 100644 --- a/source/advanced/index.rst +++ b/source/advanced/index.rst @@ -4,7 +4,7 @@ Advanced Topics .. toctree:: :maxdepth: 2 - confluent/index - docker/index - hamn/index - mixed_cluster + confluent/index.rst + docker/index.rst + hamn/index.rst + mixed_cluster.rst diff --git a/source/developers/git/index.rst b/source/developers/git/index.rst index 6569733ad..2a3d8c8e4 100644 --- a/source/developers/git/index.rst +++ b/source/developers/git/index.rst @@ -9,6 +9,6 @@ xCAT uses git for source code version control. There are many resources and doc .. toctree:: - :maxdepth: 1 + :maxdepth: 2 diff --git a/source/developers/mini-design/index.rst b/source/developers/mini-design/index.rst index 35b63f803..324383271 100644 --- a/source/developers/mini-design/index.rst +++ b/source/developers/mini-design/index.rst @@ -11,7 +11,7 @@ The **Design Document** for certain feature. ---- .. toctree:: - :maxdepth: 1 + :maxdepth: 2 2.11/docker.rst 2.11/docker-swarm.rst @@ -19,6 +19,6 @@ The **Design Document** for certain feature. 2.10 ---- .. toctree:: - :maxdepth: 1 + :maxdepth: 2 2.10/xcatdebugmode.rst diff --git a/source/guides/admin-guides/index.rst b/source/guides/admin-guides/index.rst index f9d9a3820..86b6f6fad 100644 --- a/source/guides/admin-guides/index.rst +++ b/source/guides/admin-guides/index.rst @@ -2,7 +2,7 @@ Admin Guide =========== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 large_clusters/index.rst ubuntu_clusters/index.rst diff --git a/source/guides/admin-guides/ubuntu_clusters/index.rst b/source/guides/admin-guides/ubuntu_clusters/index.rst index 9491dbd9c..a46c87ed8 100644 --- a/source/guides/admin-guides/ubuntu_clusters/index.rst +++ b/source/guides/admin-guides/ubuntu_clusters/index.rst @@ -4,7 +4,6 @@ Managing Ubuntu/Debian Clusters .. toctree:: :maxdepth: 2 - - xCAT_on_Ubuntu_Server - ../../install-guides/common/prepare_mgmt_node + xCAT_on_Ubuntu_Server.rst + ../../install-guides/common/prepare_mgmt_node.rst diff --git a/source/guides/install-guides/apt/index.rst b/source/guides/install-guides/apt/index.rst index e68d9b3cc..be2dd8524 100644 --- a/source/guides/install-guides/apt/index.rst +++ b/source/guides/install-guides/apt/index.rst @@ -6,4 +6,4 @@ For the list of currently supported Ubuntu LTS operatin systems, see :ref:`ubunt .. toctree:: :maxdepth: 2 - ../common/prepare_mgmt_node + ../common/prepare_mgmt_node.rst diff --git a/source/guides/install-guides/index.rst b/source/guides/install-guides/index.rst index 773fe4f5a..8f9786b4e 100644 --- a/source/guides/install-guides/index.rst +++ b/source/guides/install-guides/index.rst @@ -2,8 +2,8 @@ Install Guides ============== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - yum/index - zypper/index - apt/index + yum/index.rst + zypper/index.rst + apt/index.rst diff --git a/source/guides/install-guides/yum/index.rst b/source/guides/install-guides/yum/index.rst index ee957176a..3fdf1f985 100644 --- a/source/guides/install-guides/yum/index.rst +++ b/source/guides/install-guides/yum/index.rst @@ -6,6 +6,6 @@ For the list of currently supported RHEL operating systems, see :ref:`rhels-os-s .. toctree:: :maxdepth: 2 - prepare_mgmt_node - install_xcat - configure_xcat + prepare_mgmt_node.rst + install_xcat.rst + configure_xcat.rst diff --git a/source/guides/install-guides/zypper/index.rst b/source/guides/install-guides/zypper/index.rst index cd3a61a46..74d6acd2b 100644 --- a/source/guides/install-guides/zypper/index.rst +++ b/source/guides/install-guides/zypper/index.rst @@ -6,6 +6,6 @@ For the list of currently supported SLES operating systems, see :ref:`sles-os-su .. toctree:: :maxdepth: 2 - prepare_mgmt_node -.. install_xcat -.. configure_xcat + prepare_mgmt_node.rst +.. install_xcat.rst +.. configure_xcat.rst diff --git a/source/index.rst b/source/index.rst index 5bc6cd81a..9cabbc498 100644 --- a/source/index.rst +++ b/source/index.rst @@ -20,11 +20,11 @@ Content .. toctree:: :maxdepth: 2 - guides/install-guides/index - guides/admin-guides/index - developers/index - advanced/index - help + guides/install-guides/index.rst + guides/admin-guides/index.rst + developers/index.rst + advanced/index.rst + help.rst Indices and tables From 4036297578ba065262de7fa7f21799b5aae79315 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Wed, 12 Aug 2015 14:33:00 -0400 Subject: [PATCH 40/57] The 2nd address line on the form was causing a SEVERE error during the build. Fixed by changing to "address 1:" and "address 2:" for the lines --- ...orporate_contributor_license_agreement.rst | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/source/developers/license/xcat_corporate_contributor_license_agreement.rst b/source/developers/license/xcat_corporate_contributor_license_agreement.rst index 36ed4df9a..ac37ca507 100644 --- a/source/developers/license/xcat_corporate_contributor_license_agreement.rst +++ b/source/developers/license/xcat_corporate_contributor_license_agreement.rst @@ -7,23 +7,23 @@ In order to clarify the intellectual property license granted with Contributions This version of the Agreement allows an entity (the "Corporation") to submit Contributions to the xCAT Community, to authorize Contributions submitted by its designated employees to the xCAT Community, and to grant copyright and patent licenses thereto. -If you have not already done so, please print this form, complete it, sign it, and send a scanned copy via email to **xcat-legal@lists.sourceforge.net** . Please read this document carefully before signing and keep a copy for your records. - +If you have not already done so, please print this form, complete it, sign it, and send a scanned copy via email to **xcat-legal@lists.sourceforge.net** . Please read this document carefully before signing and keep a copy for your records. + Corporation name: ___________________________________________________ - - - Corporation address: ________________________________________________ - - ________________________________________________ - + Address 1: ___________________________________________________ + + + Address 2: ___________________________________________________ + + Point of Contact: ___________________________________________________ - + E-Mail: _____________________________________________________________ - + Telephone: __________________________ Fax: __________________________ From 3044e9c6cfc05c13bbc9844f95a158b69dee85d5 Mon Sep 17 00:00:00 2001 From: wangxiaopeng Date: Thu, 13 Aug 2015 10:19:55 -0400 Subject: [PATCH 41/57] Add the doc skeleton for \'Admin Guide\'->\'Basic Concept\' If we all agree with the format, we will add others --- .../admin-guides/basic_concepts/.index.rst.swp | Bin 0 -> 12288 bytes .../basic_concepts/global_cfg/index.rst | 4 ++++ .../admin-guides/basic_concepts/index.rst | 10 ++++++++++ .../basic_concepts/network_planning/index.rst | 8 ++++++++ .../network_planning/network_cfg/index.rst | 2 ++ .../network_planning/network_service/index.rst | 2 ++ .../basic_concepts/xcat_db/index.rst | 11 +++++++++++ .../basic_concepts/xcat_object/index.rst | 12 ++++++++++++ source/guides/admin-guides/index.rst | 4 +--- .../admin-guides/ubuntu_clusters/index.rst | 9 --------- .../ubuntu_clusters/xCAT_on_Ubuntu_Server.rst | 3 --- 11 files changed, 50 insertions(+), 15 deletions(-) create mode 100644 source/guides/admin-guides/basic_concepts/.index.rst.swp create mode 100644 source/guides/admin-guides/basic_concepts/global_cfg/index.rst create mode 100644 source/guides/admin-guides/basic_concepts/index.rst create mode 100644 source/guides/admin-guides/basic_concepts/network_planning/index.rst create mode 100644 source/guides/admin-guides/basic_concepts/network_planning/network_cfg/index.rst create mode 100644 source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst create mode 100644 source/guides/admin-guides/basic_concepts/xcat_db/index.rst create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/index.rst delete mode 100644 source/guides/admin-guides/ubuntu_clusters/index.rst delete mode 100644 source/guides/admin-guides/ubuntu_clusters/xCAT_on_Ubuntu_Server.rst diff --git a/source/guides/admin-guides/basic_concepts/.index.rst.swp b/source/guides/admin-guides/basic_concepts/.index.rst.swp new file mode 100644 index 0000000000000000000000000000000000000000..5e9b341daae6fbc3805c0b84facdaf1895e3c713 GIT binary patch literal 12288 zcmeI&y-ve05C`xpBNF0kWHB%|DFq2B5(`WW3=CyMkz<=S(Arhvh%AU#VBsZr4Hy}D z0eFK-JOGy}NNtyPV4?b3I=MbyD*LxZxukVUk$I|O z<*YJ8pNFZ{rVO%tp))RWKGZ;9xdqnfuzk>~?zq3VE4H^f%Y9wk4gwH>00bZa0SG_< z0uY!I@WTc@a%QE@uGVv7X0Df*AOHafKmY;|fB*y_009U<00I#BhXPU)?W_~U9M$*# z-}nC!ufI4xIX*bvI9@qkIG#BkIL6QX!#m^15P$##AOHafKmY;|fB*y_0D(Ui5JFhv z?_G8m5Bt*E)OIKO)_J$vcZuxB>SiWiwa3RgnJykDU2 Date: Thu, 13 Aug 2015 10:46:49 -0400 Subject: [PATCH 42/57] Change yum to zypper for SLES related documentation --- .../admin-guides/large_clusters/databases/mysql_install.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_install.rst b/source/guides/admin-guides/large_clusters/databases/mysql_install.rst index 30eb3f7dc..a22eef7b6 100644 --- a/source/guides/admin-guides/large_clusters/databases/mysql_install.rst +++ b/source/guides/admin-guides/large_clusters/databases/mysql_install.rst @@ -44,7 +44,7 @@ Redhat Enterprise Linux Suse Linux Enterprise Server ---------------------------- -* MySQL - Using ``yum``, ensure that the following packages are installed on the management node: :: +* MySQL - Using ``zypper``, ensure that the following packages are installed on the management node: :: mysql-client-5* libmysqlclient_r15* @@ -53,7 +53,7 @@ Suse Linux Enterprise Server perl-DBD-mysql-4* mysql-5* -* MariaDB - Using ``yum``, ensure that the following packages are installed on the management node: :: +* MariaDB - Using ``zypper``, ensure that the following packages are installed on the management node: :: mariadb-client-10.* mariadb-10.* From 60f679e149803692cb8d4f06e0f7862d939be7c9 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 13 Aug 2015 16:01:19 -0400 Subject: [PATCH 43/57] Update the help page to include a comment on using the GitHub issues system as a first option, the mailing list is still avilable to those who enjoy email --- source/help.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/help.rst b/source/help.rst index a3d59a030..1d26c6209 100644 --- a/source/help.rst +++ b/source/help.rst @@ -1,5 +1,7 @@ Need Help ========= -If you're having trouble, please email the xcat users mailing list: xcat-user@list.sourceforge.net +xCAT is now on GitHub! https://github.com/xcat2 +For support, we encourage the use of the GutHub issues system. +However, the older email list is still availble: xcat-user@list.sourceforge.net From ea96577fe9ccd3191254fbdff00f2c165360a138 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 13 Aug 2015 16:15:14 -0400 Subject: [PATCH 44/57] Added skeleton structure for the overview section for documentation --- source/index.rst | 1 + source/overview/architecture.rst | 4 ++++ source/overview/features.rst | 4 ++++ source/overview/index.rst | 13 +++++++++++++ source/overview/support_list.rst | 2 ++ 5 files changed, 24 insertions(+) create mode 100644 source/overview/architecture.rst create mode 100644 source/overview/features.rst create mode 100644 source/overview/index.rst create mode 100644 source/overview/support_list.rst diff --git a/source/index.rst b/source/index.rst index 9cabbc498..c202bd7a2 100644 --- a/source/index.rst +++ b/source/index.rst @@ -20,6 +20,7 @@ Content .. toctree:: :maxdepth: 2 + overview/index.rst guides/install-guides/index.rst guides/admin-guides/index.rst developers/index.rst diff --git a/source/overview/architecture.rst b/source/overview/architecture.rst new file mode 100644 index 000000000..d76d7e7da --- /dev/null +++ b/source/overview/architecture.rst @@ -0,0 +1,4 @@ +Architecture +============ + +https://sourceforge.net/p/xcat/wiki/XCAT_Overview%2C_Architecture%2C_and_Planning/#xcat-architecture diff --git a/source/overview/features.rst b/source/overview/features.rst new file mode 100644 index 000000000..4640ce691 --- /dev/null +++ b/source/overview/features.rst @@ -0,0 +1,4 @@ +Features +======== + +https://sourceforge.net/p/xcat/wiki/XCAT_Overview%2C_Architecture%2C_and_Planning/#overview-of-xcats-features diff --git a/source/overview/index.rst b/source/overview/index.rst new file mode 100644 index 000000000..c7bc169d5 --- /dev/null +++ b/source/overview/index.rst @@ -0,0 +1,13 @@ +Overview +======== + +xCAT enables you to easily manage large number of servers for any type of techincal computing workload. + +xCAT is known for exceptional scaling, wide variety of supported hardware, operating systems, and virtalization platforms, and complete day0 setup capabilities. + +.. toctree:: + :maxdepth: 2 + + features.rst + support_list.rst + architecture.rst diff --git a/source/overview/support_list.rst b/source/overview/support_list.rst new file mode 100644 index 000000000..04d821fc1 --- /dev/null +++ b/source/overview/support_list.rst @@ -0,0 +1,2 @@ +Supported Hardware and Operating Systems +======================================== From e88bb075fac8c16e5fea29182be036cce11ea10f Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 13 Aug 2015 16:17:54 -0400 Subject: [PATCH 45/57] Made some changes to the basic_concepts, mostly what I had discussed with Xiao Peng through xcat2/xcat-doc pull request #14 --- .../basic_concepts/.index.rst.swp | Bin 12288 -> 0 bytes .../network_service/index.rst | 6 +++-- .../basic_concepts/xcat_db/index.rst | 25 ++++++++++++------ .../basic_concepts/xcat_object/index.rst | 17 +++++------- .../basic_concepts/xcat_object/node.rst | 6 +++++ .../basic_concepts/xcat_object/nodegroup.rst | 2 ++ .../basic_concepts/xcat_object/osimage.rst | 2 ++ 7 files changed, 38 insertions(+), 20 deletions(-) delete mode 100644 source/guides/admin-guides/basic_concepts/.index.rst.swp create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/node.rst create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/nodegroup.rst create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst diff --git a/source/guides/admin-guides/basic_concepts/.index.rst.swp b/source/guides/admin-guides/basic_concepts/.index.rst.swp deleted file mode 100644 index 5e9b341daae6fbc3805c0b84facdaf1895e3c713..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 12288 zcmeI&y-ve05C`xpBNF0kWHB%|DFq2B5(`WW3=CyMkz<=S(Arhvh%AU#VBsZr4Hy}D z0eFK-JOGy}NNtyPV4?b3I=MbyD*LxZxukVUk$I|O z<*YJ8pNFZ{rVO%tp))RWKGZ;9xdqnfuzk>~?zq3VE4H^f%Y9wk4gwH>00bZa0SG_< z0uY!I@WTc@a%QE@uGVv7X0Df*AOHafKmY;|fB*y_009U<00I#BhXPU)?W_~U9M$*# z-}nC!ufI4xIX*bvI9@qkIG#BkIL6QX!#m^15P$##AOHafKmY;|fB*y_0D(Ui5JFhv z?_G8m5Bt*E)OIKO)_J$vcZuxB>SiWiwa3RgnJykDU2 Date: Thu, 13 Aug 2015 16:22:41 -0400 Subject: [PATCH 46/57] Commit initial skeleton for the hardware_arcitecture and references section for the documentation --- .../hardware_architectures/common/discovery.rst | 2 ++ .../hardware_architectures/common/diskful.rst | 2 ++ .../hardware_architectures/common/diskless.rst | 2 ++ .../hardware_architectures/common/management.rst | 2 ++ .../common/management/rbeacon.rst | 2 ++ .../common/management/rcons.rst | 2 ++ .../common/management/renergy.rst | 2 ++ .../common/management/reventlog.rst | 2 ++ .../common/management/rflash.rst | 2 ++ .../common/management/rinv.rst | 2 ++ .../common/management/rpower.rst | 2 ++ .../common/management/rspconfig.rst | 2 ++ .../common/management/rvitals.rst | 2 ++ .../hardware_architectures/index.rst | 8 ++++++++ .../hardware_architectures/ppc64le/index.rst | 8 ++++++++ .../ppc64le/power8le_baremetal/index.rst | 11 +++++++++++ .../power8le_baremetal/management/index.rst | 16 ++++++++++++++++ .../ppc64le/power8le_kvm/index.rst | 11 +++++++++++ .../ppc64le/power8le_kvm/management/index.rst | 16 ++++++++++++++++ .../hardware_architectures/x86_64/index.rst | 8 ++++++++ .../x86_64/x86_64_baremetal/index.rst | 11 +++++++++++ .../x86_64/x86_64_baremetal/management/index.rst | 16 ++++++++++++++++ .../x86_64/x86_64_kvm/index.rst | 11 +++++++++++ .../x86_64/x86_64_kvm/management/index.rst | 16 ++++++++++++++++ source/guides/admin-guides/index.rst | 2 ++ source/guides/admin-guides/references/index.rst | 13 +++++++++++++ 26 files changed, 173 insertions(+) create mode 100644 source/guides/admin-guides/hardware_architectures/common/discovery.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/diskful.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/diskless.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management/rbeacon.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management/rcons.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management/renergy.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management/reventlog.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management/rflash.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management/rinv.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management/rpower.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management/rspconfig.rst create mode 100644 source/guides/admin-guides/hardware_architectures/common/management/rvitals.rst create mode 100644 source/guides/admin-guides/hardware_architectures/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/ppc64le/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/management/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/management/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/x86_64/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/management/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/index.rst create mode 100644 source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/management/index.rst create mode 100644 source/guides/admin-guides/references/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/discovery.rst b/source/guides/admin-guides/hardware_architectures/common/discovery.rst new file mode 100644 index 000000000..af02f5d75 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/discovery.rst @@ -0,0 +1,2 @@ +Hardware Discovery +================== diff --git a/source/guides/admin-guides/hardware_architectures/common/diskful.rst b/source/guides/admin-guides/hardware_architectures/common/diskful.rst new file mode 100644 index 000000000..50d88b693 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/diskful.rst @@ -0,0 +1,2 @@ +Diskful Installation +==================== diff --git a/source/guides/admin-guides/hardware_architectures/common/diskless.rst b/source/guides/admin-guides/hardware_architectures/common/diskless.rst new file mode 100644 index 000000000..e984a34e9 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/diskless.rst @@ -0,0 +1,2 @@ +Diskless Installation +===================== diff --git a/source/guides/admin-guides/hardware_architectures/common/management.rst b/source/guides/admin-guides/hardware_architectures/common/management.rst new file mode 100644 index 000000000..8017333cf --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management.rst @@ -0,0 +1,2 @@ +Hardware Management +=================== diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rbeacon.rst b/source/guides/admin-guides/hardware_architectures/common/management/rbeacon.rst new file mode 100644 index 000000000..a55f4e30b --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management/rbeacon.rst @@ -0,0 +1,2 @@ +``rbeacon`` +=========== \ No newline at end of file diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rcons.rst b/source/guides/admin-guides/hardware_architectures/common/management/rcons.rst new file mode 100644 index 000000000..0857a2db7 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management/rcons.rst @@ -0,0 +1,2 @@ +``rcons`` +========= \ No newline at end of file diff --git a/source/guides/admin-guides/hardware_architectures/common/management/renergy.rst b/source/guides/admin-guides/hardware_architectures/common/management/renergy.rst new file mode 100644 index 000000000..3ca21667a --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management/renergy.rst @@ -0,0 +1,2 @@ +``renergy`` +=========== \ No newline at end of file diff --git a/source/guides/admin-guides/hardware_architectures/common/management/reventlog.rst b/source/guides/admin-guides/hardware_architectures/common/management/reventlog.rst new file mode 100644 index 000000000..b701de10a --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management/reventlog.rst @@ -0,0 +1,2 @@ +``reventlog`` +============= \ No newline at end of file diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rflash.rst b/source/guides/admin-guides/hardware_architectures/common/management/rflash.rst new file mode 100644 index 000000000..438bb80cf --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management/rflash.rst @@ -0,0 +1,2 @@ +``rflash`` +========== \ No newline at end of file diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rinv.rst b/source/guides/admin-guides/hardware_architectures/common/management/rinv.rst new file mode 100644 index 000000000..dad597a14 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management/rinv.rst @@ -0,0 +1,2 @@ +``rinv`` +======== \ No newline at end of file diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rpower.rst b/source/guides/admin-guides/hardware_architectures/common/management/rpower.rst new file mode 100644 index 000000000..af106290a --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management/rpower.rst @@ -0,0 +1,2 @@ +``rpower`` +========== \ No newline at end of file diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rspconfig.rst b/source/guides/admin-guides/hardware_architectures/common/management/rspconfig.rst new file mode 100644 index 000000000..7506db83c --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management/rspconfig.rst @@ -0,0 +1,2 @@ +``rspconfig`` +============= \ No newline at end of file diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rvitals.rst b/source/guides/admin-guides/hardware_architectures/common/management/rvitals.rst new file mode 100644 index 000000000..f60600b93 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/common/management/rvitals.rst @@ -0,0 +1,2 @@ +``rvitals`` +=========== \ No newline at end of file diff --git a/source/guides/admin-guides/hardware_architectures/index.rst b/source/guides/admin-guides/hardware_architectures/index.rst new file mode 100644 index 000000000..9185c722b --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/index.rst @@ -0,0 +1,8 @@ +Hardware Architectures +====================== + +.. toctree:: + :maxdepth: 2 + + ppc64le/index.rst + x86_64/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/index.rst b/source/guides/admin-guides/hardware_architectures/ppc64le/index.rst new file mode 100644 index 000000000..e9b3e7899 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/ppc64le/index.rst @@ -0,0 +1,8 @@ +ppc64le +======= + +.. toctree:: + :maxdepth: 2 + + power8le_baremetal/index.rst + power8le_kvm/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/index.rst b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/index.rst new file mode 100644 index 000000000..27d0b2cee --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/index.rst @@ -0,0 +1,11 @@ +IBM Power8 LE and OpenPOWER (bare metal) +======================================== + +.. toctree:: + :maxdepth: 2 + + ../../common/discovery.rst + management/index.rst + ../../common/diskful.rst + ../../common/diskless.rst + diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/management/index.rst b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/management/index.rst new file mode 100644 index 000000000..d491207b5 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/management/index.rst @@ -0,0 +1,16 @@ +Hardware Management +=================== + +.. toctree:: + :maxdepth: 2 + + ../../../common/management/rpower.rst + ../../../common/management/rspconfig.rst + ../../../common/management/reventlog.rst + ../../../common/management/rbeacon + ../../../common/management/rcons + ../../../common/management/rinv + ../../../common/management/rvitals + ../../../common/management/rflash + ../../../common/management/renergy + diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/index.rst b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/index.rst new file mode 100644 index 000000000..156ff80de --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/index.rst @@ -0,0 +1,11 @@ +IBM Power8 LE and OpenPOWER (kvm) +================================= + +.. toctree:: + :maxdepth: 2 + + ../../common/discovery.rst + management/index.rst + ../../common/diskful.rst + ../../common/diskless.rst + diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/management/index.rst b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/management/index.rst new file mode 100644 index 000000000..d491207b5 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/management/index.rst @@ -0,0 +1,16 @@ +Hardware Management +=================== + +.. toctree:: + :maxdepth: 2 + + ../../../common/management/rpower.rst + ../../../common/management/rspconfig.rst + ../../../common/management/reventlog.rst + ../../../common/management/rbeacon + ../../../common/management/rcons + ../../../common/management/rinv + ../../../common/management/rvitals + ../../../common/management/rflash + ../../../common/management/renergy + diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/index.rst b/source/guides/admin-guides/hardware_architectures/x86_64/index.rst new file mode 100644 index 000000000..a8855b0f5 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/x86_64/index.rst @@ -0,0 +1,8 @@ +x86_64 +====== + +.. toctree:: + :maxdepth: 2 + + x86_64_baremetal/index.rst + x86_64_kvm/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/index.rst b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/index.rst new file mode 100644 index 000000000..7dab37f81 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/index.rst @@ -0,0 +1,11 @@ +x86_64 (bare metal) +=================== + +.. toctree:: + :maxdepth: 2 + + ../../common/discovery.rst + management/index.rst + ../../common/diskful.rst + ../../common/diskless.rst + diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/management/index.rst b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/management/index.rst new file mode 100644 index 000000000..d491207b5 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/management/index.rst @@ -0,0 +1,16 @@ +Hardware Management +=================== + +.. toctree:: + :maxdepth: 2 + + ../../../common/management/rpower.rst + ../../../common/management/rspconfig.rst + ../../../common/management/reventlog.rst + ../../../common/management/rbeacon + ../../../common/management/rcons + ../../../common/management/rinv + ../../../common/management/rvitals + ../../../common/management/rflash + ../../../common/management/renergy + diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/index.rst b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/index.rst new file mode 100644 index 000000000..178354f92 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/index.rst @@ -0,0 +1,11 @@ +x86_64 (kvm) +============ + +.. toctree:: + :maxdepth: 2 + + ../../common/discovery.rst + management/index.rst + ../../common/diskful.rst + ../../common/diskless.rst + diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/management/index.rst b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/management/index.rst new file mode 100644 index 000000000..d491207b5 --- /dev/null +++ b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/management/index.rst @@ -0,0 +1,16 @@ +Hardware Management +=================== + +.. toctree:: + :maxdepth: 2 + + ../../../common/management/rpower.rst + ../../../common/management/rspconfig.rst + ../../../common/management/reventlog.rst + ../../../common/management/rbeacon + ../../../common/management/rcons + ../../../common/management/rinv + ../../../common/management/rvitals + ../../../common/management/rflash + ../../../common/management/renergy + diff --git a/source/guides/admin-guides/index.rst b/source/guides/admin-guides/index.rst index 81d124bab..ba23d53f3 100644 --- a/source/guides/admin-guides/index.rst +++ b/source/guides/admin-guides/index.rst @@ -5,4 +5,6 @@ Admin Guide :maxdepth: 2 basic_concepts/index.rst + hardware_architectures/index.rst + references/index.rst large_clusters/index.rst diff --git a/source/guides/admin-guides/references/index.rst b/source/guides/admin-guides/references/index.rst new file mode 100644 index 000000000..c66324cfe --- /dev/null +++ b/source/guides/admin-guides/references/index.rst @@ -0,0 +1,13 @@ +References +========== + +xCAT Commands +------------- + +xCAT Man Pages +-------------- + + +xCAT Database Tables +-------------------- + From af9368827a7a3db36b74a22cb498504f5e59faf4 Mon Sep 17 00:00:00 2001 From: wangxiaopeng Date: Thu, 13 Aug 2015 22:32:05 -0400 Subject: [PATCH 47/57] Refine the doc skeleton in the Basic Concept part Since it has been discussed with Victor, I check it in directly --- .../network_service/index.rst | 4 +-- .../basic_concepts/xcat_db/index.rst | 25 +++++++++++++------ .../basic_concepts/xcat_object/group.rst | 2 ++ .../basic_concepts/xcat_object/index.rst | 17 ++++++------- .../basic_concepts/xcat_object/node.rst | 5 ++++ .../basic_concepts/xcat_object/osimage.rst | 2 ++ 6 files changed, 35 insertions(+), 20 deletions(-) create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/group.rst create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/node.rst create mode 100644 source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst diff --git a/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst b/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst index 54dd662bd..734496736 100644 --- a/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst +++ b/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst @@ -1,2 +1,2 @@ -Network Services which are used in xCAT -================================== +Network Services +================ diff --git a/source/guides/admin-guides/basic_concepts/xcat_db/index.rst b/source/guides/admin-guides/basic_concepts/xcat_db/index.rst index a202a8c9f..d3d4212fd 100644 --- a/source/guides/admin-guides/basic_concepts/xcat_db/index.rst +++ b/source/guides/admin-guides/basic_concepts/xcat_db/index.rst @@ -1,11 +1,20 @@ -xCAT Database -============= +Database +======== -Definition of xCAT DB ---------------------- +xCAT stores all the persistent data used to manage clusters in a database. -How to Manipulate xCAT DB -------------------------- +As the administrator, you can use a set of table oriented commands to modify the data (**recommended**), or directly modify the table using the ``tabedit`` command. -How to Use Regular Expression in xCAT DB ----------------------------------------- +For a more indepth overview see the manpage for xcatdb: ``man xcatdb`` + +Commands +-------- + +Object Definitions +------------------ + +Node Groups +----------- + +Regular Expressions +------------------- diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/group.rst b/source/guides/admin-guides/basic_concepts/xcat_object/group.rst new file mode 100644 index 000000000..acb591df6 --- /dev/null +++ b/source/guides/admin-guides/basic_concepts/xcat_object/group.rst @@ -0,0 +1,2 @@ +``group`` +========= diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/index.rst b/source/guides/admin-guides/basic_concepts/xcat_object/index.rst index a9eb888ce..df5d96fd2 100644 --- a/source/guides/admin-guides/basic_concepts/xcat_object/index.rst +++ b/source/guides/admin-guides/basic_concepts/xcat_object/index.rst @@ -1,12 +1,9 @@ -xCAT Object -=========== +Objects +======= -Node Object ------------ -Node Range +.. toctree:: + :maxdepth: 2 -OSimage Object --------------- - -Group Object ------------- + node.rst + osimage.rst + group.rst diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/node.rst b/source/guides/admin-guides/basic_concepts/xcat_object/node.rst new file mode 100644 index 000000000..267f86f31 --- /dev/null +++ b/source/guides/admin-guides/basic_concepts/xcat_object/node.rst @@ -0,0 +1,5 @@ +``node`` +======== + +Node Range +---------- diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst b/source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst new file mode 100644 index 000000000..c4549b949 --- /dev/null +++ b/source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst @@ -0,0 +1,2 @@ +``osimage`` +=========== From 135d72e5b5eff1cc3bc12ae76ccfca11f5e8ce37 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 13 Aug 2015 23:34:50 -0400 Subject: [PATCH 48/57] Fix typo in this page GutHub -> GitHub Also added hyperlinks for the issues page for xcat-core, confluent & xcat-doc --- source/help.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/source/help.rst b/source/help.rst index 1d26c6209..4ccff477d 100644 --- a/source/help.rst +++ b/source/help.rst @@ -1,7 +1,12 @@ Need Help ========= -xCAT is now on GitHub! https://github.com/xcat2 -For support, we encourage the use of the GutHub issues system. +xCAT is now on `GitHub! `_ -However, the older email list is still availble: xcat-user@list.sourceforge.net +For support, we encourage the use of the GitHub issues system. + * `xcat-core `_ + * `confluent `_ + * `xcat-doc `_ (documentation) + + +The older email list is still availble: xcat-user@list.sourceforge.net From 67cbb37cdf7593b0872d41f540ea0357db5bf182 Mon Sep 17 00:00:00 2001 From: wangxiaopeng Date: Fri, 14 Aug 2015 04:28:35 -0400 Subject: [PATCH 49/57] Change the skeleton of cluster management I moved the [Hardware Architectures] to [Manage Clusters] since I thought the name [Hardware Architectures] will make user confusing that this page is for hardware things. Another change was I moved the kvm part to be a sub-doc of specific arch. This is because the kvm only can be done after the bare-metal deployment. In the kvm part, I'd like only includes the [host install] and [vm management]. The OS deployment should be same with bare-metal. And since there's no much customer were using kvm, move it to low level will make our doc more clear to follow. --- .../hardware_architectures/ppc64le/index.rst | 8 -------- .../ppc64le/power8le_baremetal/index.rst | 11 ----------- .../ppc64le/power8le_kvm/index.rst | 11 ----------- .../x86_64_baremetal/management/index.rst | 16 ---------------- .../x86_64/x86_64_kvm/management/index.rst | 16 ---------------- source/guides/admin-guides/index.rst | 2 +- .../common/discovery.rst | 0 .../common/diskful.rst | 0 .../common/diskless.rst | 0 .../manage_clusters/common/kvm/manage_vm.rst | 8 ++++++++ .../common/management.rst | 0 .../common/management/rbeacon.rst | 0 .../common/management/rcons.rst | 0 .../common/management/renergy.rst | 0 .../common/management/reventlog.rst | 0 .../common/management/rflash.rst | 0 .../common/management/rinv.rst | 0 .../common/management/rpower.rst | 0 .../common/management/rspconfig.rst | 0 .../common/management/rvitals.rst | 0 .../index.rst | 4 ++-- .../manage_clusters/ppc64le/index.rst | 11 +++++++++++ .../ppc64le/management/.index.rst.swp | Bin 0 -> 12288 bytes .../ppc64le/management/index.rst | 16 ++++++++++++++++ .../ppc64le/power8le_kvm/index.rst | 8 ++++++++ .../ppc64le/power8le_kvm/install_powerkvm.rst | 2 ++ .../x86_64/index.rst | 0 .../x86_64/x86_64_baremetal/index.rst | 0 .../x86_64_baremetal}/management/index.rst | 0 .../x86_64/x86_64_kvm/index.rst | 0 .../x86_64/x86_64_kvm}/management/index.rst | 0 31 files changed, 48 insertions(+), 65 deletions(-) delete mode 100644 source/guides/admin-guides/hardware_architectures/ppc64le/index.rst delete mode 100644 source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/index.rst delete mode 100644 source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/index.rst delete mode 100644 source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/management/index.rst delete mode 100644 source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/management/index.rst rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/discovery.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/diskful.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/diskless.rst (100%) create mode 100644 source/guides/admin-guides/manage_clusters/common/kvm/manage_vm.rst rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management/rbeacon.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management/rcons.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management/renergy.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management/reventlog.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management/rflash.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management/rinv.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management/rpower.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management/rspconfig.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/common/management/rvitals.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/index.rst (60%) create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/.index.rst.swp create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/install_powerkvm.rst rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/x86_64/index.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/x86_64/x86_64_baremetal/index.rst (100%) rename source/guides/admin-guides/{hardware_architectures/ppc64le/power8le_baremetal => manage_clusters/x86_64/x86_64_baremetal}/management/index.rst (100%) rename source/guides/admin-guides/{hardware_architectures => manage_clusters}/x86_64/x86_64_kvm/index.rst (100%) rename source/guides/admin-guides/{hardware_architectures/ppc64le/power8le_kvm => manage_clusters/x86_64/x86_64_kvm}/management/index.rst (100%) diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/index.rst b/source/guides/admin-guides/hardware_architectures/ppc64le/index.rst deleted file mode 100644 index e9b3e7899..000000000 --- a/source/guides/admin-guides/hardware_architectures/ppc64le/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -ppc64le -======= - -.. toctree:: - :maxdepth: 2 - - power8le_baremetal/index.rst - power8le_kvm/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/index.rst b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/index.rst deleted file mode 100644 index 27d0b2cee..000000000 --- a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -IBM Power8 LE and OpenPOWER (bare metal) -======================================== - -.. toctree:: - :maxdepth: 2 - - ../../common/discovery.rst - management/index.rst - ../../common/diskful.rst - ../../common/diskless.rst - diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/index.rst b/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/index.rst deleted file mode 100644 index 156ff80de..000000000 --- a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -IBM Power8 LE and OpenPOWER (kvm) -================================= - -.. toctree:: - :maxdepth: 2 - - ../../common/discovery.rst - management/index.rst - ../../common/diskful.rst - ../../common/diskless.rst - diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/management/index.rst b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/management/index.rst deleted file mode 100644 index d491207b5..000000000 --- a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/management/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -Hardware Management -=================== - -.. toctree:: - :maxdepth: 2 - - ../../../common/management/rpower.rst - ../../../common/management/rspconfig.rst - ../../../common/management/reventlog.rst - ../../../common/management/rbeacon - ../../../common/management/rcons - ../../../common/management/rinv - ../../../common/management/rvitals - ../../../common/management/rflash - ../../../common/management/renergy - diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/management/index.rst b/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/management/index.rst deleted file mode 100644 index d491207b5..000000000 --- a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/management/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -Hardware Management -=================== - -.. toctree:: - :maxdepth: 2 - - ../../../common/management/rpower.rst - ../../../common/management/rspconfig.rst - ../../../common/management/reventlog.rst - ../../../common/management/rbeacon - ../../../common/management/rcons - ../../../common/management/rinv - ../../../common/management/rvitals - ../../../common/management/rflash - ../../../common/management/renergy - diff --git a/source/guides/admin-guides/index.rst b/source/guides/admin-guides/index.rst index ba23d53f3..20502bd4b 100644 --- a/source/guides/admin-guides/index.rst +++ b/source/guides/admin-guides/index.rst @@ -5,6 +5,6 @@ Admin Guide :maxdepth: 2 basic_concepts/index.rst - hardware_architectures/index.rst + manage_clusters/index.rst references/index.rst large_clusters/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/discovery.rst b/source/guides/admin-guides/manage_clusters/common/discovery.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/discovery.rst rename to source/guides/admin-guides/manage_clusters/common/discovery.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/diskful.rst b/source/guides/admin-guides/manage_clusters/common/diskful.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/diskful.rst rename to source/guides/admin-guides/manage_clusters/common/diskful.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/diskless.rst b/source/guides/admin-guides/manage_clusters/common/diskless.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/diskless.rst rename to source/guides/admin-guides/manage_clusters/common/diskless.rst diff --git a/source/guides/admin-guides/manage_clusters/common/kvm/manage_vm.rst b/source/guides/admin-guides/manage_clusters/common/kvm/manage_vm.rst new file mode 100644 index 000000000..ab5ec9ab7 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/kvm/manage_vm.rst @@ -0,0 +1,8 @@ +Manage Virtual Machine +====================== + +Create Virtual Machine +---------------------- + +Change Virtual Machine +---------------------- diff --git a/source/guides/admin-guides/hardware_architectures/common/management.rst b/source/guides/admin-guides/manage_clusters/common/management.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management.rst rename to source/guides/admin-guides/manage_clusters/common/management.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rbeacon.rst b/source/guides/admin-guides/manage_clusters/common/management/rbeacon.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management/rbeacon.rst rename to source/guides/admin-guides/manage_clusters/common/management/rbeacon.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rcons.rst b/source/guides/admin-guides/manage_clusters/common/management/rcons.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management/rcons.rst rename to source/guides/admin-guides/manage_clusters/common/management/rcons.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/management/renergy.rst b/source/guides/admin-guides/manage_clusters/common/management/renergy.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management/renergy.rst rename to source/guides/admin-guides/manage_clusters/common/management/renergy.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/management/reventlog.rst b/source/guides/admin-guides/manage_clusters/common/management/reventlog.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management/reventlog.rst rename to source/guides/admin-guides/manage_clusters/common/management/reventlog.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rflash.rst b/source/guides/admin-guides/manage_clusters/common/management/rflash.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management/rflash.rst rename to source/guides/admin-guides/manage_clusters/common/management/rflash.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rinv.rst b/source/guides/admin-guides/manage_clusters/common/management/rinv.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management/rinv.rst rename to source/guides/admin-guides/manage_clusters/common/management/rinv.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rpower.rst b/source/guides/admin-guides/manage_clusters/common/management/rpower.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management/rpower.rst rename to source/guides/admin-guides/manage_clusters/common/management/rpower.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rspconfig.rst b/source/guides/admin-guides/manage_clusters/common/management/rspconfig.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management/rspconfig.rst rename to source/guides/admin-guides/manage_clusters/common/management/rspconfig.rst diff --git a/source/guides/admin-guides/hardware_architectures/common/management/rvitals.rst b/source/guides/admin-guides/manage_clusters/common/management/rvitals.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/common/management/rvitals.rst rename to source/guides/admin-guides/manage_clusters/common/management/rvitals.rst diff --git a/source/guides/admin-guides/hardware_architectures/index.rst b/source/guides/admin-guides/manage_clusters/index.rst similarity index 60% rename from source/guides/admin-guides/hardware_architectures/index.rst rename to source/guides/admin-guides/manage_clusters/index.rst index 9185c722b..e2040f6ce 100644 --- a/source/guides/admin-guides/hardware_architectures/index.rst +++ b/source/guides/admin-guides/manage_clusters/index.rst @@ -1,5 +1,5 @@ -Hardware Architectures -====================== +Manage Clusters +=============== .. toctree:: :maxdepth: 2 diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/index.rst new file mode 100644 index 000000000..072b74e6c --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/index.rst @@ -0,0 +1,11 @@ +IBM Power8 LE and OpenPOWER +=========================== + +.. toctree:: + :maxdepth: 2 + + ../common/discovery.rst + management/index.rst + ../common/diskful.rst + ../common/diskless.rst + power8le_kvm/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/.index.rst.swp b/source/guides/admin-guides/manage_clusters/ppc64le/management/.index.rst.swp new file mode 100644 index 0000000000000000000000000000000000000000..e2a4b6f2fe4d847006a19e54341ec9ea55db2944 GIT binary patch literal 12288 zcmeI&F>ll`6bJCv?$C-#ofr(A8<(~M=_JGoL&tWleD>>|rNoYG=X#y^4h$XmB(xs^ ziMf^f75WWWcsULUft2e?`CIo_-ZIaS(c%zTYrUKLF^n!UX^T literal 0 HcmV?d00001 diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst new file mode 100644 index 000000000..aebe27a92 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst @@ -0,0 +1,16 @@ +Hardware Management +=================== + +.. toctree:: + :maxdepth: 2 + + ../../common/management/rpower.rst + ../../common/management/rspconfig.rst + ../../common/management/reventlog.rst + ../../common/management/rbeacon + ../../common/management/rcons + ../../common/management/rinv + ../../common/management/rvitals + ../../common/management/rflash + ../../common/management/renergy + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/index.rst new file mode 100644 index 000000000..d117d3071 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/index.rst @@ -0,0 +1,8 @@ +Manage kvm VM +================================= + +.. toctree:: + :maxdepth: 2 + + install_powerkvm.rst + ../../common/kvm/manage_vm.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/install_powerkvm.rst b/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/install_powerkvm.rst new file mode 100644 index 000000000..8ee5dd48e --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/install_powerkvm.rst @@ -0,0 +1,2 @@ +Install PowerKVM +================ diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/index.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/x86_64/index.rst rename to source/guides/admin-guides/manage_clusters/x86_64/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/index.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/x86_64/x86_64_baremetal/index.rst rename to source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/management/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/management/index.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/ppc64le/power8le_baremetal/management/index.rst rename to source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/management/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/index.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/x86_64/x86_64_kvm/index.rst rename to source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/index.rst diff --git a/source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/management/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/management/index.rst similarity index 100% rename from source/guides/admin-guides/hardware_architectures/ppc64le/power8le_kvm/management/index.rst rename to source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/management/index.rst From 1cb6ceaff08c7bfd25fbcd71c1cc47f0e5cd1d4d Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 14 Aug 2015 09:04:06 -0400 Subject: [PATCH 50/57] The yum_common and zypper_common files are not needed. The content is rolled into the prepare_mgmt_node file since each subdirectory contains specific instructions for that OS --- source/guides/install-guides/apt/index.rst | 2 +- .../install-guides/apt/prepare_mgmt_node.rst | 26 +++++++ .../common/prepare_mgmt_node.rst | 76 ------------------- .../install-guides/yum/prepare_mgmt_node.rst | 26 ++++++- .../guides/install-guides/yum/yum_common.rst | 42 ---------- .../zypper/prepare_mgmt_node.rst | 26 ++++++- .../guides/install-guides/zypper/sles_support | 2 - .../install-guides/zypper/zypper_common.rst | 43 ----------- 8 files changed, 73 insertions(+), 170 deletions(-) create mode 100644 source/guides/install-guides/apt/prepare_mgmt_node.rst delete mode 100644 source/guides/install-guides/common/prepare_mgmt_node.rst delete mode 100644 source/guides/install-guides/yum/yum_common.rst delete mode 100644 source/guides/install-guides/zypper/sles_support delete mode 100644 source/guides/install-guides/zypper/zypper_common.rst diff --git a/source/guides/install-guides/apt/index.rst b/source/guides/install-guides/apt/index.rst index be2dd8524..ede05d007 100644 --- a/source/guides/install-guides/apt/index.rst +++ b/source/guides/install-guides/apt/index.rst @@ -6,4 +6,4 @@ For the list of currently supported Ubuntu LTS operatin systems, see :ref:`ubunt .. toctree:: :maxdepth: 2 - ../common/prepare_mgmt_node.rst + prepare_mgmt_node.rst diff --git a/source/guides/install-guides/apt/prepare_mgmt_node.rst b/source/guides/install-guides/apt/prepare_mgmt_node.rst new file mode 100644 index 000000000..c5211a093 --- /dev/null +++ b/source/guides/install-guides/apt/prepare_mgmt_node.rst @@ -0,0 +1,26 @@ +Prepare the Management Node +=========================== + +These steps prepare the Management Node or xCAT Installation + +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 + +Configure the Base OS Repository +-------------------------------- + +**TODO** + +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. + diff --git a/source/guides/install-guides/common/prepare_mgmt_node.rst b/source/guides/install-guides/common/prepare_mgmt_node.rst deleted file mode 100644 index 50935396e..000000000 --- a/source/guides/install-guides/common/prepare_mgmt_node.rst +++ /dev/null @@ -1,76 +0,0 @@ -Prepare the Management Node for xCAT Installation -================================================= - -These steps prepare the Management Node or xCAT Installation - -Install an OS on the Management Node ------------------------------------- - -The hardware requirements for your xCAT management node largely depends on the size of the cluster you plan to manage and the type of provisioning being used (diskful, diskless, system clones, etc). The majority of system load comes during cluster provisioning. - -**Memory Recommendations:** - -+--------------+-------------+ -| Cluster size | Memory (GB) | -+==============+=============+ -| small (< 16) | 4-6 | -+--------------+-------------+ -| medium | 6-8 | -+--------------+-------------+ -| large | > 16 | -+--------------+-------------+ - -Install any flavor of the supported operating system onto the management node. - -The xCAT software RPMs will attempt to automatially install any base software provided by the Operating System if they are not already installed onto the machine. In order for this to succeed, the node must have a repository set up providing the base operating system packages. - -Configure the Base OS Repository --------------------------------- - -xCAT uses Linux Package Managers (yum, zypper, apt, etc) 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 - -#. Copy the dvd .iso file onto 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 - -#. Mount the dvd iso to a directory on the management node. :: - - # - # [rhel] 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 - - # - # [sles] 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 - -#. Create the local repository configuration file pointing to mounted iso image. :: - - # - # [rhel] - # - vi /etc/yum/yum.repos.d/rhels71-base.repo - - # - # [sles] - # - vi /etc/zypp/repos.d/sles12-base.repo - - - -# Setting up OS Repository on Mgmt Node - -Disable system services ------------------------ - -Disable the Firewall - - -* Set up Network -* Configure Network Interface Cards (NICs) -* Install the Management Node OS -* Supported OS and Hardware diff --git a/source/guides/install-guides/yum/prepare_mgmt_node.rst b/source/guides/install-guides/yum/prepare_mgmt_node.rst index 356774071..c9b3655a4 100644 --- a/source/guides/install-guides/yum/prepare_mgmt_node.rst +++ b/source/guides/install-guides/yum/prepare_mgmt_node.rst @@ -15,9 +15,29 @@ Install one of the supported operating systems :ref:`rhels-os-support-label` on Configure the Base OS Repository -------------------------------- - .. include:: yum_common.rst - :start-after: BEGIN_configure_base_os_repository - :end-before: END_configure_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 + +#. Copy the dvd .iso file onto 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 + +#. Mount the dvd iso to a directory 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 + +#. Create the local repository configuration file pointing to mounted iso image. :: + + cat /etc/yum/yum.repos.d/rhels71-base.repo + [rhel-7-server] + name=RHEL 7 SERVER packages + baseurl=file:///mnt/iso/rhels71/Server + enabled=1 + gpgcheck=1 Set up Network diff --git a/source/guides/install-guides/yum/yum_common.rst b/source/guides/install-guides/yum/yum_common.rst deleted file mode 100644 index 8cc72e702..000000000 --- a/source/guides/install-guides/yum/yum_common.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. BEGIN_configure_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 - -#. Copy the dvd .iso file onto 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 - -#. Mount the dvd iso to a directory 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 - -#. Create the local repository configuration file pointing to mounted iso image. :: - - cat /etc/yum/yum.repos.d/rhels71-base.repo - [rhel-7-server] - name=RHEL 7 SERVER packages - baseurl=file:///mnt/iso/rhels71/Server - enabled=1 - gpgcheck=1 - - -.. END_configure_base_os_repository - - - - -.. BEGIN_disable_firewall -.. DEPRECATED: Firewall instructions is not applicable after xCAT 2.8 - -The management node provides many services to the cluster nodes. Running a firewall on the management node can interfere with these services. -If your cluster is running on a secure network, the easiest thing to do is disable the firewall on the management node:: - - service iptables stop - service ip6tables stop - -.. END_disable_firewall diff --git a/source/guides/install-guides/zypper/prepare_mgmt_node.rst b/source/guides/install-guides/zypper/prepare_mgmt_node.rst index 0ec91c7ea..afb348ed2 100644 --- a/source/guides/install-guides/zypper/prepare_mgmt_node.rst +++ b/source/guides/install-guides/zypper/prepare_mgmt_node.rst @@ -15,9 +15,29 @@ Install one of the supported operating systems :ref:`sles-os-support-label` on t Configure the Base OS Repository -------------------------------- - .. include:: zypper_common.rst - :start-after: BEGIN_configure_base_os_repository - :end-before: END_configure_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 + +#. Copy the dvd .iso file onto the management node: :: + + mkdir -p /tmp/iso + scp @:/images/iso/sles12/ppc64le/SLE-12-Server-DVD-ppc64le-GM-DVD1.iso /tmp/iso + +#. Mount the dvd iso to a directory 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 + +#. Create the local repository configuration file pointing to mounted iso image. :: + + cat /etc/zypp/repos.d/sles12le-base.repo + [sles-12-le-server] + name=SLES 12 ppc64le Server Packages + baseurl=file:///mnt/iso/sles12/suse + enabled=1 + gpgcheck=1 Set up Network diff --git a/source/guides/install-guides/zypper/sles_support b/source/guides/install-guides/zypper/sles_support deleted file mode 100644 index 1972fdce9..000000000 --- a/source/guides/install-guides/zypper/sles_support +++ /dev/null @@ -1,2 +0,0 @@ -SLES 11 -SLES 12 LE diff --git a/source/guides/install-guides/zypper/zypper_common.rst b/source/guides/install-guides/zypper/zypper_common.rst deleted file mode 100644 index 1a4678f47..000000000 --- a/source/guides/install-guides/zypper/zypper_common.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. BEGIN_configure_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 - -#. Copy the dvd .iso file onto the management node: :: - - mkdir -p /tmp/iso - scp @:/images/iso/sles12/ppc64le/SLE-12-Server-DVD-ppc64le-GM-DVD1.iso /tmp/iso - -#. Mount the dvd iso to a directory 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 - -#. Create the local repository configuration file pointing to mounted iso image. :: - - cat /etc/zypp/repos.d/sles12le-base.repo - [sles-12-le-server] - name=SLES 12 ppc64le Server Packages - baseurl=file:///mnt/iso/sles12/suse - enabled=1 - gpgcheck=1 - - -.. END_configure_base_os_repository - - - - -.. BEGIN_disable_firewall -.. DEPRECATED: Firewall instructions is not applicable after xCAT 2.8 - -The management node provides many services to the cluster nodes. Running a firewall on the management node can interfere with these services. -If your cluster is running on a secure network, the easiest thing to do is disable the firewall on the management node:: - - service iptables stop - service ip6tables stop - -.. END_disable_firewall - From b8f64cc3fa5015a5c66b21e4c3f1412db8b3ad3a Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 14 Aug 2015 09:06:39 -0400 Subject: [PATCH 51/57] Remove the swp file, there must have been a VI editor session opened when doing a commit --- .../ppc64le/management/.index.rst.swp | Bin 12288 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/.index.rst.swp diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/.index.rst.swp b/source/guides/admin-guides/manage_clusters/ppc64le/management/.index.rst.swp deleted file mode 100644 index e2a4b6f2fe4d847006a19e54341ec9ea55db2944..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 12288 zcmeI&F>ll`6bJCv?$C-#ofr(A8<(~M=_JGoL&tWleD>>|rNoYG=X#y^4h$XmB(xs^ ziMf^f75WWWcsULUft2e?`CIo_-ZIaS(c%zTYrUKLF^n!UX^T From ce25574feb780ddc3c30c495c4f272d6cb6ca758 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 14 Aug 2015 09:45:54 -0400 Subject: [PATCH 52/57] Fix the bread crumbs and set the skeleton for the ppc64le hardware management pages --- .../common/management/rpower.rst | 13 ++++++++++++- .../ppc64le/discovery/index.rst | 4 ++++ .../manage_clusters/ppc64le/diskful/index.rst | 4 ++++ .../manage_clusters/ppc64le/diskless/index.rst | 4 ++++ .../manage_clusters/ppc64le/index.rst | 12 ++++++------ .../ppc64le/management/index.rst | 18 +++++++++--------- .../ppc64le/management/rbeacon.rst | 1 + .../ppc64le/management/rcons.rst | 1 + .../ppc64le/management/renergy.rst | 1 + .../ppc64le/management/reventlog.rst | 1 + .../ppc64le/management/rflash.rst | 1 + .../ppc64le/management/rinv.rst | 1 + .../ppc64le/management/rpower.rst | 1 + .../ppc64le/management/rspconfig.rst | 1 + .../ppc64le/management/rvitals.rst | 1 + .../ppc64le/power8le_kvm/index.rst | 8 -------- .../ppc64le/power8le_kvm/install_powerkvm.rst | 2 -- .../ppc64le/virtual_machines/index.rst | 8 ++++++++ .../ppc64le/virtual_machines/manage_vms.rst | 4 ++++ .../ppc64le/virtual_machines/powerKVM.rst | 5 +++++ 20 files changed, 65 insertions(+), 26 deletions(-) create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst delete mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/index.rst delete mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/install_powerkvm.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/rpower.rst b/source/guides/admin-guides/manage_clusters/common/management/rpower.rst index af106290a..06329fba8 100644 --- a/source/guides/admin-guides/manage_clusters/common/management/rpower.rst +++ b/source/guides/admin-guides/manage_clusters/common/management/rpower.rst @@ -1,2 +1,13 @@ ``rpower`` -========== \ No newline at end of file +========== + +rpower1 +------- + +Here is some common rpower information! + +rpower2 +------- + +some more... + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst new file mode 100644 index 000000000..5c6ad7fa3 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst @@ -0,0 +1,4 @@ +.. ======================== +.. Using common shared file +.. ======================== +.. include:: ../../common/discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst new file mode 100644 index 000000000..5a1e6239f --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst @@ -0,0 +1,4 @@ +.. ======================== +.. Using common shared file +.. ======================== +.. include:: ../../common/diskful.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst new file mode 100644 index 000000000..7c5c3880f --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst @@ -0,0 +1,4 @@ +.. ======================== +.. Using common shared file +.. ======================== +.. include:: ../../common/diskless.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/index.rst index 072b74e6c..f78b9ad5f 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/index.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/index.rst @@ -1,11 +1,11 @@ -IBM Power8 LE and OpenPOWER -=========================== +IBM Power8 LE / OpenPOWER +========================= .. toctree:: :maxdepth: 2 - ../common/discovery.rst + discovery/index.rst management/index.rst - ../common/diskful.rst - ../common/diskless.rst - power8le_kvm/index.rst + diskful/index.rst + diskless/index.rst + virtual_machines/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst index aebe27a92..d786c1d07 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst @@ -4,13 +4,13 @@ Hardware Management .. toctree:: :maxdepth: 2 - ../../common/management/rpower.rst - ../../common/management/rspconfig.rst - ../../common/management/reventlog.rst - ../../common/management/rbeacon - ../../common/management/rcons - ../../common/management/rinv - ../../common/management/rvitals - ../../common/management/rflash - ../../common/management/renergy + rpower.rst + rspconfig.rst + reventlog.rst + rbeacon.rst + rcons.rst + rinv.rst + rvitals.rst + rflash.rst + renergy.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst new file mode 100644 index 000000000..77f805231 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rbeacon.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst new file mode 100644 index 000000000..e031077b4 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rcons.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst new file mode 100644 index 000000000..afa4dd21e --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/renergy.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst new file mode 100644 index 000000000..d6054710a --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/reventlog.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst new file mode 100644 index 000000000..93c688150 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rflash.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst new file mode 100644 index 000000000..3392765a8 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rinv.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst new file mode 100644 index 000000000..2ecf9f22a --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rpower.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst new file mode 100644 index 000000000..88f19f51b --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rspconfig.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst b/source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst new file mode 100644 index 000000000..87880aa2e --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rvitals.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/index.rst deleted file mode 100644 index d117d3071..000000000 --- a/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Manage kvm VM -================================= - -.. toctree:: - :maxdepth: 2 - - install_powerkvm.rst - ../../common/kvm/manage_vm.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/install_powerkvm.rst b/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/install_powerkvm.rst deleted file mode 100644 index 8ee5dd48e..000000000 --- a/source/guides/admin-guides/manage_clusters/ppc64le/power8le_kvm/install_powerkvm.rst +++ /dev/null @@ -1,2 +0,0 @@ -Install PowerKVM -================ diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/index.rst new file mode 100644 index 000000000..448fa9d0c --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/index.rst @@ -0,0 +1,8 @@ +Virtual Machines +================ + +.. toctree:: + :maxdepth: 2 + + powerKVM.rst + manage_vms.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst b/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst new file mode 100644 index 000000000..c2fcb0671 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst @@ -0,0 +1,4 @@ +.. ======================== +.. Using common shared file +.. ======================== +.. include:: ../../common/kvm/manage_vm.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst b/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst new file mode 100644 index 000000000..4c334720f --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst @@ -0,0 +1,5 @@ +PowerKVM +======== + +Install PoweKVM +--------------- From a2f710acdf93cef7e964b2c33b9c7ca11827fda4 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 14 Aug 2015 09:47:11 -0400 Subject: [PATCH 53/57] Sync up the changes made for ppc64le to x86_64 doc skeleton and also fix the issues with the bread crumbs --- .../manage_clusters/x86_64/discovery/index.rst | 4 ++++ .../manage_clusters/x86_64/diskful/index.rst | 4 ++++ .../manage_clusters/x86_64/diskless/index.rst | 4 ++++ .../manage_clusters/x86_64/index.rst | 7 +++++-- .../manage_clusters/x86_64/management/index.rst | 16 ++++++++++++++++ .../x86_64/management/rbeacon.rst | 1 + .../manage_clusters/x86_64/management/rcons.rst | 1 + .../x86_64/management/renergy.rst | 1 + .../x86_64/management/reventlog.rst | 1 + .../manage_clusters/x86_64/management/rflash.rst | 1 + .../manage_clusters/x86_64/management/rinv.rst | 1 + .../manage_clusters/x86_64/management/rpower.rst | 1 + .../x86_64/management/rspconfig.rst | 1 + .../x86_64/management/rvitals.rst | 1 + .../x86_64/virtual_machines/index.rst | 6 ++++++ .../x86_64/x86_64_baremetal/index.rst | 11 ----------- .../x86_64/x86_64_baremetal/management/index.rst | 16 ---------------- .../manage_clusters/x86_64/x86_64_kvm/index.rst | 11 ----------- .../x86_64/x86_64_kvm/management/index.rst | 16 ---------------- 19 files changed, 48 insertions(+), 56 deletions(-) create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/rbeacon.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/rcons.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/renergy.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/reventlog.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/rflash.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/rinv.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/rpower.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/rspconfig.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/management/rvitals.rst create mode 100644 source/guides/admin-guides/manage_clusters/x86_64/virtual_machines/index.rst delete mode 100644 source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/index.rst delete mode 100644 source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/management/index.rst delete mode 100644 source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/index.rst delete mode 100644 source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/management/index.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst new file mode 100644 index 000000000..5c6ad7fa3 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst @@ -0,0 +1,4 @@ +.. ======================== +.. Using common shared file +.. ======================== +.. include:: ../../common/discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst new file mode 100644 index 000000000..5a1e6239f --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst @@ -0,0 +1,4 @@ +.. ======================== +.. Using common shared file +.. ======================== +.. include:: ../../common/diskful.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst new file mode 100644 index 000000000..7c5c3880f --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst @@ -0,0 +1,4 @@ +.. ======================== +.. Using common shared file +.. ======================== +.. include:: ../../common/diskless.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/index.rst index a8855b0f5..1d4ff5161 100644 --- a/source/guides/admin-guides/manage_clusters/x86_64/index.rst +++ b/source/guides/admin-guides/manage_clusters/x86_64/index.rst @@ -4,5 +4,8 @@ x86_64 .. toctree:: :maxdepth: 2 - x86_64_baremetal/index.rst - x86_64_kvm/index.rst + discovery/index.rst + management/index.rst + diskful/index.rst + diskless/index.rst + virtual_machines/index.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/index.rst new file mode 100644 index 000000000..d786c1d07 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/index.rst @@ -0,0 +1,16 @@ +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/source/guides/admin-guides/manage_clusters/x86_64/management/rbeacon.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/rbeacon.rst new file mode 100644 index 000000000..77f805231 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/rbeacon.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rbeacon.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rcons.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/rcons.rst new file mode 100644 index 000000000..e031077b4 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/rcons.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rcons.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/renergy.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/renergy.rst new file mode 100644 index 000000000..afa4dd21e --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/renergy.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/renergy.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/reventlog.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/reventlog.rst new file mode 100644 index 000000000..d6054710a --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/reventlog.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/reventlog.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rflash.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/rflash.rst new file mode 100644 index 000000000..93c688150 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/rflash.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rflash.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rinv.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/rinv.rst new file mode 100644 index 000000000..3392765a8 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/rinv.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rinv.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rpower.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/rpower.rst new file mode 100644 index 000000000..2ecf9f22a --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/rpower.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rpower.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rspconfig.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/rspconfig.rst new file mode 100644 index 000000000..88f19f51b --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/rspconfig.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rspconfig.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rvitals.rst b/source/guides/admin-guides/manage_clusters/x86_64/management/rvitals.rst new file mode 100644 index 000000000..87880aa2e --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/management/rvitals.rst @@ -0,0 +1 @@ +.. include:: ../../common/management/rvitals.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/virtual_machines/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/virtual_machines/index.rst new file mode 100644 index 000000000..788b200d8 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/x86_64/virtual_machines/index.rst @@ -0,0 +1,6 @@ +Virtual Machines +================ + +.. toctree:: + :maxdepth: 2 + diff --git a/source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/index.rst deleted file mode 100644 index 7dab37f81..000000000 --- a/source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -x86_64 (bare metal) -=================== - -.. toctree:: - :maxdepth: 2 - - ../../common/discovery.rst - management/index.rst - ../../common/diskful.rst - ../../common/diskless.rst - diff --git a/source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/management/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/management/index.rst deleted file mode 100644 index d491207b5..000000000 --- a/source/guides/admin-guides/manage_clusters/x86_64/x86_64_baremetal/management/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -Hardware Management -=================== - -.. toctree:: - :maxdepth: 2 - - ../../../common/management/rpower.rst - ../../../common/management/rspconfig.rst - ../../../common/management/reventlog.rst - ../../../common/management/rbeacon - ../../../common/management/rcons - ../../../common/management/rinv - ../../../common/management/rvitals - ../../../common/management/rflash - ../../../common/management/renergy - diff --git a/source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/index.rst deleted file mode 100644 index 178354f92..000000000 --- a/source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -x86_64 (kvm) -============ - -.. toctree:: - :maxdepth: 2 - - ../../common/discovery.rst - management/index.rst - ../../common/diskful.rst - ../../common/diskless.rst - diff --git a/source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/management/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/management/index.rst deleted file mode 100644 index d491207b5..000000000 --- a/source/guides/admin-guides/manage_clusters/x86_64/x86_64_kvm/management/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -Hardware Management -=================== - -.. toctree:: - :maxdepth: 2 - - ../../../common/management/rpower.rst - ../../../common/management/rspconfig.rst - ../../../common/management/reventlog.rst - ../../../common/management/rbeacon - ../../../common/management/rcons - ../../../common/management/rinv - ../../../common/management/rvitals - ../../../common/management/rflash - ../../../common/management/renergy - From 996c00f53c7a275c128914f1531fd2ece4c4c477 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 14 Aug 2015 09:51:00 -0400 Subject: [PATCH 54/57] Remove reference to power8, just leave docs as Power LE --- source/guides/admin-guides/manage_clusters/ppc64le/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/index.rst index f78b9ad5f..f27472567 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/index.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/index.rst @@ -1,4 +1,4 @@ -IBM Power8 LE / OpenPOWER +IBM Power LE / OpenPOWER ========================= .. toctree:: From d4a3f34e84d9d4956dfd635515cf503eb08b2d97 Mon Sep 17 00:00:00 2001 From: wangxiaopeng Date: Wed, 19 Aug 2015 11:15:29 -0400 Subject: [PATCH 55/57] Add doc skeleton for diskful and diskless install --- .../common/deployment/additional_pkg.rst | 5 +++++ .../common/deployment/cfg_partition.rst | 2 ++ .../common/deployment/cfg_second_adapter.rst | 2 ++ .../common/deployment/create_img.rst | 7 +++++++ .../common/deployment/deploy_os.rst | 10 ++++++++++ .../common/deployment/driver_update_disk.rst | 2 ++ .../common/deployment/enable_kdump.rst | 2 ++ .../common/deployment/generate_img.rst | 8 ++++++++ .../common/deployment/pre_post_script.rst | 5 +++++ .../common/deployment/raid_cfg.rst | 2 ++ .../common/deployment/syncfile.rst | 2 ++ .../manage_clusters/common/diskful.rst | 2 -- .../manage_clusters/common/diskless.rst | 2 -- .../manage_clusters/common/parallel_cmd.rst | 2 ++ .../manage_clusters/common/updatenode.rst | 2 ++ .../diskful/advanced_topics/additional_pkg.rst | 2 ++ .../diskful/advanced_topics/cfg_partition.rst | 2 ++ .../advanced_topics/cfg_second_adapter.rst | 2 ++ .../advanced_topics/driver_update_disk.rst | 2 ++ .../ppc64le/diskful/advanced_topics/index.rst | 15 +++++++++++++++ .../diskful/advanced_topics/pre_post_script.rst | 2 ++ .../diskful/advanced_topics/raid_cfg.rst | 2 ++ .../diskful/advanced_topics/syncfile.rst | 2 ++ .../ppc64le/diskful/deploy_os.rst | 2 ++ .../ppc64le/diskful/image_mgmt.rst | 2 ++ .../manage_clusters/ppc64le/diskful/index.rst | 14 ++++++++++---- .../diskless/advanced_topics/additional_pkg.rst | 2 ++ .../diskless/advanced_topics/cfg_partition.rst | 2 ++ .../advanced_topics/cfg_second_adapter.rst | 2 ++ .../advanced_topics/driver_update_disk.rst | 2 ++ .../diskless/advanced_topics/enable_kdump.rst | 2 ++ .../ppc64le/diskless/advanced_topics/index.rst | 13 +++++++++++++ .../advanced_topics/pre_post_script.rst | 2 ++ .../diskless/advanced_topics/raid_cfg.rst | 2 ++ .../diskless/advanced_topics/syncfile.rst | 2 ++ .../ppc64le/diskless/deploy_os.rst | 2 ++ .../ppc64le/diskless/image_mgmt.rst | 3 +++ .../manage_clusters/ppc64le/diskless/index.rst | 14 ++++++++++---- .../manage_clusters/ppc64le/index.rst | 2 ++ .../manage_clusters/ppc64le/parallel_cmd.rst | 2 ++ .../manage_clusters/ppc64le/updatenode.rst | 2 ++ .../manage_clusters/x86_64/diskful/index.rst | 1 - .../manage_clusters/x86_64/diskless/index.rst | 1 - .../common/.install_guide.rst.swp | Bin 0 -> 12288 bytes 44 files changed, 144 insertions(+), 14 deletions(-) create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/additional_pkg.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/cfg_second_adapter.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/generate_img.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/pre_post_script.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/raid_cfg.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/deployment/syncfile.rst delete mode 100644 source/guides/admin-guides/manage_clusters/common/diskful.rst delete mode 100644 source/guides/admin-guides/manage_clusters/common/diskless.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/updatenode.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/additional_pkg.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_partition.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_second_adapter.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/driver_update_disk.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/pre_post_script.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/raid_cfg.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/syncfile.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/image_mgmt.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/additional_pkg.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_partition.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_second_adapter.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/driver_update_disk.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/enable_kdump.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/pre_post_script.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/raid_cfg.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/syncfile.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/deploy_os.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/image_mgmt.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/parallel_cmd.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/updatenode.rst create mode 100644 source/guides/install-guides/common/.install_guide.rst.swp diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/additional_pkg.rst b/source/guides/admin-guides/manage_clusters/common/deployment/additional_pkg.rst new file mode 100644 index 000000000..76a941c50 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/additional_pkg.rst @@ -0,0 +1,5 @@ +Install Additional OS Packages +============================== + +Install Additional Other Packages +================================= diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst b/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst new file mode 100644 index 000000000..ba7f5ba82 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst @@ -0,0 +1,2 @@ +Configure Disk Partition +======================== diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/cfg_second_adapter.rst b/source/guides/admin-guides/manage_clusters/common/deployment/cfg_second_adapter.rst new file mode 100644 index 000000000..3d373b210 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/cfg_second_adapter.rst @@ -0,0 +1,2 @@ +Configure Secondary Network Adapter +=================================== diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst b/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst new file mode 100644 index 000000000..3ccac1dc3 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst @@ -0,0 +1,7 @@ +Select or Create an osimage Definition +====================================== +Run copycds to create image + +Customize the osimage definitions +================================= + diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst b/source/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst new file mode 100644 index 000000000..4ea116030 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst @@ -0,0 +1,10 @@ +Initialize the Compute for Deployment +===================================== +nodeset + +Start the OS Deployment +======================= + +rsetboot net +rpower on + diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst b/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst new file mode 100644 index 000000000..9f3a2d240 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst @@ -0,0 +1,2 @@ +Using Driver Update Disk +======================== diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst b/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst new file mode 100644 index 000000000..4152a6cf9 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst @@ -0,0 +1,2 @@ +Enable Kdump Over Ethernet +========================== diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/generate_img.rst b/source/guides/admin-guides/manage_clusters/common/deployment/generate_img.rst new file mode 100644 index 000000000..239a094ee --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/generate_img.rst @@ -0,0 +1,8 @@ +Generate Diskless Image +======================= + +Pack Diskless Image +=================== + +Export and Import Image +======================= diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/pre_post_script.rst b/source/guides/admin-guides/manage_clusters/common/deployment/pre_post_script.rst new file mode 100644 index 000000000..988c19ac8 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/pre_post_script.rst @@ -0,0 +1,5 @@ +Using Prescript +=============== + +Using Postscript +================ diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/raid_cfg.rst b/source/guides/admin-guides/manage_clusters/common/deployment/raid_cfg.rst new file mode 100644 index 000000000..2a08772e1 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/raid_cfg.rst @@ -0,0 +1,2 @@ +Configure RAID before Deploy OS +=============================== diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/syncfile.rst b/source/guides/admin-guides/manage_clusters/common/deployment/syncfile.rst new file mode 100644 index 000000000..87dc2be90 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/deployment/syncfile.rst @@ -0,0 +1,2 @@ +Sync Files to Compute Node +========================== diff --git a/source/guides/admin-guides/manage_clusters/common/diskful.rst b/source/guides/admin-guides/manage_clusters/common/diskful.rst deleted file mode 100644 index 50d88b693..000000000 --- a/source/guides/admin-guides/manage_clusters/common/diskful.rst +++ /dev/null @@ -1,2 +0,0 @@ -Diskful Installation -==================== diff --git a/source/guides/admin-guides/manage_clusters/common/diskless.rst b/source/guides/admin-guides/manage_clusters/common/diskless.rst deleted file mode 100644 index e984a34e9..000000000 --- a/source/guides/admin-guides/manage_clusters/common/diskless.rst +++ /dev/null @@ -1,2 +0,0 @@ -Diskless Installation -===================== diff --git a/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst b/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst new file mode 100644 index 000000000..600bc1b2f --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst @@ -0,0 +1,2 @@ +Using Parallel Command +====================== diff --git a/source/guides/admin-guides/manage_clusters/common/updatenode.rst b/source/guides/admin-guides/manage_clusters/common/updatenode.rst new file mode 100644 index 000000000..39d885ca6 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/updatenode.rst @@ -0,0 +1,2 @@ +Update Compute Node +=================== diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/additional_pkg.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/additional_pkg.rst new file mode 100644 index 000000000..4f5b00cb6 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/additional_pkg.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/additional_pkg.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_partition.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_partition.rst new file mode 100644 index 000000000..ae27d5333 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_partition.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/cfg_partition.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_second_adapter.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_second_adapter.rst new file mode 100644 index 000000000..097b8010d --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_second_adapter.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/cfg_second_adapter.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/driver_update_disk.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/driver_update_disk.rst new file mode 100644 index 000000000..fbbe6539f --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/driver_update_disk.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/driver_update_disk.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/index.rst new file mode 100644 index 000000000..8d09b8045 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/index.rst @@ -0,0 +1,15 @@ +Advanced Topics +=============== + +.. toctree:: + :maxdepth: 2 + + raid_cfg.rst + driver_update_disk.rst + cfg_partition.rst + pre_post_script.rst + syncfile.rst + additional_pkg.rst + cfg_second_adapter.rst + + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/pre_post_script.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/pre_post_script.rst new file mode 100644 index 000000000..370de5657 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/pre_post_script.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/pre_post_script.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/raid_cfg.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/raid_cfg.rst new file mode 100644 index 000000000..5fac6f24c --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/raid_cfg.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/raid_cfg.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/syncfile.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/syncfile.rst new file mode 100644 index 000000000..bc6fb2f89 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/syncfile.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/syncfile.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst new file mode 100644 index 000000000..be4ba945c --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst @@ -0,0 +1,2 @@ + +.. include:: ../../common/deployment/deploy_os.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/image_mgmt.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/image_mgmt.rst new file mode 100644 index 000000000..5ac9c0b46 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/image_mgmt.rst @@ -0,0 +1,2 @@ + +.. include:: ../../common/deployment/create_img.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst index 5a1e6239f..38dc3e842 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst @@ -1,4 +1,10 @@ -.. ======================== -.. Using common shared file -.. ======================== -.. include:: ../../common/diskful.rst +Diskful Installation +==================== + +.. toctree:: + :maxdepth: 2 + + image_mgmt.rst + advanced_topics/index.rst + deploy_os.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/additional_pkg.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/additional_pkg.rst new file mode 100644 index 000000000..4f5b00cb6 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/additional_pkg.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/additional_pkg.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_partition.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_partition.rst new file mode 100644 index 000000000..ae27d5333 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_partition.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/cfg_partition.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_second_adapter.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_second_adapter.rst new file mode 100644 index 000000000..097b8010d --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_second_adapter.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/cfg_second_adapter.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/driver_update_disk.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/driver_update_disk.rst new file mode 100644 index 000000000..fbbe6539f --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/driver_update_disk.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/driver_update_disk.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/enable_kdump.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/enable_kdump.rst new file mode 100644 index 000000000..6c9cbede4 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/enable_kdump.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/enable_kdump.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/index.rst new file mode 100644 index 000000000..fcff675e6 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/index.rst @@ -0,0 +1,13 @@ +Advanced Topics +=============== + +.. toctree:: + :maxdepth: 2 + + driver_update_disk.rst + pre_post_script.rst + syncfile.rst + additional_pkg.rst + cfg_second_adapter.rst + enable_kdump.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/pre_post_script.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/pre_post_script.rst new file mode 100644 index 000000000..370de5657 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/pre_post_script.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/pre_post_script.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/raid_cfg.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/raid_cfg.rst new file mode 100644 index 000000000..5fac6f24c --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/raid_cfg.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/raid_cfg.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/syncfile.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/syncfile.rst new file mode 100644 index 000000000..bc6fb2f89 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/syncfile.rst @@ -0,0 +1,2 @@ +.. include:: ../../../common/deployment/syncfile.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/deploy_os.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/deploy_os.rst new file mode 100644 index 000000000..be4ba945c --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/deploy_os.rst @@ -0,0 +1,2 @@ + +.. include:: ../../common/deployment/deploy_os.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/image_mgmt.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/image_mgmt.rst new file mode 100644 index 000000000..488130fd8 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/image_mgmt.rst @@ -0,0 +1,3 @@ + +.. include:: ../../common/deployment/create_img.rst +.. include:: ../../common/deployment/generate_img.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst index 7c5c3880f..249ca199f 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst @@ -1,4 +1,10 @@ -.. ======================== -.. Using common shared file -.. ======================== -.. include:: ../../common/diskless.rst +Diskless Installation +===================== + +.. toctree:: + :maxdepth: 2 + + image_mgmt.rst + advanced_topics/index.rst + deploy_os.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/index.rst index f27472567..f0772960e 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/index.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/index.rst @@ -8,4 +8,6 @@ IBM Power LE / OpenPOWER management/index.rst diskful/index.rst diskless/index.rst + updatenode.rst + parallel_cmd.rst virtual_machines/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/parallel_cmd.rst b/source/guides/admin-guides/manage_clusters/ppc64le/parallel_cmd.rst new file mode 100644 index 000000000..addff2fb8 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/parallel_cmd.rst @@ -0,0 +1,2 @@ +.. include:: ../common/parallel_cmd.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/updatenode.rst b/source/guides/admin-guides/manage_clusters/ppc64le/updatenode.rst new file mode 100644 index 000000000..103d0598c --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/updatenode.rst @@ -0,0 +1,2 @@ +.. include:: ../common/updatenode.rst + diff --git a/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst index 5a1e6239f..41d63d3eb 100644 --- a/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst +++ b/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst @@ -1,4 +1,3 @@ .. ======================== .. Using common shared file .. ======================== -.. include:: ../../common/diskful.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst index 7c5c3880f..41d63d3eb 100644 --- a/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst +++ b/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst @@ -1,4 +1,3 @@ .. ======================== .. Using common shared file .. ======================== -.. include:: ../../common/diskless.rst diff --git a/source/guides/install-guides/common/.install_guide.rst.swp b/source/guides/install-guides/common/.install_guide.rst.swp new file mode 100644 index 0000000000000000000000000000000000000000..e208266880703f26426b4685eac712392a1fdc0b GIT binary patch literal 12288 zcmeI2&2AGh5XW5(+{#zEGk`#8+U&Ma6@&nZeyFNMibPwk(Pr(WhP54RFUq1wNE|`p zz#DJ^-U4nM`UG&`g^kALzdirWhhHk)uQT4HFY7<>I{ zfA`0))9l`5#;h?uOi!}Bt@NarupXy|i?}QOUfz!TY2q8)q!CZFOoiyn7(Ev|liL)d za><2@rFK5avPR{mMk%9*v#oMAvhGk_9;QQzAp%F4z%;vhWpN>#@ZyE@Fmq=2C?A&2 zMg)ie5g-CYfCvx)B0vO)zySijH^rXe+_7r@Y&A|D7%P_sB0vO)01+SpM1Tko0U|&I zhyW2F0z}|HB#>~%&P_A+5*7acAO8OTeUh>7sBfsRs4piN`;7XC`ha?adX7p_Yp6@8 zK*DWD%5^~A|nDsfCvx)B0vO)01+SpM1Tkofs#NJ!TQ!(t9tU>GOne% z%C|H=n#T3H#+Z$}b8G;26WbL~*#K_C;_}FwoZS>$=4zC^+_*kWhQZ|QZH14tp>`AZ zoP_}_HAY*9>|0|t?uO1+v)p-MVOu^GnB5f0*aB)BD_CpN-mG4);_r*cxwJwF?cI%f zow1!g0j|Kx3hZBN&@mPYd}R*()jK<&5}kC*EC{3_3mCHkxabMZ9T*Kh6bikWPWhcy z{bCX5WeEnDsthEWmm$9BmEk>Wo=7K+mbweM6C7$>x<{Qnn}_g`3FqdAU8b4Q0$t(L y*$5!?uabwxN?(MntFvS#;eZd}g#(`3P Date: Thu, 20 Aug 2015 04:55:16 -0400 Subject: [PATCH 56/57] Refine the doc skeleton Move the subitems from install->Advanced topics to customized_image Add the subimtes for Advacned_topics Add the subitems for discovery Add subitems for developers --- source/advanced/change_mn_ip.rst | 2 + source/advanced/change_node_ip.rst | 2 + source/advanced/hamn/index.rst | 4 +- source/advanced/hierarchy_cluster.rst | 2 + source/advanced/ib.rst | 2 + source/advanced/index.rst | 18 ++++++- source/advanced/ipv6_support.rst | 2 + source/advanced/kit.rst | 2 + source/advanced/restapi/index.rst | 8 +++ .../restapi/restapi.rst} | 2 +- source/advanced/restapi/set_up_ws.rst | 2 + source/advanced/softlayer.rst | 2 + source/advanced/switch_mgmt.rst | 2 + source/advanced/sysclone.rst | 2 + source/advanced/vlan.rst | 2 + source/advanced/xcat_port.rst | 2 + source/advanced/xcat_security.rst | 2 + source/advanced/zone.rst | 2 + source/developers/debug_xcat.rst | 2 + source/developers/developer_guide.rst | 2 + source/developers/index.rst | 4 +- .../mini-design/2.10/xcatdebugmode.rst | 14 ----- .../mini-design/2.11/docker-swarm.rst | 2 - source/developers/mini-design/2.11/docker.rst | 49 ------------------ source/developers/mini-design/index.rst | 24 --------- source/developers/programming_tips.rst | 2 + .../common/deployment/create_img.rst | 3 -- .../common/discover/manually_define.rst | 2 + .../common/discover/manually_discovery.rst | 2 + .../common/discover/mtms_discovery.rst | 2 + .../common/discover/seq_discovery.rst | 2 + .../common/discover/switch_discovery.rst | 2 + .../ppc64le/discovery/index.rst | 16 ++++-- .../ppc64le/discovery/manually_define.rst | 1 + .../ppc64le/discovery/manually_discovery.rst | 1 + .../ppc64le/discovery/mtms_discovery.rst | 1 + .../ppc64le/discovery/seq_discovery.rst | 1 + .../ppc64le/discovery/switch_discovery.rst | 1 + .../ppc64le/diskful/advanced_topics/index.rst | 15 ------ .../{image_mgmt.rst => copy_image.rst} | 0 .../additional_pkg.rst | 0 .../cfg_partition.rst | 0 .../cfg_second_adapter.rst | 0 .../driver_update_disk.rst | 0 .../ppc64le/diskful/customize_image/index.rst | 16 ++++++ .../pre_post_script.rst | 0 .../raid_cfg.rst | 0 .../syncfile.rst | 0 .../manage_clusters/ppc64le/diskful/index.rst | 5 +- .../diskless/advanced_topics/index.rst | 13 ----- .../ppc64le/diskless/copy_image.rst | 2 + .../additional_pkg.rst | 0 .../cfg_partition.rst | 0 .../cfg_second_adapter.rst | 0 .../driver_update_disk.rst | 0 .../enable_kdump.rst | 0 .../diskless/customize_image/index.rst | 15 ++++++ .../pre_post_script.rst | 0 .../raid_cfg.rst | 0 .../syncfile.rst | 0 .../{image_mgmt.rst => gen_image.rst} | 2 - .../ppc64le/diskless/index.rst | 6 +-- .../ppc64le/virtual_machines/manage_vms.rst | 3 -- .../x86_64/discovery/index.rst | 4 -- .../manage_clusters/x86_64/diskful/index.rst | 3 -- .../manage_clusters/x86_64/diskless/index.rst | 3 -- .../common/.install_guide.rst.swp | Bin 12288 -> 0 bytes source/index.rst | 2 +- source/overview/index.rst | 1 + source/overview/setup_cluster_process.rst | 2 + 70 files changed, 133 insertions(+), 152 deletions(-) create mode 100644 source/advanced/change_mn_ip.rst create mode 100644 source/advanced/change_node_ip.rst create mode 100644 source/advanced/hierarchy_cluster.rst create mode 100644 source/advanced/ib.rst create mode 100644 source/advanced/ipv6_support.rst create mode 100644 source/advanced/kit.rst create mode 100644 source/advanced/restapi/index.rst rename source/{guides/admin-guides/manage_clusters/common/discovery.rst => advanced/restapi/restapi.rst} (50%) create mode 100644 source/advanced/restapi/set_up_ws.rst create mode 100644 source/advanced/softlayer.rst create mode 100644 source/advanced/switch_mgmt.rst create mode 100644 source/advanced/sysclone.rst create mode 100644 source/advanced/vlan.rst create mode 100644 source/advanced/xcat_port.rst create mode 100644 source/advanced/xcat_security.rst create mode 100644 source/advanced/zone.rst create mode 100644 source/developers/debug_xcat.rst create mode 100644 source/developers/developer_guide.rst delete mode 100644 source/developers/mini-design/2.10/xcatdebugmode.rst delete mode 100644 source/developers/mini-design/2.11/docker-swarm.rst delete mode 100644 source/developers/mini-design/2.11/docker.rst delete mode 100644 source/developers/mini-design/index.rst create mode 100644 source/developers/programming_tips.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/discover/manually_define.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/discover/manually_discovery.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/discover/mtms_discovery.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/discover/seq_discovery.rst create mode 100644 source/guides/admin-guides/manage_clusters/common/discover/switch_discovery.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_define.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst delete mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/index.rst rename source/guides/admin-guides/manage_clusters/ppc64le/diskful/{image_mgmt.rst => copy_image.rst} (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskful/{advanced_topics => customize_image}/additional_pkg.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskful/{advanced_topics => customize_image}/cfg_partition.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskful/{advanced_topics => customize_image}/cfg_second_adapter.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskful/{advanced_topics => customize_image}/driver_update_disk.rst (100%) create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/index.rst rename source/guides/admin-guides/manage_clusters/ppc64le/diskful/{advanced_topics => customize_image}/pre_post_script.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskful/{advanced_topics => customize_image}/raid_cfg.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskful/{advanced_topics => customize_image}/syncfile.rst (100%) delete mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/index.rst create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/copy_image.rst rename source/guides/admin-guides/manage_clusters/ppc64le/diskless/{advanced_topics => customize_image}/additional_pkg.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskless/{advanced_topics => customize_image}/cfg_partition.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskless/{advanced_topics => customize_image}/cfg_second_adapter.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskless/{advanced_topics => customize_image}/driver_update_disk.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskless/{advanced_topics => customize_image}/enable_kdump.rst (100%) create mode 100644 source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/index.rst rename source/guides/admin-guides/manage_clusters/ppc64le/diskless/{advanced_topics => customize_image}/pre_post_script.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskless/{advanced_topics => customize_image}/raid_cfg.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskless/{advanced_topics => customize_image}/syncfile.rst (100%) rename source/guides/admin-guides/manage_clusters/ppc64le/diskless/{image_mgmt.rst => gen_image.rst} (50%) delete mode 100644 source/guides/install-guides/common/.install_guide.rst.swp create mode 100644 source/overview/setup_cluster_process.rst diff --git a/source/advanced/change_mn_ip.rst b/source/advanced/change_mn_ip.rst new file mode 100644 index 000000000..d02fd709a --- /dev/null +++ b/source/advanced/change_mn_ip.rst @@ -0,0 +1,2 @@ +Changing the Hostname or IP for Management Node +=============================================== diff --git a/source/advanced/change_node_ip.rst b/source/advanced/change_node_ip.rst new file mode 100644 index 000000000..969f644bb --- /dev/null +++ b/source/advanced/change_node_ip.rst @@ -0,0 +1,2 @@ +Chaning the Hostname or IP for Compute Node +=========================================== diff --git a/source/advanced/hamn/index.rst b/source/advanced/hamn/index.rst index ded16df58..9e4e10e6b 100644 --- a/source/advanced/hamn/index.rst +++ b/source/advanced/hamn/index.rst @@ -1,5 +1,5 @@ -High Available Management Node -============================== +Highly Available Management Node +================================ .. toctree:: :maxdepth: 2 diff --git a/source/advanced/hierarchy_cluster.rst b/source/advanced/hierarchy_cluster.rst new file mode 100644 index 000000000..fa3b38c3f --- /dev/null +++ b/source/advanced/hierarchy_cluster.rst @@ -0,0 +1,2 @@ +Setting Up a Linux Hierarchical Cluster +======================================= diff --git a/source/advanced/ib.rst b/source/advanced/ib.rst new file mode 100644 index 000000000..bbd3f2ef0 --- /dev/null +++ b/source/advanced/ib.rst @@ -0,0 +1,2 @@ +Managing the Mellanox Infiniband Network +======================================== diff --git a/source/advanced/index.rst b/source/advanced/index.rst index 4f04f4bea..d9deb5afb 100644 --- a/source/advanced/index.rst +++ b/source/advanced/index.rst @@ -4,7 +4,21 @@ Advanced Topics .. toctree:: :maxdepth: 2 + restapi/index.rst + mixed_cluster.rst + hierarchy_cluster.rst + hamn/index.rst + change_mn_ip.rst + change_node_ip.rst + xcat_security.rst + kit.rst + ib.rst confluent/index.rst docker/index.rst - hamn/index.rst - mixed_cluster.rst + ipv6_support.rst + xcat_port.rst + sysclone.rst + switch_mgmt.rst + vlan.rst + zone.rst + softlayer.rst diff --git a/source/advanced/ipv6_support.rst b/source/advanced/ipv6_support.rst new file mode 100644 index 000000000..82ead6440 --- /dev/null +++ b/source/advanced/ipv6_support.rst @@ -0,0 +1,2 @@ +Configuring IPv6 in xCAT Cluster +================================ diff --git a/source/advanced/kit.rst b/source/advanced/kit.rst new file mode 100644 index 000000000..e83fc2930 --- /dev/null +++ b/source/advanced/kit.rst @@ -0,0 +1,2 @@ +Using Software KITs +=================== diff --git a/source/advanced/restapi/index.rst b/source/advanced/restapi/index.rst new file mode 100644 index 000000000..6724c604d --- /dev/null +++ b/source/advanced/restapi/index.rst @@ -0,0 +1,8 @@ +xCAT Web Services REST API +========================== + +.. toctree:: + :maxdepth: 2 + + set_up_ws.rst + restapi.rst diff --git a/source/guides/admin-guides/manage_clusters/common/discovery.rst b/source/advanced/restapi/restapi.rst similarity index 50% rename from source/guides/admin-guides/manage_clusters/common/discovery.rst rename to source/advanced/restapi/restapi.rst index af02f5d75..c28bacd72 100644 --- a/source/guides/admin-guides/manage_clusters/common/discovery.rst +++ b/source/advanced/restapi/restapi.rst @@ -1,2 +1,2 @@ -Hardware Discovery +REST API Reference ================== diff --git a/source/advanced/restapi/set_up_ws.rst b/source/advanced/restapi/set_up_ws.rst new file mode 100644 index 000000000..e9fde8a04 --- /dev/null +++ b/source/advanced/restapi/set_up_ws.rst @@ -0,0 +1,2 @@ +Set Up Web Service for REST API +=============================== diff --git a/source/advanced/softlayer.rst b/source/advanced/softlayer.rst new file mode 100644 index 000000000..ea9bcaf65 --- /dev/null +++ b/source/advanced/softlayer.rst @@ -0,0 +1,2 @@ +Using xCAT in SoftLayer +======================= diff --git a/source/advanced/switch_mgmt.rst b/source/advanced/switch_mgmt.rst new file mode 100644 index 000000000..c4c2617bc --- /dev/null +++ b/source/advanced/switch_mgmt.rst @@ -0,0 +1,2 @@ +Managing Ethernet Switches +========================== diff --git a/source/advanced/sysclone.rst b/source/advanced/sysclone.rst new file mode 100644 index 000000000..6b26ec335 --- /dev/null +++ b/source/advanced/sysclone.rst @@ -0,0 +1,2 @@ +Using System Clone to Deploy Diskful Node +========================================= diff --git a/source/advanced/vlan.rst b/source/advanced/vlan.rst new file mode 100644 index 000000000..0867106da --- /dev/null +++ b/source/advanced/vlan.rst @@ -0,0 +1,2 @@ +VLAN Configuration +================== diff --git a/source/advanced/xcat_port.rst b/source/advanced/xcat_port.rst new file mode 100644 index 000000000..5952d1531 --- /dev/null +++ b/source/advanced/xcat_port.rst @@ -0,0 +1,2 @@ +xCAT Port Usage +=============== diff --git a/source/advanced/xcat_security.rst b/source/advanced/xcat_security.rst new file mode 100644 index 000000000..04d904fe1 --- /dev/null +++ b/source/advanced/xcat_security.rst @@ -0,0 +1,2 @@ +xCAT 2 Security +=============== diff --git a/source/advanced/zone.rst b/source/advanced/zone.rst new file mode 100644 index 000000000..43833006b --- /dev/null +++ b/source/advanced/zone.rst @@ -0,0 +1,2 @@ +Setting Up Management Zones +=========================== diff --git a/source/developers/debug_xcat.rst b/source/developers/debug_xcat.rst new file mode 100644 index 000000000..7ae5bab53 --- /dev/null +++ b/source/developers/debug_xcat.rst @@ -0,0 +1,2 @@ +Debug xCAT Problems +=================== diff --git a/source/developers/developer_guide.rst b/source/developers/developer_guide.rst new file mode 100644 index 000000000..cf18c40ac --- /dev/null +++ b/source/developers/developer_guide.rst @@ -0,0 +1,2 @@ +Developer Guide +=============== diff --git a/source/developers/index.rst b/source/developers/index.rst index 67fe4b126..c9ae4dd8c 100644 --- a/source/developers/index.rst +++ b/source/developers/index.rst @@ -7,6 +7,8 @@ This page is for developers interested in working with xCAT. .. toctree:: :maxdepth: 2 + developer_guide.rst + programming_tips.rst + debug_xcat.rst license/index.rst git/index.rst - mini-design/index.rst diff --git a/source/developers/mini-design/2.10/xcatdebugmode.rst b/source/developers/mini-design/2.10/xcatdebugmode.rst deleted file mode 100644 index 9528ac312..000000000 --- a/source/developers/mini-design/2.10/xcatdebugmode.rst +++ /dev/null @@ -1,14 +0,0 @@ -Mini-design for xCAT Debug Mode -=============================== - -Overview --------- - - -+--------+----------+ -| Name | Age | -+========+==========+ -| Wang | 20 | -+--------+----------+ -| Zhao | 18 | -+--------+----------+ diff --git a/source/developers/mini-design/2.11/docker-swarm.rst b/source/developers/mini-design/2.11/docker-swarm.rst deleted file mode 100644 index dc44c4c66..000000000 --- a/source/developers/mini-design/2.11/docker-swarm.rst +++ /dev/null @@ -1,2 +0,0 @@ -Mini-design for Docker Swarm Support -==================================== diff --git a/source/developers/mini-design/2.11/docker.rst b/source/developers/mini-design/2.11/docker.rst deleted file mode 100644 index fe9589fbc..000000000 --- a/source/developers/mini-design/2.11/docker.rst +++ /dev/null @@ -1,49 +0,0 @@ -Mini-design for Docker Support -============================== - -Overview --------- - -Docker technology is very hot recently, xCAT plans to support it as a way to deploy applictions. - -Interface ---------- - -General Command Line -^^^^^^^^^^^^^^^^^^^^ - -Will add several new commands to support docker. - -* docker create - - * Create only - * Start after creating - -* docker stop - -Stop the docker container - -* docker remove - -Rest API -^^^^^^^^ - -Add xCAT Rest API to support docker. - -* docker create - -URI - /xcatws//start - -:: - #curl - #wget - -Add a Table -^^^^^^^^^^^ -+-----------+------------+-------------+ -|Operation |Params |Result | -+===========+============+=============+ -|GET |node |on/off | -+-----------+------------+-------------+ -|PUT |node |on/off | -+-----------+------------+-------------+ diff --git a/source/developers/mini-design/index.rst b/source/developers/mini-design/index.rst deleted file mode 100644 index 324383271..000000000 --- a/source/developers/mini-design/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -Mini-Design -=========== - -The **Design Document** for certain feature. - -**NOTE** - -*The documents displayed in this page are not official guides for user to reference. They are just design documents that describe how to implement certain feature. And sometimes they are not updated with the current implementation.* - -2.11 ----- - -.. toctree:: - :maxdepth: 2 - - 2.11/docker.rst - 2.11/docker-swarm.rst - -2.10 ----- -.. toctree:: - :maxdepth: 2 - - 2.10/xcatdebugmode.rst diff --git a/source/developers/programming_tips.rst b/source/developers/programming_tips.rst new file mode 100644 index 000000000..529c10e42 --- /dev/null +++ b/source/developers/programming_tips.rst @@ -0,0 +1,2 @@ +Programming Tips +================ diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst b/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst index 3ccac1dc3..bafa70f7a 100644 --- a/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst +++ b/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst @@ -2,6 +2,3 @@ Select or Create an osimage Definition ====================================== Run copycds to create image -Customize the osimage definitions -================================= - diff --git a/source/guides/admin-guides/manage_clusters/common/discover/manually_define.rst b/source/guides/admin-guides/manage_clusters/common/discover/manually_define.rst new file mode 100644 index 000000000..8d70d1942 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/discover/manually_define.rst @@ -0,0 +1,2 @@ +Manually Define Nodes +===================== diff --git a/source/guides/admin-guides/manage_clusters/common/discover/manually_discovery.rst b/source/guides/admin-guides/manage_clusters/common/discover/manually_discovery.rst new file mode 100644 index 000000000..f576a5c06 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/discover/manually_discovery.rst @@ -0,0 +1,2 @@ +Manually Discover Nodes +======================= diff --git a/source/guides/admin-guides/manage_clusters/common/discover/mtms_discovery.rst b/source/guides/admin-guides/manage_clusters/common/discover/mtms_discovery.rst new file mode 100644 index 000000000..9239eb9e7 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/discover/mtms_discovery.rst @@ -0,0 +1,2 @@ +MTMS-based Discovery +==================== diff --git a/source/guides/admin-guides/manage_clusters/common/discover/seq_discovery.rst b/source/guides/admin-guides/manage_clusters/common/discover/seq_discovery.rst new file mode 100644 index 000000000..f3004dedf --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/discover/seq_discovery.rst @@ -0,0 +1,2 @@ +Sequential-based Discovery +========================== diff --git a/source/guides/admin-guides/manage_clusters/common/discover/switch_discovery.rst b/source/guides/admin-guides/manage_clusters/common/discover/switch_discovery.rst new file mode 100644 index 000000000..3d6c627c0 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/common/discover/switch_discovery.rst @@ -0,0 +1,2 @@ +Switch-based Discovery +====================== diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst index 5c6ad7fa3..cceff4896 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst @@ -1,4 +1,12 @@ -.. ======================== -.. Using common shared file -.. ======================== -.. include:: ../../common/discovery.rst +Hardware Discoveriy & Define Node +================================= + +.. toctree:: + :maxdepth: 2 + + manually_define.rst + mtms_discovery.rst + switch_discovery.rst + seq_discovery.rst + manually_discovery.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_define.rst b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_define.rst new file mode 100644 index 000000000..c0b822a66 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_define.rst @@ -0,0 +1 @@ +.. include:: ../../common/discover/manually_define.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst new file mode 100644 index 000000000..f36c7d7fe --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst @@ -0,0 +1 @@ +.. include:: ../../common/discover/manually_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst new file mode 100644 index 000000000..88eb9606f --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst @@ -0,0 +1 @@ +.. include:: ../../common/discover/mtms_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst new file mode 100644 index 000000000..91d65af17 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst @@ -0,0 +1 @@ +.. include:: ../../common/discover/seq_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst new file mode 100644 index 000000000..0b83eca00 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst @@ -0,0 +1 @@ +.. include:: ../../common/discover/switch_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/index.rst deleted file mode 100644 index 8d09b8045..000000000 --- a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -Advanced Topics -=============== - -.. toctree:: - :maxdepth: 2 - - raid_cfg.rst - driver_update_disk.rst - cfg_partition.rst - pre_post_script.rst - syncfile.rst - additional_pkg.rst - cfg_second_adapter.rst - - diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/image_mgmt.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/copy_image.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/image_mgmt.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskful/copy_image.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/additional_pkg.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/additional_pkg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/additional_pkg.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/additional_pkg.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_partition.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_partition.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_partition.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_partition.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_second_adapter.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_second_adapter.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/cfg_second_adapter.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_second_adapter.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/driver_update_disk.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/driver_update_disk.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/driver_update_disk.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/driver_update_disk.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/index.rst new file mode 100644 index 000000000..d81ffe7bf --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/index.rst @@ -0,0 +1,16 @@ +Customize osimage (Optional) +============================ +Optional means all the subitems in this page are not necessary to finish an OS deployment. If you are new to xCAT, you can just jump to `Initialize the Compute for Deployment`. + +.. toctree:: + :maxdepth: 2 + + raid_cfg.rst + driver_update_disk.rst + cfg_partition.rst + pre_post_script.rst + syncfile.rst + additional_pkg.rst + cfg_second_adapter.rst + + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/pre_post_script.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/pre_post_script.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/pre_post_script.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/pre_post_script.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/raid_cfg.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/raid_cfg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/raid_cfg.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/raid_cfg.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/syncfile.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/syncfile.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/advanced_topics/syncfile.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/syncfile.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst index 38dc3e842..3e7c62d47 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst @@ -4,7 +4,6 @@ Diskful Installation .. toctree:: :maxdepth: 2 - image_mgmt.rst - advanced_topics/index.rst + copy_image.rst + customize_image/index.rst deploy_os.rst - diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/index.rst deleted file mode 100644 index fcff675e6..000000000 --- a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -Advanced Topics -=============== - -.. toctree:: - :maxdepth: 2 - - driver_update_disk.rst - pre_post_script.rst - syncfile.rst - additional_pkg.rst - cfg_second_adapter.rst - enable_kdump.rst - diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/copy_image.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/copy_image.rst new file mode 100644 index 000000000..5ac9c0b46 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/copy_image.rst @@ -0,0 +1,2 @@ + +.. include:: ../../common/deployment/create_img.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/additional_pkg.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/additional_pkg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/additional_pkg.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/additional_pkg.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_partition.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_partition.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_partition.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_partition.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_second_adapter.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_second_adapter.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/cfg_second_adapter.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_second_adapter.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/driver_update_disk.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/driver_update_disk.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/driver_update_disk.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/driver_update_disk.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/enable_kdump.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/enable_kdump.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/enable_kdump.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/enable_kdump.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/index.rst new file mode 100644 index 000000000..56c351395 --- /dev/null +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/index.rst @@ -0,0 +1,15 @@ +Customize osimage (Optional) +============================ +Optional means all the subitems in this page are not necessary to finish an OS deployment. If you are new to xCAT, you can just jump + to `Initialize the Compute for Deployment`. + +.. toctree:: + :maxdepth: 2 + + driver_update_disk.rst + pre_post_script.rst + syncfile.rst + additional_pkg.rst + cfg_second_adapter.rst + enable_kdump.rst + diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/pre_post_script.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/pre_post_script.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/pre_post_script.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/pre_post_script.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/raid_cfg.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/raid_cfg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/raid_cfg.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/raid_cfg.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/syncfile.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/syncfile.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/advanced_topics/syncfile.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/syncfile.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/image_mgmt.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/gen_image.rst similarity index 50% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/image_mgmt.rst rename to source/guides/admin-guides/manage_clusters/ppc64le/diskless/gen_image.rst index 488130fd8..55d8dfd31 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/image_mgmt.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/gen_image.rst @@ -1,3 +1 @@ - -.. include:: ../../common/deployment/create_img.rst .. include:: ../../common/deployment/generate_img.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst index 249ca199f..02ef13310 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst @@ -4,7 +4,7 @@ Diskless Installation .. toctree:: :maxdepth: 2 - image_mgmt.rst - advanced_topics/index.rst + copy_image.rst + customize_image/index.rst + gen_image.rst deploy_os.rst - diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst b/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst index c2fcb0671..00899052e 100644 --- a/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst +++ b/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst @@ -1,4 +1 @@ -.. ======================== -.. Using common shared file -.. ======================== .. include:: ../../common/kvm/manage_vm.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst index 5c6ad7fa3..e69de29bb 100644 --- a/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst +++ b/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst @@ -1,4 +0,0 @@ -.. ======================== -.. Using common shared file -.. ======================== -.. include:: ../../common/discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst index 41d63d3eb..e69de29bb 100644 --- a/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst +++ b/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst @@ -1,3 +0,0 @@ -.. ======================== -.. Using common shared file -.. ======================== diff --git a/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst b/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst index 41d63d3eb..e69de29bb 100644 --- a/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst +++ b/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst @@ -1,3 +0,0 @@ -.. ======================== -.. Using common shared file -.. ======================== diff --git a/source/guides/install-guides/common/.install_guide.rst.swp b/source/guides/install-guides/common/.install_guide.rst.swp deleted file mode 100644 index e208266880703f26426b4685eac712392a1fdc0b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 12288 zcmeI2&2AGh5XW5(+{#zEGk`#8+U&Ma6@&nZeyFNMibPwk(Pr(WhP54RFUq1wNE|`p zz#DJ^-U4nM`UG&`g^kALzdirWhhHk)uQT4HFY7<>I{ zfA`0))9l`5#;h?uOi!}Bt@NarupXy|i?}QOUfz!TY2q8)q!CZFOoiyn7(Ev|liL)d za><2@rFK5avPR{mMk%9*v#oMAvhGk_9;QQzAp%F4z%;vhWpN>#@ZyE@Fmq=2C?A&2 zMg)ie5g-CYfCvx)B0vO)zySijH^rXe+_7r@Y&A|D7%P_sB0vO)01+SpM1Tko0U|&I zhyW2F0z}|HB#>~%&P_A+5*7acAO8OTeUh>7sBfsRs4piN`;7XC`ha?adX7p_Yp6@8 zK*DWD%5^~A|nDsfCvx)B0vO)01+SpM1Tkofs#NJ!TQ!(t9tU>GOne% z%C|H=n#T3H#+Z$}b8G;26WbL~*#K_C;_}FwoZS>$=4zC^+_*kWhQZ|QZH14tp>`AZ zoP_}_HAY*9>|0|t?uO1+v)p-MVOu^GnB5f0*aB)BD_CpN-mG4);_r*cxwJwF?cI%f zow1!g0j|Kx3hZBN&@mPYd}R*()jK<&5}kC*EC{3_3mCHkxabMZ9T*Kh6bikWPWhcy z{bCX5WeEnDsthEWmm$9BmEk>Wo=7K+mbweM6C7$>x<{Qnn}_g`3FqdAU8b4Q0$t(L y*$5!?uabwxN?(MntFvS#;eZd}g#(`3P Date: Thu, 20 Aug 2015 15:54:56 -0400 Subject: [PATCH 57/57] Staging files under xcat-doc/doc to get moved to xcat-core project --- Makefile => docs/Makefile | 0 make.bat => docs/make.bat | 0 {source => docs/source}/advanced/change_mn_ip.rst | 0 {source => docs/source}/advanced/change_node_ip.rst | 0 .../advanced/confluent/client/confluent_client.rst | 0 .../source}/advanced/confluent/client/index.rst | 0 .../source}/advanced/confluent/index.rst | 0 .../advanced/confluent/server/confluent_server.rst | 0 .../source}/advanced/confluent/server/index.rst | 0 {source => docs/source}/advanced/docker/index.rst | 0 .../hamn/high_available_management_node.rst | 0 {source => docs/source}/advanced/hamn/index.rst | 0 .../source}/advanced/hierarchy_cluster.rst | 0 {source => docs/source}/advanced/ib.rst | 0 {source => docs/source}/advanced/index.rst | 0 {source => docs/source}/advanced/ipv6_support.rst | 0 {source => docs/source}/advanced/kit.rst | 0 {source => docs/source}/advanced/mixed_cluster.rst | 0 {source => docs/source}/advanced/restapi/index.rst | 0 .../source}/advanced/restapi/restapi.rst | 0 .../source}/advanced/restapi/set_up_ws.rst | 0 {source => docs/source}/advanced/softlayer.rst | 0 {source => docs/source}/advanced/switch_mgmt.rst | 0 {source => docs/source}/advanced/sysclone.rst | 0 {source => docs/source}/advanced/vlan.rst | 0 {source => docs/source}/advanced/xcat_port.rst | 0 {source => docs/source}/advanced/xcat_security.rst | 0 {source => docs/source}/advanced/zone.rst | 0 {source => docs/source}/conf.py | 0 {source => docs/source}/developers/debug_xcat.rst | 0 .../source}/developers/developer_guide.rst | 0 {source => docs/source}/developers/git/index.rst | 0 {source => docs/source}/developers/index.rst | 0 .../license/contributor_license_agreement.rst | 0 .../source}/developers/license/index.rst | 0 .../license/xcat-project-maintainer-agreement.pdf | Bin ...xcat_corporate_contributor_license_agreement.rst | 0 ...cat_individual_contributor_license_agreement.rst | 0 .../license/xcat_maintainer_license_agreement.rst | 0 .../source}/developers/programming_tips.rst | 0 .../basic_concepts/global_cfg/index.rst | 0 .../guides/admin-guides/basic_concepts/index.rst | 0 .../basic_concepts/network_planning/index.rst | 0 .../network_planning/network_cfg/index.rst | 0 .../network_planning/network_service/index.rst | 0 .../admin-guides/basic_concepts/xcat_db/index.rst | 0 .../basic_concepts/xcat_object/group.rst | 0 .../basic_concepts/xcat_object/index.rst | 0 .../basic_concepts/xcat_object/node.rst | 0 .../basic_concepts/xcat_object/nodegroup.rst | 0 .../basic_concepts/xcat_object/osimage.rst | 0 .../source}/guides/admin-guides/index.rst | 0 .../admin-guides/large_clusters/databases/index.rst | 0 .../large_clusters/databases/mysql_configure.rst | 0 .../large_clusters/databases/mysql_install.rst | 0 .../large_clusters/databases/mysql_remove.rst | 0 .../large_clusters/databases/mysql_using.rst | 0 .../large_clusters/databases/postgres_configure.rst | 0 .../large_clusters/databases/postgres_install.rst | 0 .../large_clusters/databases/postgres_remove.rst | 0 .../large_clusters/databases/postgres_tips.rst | 0 .../large_clusters/databases/postgres_using.rst | 0 .../guides/admin-guides/large_clusters/index.rst | 0 .../service_nodes/define_service_nodes.rst | 0 .../service_nodes/provision_service_nodes.rst | 0 .../service_nodes/service_nodes101.rst | 0 .../guides/admin-guides/large_clusters/tips.rst | 0 .../common/deployment/additional_pkg.rst | 0 .../common/deployment/cfg_partition.rst | 0 .../common/deployment/cfg_second_adapter.rst | 0 .../common/deployment/create_img.rst | 0 .../manage_clusters/common/deployment/deploy_os.rst | 0 .../common/deployment/driver_update_disk.rst | 0 .../common/deployment/enable_kdump.rst | 0 .../common/deployment/generate_img.rst | 0 .../common/deployment/pre_post_script.rst | 0 .../manage_clusters/common/deployment/raid_cfg.rst | 0 .../manage_clusters/common/deployment/syncfile.rst | 0 .../common/discover/manually_define.rst | 0 .../common/discover/manually_discovery.rst | 0 .../common/discover/mtms_discovery.rst | 0 .../common/discover/seq_discovery.rst | 0 .../common/discover/switch_discovery.rst | 0 .../manage_clusters/common/kvm/manage_vm.rst | 0 .../manage_clusters/common/management.rst | 0 .../manage_clusters/common/management/rbeacon.rst | 0 .../manage_clusters/common/management/rcons.rst | 0 .../manage_clusters/common/management/renergy.rst | 0 .../manage_clusters/common/management/reventlog.rst | 0 .../manage_clusters/common/management/rflash.rst | 0 .../manage_clusters/common/management/rinv.rst | 0 .../manage_clusters/common/management/rpower.rst | 0 .../manage_clusters/common/management/rspconfig.rst | 0 .../manage_clusters/common/management/rvitals.rst | 0 .../manage_clusters/common/parallel_cmd.rst | 0 .../manage_clusters/common/updatenode.rst | 0 .../guides/admin-guides/manage_clusters/index.rst | 0 .../manage_clusters/ppc64le/discovery/index.rst | 0 .../ppc64le/discovery/manually_define.rst | 0 .../ppc64le/discovery/manually_discovery.rst | 0 .../ppc64le/discovery/mtms_discovery.rst | 0 .../ppc64le/discovery/seq_discovery.rst | 0 .../ppc64le/discovery/switch_discovery.rst | 0 .../manage_clusters/ppc64le/diskful/copy_image.rst | 0 .../diskful/customize_image/additional_pkg.rst | 0 .../diskful/customize_image/cfg_partition.rst | 0 .../diskful/customize_image/cfg_second_adapter.rst | 0 .../diskful/customize_image/driver_update_disk.rst | 0 .../ppc64le/diskful/customize_image/index.rst | 0 .../diskful/customize_image/pre_post_script.rst | 0 .../ppc64le/diskful/customize_image/raid_cfg.rst | 0 .../ppc64le/diskful/customize_image/syncfile.rst | 0 .../manage_clusters/ppc64le/diskful/deploy_os.rst | 0 .../manage_clusters/ppc64le/diskful/index.rst | 0 .../manage_clusters/ppc64le/diskless/copy_image.rst | 0 .../diskless/customize_image/additional_pkg.rst | 0 .../diskless/customize_image/cfg_partition.rst | 0 .../diskless/customize_image/cfg_second_adapter.rst | 0 .../diskless/customize_image/driver_update_disk.rst | 0 .../diskless/customize_image/enable_kdump.rst | 0 .../ppc64le/diskless/customize_image/index.rst | 0 .../diskless/customize_image/pre_post_script.rst | 0 .../ppc64le/diskless/customize_image/raid_cfg.rst | 0 .../ppc64le/diskless/customize_image/syncfile.rst | 0 .../manage_clusters/ppc64le/diskless/deploy_os.rst | 0 .../manage_clusters/ppc64le/diskless/gen_image.rst | 0 .../manage_clusters/ppc64le/diskless/index.rst | 0 .../admin-guides/manage_clusters/ppc64le/index.rst | 0 .../manage_clusters/ppc64le/management/index.rst | 0 .../manage_clusters/ppc64le/management/rbeacon.rst | 0 .../manage_clusters/ppc64le/management/rcons.rst | 0 .../manage_clusters/ppc64le/management/renergy.rst | 0 .../ppc64le/management/reventlog.rst | 0 .../manage_clusters/ppc64le/management/rflash.rst | 0 .../manage_clusters/ppc64le/management/rinv.rst | 0 .../manage_clusters/ppc64le/management/rpower.rst | 0 .../ppc64le/management/rspconfig.rst | 0 .../manage_clusters/ppc64le/management/rvitals.rst | 0 .../manage_clusters/ppc64le/parallel_cmd.rst | 0 .../manage_clusters/ppc64le/updatenode.rst | 0 .../ppc64le/virtual_machines/index.rst | 0 .../ppc64le/virtual_machines/manage_vms.rst | 0 .../ppc64le/virtual_machines/powerKVM.rst | 0 .../manage_clusters/x86_64/discovery/index.rst | 0 .../manage_clusters/x86_64/diskful/index.rst | 0 .../manage_clusters/x86_64/diskless/index.rst | 0 .../admin-guides/manage_clusters/x86_64/index.rst | 0 .../manage_clusters/x86_64/management/index.rst | 0 .../manage_clusters/x86_64/management/rbeacon.rst | 0 .../manage_clusters/x86_64/management/rcons.rst | 0 .../manage_clusters/x86_64/management/renergy.rst | 0 .../manage_clusters/x86_64/management/reventlog.rst | 0 .../manage_clusters/x86_64/management/rflash.rst | 0 .../manage_clusters/x86_64/management/rinv.rst | 0 .../manage_clusters/x86_64/management/rpower.rst | 0 .../manage_clusters/x86_64/management/rspconfig.rst | 0 .../manage_clusters/x86_64/management/rvitals.rst | 0 .../x86_64/virtual_machines/index.rst | 0 .../guides/admin-guides/references/index.rst | 0 .../source}/guides/install-guides/apt/index.rst | 0 .../guides/install-guides/apt/prepare_mgmt_node.rst | 0 .../guides/install-guides/common/install_guide.rst | 0 .../source}/guides/install-guides/index.rst | 0 .../guides/install-guides/yum/configure_xcat.rst | 0 .../source}/guides/install-guides/yum/index.rst | 0 .../guides/install-guides/yum/install_xcat.rst | 0 .../guides/install-guides/yum/prepare_mgmt_node.rst | 0 .../source}/guides/install-guides/zypper/index.rst | 0 .../install-guides/zypper/prepare_mgmt_node.rst | 0 {source => docs/source}/help.rst | 0 {source => docs/source}/index.rst | 0 {source => docs/source}/overview/architecture.rst | 0 {source => docs/source}/overview/features.rst | 0 {source => docs/source}/overview/index.rst | 0 .../source}/overview/setup_cluster_process.rst | 0 {source => docs/source}/overview/support_list.rst | 0 {source => docs/source}/xcat2_support_list.rst | 0 177 files changed, 0 insertions(+), 0 deletions(-) rename Makefile => docs/Makefile (100%) rename make.bat => docs/make.bat (100%) rename {source => docs/source}/advanced/change_mn_ip.rst (100%) rename {source => docs/source}/advanced/change_node_ip.rst (100%) rename {source => docs/source}/advanced/confluent/client/confluent_client.rst (100%) rename {source => docs/source}/advanced/confluent/client/index.rst (100%) rename {source => docs/source}/advanced/confluent/index.rst (100%) rename {source => docs/source}/advanced/confluent/server/confluent_server.rst (100%) rename {source => docs/source}/advanced/confluent/server/index.rst (100%) rename {source => docs/source}/advanced/docker/index.rst (100%) rename {source => docs/source}/advanced/hamn/high_available_management_node.rst (100%) rename {source => docs/source}/advanced/hamn/index.rst (100%) rename {source => docs/source}/advanced/hierarchy_cluster.rst (100%) rename {source => docs/source}/advanced/ib.rst (100%) rename {source => docs/source}/advanced/index.rst (100%) rename {source => docs/source}/advanced/ipv6_support.rst (100%) rename {source => docs/source}/advanced/kit.rst (100%) rename {source => docs/source}/advanced/mixed_cluster.rst (100%) rename {source => docs/source}/advanced/restapi/index.rst (100%) rename {source => docs/source}/advanced/restapi/restapi.rst (100%) rename {source => docs/source}/advanced/restapi/set_up_ws.rst (100%) rename {source => docs/source}/advanced/softlayer.rst (100%) rename {source => docs/source}/advanced/switch_mgmt.rst (100%) rename {source => docs/source}/advanced/sysclone.rst (100%) rename {source => docs/source}/advanced/vlan.rst (100%) rename {source => docs/source}/advanced/xcat_port.rst (100%) rename {source => docs/source}/advanced/xcat_security.rst (100%) rename {source => docs/source}/advanced/zone.rst (100%) rename {source => docs/source}/conf.py (100%) rename {source => docs/source}/developers/debug_xcat.rst (100%) rename {source => docs/source}/developers/developer_guide.rst (100%) rename {source => docs/source}/developers/git/index.rst (100%) rename {source => docs/source}/developers/index.rst (100%) rename {source => docs/source}/developers/license/contributor_license_agreement.rst (100%) rename {source => docs/source}/developers/license/index.rst (100%) rename {source => docs/source}/developers/license/xcat-project-maintainer-agreement.pdf (100%) rename {source => docs/source}/developers/license/xcat_corporate_contributor_license_agreement.rst (100%) rename {source => docs/source}/developers/license/xcat_individual_contributor_license_agreement.rst (100%) rename {source => docs/source}/developers/license/xcat_maintainer_license_agreement.rst (100%) rename {source => docs/source}/developers/programming_tips.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/global_cfg/index.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/index.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/network_planning/index.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/network_planning/network_cfg/index.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/xcat_db/index.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/xcat_object/group.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/xcat_object/index.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/xcat_object/node.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/xcat_object/nodegroup.rst (100%) rename {source => docs/source}/guides/admin-guides/basic_concepts/xcat_object/osimage.rst (100%) rename {source => docs/source}/guides/admin-guides/index.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/index.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/mysql_configure.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/mysql_install.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/mysql_remove.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/mysql_using.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/postgres_configure.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/postgres_install.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/postgres_remove.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/postgres_tips.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/databases/postgres_using.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/index.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst (100%) rename {source => docs/source}/guides/admin-guides/large_clusters/tips.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/additional_pkg.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/cfg_second_adapter.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/create_img.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/generate_img.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/pre_post_script.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/raid_cfg.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/deployment/syncfile.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/discover/manually_define.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/discover/manually_discovery.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/discover/mtms_discovery.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/discover/seq_discovery.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/discover/switch_discovery.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/kvm/manage_vm.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management/rbeacon.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management/rcons.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management/renergy.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management/reventlog.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management/rflash.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management/rinv.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management/rpower.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management/rspconfig.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/management/rvitals.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/parallel_cmd.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/common/updatenode.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_define.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/copy_image.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/additional_pkg.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_partition.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_second_adapter.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/driver_update_disk.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/pre_post_script.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/raid_cfg.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/syncfile.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/copy_image.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/additional_pkg.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_partition.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_second_adapter.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/driver_update_disk.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/enable_kdump.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/pre_post_script.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/raid_cfg.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/syncfile.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/deploy_os.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/gen_image.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/parallel_cmd.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/updatenode.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/index.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/rbeacon.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/rcons.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/renergy.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/reventlog.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/rflash.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/rinv.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/rpower.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/rspconfig.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/management/rvitals.rst (100%) rename {source => docs/source}/guides/admin-guides/manage_clusters/x86_64/virtual_machines/index.rst (100%) rename {source => docs/source}/guides/admin-guides/references/index.rst (100%) rename {source => docs/source}/guides/install-guides/apt/index.rst (100%) rename {source => docs/source}/guides/install-guides/apt/prepare_mgmt_node.rst (100%) rename {source => docs/source}/guides/install-guides/common/install_guide.rst (100%) rename {source => docs/source}/guides/install-guides/index.rst (100%) rename {source => docs/source}/guides/install-guides/yum/configure_xcat.rst (100%) rename {source => docs/source}/guides/install-guides/yum/index.rst (100%) rename {source => docs/source}/guides/install-guides/yum/install_xcat.rst (100%) rename {source => docs/source}/guides/install-guides/yum/prepare_mgmt_node.rst (100%) rename {source => docs/source}/guides/install-guides/zypper/index.rst (100%) rename {source => docs/source}/guides/install-guides/zypper/prepare_mgmt_node.rst (100%) rename {source => docs/source}/help.rst (100%) rename {source => docs/source}/index.rst (100%) rename {source => docs/source}/overview/architecture.rst (100%) rename {source => docs/source}/overview/features.rst (100%) rename {source => docs/source}/overview/index.rst (100%) rename {source => docs/source}/overview/setup_cluster_process.rst (100%) rename {source => docs/source}/overview/support_list.rst (100%) rename {source => docs/source}/xcat2_support_list.rst (100%) diff --git a/Makefile b/docs/Makefile similarity index 100% rename from Makefile rename to docs/Makefile diff --git a/make.bat b/docs/make.bat similarity index 100% rename from make.bat rename to docs/make.bat diff --git a/source/advanced/change_mn_ip.rst b/docs/source/advanced/change_mn_ip.rst similarity index 100% rename from source/advanced/change_mn_ip.rst rename to docs/source/advanced/change_mn_ip.rst diff --git a/source/advanced/change_node_ip.rst b/docs/source/advanced/change_node_ip.rst similarity index 100% rename from source/advanced/change_node_ip.rst rename to docs/source/advanced/change_node_ip.rst diff --git a/source/advanced/confluent/client/confluent_client.rst b/docs/source/advanced/confluent/client/confluent_client.rst similarity index 100% rename from source/advanced/confluent/client/confluent_client.rst rename to docs/source/advanced/confluent/client/confluent_client.rst diff --git a/source/advanced/confluent/client/index.rst b/docs/source/advanced/confluent/client/index.rst similarity index 100% rename from source/advanced/confluent/client/index.rst rename to docs/source/advanced/confluent/client/index.rst diff --git a/source/advanced/confluent/index.rst b/docs/source/advanced/confluent/index.rst similarity index 100% rename from source/advanced/confluent/index.rst rename to docs/source/advanced/confluent/index.rst diff --git a/source/advanced/confluent/server/confluent_server.rst b/docs/source/advanced/confluent/server/confluent_server.rst similarity index 100% rename from source/advanced/confluent/server/confluent_server.rst rename to docs/source/advanced/confluent/server/confluent_server.rst diff --git a/source/advanced/confluent/server/index.rst b/docs/source/advanced/confluent/server/index.rst similarity index 100% rename from source/advanced/confluent/server/index.rst rename to docs/source/advanced/confluent/server/index.rst diff --git a/source/advanced/docker/index.rst b/docs/source/advanced/docker/index.rst similarity index 100% rename from source/advanced/docker/index.rst rename to docs/source/advanced/docker/index.rst diff --git a/source/advanced/hamn/high_available_management_node.rst b/docs/source/advanced/hamn/high_available_management_node.rst similarity index 100% rename from source/advanced/hamn/high_available_management_node.rst rename to docs/source/advanced/hamn/high_available_management_node.rst diff --git a/source/advanced/hamn/index.rst b/docs/source/advanced/hamn/index.rst similarity index 100% rename from source/advanced/hamn/index.rst rename to docs/source/advanced/hamn/index.rst diff --git a/source/advanced/hierarchy_cluster.rst b/docs/source/advanced/hierarchy_cluster.rst similarity index 100% rename from source/advanced/hierarchy_cluster.rst rename to docs/source/advanced/hierarchy_cluster.rst diff --git a/source/advanced/ib.rst b/docs/source/advanced/ib.rst similarity index 100% rename from source/advanced/ib.rst rename to docs/source/advanced/ib.rst diff --git a/source/advanced/index.rst b/docs/source/advanced/index.rst similarity index 100% rename from source/advanced/index.rst rename to docs/source/advanced/index.rst diff --git a/source/advanced/ipv6_support.rst b/docs/source/advanced/ipv6_support.rst similarity index 100% rename from source/advanced/ipv6_support.rst rename to docs/source/advanced/ipv6_support.rst diff --git a/source/advanced/kit.rst b/docs/source/advanced/kit.rst similarity index 100% rename from source/advanced/kit.rst rename to docs/source/advanced/kit.rst diff --git a/source/advanced/mixed_cluster.rst b/docs/source/advanced/mixed_cluster.rst similarity index 100% rename from source/advanced/mixed_cluster.rst rename to docs/source/advanced/mixed_cluster.rst diff --git a/source/advanced/restapi/index.rst b/docs/source/advanced/restapi/index.rst similarity index 100% rename from source/advanced/restapi/index.rst rename to docs/source/advanced/restapi/index.rst diff --git a/source/advanced/restapi/restapi.rst b/docs/source/advanced/restapi/restapi.rst similarity index 100% rename from source/advanced/restapi/restapi.rst rename to docs/source/advanced/restapi/restapi.rst diff --git a/source/advanced/restapi/set_up_ws.rst b/docs/source/advanced/restapi/set_up_ws.rst similarity index 100% rename from source/advanced/restapi/set_up_ws.rst rename to docs/source/advanced/restapi/set_up_ws.rst diff --git a/source/advanced/softlayer.rst b/docs/source/advanced/softlayer.rst similarity index 100% rename from source/advanced/softlayer.rst rename to docs/source/advanced/softlayer.rst diff --git a/source/advanced/switch_mgmt.rst b/docs/source/advanced/switch_mgmt.rst similarity index 100% rename from source/advanced/switch_mgmt.rst rename to docs/source/advanced/switch_mgmt.rst diff --git a/source/advanced/sysclone.rst b/docs/source/advanced/sysclone.rst similarity index 100% rename from source/advanced/sysclone.rst rename to docs/source/advanced/sysclone.rst diff --git a/source/advanced/vlan.rst b/docs/source/advanced/vlan.rst similarity index 100% rename from source/advanced/vlan.rst rename to docs/source/advanced/vlan.rst diff --git a/source/advanced/xcat_port.rst b/docs/source/advanced/xcat_port.rst similarity index 100% rename from source/advanced/xcat_port.rst rename to docs/source/advanced/xcat_port.rst diff --git a/source/advanced/xcat_security.rst b/docs/source/advanced/xcat_security.rst similarity index 100% rename from source/advanced/xcat_security.rst rename to docs/source/advanced/xcat_security.rst diff --git a/source/advanced/zone.rst b/docs/source/advanced/zone.rst similarity index 100% rename from source/advanced/zone.rst rename to docs/source/advanced/zone.rst diff --git a/source/conf.py b/docs/source/conf.py similarity index 100% rename from source/conf.py rename to docs/source/conf.py diff --git a/source/developers/debug_xcat.rst b/docs/source/developers/debug_xcat.rst similarity index 100% rename from source/developers/debug_xcat.rst rename to docs/source/developers/debug_xcat.rst diff --git a/source/developers/developer_guide.rst b/docs/source/developers/developer_guide.rst similarity index 100% rename from source/developers/developer_guide.rst rename to docs/source/developers/developer_guide.rst diff --git a/source/developers/git/index.rst b/docs/source/developers/git/index.rst similarity index 100% rename from source/developers/git/index.rst rename to docs/source/developers/git/index.rst diff --git a/source/developers/index.rst b/docs/source/developers/index.rst similarity index 100% rename from source/developers/index.rst rename to docs/source/developers/index.rst diff --git a/source/developers/license/contributor_license_agreement.rst b/docs/source/developers/license/contributor_license_agreement.rst similarity index 100% rename from source/developers/license/contributor_license_agreement.rst rename to docs/source/developers/license/contributor_license_agreement.rst diff --git a/source/developers/license/index.rst b/docs/source/developers/license/index.rst similarity index 100% rename from source/developers/license/index.rst rename to docs/source/developers/license/index.rst diff --git a/source/developers/license/xcat-project-maintainer-agreement.pdf b/docs/source/developers/license/xcat-project-maintainer-agreement.pdf similarity index 100% rename from source/developers/license/xcat-project-maintainer-agreement.pdf rename to docs/source/developers/license/xcat-project-maintainer-agreement.pdf diff --git a/source/developers/license/xcat_corporate_contributor_license_agreement.rst b/docs/source/developers/license/xcat_corporate_contributor_license_agreement.rst similarity index 100% rename from source/developers/license/xcat_corporate_contributor_license_agreement.rst rename to docs/source/developers/license/xcat_corporate_contributor_license_agreement.rst diff --git a/source/developers/license/xcat_individual_contributor_license_agreement.rst b/docs/source/developers/license/xcat_individual_contributor_license_agreement.rst similarity index 100% rename from source/developers/license/xcat_individual_contributor_license_agreement.rst rename to docs/source/developers/license/xcat_individual_contributor_license_agreement.rst diff --git a/source/developers/license/xcat_maintainer_license_agreement.rst b/docs/source/developers/license/xcat_maintainer_license_agreement.rst similarity index 100% rename from source/developers/license/xcat_maintainer_license_agreement.rst rename to docs/source/developers/license/xcat_maintainer_license_agreement.rst diff --git a/source/developers/programming_tips.rst b/docs/source/developers/programming_tips.rst similarity index 100% rename from source/developers/programming_tips.rst rename to docs/source/developers/programming_tips.rst diff --git a/source/guides/admin-guides/basic_concepts/global_cfg/index.rst b/docs/source/guides/admin-guides/basic_concepts/global_cfg/index.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/global_cfg/index.rst rename to docs/source/guides/admin-guides/basic_concepts/global_cfg/index.rst diff --git a/source/guides/admin-guides/basic_concepts/index.rst b/docs/source/guides/admin-guides/basic_concepts/index.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/index.rst rename to docs/source/guides/admin-guides/basic_concepts/index.rst diff --git a/source/guides/admin-guides/basic_concepts/network_planning/index.rst b/docs/source/guides/admin-guides/basic_concepts/network_planning/index.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/network_planning/index.rst rename to docs/source/guides/admin-guides/basic_concepts/network_planning/index.rst diff --git a/source/guides/admin-guides/basic_concepts/network_planning/network_cfg/index.rst b/docs/source/guides/admin-guides/basic_concepts/network_planning/network_cfg/index.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/network_planning/network_cfg/index.rst rename to docs/source/guides/admin-guides/basic_concepts/network_planning/network_cfg/index.rst diff --git a/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst b/docs/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst rename to docs/source/guides/admin-guides/basic_concepts/network_planning/network_service/index.rst diff --git a/source/guides/admin-guides/basic_concepts/xcat_db/index.rst b/docs/source/guides/admin-guides/basic_concepts/xcat_db/index.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/xcat_db/index.rst rename to docs/source/guides/admin-guides/basic_concepts/xcat_db/index.rst diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/group.rst b/docs/source/guides/admin-guides/basic_concepts/xcat_object/group.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/xcat_object/group.rst rename to docs/source/guides/admin-guides/basic_concepts/xcat_object/group.rst diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/index.rst b/docs/source/guides/admin-guides/basic_concepts/xcat_object/index.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/xcat_object/index.rst rename to docs/source/guides/admin-guides/basic_concepts/xcat_object/index.rst diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/node.rst b/docs/source/guides/admin-guides/basic_concepts/xcat_object/node.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/xcat_object/node.rst rename to docs/source/guides/admin-guides/basic_concepts/xcat_object/node.rst diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/nodegroup.rst b/docs/source/guides/admin-guides/basic_concepts/xcat_object/nodegroup.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/xcat_object/nodegroup.rst rename to docs/source/guides/admin-guides/basic_concepts/xcat_object/nodegroup.rst diff --git a/source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst b/docs/source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst similarity index 100% rename from source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst rename to docs/source/guides/admin-guides/basic_concepts/xcat_object/osimage.rst diff --git a/source/guides/admin-guides/index.rst b/docs/source/guides/admin-guides/index.rst similarity index 100% rename from source/guides/admin-guides/index.rst rename to docs/source/guides/admin-guides/index.rst diff --git a/source/guides/admin-guides/large_clusters/databases/index.rst b/docs/source/guides/admin-guides/large_clusters/databases/index.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/index.rst rename to docs/source/guides/admin-guides/large_clusters/databases/index.rst diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst b/docs/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/mysql_configure.rst rename to docs/source/guides/admin-guides/large_clusters/databases/mysql_configure.rst diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_install.rst b/docs/source/guides/admin-guides/large_clusters/databases/mysql_install.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/mysql_install.rst rename to docs/source/guides/admin-guides/large_clusters/databases/mysql_install.rst diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_remove.rst b/docs/source/guides/admin-guides/large_clusters/databases/mysql_remove.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/mysql_remove.rst rename to docs/source/guides/admin-guides/large_clusters/databases/mysql_remove.rst diff --git a/source/guides/admin-guides/large_clusters/databases/mysql_using.rst b/docs/source/guides/admin-guides/large_clusters/databases/mysql_using.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/mysql_using.rst rename to docs/source/guides/admin-guides/large_clusters/databases/mysql_using.rst diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst b/docs/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/postgres_configure.rst rename to docs/source/guides/admin-guides/large_clusters/databases/postgres_configure.rst diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_install.rst b/docs/source/guides/admin-guides/large_clusters/databases/postgres_install.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/postgres_install.rst rename to docs/source/guides/admin-guides/large_clusters/databases/postgres_install.rst diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_remove.rst b/docs/source/guides/admin-guides/large_clusters/databases/postgres_remove.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/postgres_remove.rst rename to docs/source/guides/admin-guides/large_clusters/databases/postgres_remove.rst diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_tips.rst b/docs/source/guides/admin-guides/large_clusters/databases/postgres_tips.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/postgres_tips.rst rename to docs/source/guides/admin-guides/large_clusters/databases/postgres_tips.rst diff --git a/source/guides/admin-guides/large_clusters/databases/postgres_using.rst b/docs/source/guides/admin-guides/large_clusters/databases/postgres_using.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/databases/postgres_using.rst rename to docs/source/guides/admin-guides/large_clusters/databases/postgres_using.rst diff --git a/source/guides/admin-guides/large_clusters/index.rst b/docs/source/guides/admin-guides/large_clusters/index.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/index.rst rename to docs/source/guides/admin-guides/large_clusters/index.rst diff --git a/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst b/docs/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst rename to docs/source/guides/admin-guides/large_clusters/service_nodes/define_service_nodes.rst diff --git a/source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst b/docs/source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst rename to docs/source/guides/admin-guides/large_clusters/service_nodes/provision_service_nodes.rst diff --git a/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst b/docs/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst rename to docs/source/guides/admin-guides/large_clusters/service_nodes/service_nodes101.rst diff --git a/source/guides/admin-guides/large_clusters/tips.rst b/docs/source/guides/admin-guides/large_clusters/tips.rst similarity index 100% rename from source/guides/admin-guides/large_clusters/tips.rst rename to docs/source/guides/admin-guides/large_clusters/tips.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/additional_pkg.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/additional_pkg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/additional_pkg.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/additional_pkg.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/cfg_second_adapter.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/cfg_second_adapter.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/cfg_second_adapter.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/cfg_second_adapter.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/generate_img.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/generate_img.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/generate_img.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/generate_img.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/pre_post_script.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/pre_post_script.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/pre_post_script.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/pre_post_script.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/raid_cfg.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/raid_cfg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/raid_cfg.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/raid_cfg.rst diff --git a/source/guides/admin-guides/manage_clusters/common/deployment/syncfile.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/deployment/syncfile.rst rename to docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile.rst diff --git a/source/guides/admin-guides/manage_clusters/common/discover/manually_define.rst b/docs/source/guides/admin-guides/manage_clusters/common/discover/manually_define.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/discover/manually_define.rst rename to docs/source/guides/admin-guides/manage_clusters/common/discover/manually_define.rst diff --git a/source/guides/admin-guides/manage_clusters/common/discover/manually_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/common/discover/manually_discovery.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/discover/manually_discovery.rst rename to docs/source/guides/admin-guides/manage_clusters/common/discover/manually_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/common/discover/mtms_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/common/discover/mtms_discovery.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/discover/mtms_discovery.rst rename to docs/source/guides/admin-guides/manage_clusters/common/discover/mtms_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/common/discover/seq_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/common/discover/seq_discovery.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/discover/seq_discovery.rst rename to docs/source/guides/admin-guides/manage_clusters/common/discover/seq_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/common/discover/switch_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/common/discover/switch_discovery.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/discover/switch_discovery.rst rename to docs/source/guides/admin-guides/manage_clusters/common/discover/switch_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/common/kvm/manage_vm.rst b/docs/source/guides/admin-guides/manage_clusters/common/kvm/manage_vm.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/kvm/manage_vm.rst rename to docs/source/guides/admin-guides/manage_clusters/common/kvm/manage_vm.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management.rst b/docs/source/guides/admin-guides/manage_clusters/common/management.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/rbeacon.rst b/docs/source/guides/admin-guides/manage_clusters/common/management/rbeacon.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management/rbeacon.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management/rbeacon.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/rcons.rst b/docs/source/guides/admin-guides/manage_clusters/common/management/rcons.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management/rcons.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management/rcons.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/renergy.rst b/docs/source/guides/admin-guides/manage_clusters/common/management/renergy.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management/renergy.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management/renergy.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/reventlog.rst b/docs/source/guides/admin-guides/manage_clusters/common/management/reventlog.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management/reventlog.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management/reventlog.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/rflash.rst b/docs/source/guides/admin-guides/manage_clusters/common/management/rflash.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management/rflash.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management/rflash.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/rinv.rst b/docs/source/guides/admin-guides/manage_clusters/common/management/rinv.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management/rinv.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management/rinv.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/rpower.rst b/docs/source/guides/admin-guides/manage_clusters/common/management/rpower.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management/rpower.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management/rpower.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/rspconfig.rst b/docs/source/guides/admin-guides/manage_clusters/common/management/rspconfig.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management/rspconfig.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management/rspconfig.rst diff --git a/source/guides/admin-guides/manage_clusters/common/management/rvitals.rst b/docs/source/guides/admin-guides/manage_clusters/common/management/rvitals.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/management/rvitals.rst rename to docs/source/guides/admin-guides/manage_clusters/common/management/rvitals.rst diff --git a/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst b/docs/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst rename to docs/source/guides/admin-guides/manage_clusters/common/parallel_cmd.rst diff --git a/source/guides/admin-guides/manage_clusters/common/updatenode.rst b/docs/source/guides/admin-guides/manage_clusters/common/updatenode.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/common/updatenode.rst rename to docs/source/guides/admin-guides/manage_clusters/common/updatenode.rst diff --git a/source/guides/admin-guides/manage_clusters/index.rst b/docs/source/guides/admin-guides/manage_clusters/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/index.rst rename to docs/source/guides/admin-guides/manage_clusters/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_define.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_define.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_define.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_define.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/copy_image.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/copy_image.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/copy_image.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/copy_image.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/additional_pkg.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/additional_pkg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/additional_pkg.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/additional_pkg.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_partition.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_partition.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_partition.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_partition.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_second_adapter.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_second_adapter.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_second_adapter.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/cfg_second_adapter.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/driver_update_disk.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/driver_update_disk.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/driver_update_disk.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/driver_update_disk.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/index.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/pre_post_script.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/pre_post_script.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/pre_post_script.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/pre_post_script.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/raid_cfg.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/raid_cfg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/raid_cfg.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/raid_cfg.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/syncfile.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/syncfile.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/syncfile.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/syncfile.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/copy_image.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/copy_image.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/copy_image.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/copy_image.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/additional_pkg.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/additional_pkg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/additional_pkg.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/additional_pkg.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_partition.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_partition.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_partition.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_partition.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_second_adapter.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_second_adapter.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_second_adapter.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_second_adapter.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/driver_update_disk.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/driver_update_disk.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/driver_update_disk.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/driver_update_disk.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/enable_kdump.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/enable_kdump.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/enable_kdump.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/enable_kdump.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/index.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/pre_post_script.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/pre_post_script.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/pre_post_script.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/pre_post_script.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/raid_cfg.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/raid_cfg.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/raid_cfg.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/raid_cfg.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/syncfile.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/syncfile.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/syncfile.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/syncfile.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/deploy_os.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/deploy_os.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/deploy_os.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/deploy_os.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/gen_image.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/gen_image.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/gen_image.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/gen_image.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/index.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rbeacon.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rcons.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/renergy.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/reventlog.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rflash.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rinv.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rpower.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rspconfig.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/management/rvitals.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/parallel_cmd.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/parallel_cmd.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/parallel_cmd.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/parallel_cmd.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/updatenode.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/updatenode.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/updatenode.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/updatenode.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/index.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/index.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/manage_vms.rst diff --git a/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst rename to docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/discovery/index.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/diskful/index.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/diskless/index.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/index.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/index.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/index.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/index.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/index.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/index.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rbeacon.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/rbeacon.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/rbeacon.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/rbeacon.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rcons.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/rcons.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/rcons.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/rcons.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/renergy.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/renergy.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/renergy.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/renergy.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/reventlog.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/reventlog.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/reventlog.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/reventlog.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rflash.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/rflash.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/rflash.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/rflash.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rinv.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/rinv.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/rinv.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/rinv.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rpower.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/rpower.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/rpower.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/rpower.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rspconfig.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/rspconfig.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/rspconfig.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/rspconfig.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/management/rvitals.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/management/rvitals.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/management/rvitals.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/management/rvitals.rst diff --git a/source/guides/admin-guides/manage_clusters/x86_64/virtual_machines/index.rst b/docs/source/guides/admin-guides/manage_clusters/x86_64/virtual_machines/index.rst similarity index 100% rename from source/guides/admin-guides/manage_clusters/x86_64/virtual_machines/index.rst rename to docs/source/guides/admin-guides/manage_clusters/x86_64/virtual_machines/index.rst diff --git a/source/guides/admin-guides/references/index.rst b/docs/source/guides/admin-guides/references/index.rst similarity index 100% rename from source/guides/admin-guides/references/index.rst rename to docs/source/guides/admin-guides/references/index.rst diff --git a/source/guides/install-guides/apt/index.rst b/docs/source/guides/install-guides/apt/index.rst similarity index 100% rename from source/guides/install-guides/apt/index.rst rename to docs/source/guides/install-guides/apt/index.rst diff --git a/source/guides/install-guides/apt/prepare_mgmt_node.rst b/docs/source/guides/install-guides/apt/prepare_mgmt_node.rst similarity index 100% rename from source/guides/install-guides/apt/prepare_mgmt_node.rst rename to docs/source/guides/install-guides/apt/prepare_mgmt_node.rst diff --git a/source/guides/install-guides/common/install_guide.rst b/docs/source/guides/install-guides/common/install_guide.rst similarity index 100% rename from source/guides/install-guides/common/install_guide.rst rename to docs/source/guides/install-guides/common/install_guide.rst diff --git a/source/guides/install-guides/index.rst b/docs/source/guides/install-guides/index.rst similarity index 100% rename from source/guides/install-guides/index.rst rename to docs/source/guides/install-guides/index.rst diff --git a/source/guides/install-guides/yum/configure_xcat.rst b/docs/source/guides/install-guides/yum/configure_xcat.rst similarity index 100% rename from source/guides/install-guides/yum/configure_xcat.rst rename to docs/source/guides/install-guides/yum/configure_xcat.rst diff --git a/source/guides/install-guides/yum/index.rst b/docs/source/guides/install-guides/yum/index.rst similarity index 100% rename from source/guides/install-guides/yum/index.rst rename to docs/source/guides/install-guides/yum/index.rst diff --git a/source/guides/install-guides/yum/install_xcat.rst b/docs/source/guides/install-guides/yum/install_xcat.rst similarity index 100% rename from source/guides/install-guides/yum/install_xcat.rst rename to docs/source/guides/install-guides/yum/install_xcat.rst diff --git a/source/guides/install-guides/yum/prepare_mgmt_node.rst b/docs/source/guides/install-guides/yum/prepare_mgmt_node.rst similarity index 100% rename from source/guides/install-guides/yum/prepare_mgmt_node.rst rename to docs/source/guides/install-guides/yum/prepare_mgmt_node.rst diff --git a/source/guides/install-guides/zypper/index.rst b/docs/source/guides/install-guides/zypper/index.rst similarity index 100% rename from source/guides/install-guides/zypper/index.rst rename to docs/source/guides/install-guides/zypper/index.rst diff --git a/source/guides/install-guides/zypper/prepare_mgmt_node.rst b/docs/source/guides/install-guides/zypper/prepare_mgmt_node.rst similarity index 100% rename from source/guides/install-guides/zypper/prepare_mgmt_node.rst rename to docs/source/guides/install-guides/zypper/prepare_mgmt_node.rst diff --git a/source/help.rst b/docs/source/help.rst similarity index 100% rename from source/help.rst rename to docs/source/help.rst diff --git a/source/index.rst b/docs/source/index.rst similarity index 100% rename from source/index.rst rename to docs/source/index.rst diff --git a/source/overview/architecture.rst b/docs/source/overview/architecture.rst similarity index 100% rename from source/overview/architecture.rst rename to docs/source/overview/architecture.rst diff --git a/source/overview/features.rst b/docs/source/overview/features.rst similarity index 100% rename from source/overview/features.rst rename to docs/source/overview/features.rst diff --git a/source/overview/index.rst b/docs/source/overview/index.rst similarity index 100% rename from source/overview/index.rst rename to docs/source/overview/index.rst diff --git a/source/overview/setup_cluster_process.rst b/docs/source/overview/setup_cluster_process.rst similarity index 100% rename from source/overview/setup_cluster_process.rst rename to docs/source/overview/setup_cluster_process.rst diff --git a/source/overview/support_list.rst b/docs/source/overview/support_list.rst similarity index 100% rename from source/overview/support_list.rst rename to docs/source/overview/support_list.rst diff --git a/source/xcat2_support_list.rst b/docs/source/xcat2_support_list.rst similarity index 100% rename from source/xcat2_support_list.rst rename to docs/source/xcat2_support_list.rst