mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-05-30 09:36:41 +00:00
Fix doc build errors and missing links
This commit is contained in:
Mark Gurevich
parent
1c35b8f26b
commit
ef3bf0c437
@ -147,9 +147,10 @@ Known Issues
|
||||
------------
|
||||
|
||||
.. [1]
|
||||
When you start up xCAT Docker container, you might see an error message at the end of the output like: ::
|
||||
|
||||
Couldn't connect to Docker daemon at http+unix://var/run/docker.sock - is it running? If it's at a non-standard location, specify the URL with the DOCKER_HOST environment variable.`
|
||||
When you start up xCAT Docker container, you might see an error message at the end of the output like ::
|
||||
|
||||
Couldn't connect to Docker daemon at http+unix://var/run/docker.sock - is it running? If it's at a non-standard location, specify the URL with the DOCKER_HOST environment variable.
|
||||
|
||||
You can ignore it, the container has already been running. It is a Docker bug `#1214 <https://github.com/docker/compose/issues/1214>`_
|
||||
|
||||
|
||||
@ -56,17 +56,20 @@ The otherpkglist file should contain the following:
|
||||
|
||||
At the time of this writing (February 2016), docker package is not available for **ppc64el** architecture from docker.org. You can follow instructions below on how to manually download and install it.
|
||||
|
||||
* Download docker engine for ppc64el
|
||||
* Download docker engine for ppc64el:
|
||||
|
||||
::
|
||||
|
||||
wget http://launchpadlibrarian.net/251622081/docker.io_1.10.3-0ubuntu4_ppc64el.deb -O /install/docker_ppc64el/docker.io_1.10.3-0ubuntu4_ppc64el.deb
|
||||
|
||||
* Configure **otherpkgdir** like this
|
||||
* Configure **otherpkgdir** like this:
|
||||
|
||||
::
|
||||
|
||||
otherpkgdir=/install/docker_ppc64el
|
||||
|
||||
* The **otherpkglist** file should be
|
||||
* The **otherpkglist** file should be:
|
||||
|
||||
::
|
||||
|
||||
# cat /install/custom/ubuntu/ubuntu_docker.pkglist
|
||||
@ -226,16 +229,19 @@ If things go wrong:
|
||||
* After dockerhost node boots, check contents of **/var/log/xcat/xcat.log** file on the dockerhost for errors.
|
||||
|
||||
* Verify **nicname** specified in **Preparing setup trust connection for docker service and create docker network object** section exists on the docker host. Depending on the version of Ubuntu OS and host architecture, it could be **eth0**, or **em1**, or **eno1**, or **enp0s1**. Verify by running on the dockerhost
|
||||
|
||||
::
|
||||
|
||||
ip addr show dev <nicname>
|
||||
|
||||
* Run **ps -ef | grep docker** to verify docker engine is running with configured options. It should look something like
|
||||
* Run **ps -ef | grep docker** to verify docker engine is running with configured options. It should look something like
|
||||
|
||||
::
|
||||
|
||||
root 3703 1 0 Apr15 ? 00:12:28 /usr/bin/docker daemon -H unix:///var/run/docker.sock -H tcp://host01:2375 --tls --tlscacert=/root/.docker/ca-cert.pem --tlscert=/root/.docker/dockerhost-cert.pem --tlskey=/root/.docker/dockerhost-cert.pem --tlsverify=true --raw-logs
|
||||
|
||||
If the output is missing some options, verify that file **/lib/systemd/system/docker.service** contains the following lines
|
||||
If the output is missing some options, verify that file **/lib/systemd/system/docker.service** contains the following lines
|
||||
|
||||
::
|
||||
|
||||
EnvironmentFile=-/etc/default/docker
|
||||
|
||||
@ -193,7 +193,7 @@ Once **/etc/hosts** is populated with all of the nodes' hostnames and IP address
|
||||
|
||||
makedns -n
|
||||
|
||||
When the **/etc/resolv.conf** files for the compute nodes are created the value of the **nameserver** in /etc/resolv.conf is gotten from **site.nameservers** or **networks.nameservers** if it's specified. ::
|
||||
When the **/etc/resolv.conf** files for the compute nodes are created the value of the **nameserver** in /etc/resolv.conf is gotten from **site.nameservers** or **networks.nameservers** if it's specified.
|
||||
|
||||
For example: ::
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ The combinations of data synchronization mechanism and manual/automatic failover
|
||||
|Automatic Failover | 4 | **5** | **6** |
|
||||
+-------------------+-------------------------+-----------------+--------------+
|
||||
|
||||
Option 1, :ref:`setup_ha_mgmt_node_with_raid1_and disks_move`
|
||||
Option 1, :ref:`setup_ha_mgmt_node_with_raid1_and_disks_move`
|
||||
|
||||
Option 2, :ref:`setup_ha_mgmt_node_with_shared_data`
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
.. _setup_ha_mgmt_node_with_raid1_and disks_move:
|
||||
.. _setup_ha_mgmt_node_with_raid1_and_disks_move:
|
||||
|
||||
Setup HA Mgmt Node With RAID1 and disks move
|
||||
============================================
|
||||
|
||||
@ -12,7 +12,7 @@ If you no longer want to use MySQL/MariaDB to maintain ``xcatdb``, and like to s
|
||||
|
||||
XCATBYPASS=1 restorexCATdb -p ~/xcat-dbback
|
||||
|
||||
* Change to PostgreSQL, please following documentation: :doc:`/guides/admin-guides/large_clusters/databases/postgres_install`
|
||||
* Change to PostgreSQL, please following documentation: :doc:`/advanced/hierarchy/databases/postgres_install`
|
||||
|
||||
|
||||
* Change back to default xCAT database, SQLite (**Note**: xCAT Hierarchy cluster will no longer work)
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
|
||||
.. _setup_service_node_stateful_label:
|
||||
|
||||
Diskful (Stateful) Installation
|
||||
===============================
|
||||
|
||||
@ -103,8 +106,8 @@ the build with fixes from RHEL6 team, once meet this problem, you need to
|
||||
manually select the SAS disk to be the first boot device and boots from the
|
||||
SAS disk.
|
||||
|
||||
Update Service Node Diskfull Image
|
||||
----------------------------------
|
||||
Update Service Node Diskful Image
|
||||
---------------------------------
|
||||
|
||||
To update the xCAT software on the Service Node:
|
||||
|
||||
|
||||
@ -46,7 +46,7 @@ Notes:
|
||||
|
||||
* The support statements refers to hardware control, operating system (os) provisioning, and general purpose system management where we do not see any obvious problems with the indicated combination.
|
||||
|
||||
* For diskless mixed cluster support, the initial diskless image must be created on a node running the target operating system version and architecture. see :ref:`Building_a_Stateless_Image_of_a_Different_Architecture_or_OS` for more details.
|
||||
* For diskless mixed cluster support, the initial diskless image must be created on a node running the target operating system version and architecture. see :doc:`/advanced/mixed_cluster/building_stateless_images` for more details.
|
||||
|
||||
.. rubric:: Footnotes
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ After you install mellanox derives in rhels7.2 successfully by xCAT, maybe you h
|
||||
Known Issue 2
|
||||
-------------
|
||||
|
||||
If you want to use ``--add-kernel-support`` attribute in sles12.1 and ppc64le scenario, you will find some dependency packages are not shipped by SLES Server DVDs, such like ``python-devel``, it's shipped in SDK DVDs. xCAT doesn't ship specific pkglist to support such scenario. If you have such requirement, please used ``otherpkglist`` and ``otherpkgs`` attributes to prepare dependency packages repository ahead. If you need help about ``otherpkglist`` and ``otherpkgs``attributes, please refer to :doc:`Add Additional Software Packages </guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/additional_pkg>`.
|
||||
If you want to use ``--add-kernel-support`` attribute in sles12.1 and ppc64le scenario, you will find some dependency packages are not shipped by SLES Server DVDs, such like ``python-devel``, it's shipped in SDK DVDs. xCAT doesn't ship specific pkglist to support such scenario. If you have such requirement, please used ``otherpkglist`` and ``otherpkgs`` attributes to prepare dependency packages repository ahead. If you need help about ``otherpkglist`` and ``otherpkgs`` attributes, please refer to :doc:`Add Additional Software Packages </guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/additional_pkg>`.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -74,7 +74,7 @@ Configure xdsh for Mellanox Switch
|
||||
----------------------------------
|
||||
To run xdsh commands to the Mellanox Switch, you must use the --devicetype input flag to xdsh. In addition, for xCAT versions less than 2.8, you must add a configuration file, please see `Setup ssh connection to the Mellanox Switch`_ section.
|
||||
|
||||
For the Mellanox Switch the ``--devicetype`` is ``IBSwitch::Mellanox``. See :doc:`xdsh man page <../../../guides/admin-guides/references/man/xdsh.1.html>` for details.
|
||||
For the Mellanox Switch the ``--devicetype`` is ``IBSwitch::Mellanox``. See :doc:`xdsh man page </guides/admin-guides/references/man1/xdsh.1>` for details.
|
||||
|
||||
Now you can run the switch commands from the mn using xdsh. For example: ::
|
||||
|
||||
|
||||
@ -1533,6 +1533,7 @@ Set the name attribute for policy 3. ::
|
||||
|
||||
|
||||
#curl -X PUT -k 'https://127.0.0.1/xcatws/policy/3?userName=root&userPW=cluster&pretty=1' -H Content-Type:application/json --data '{"name":"root"}'
|
||||
|
||||
POST - Create the policy {policyname}. DataBody: {attr1:v1,att2:v2...}.
|
||||
```````````````````````````````````````````````````````````````````````
|
||||
|
||||
|
||||
@ -40,7 +40,7 @@ This document describes how to install and configure a template node (called gol
|
||||
Prepare the xCAT Management Node for Support Sysclone
|
||||
`````````````````````````````````````````````````````
|
||||
|
||||
How to configure xCAT management node please refer to section :ref:`Install Guides <install_guides>`
|
||||
How to configure xCAT management node please refer to section :ref:`install_guides`
|
||||
|
||||
For support Sysclone, we need to install some extra rpms on management node and the golden client.
|
||||
|
||||
|
||||
@ -76,7 +76,42 @@ language = None
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
#
|
||||
# Adding a pattern or a file on this list will still make file available in the documentation,
|
||||
# but will eliminate the warning message "document isn't included in any toctree"
|
||||
# However, some files that generate such warning contain labels being referred to from other files,
|
||||
# if put on the exclude_patters list, such labels are not visible. The commented out files in the
|
||||
# exclude_patters list below, are such files. They generate a warning, but contain reference labels.
|
||||
exclude_patterns = ['guides/install-guides/common_sections.rst',
|
||||
'**manage_clusters/common/deployment/*.rst',
|
||||
'**manage_clusters/common/discover/**',
|
||||
'**manage_clusters/common/management/**',
|
||||
'**manage_clusters/common/parallel_cmd.rst',
|
||||
'**manage_clusters/common/updatenode.rst',
|
||||
'**manage_clusters/common/kvm/manage_vm.rst',
|
||||
'**manage_clusters/common/management.rst',
|
||||
'**ppc64le/discovery/config_environment.rst',
|
||||
'**ppc64le/discovery/pbmc_discovery.rst',
|
||||
'**ppc64le/discovery/pbmc_discovery_with_bmcdiscover.rst',
|
||||
'**ppc64le/discovery/pbmc_discovery_with_lsslp.rst',
|
||||
'**ppc64le/discovery/schedule_environment.rst',
|
||||
'**ppc64le/discovery/standard_cn_definition.rst',
|
||||
'**ppc64le/diskless/customize_image/cfg_partition.rst',
|
||||
'**ppc64le/diskless/customize_image/raid_cfg.rst',
|
||||
#'**chain/create_image_for_runimage.rst'
|
||||
#'**hamn/setup_ha_mgmt_node_with_drbd_pacemaker_corosync.rst'
|
||||
#'**hamn/setup_ha_mgmt_node_with_raid1_and_disks_move.rst'
|
||||
#'**hamn/setup_ha_mgmt_node_with_shared_data.rst',
|
||||
#'**hamn/setup_xcat_high_available_management_node_in_softlayer.rst',
|
||||
'**hierarchy/databases/postgres_tips.rst',
|
||||
'**hierarchy/define_and_install_compute_node.rst',
|
||||
#'**hierarchy/define_service_node.rst',
|
||||
'**networks/getadapter.rst'
|
||||
#'**networks/vlan/index.rst',
|
||||
#'**networks/vlan/vlan.rst',
|
||||
#'**license/xcat_corporate_contributor_license_agreement.rst',
|
||||
#'**license/xcat_individual_contributor_license_agreement.rst'
|
||||
]
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
@ -145,7 +180,7 @@ else:
|
||||
# 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']
|
||||
#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
|
||||
|
||||
@ -1,255 +0,0 @@
|
||||
Guidelines for xCAT Documentation
|
||||
=================================
|
||||
The following guidelines should be followed when making changes to the xCAT documentation to help create consistency in the documentation.
|
||||
|
||||
Document Structure
|
||||
------------------
|
||||
|
||||
Section Structure
|
||||
`````````````````
|
||||
|
||||
xCAT doc page may have 4 levels of title at most: ::
|
||||
|
||||
The First Title
|
||||
===============
|
||||
|
||||
The Second Title
|
||||
----------------
|
||||
|
||||
The Third Title
|
||||
```````````````
|
||||
|
||||
The Forth Title
|
||||
'''''''''''''''
|
||||
|
||||
List Structure
|
||||
``````````````
|
||||
|
||||
Bullet Lists
|
||||
''''''''''''
|
||||
|
||||
* Bullet one
|
||||
|
||||
The Content.
|
||||
* Bullet Two
|
||||
|
||||
The Content.
|
||||
|
||||
::
|
||||
|
||||
* Bullet one
|
||||
The Content.
|
||||
* Bullet Two
|
||||
The Content.
|
||||
|
||||
Enumerated List
|
||||
'''''''''''''''
|
||||
|
||||
1. Item 1
|
||||
|
||||
a) item a
|
||||
b) item b
|
||||
|
||||
2. Item 2
|
||||
|
||||
a) item a
|
||||
|
||||
::
|
||||
|
||||
1. Item 1
|
||||
a) item a
|
||||
b) item b
|
||||
2. Item 2
|
||||
a) item a
|
||||
|
||||
Hyperlinks -> Internal Links -> External Links
|
||||
----------------------------------------------
|
||||
|
||||
Add links to refer other web page is a very common way in writting document, it's very helpful to reduce the doc duplication and make doc to be easy to understand. Following are several ways to add a link in the xCAT documentation.
|
||||
|
||||
* **Add an Internal Link to ``Customized Link Target``**
|
||||
|
||||
``Customized Link Target`` means a user defined **Link Target**.
|
||||
|
||||
.. _my_link_target:
|
||||
|
||||
Define a **Link Target** named ``my_link_target``: ::
|
||||
|
||||
.. _my_link_target:
|
||||
|
||||
**Customized Link Target**
|
||||
|
||||
This part of content is a link target which can be linked by other content.
|
||||
|
||||
..
|
||||
|
||||
Link to the customized link target ``my_link_target`` :ref:`my link <my_link_target>`: ::
|
||||
|
||||
Link to the customized link target ``my_link_target`` :ref:`my link <my_link_target>`
|
||||
|
||||
..
|
||||
|
||||
``Usage:`` This method is used to add a **Link Target** in any page that can be referred by any other pages.
|
||||
|
||||
* **Add an Internal Link to Current Page**
|
||||
|
||||
Link to an internal section in current page: `Guidelines for xCAT Documentation`_: ::
|
||||
|
||||
Link to an internal section in current page: `Guidelines for xCAT Documentation`_
|
||||
|
||||
..
|
||||
|
||||
``Usage:`` Every title of a section is an auto-generated 'link target', so you can use it directly. But it's only available inside the current page.
|
||||
|
||||
* **Add an Internal Link to Other Page via File Path**
|
||||
|
||||
Link to page ``http://server/overview/suport_list.html`` with **absolute file path** :doc:`support list </overview/support_list>`: ::
|
||||
|
||||
Link to page ``http://server/overview/suport_list.html`` with **absolute file path** :doc:`support list </overview/support_list>`
|
||||
|
||||
..
|
||||
|
||||
Link to page ``http://server/overview/suport_list.html`` with **relative file path** :doc:`support list <../overview/support_list>`: ::
|
||||
|
||||
Link to page ``http://server/overview/suport_list.html`` with **relative file path** :doc:`support list <../overview/support_list>`
|
||||
|
||||
..
|
||||
|
||||
``Usage:`` When you want to link to another whole page but don't want to make a ``Customized Link Target`` in that source page, you can use the file path to link it directly.
|
||||
|
||||
* **Add an External Link**
|
||||
|
||||
Link to an external web page: `google <http://www.goole.com>`_: ::
|
||||
|
||||
Link to an external web page: `google <http://www.goole.com>`_
|
||||
|
||||
..
|
||||
|
||||
``Usage:`` When you want to link to a page which does not belong to xCAT documentation.
|
||||
|
||||
``Note:`` The ``https://`` keyword must be added before the web page URL.
|
||||
|
||||
* **Add a Link with Explicit URL Displayed**
|
||||
|
||||
Link to http://www.google.com: ::
|
||||
|
||||
Link to http://www.google.com
|
||||
|
||||
..
|
||||
|
||||
``Usage:`` Make a link and display the URL.
|
||||
|
||||
|
||||
Add OS or ARCH Specific Contents
|
||||
--------------------------------
|
||||
|
||||
When writing a common xCAT doc, we always encounter the case that certain small part of content needs to be OS or ARCH specific. In this case, please use the following format to add specific branches.
|
||||
|
||||
The keyword in the **[]** can be an OS name or ARCH name, or any name which can distinguish the content from other part.
|
||||
|
||||
The valid keyword includes: **RHEL**, **SLES**, **UBUNTU**, **CENTOS**, **X86_64**, **PPC64**, **PPC64LE**. If the keyword is an OS, it can be postfixed with an OS version e.g. RHEL7.
|
||||
|
||||
* **[RHEL7]**
|
||||
|
||||
This part of description is for [rh7] specific.
|
||||
|
||||
* **[SLES]**
|
||||
|
||||
This part of description is for [sles] specific.
|
||||
|
||||
* **[PPC64LE]**
|
||||
|
||||
This part of description is for [ppc64le] specific.
|
||||
|
||||
::
|
||||
|
||||
* **[RHEL7]**
|
||||
|
||||
This part of description is for [rh7] specific.
|
||||
|
||||
|
||||
Miscellaneous
|
||||
-------------
|
||||
|
||||
Add a Comment
|
||||
`````````````
|
||||
|
||||
.. Try the comment
|
||||
|
||||
The sentence started with ``..`` will be a comment that won't be displayed in the doc. ::
|
||||
|
||||
.. This is a comment
|
||||
|
||||
Add Literal Block
|
||||
`````````````````
|
||||
|
||||
If you want to add a paragraph of code or something that don't want to be interpreted by browser: ::
|
||||
|
||||
If you want to add a paragraph of code or something that don't want to be interpreted by browser: ::
|
||||
#lsdef node1
|
||||
#tabdump
|
||||
|
||||
Decorate Word
|
||||
`````````````
|
||||
|
||||
If you want to display one or several words to be ``Literal Word``: ::
|
||||
|
||||
If you want to display one or several words to be ``Literal Word``
|
||||
|
||||
If you want to make a **strong emphasis** of the word: ::
|
||||
|
||||
If you want to make a **strong emphasis** of the word:
|
||||
|
||||
Add a Table
|
||||
```````````
|
||||
|
||||
Add a table in the doc:
|
||||
|
||||
+------------+------------+-----------+
|
||||
| Header 1 | Header 2 | Header 3 |
|
||||
+============+============+===========+
|
||||
| body row 1 | column 2 | column 3 |
|
||||
+------------+------------+-----------+
|
||||
| body row 2 | Cells may span columns.|
|
||||
+------------+------------+-----------+
|
||||
| body row 3 | Cells may | - Cells |
|
||||
+------------+ span rows. | - contain |
|
||||
| body row 4 | | - blocks. |
|
||||
+------------+------------+-----------+
|
||||
|
||||
::
|
||||
|
||||
+------------+------------+-----------+
|
||||
| Header 1 | Header 2 | Header 3 |
|
||||
+============+============+===========+
|
||||
| body row 1 | column 2 | column 3 |
|
||||
+------------+------------+-----------+
|
||||
| body row 2 | Cells may span columns.|
|
||||
+------------+------------+-----------+
|
||||
| body row 3 | Cells may | - Cells |
|
||||
+------------+ span rows. | - contain |
|
||||
| body row 4 | | - blocks. |
|
||||
+------------+------------+-----------+
|
||||
|
||||
Add Footnotes
|
||||
`````````````
|
||||
|
||||
This is the first example of footnotes [1]_.
|
||||
|
||||
This is the second example of footnotes [2]_.
|
||||
|
||||
::
|
||||
|
||||
This is the first example of footnotes [1]_.
|
||||
This is the second example of footnotes [2]_.
|
||||
|
||||
.. [1] First footnote
|
||||
.. [2] Second footnote
|
||||
|
||||
------------------------
|
||||
|
||||
.. [1] First footnote
|
||||
.. [2] Second footnote
|
||||
|
||||
|
||||
|
||||
@ -65,7 +65,7 @@ Enumerated List
|
||||
Hyperlinks -> Internal Links -> External Links
|
||||
----------------------------------------------
|
||||
|
||||
Add links to refer other web page is a very common way in writting document, it's very helpful to reduce the doc duplication and make doc to be easy to understand. Following are several ways to add a link in the xCAT documentation.
|
||||
Add links to refer other web page is a very common way in writting document, it's very helpful to reduce the doc duplication and make docs easy to understand. Following are several ways to add a link in the xCAT documentation.
|
||||
|
||||
* **Add an Internal Link to ``Customized Link Target``**
|
||||
|
||||
@ -85,7 +85,7 @@ Add links to refer other web page is a very common way in writting document, it
|
||||
|
||||
Link to the customized link target ``my_link_target`` :ref:`my link <my_link_target>`: ::
|
||||
|
||||
Link to the customized link target ``my_link_target`` :ref:`my link <my_link_target>`
|
||||
:ref:`my link <my_link_target>`
|
||||
|
||||
..
|
||||
|
||||
@ -95,7 +95,7 @@ Add links to refer other web page is a very common way in writting document, it
|
||||
|
||||
Link to an internal section in current page: `Guidelines for xCAT Documentation`_: ::
|
||||
|
||||
Link to an internal section in current page: `Guidelines for xCAT Documentation`_
|
||||
`Guidelines for xCAT Documentation`_
|
||||
|
||||
..
|
||||
|
||||
@ -103,15 +103,15 @@ Add links to refer other web page is a very common way in writting document, it
|
||||
|
||||
* **Add an Internal Link to Other Page via File Path**
|
||||
|
||||
Link to page ``http://server/overview/suport_list.html`` with **absolute file path** :doc:`support list </overview/support_list>`: ::
|
||||
Link to page `http://server/overview/suport_list.html` with **absolute file path** ::
|
||||
|
||||
Link to page ``http://server/overview/suport_list.html`` with **absolute file path** :doc:`support list </overview/support_list>`
|
||||
:doc:`support list </overview/support_list>`
|
||||
|
||||
..
|
||||
|
||||
Link to page ``http://server/overview/suport_list.html`` with **relative file path** :doc:`support list <../overview/support_list>`: ::
|
||||
Link to page `http://server/overview/suport_list.html` with **relative file path** ::
|
||||
|
||||
Link to page ``http://server/overview/suport_list.html`` with **relative file path** :doc:`support list <../overview/support_list>`
|
||||
:doc:`support list <../overview/support_list>`
|
||||
|
||||
..
|
||||
|
||||
@ -121,7 +121,7 @@ Add links to refer other web page is a very common way in writting document, it
|
||||
|
||||
Link to an external web page: `google <http://www.goole.com>`_: ::
|
||||
|
||||
Link to an external web page: `google <http://www.goole.com>`_
|
||||
`google <http://www.goole.com>`_
|
||||
|
||||
..
|
||||
|
||||
@ -133,7 +133,7 @@ Add links to refer other web page is a very common way in writting document, it
|
||||
|
||||
Link to http://www.google.com: ::
|
||||
|
||||
Link to http://www.google.com
|
||||
http://www.google.com
|
||||
|
||||
..
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ Database Attributes
|
||||
-------------------
|
||||
|
||||
* excludenodes:
|
||||
A set of comma separated nodes and/or groups that would automatically be subtracted from any noderange, it can be used for excluding some failed nodes from any xCAT command. See :doc:`noderange </guides/admin-guides/references/man3/noderange>` for details on supported formats.
|
||||
A set of comma separated nodes and/or groups that would automatically be subtracted from any noderange, it can be used for excluding some failed nodes from any xCAT command. See :doc:`noderange </guides/admin-guides/references/man3/noderange.3>` for details on supported formats.
|
||||
|
||||
* nodestatus:
|
||||
If set to ``n``, the ``nodelist.status`` column will not be updated during the node deployment, node discovery and power operations. The default is to update.
|
||||
|
||||
@ -87,7 +87,7 @@ You can create/modify an osimage definition easily based on the default osimage
|
||||
|
||||
For example, if you need to change the osimage name to your favorite name, this command may be helpful: ::
|
||||
|
||||
lsdef -t osimage -z rhels6.2-x86_64-install-compute | sed 's/^[^ ]\+:/mycomputeimage:/' | mkdef -z
|
||||
chdef -t osimage rhels6.2-x86_64-install-compute -n rhels6.2_myimage
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _deploy_os:
|
||||
|
||||
Initialize the Compute for Deployment
|
||||
=====================================
|
||||
|
||||
@ -34,5 +32,3 @@ For **x86_64 servers**, those two operations need two independent commands.
|
||||
|
||||
rpower <node> reset
|
||||
|
||||
|
||||
|
||||
|
||||
@ -79,4 +79,4 @@ The default driver list: ::
|
||||
|
||||
Note: With this approach, xCAT will search for the drivers in the rootimage. You need to make sure the drivers have been included in the rootimage before generating the initrd. You can install the drivers manually in an existing rootimage (using chroot) and run genimage again, or you can use a postinstall script to install drivers to the rootimage during your initial genimage run.
|
||||
|
||||
Use the driver rpm package to add new drivers from rpm packages to the diskless initrd.Refer to the :doc:`cfg_second_adapter.rst` for details.
|
||||
Use the driver rpm package to add new drivers from rpm packages to the diskless initrd. Refer to the :doc:`/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/cfg_second_adapter` for details.
|
||||
|
||||
@ -218,6 +218,8 @@ Example of mypostscript ::
|
||||
|
||||
The mypostscript file is generated according to the mypostscript.tmpl file.
|
||||
|
||||
.. _Using-the-mypostscript-template-label:
|
||||
|
||||
Using the mypostscript template
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
@ -91,7 +91,7 @@ If the above syncfile is performed by the **updatenode/xdcp** commands, or perfo
|
||||
|
||||
|
||||
Support nodes in synclist file
|
||||
~~~~~~~~~~~~~~~~~
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Note: From xCAT 2.9.2 on AIX and from xCAT 2.12 on Linux, xCAT support a new format for syncfile. The new format is ::
|
||||
|
||||
|
||||
@ -94,7 +94,7 @@ If you need to, you can also pass arguments to your scripts: ::
|
||||
|
||||
mypostscript template for ``updatenode``
|
||||
|
||||
You can customize what attributes you want made available to the post*script, using the shipped mypostscript.tmpl file :ref:`Using-the-mypostscript-template`.
|
||||
You can customize what attributes you want made available to the postscript, using the shipped mypostscript.tmpl file :ref:`Using-the-mypostscript-template-label`.
|
||||
|
||||
Synchronize new/updated configuration files
|
||||
-------------------------------------------
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
|
||||
Configure xCAT
|
||||
--------------
|
||||
|
||||
@ -15,8 +16,6 @@ Run the following command to add networks in ``networks`` table if there are no
|
||||
|
||||
makenetworks
|
||||
|
||||
.. _Setup-dhcp:
|
||||
|
||||
Setup DHCP
|
||||
``````````
|
||||
|
||||
|
||||
@ -12,6 +12,8 @@ Switch info::
|
||||
Switch IP Address: 10.0.201.1
|
||||
Switch port for Compute Node: port0
|
||||
|
||||
.. _Setup-dhcp:
|
||||
|
||||
.. include:: config_environment.rst
|
||||
|
||||
Predefined Nodes
|
||||
@ -19,8 +21,8 @@ Predefined Nodes
|
||||
|
||||
In order to differentiate one node from another, the admin needs to predefine node in xCAT database based on the switches information. This consists of two parts:
|
||||
|
||||
#. :ref:`predefined_switches_label`
|
||||
#. :ref:`predefined_server_nodes_label`
|
||||
#. :ref:`Predefine Switches <predefined_switches_label>`
|
||||
#. :ref:`Predefine Server Node <predefined_server_nodes_label>`
|
||||
|
||||
|
||||
.. _predefined_switches_label:
|
||||
|
||||
@ -1,2 +1,3 @@
|
||||
|
||||
.. _deploy_os:
|
||||
.. include:: ../../common/deployment/deploy_os.rst
|
||||
|
||||
@ -6,7 +6,7 @@ Provision Hypervisor with PowerKVM
|
||||
----------------------------------
|
||||
|
||||
|
||||
Please follow the ``Diskful Installation Documentation`` :ref:`Diskful Installation <diskfull_installation>` to provision kvm hypervisor with PowerKVM, several customization steps should be taken into consideration.
|
||||
Please follow the :ref:`Diskful Installation <diskful_installation>` to provision kvm hypervisor with PowerKVM, several customization steps should be taken into consideration.
|
||||
|
||||
To demonstrate the brief steps on hypervisor provision, take **ibm-powerkvm-3.1.0.0-39.0-ppc64le-gold-201511041419.iso** for example here:
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ SYNOPSIS
|
||||
|
||||
To build a new Kit
|
||||
|
||||
\ **buildkit**\ [\ **-V | -**\ **-verbose]**\ \ *subcommand*\ [\ *kit_name*\ ] [\ *repo_name*\ |\ **all**\ ] [\ **-l | -**\ **-kitloc**\ \ *kit_location*\ ]
|
||||
\ **buildkit**\ [\ **-V | -**\ **-verbose]**\ \ *subcommand*\ [\ *kit_name*\ ] [\ *repo_name*\ | \ **all**\ ] [\ **-l | -**\ **-kitloc**\ \ *kit_location*\ ]
|
||||
|
||||
To add packages to an existing Kit.
|
||||
|
||||
@ -314,7 +314,7 @@ EXAMPLES
|
||||
|
||||
\ **buildkit listrepo**\
|
||||
|
||||
\ **buildkit buildrepo all **\
|
||||
\ **buildkit buildrepo all**\
|
||||
|
||||
\ **buildkit buildtar**\
|
||||
|
||||
|
||||
@ -31,7 +31,7 @@ DESCRIPTION
|
||||
|
||||
Generate the initrd for the osimage: \ **imagename**\ which is an xCAT object of \ *osimage*\ type.
|
||||
|
||||
\ **Diskfull Osimage**\
|
||||
\ **Diskful Osimage**\
|
||||
|
||||
|
||||
If the \ **imagename**\ is a stateful one (The provmethod attribute for the osimage is 'install'),
|
||||
|
||||
@ -29,7 +29,7 @@ DESCRIPTION
|
||||
***********
|
||||
|
||||
|
||||
Traditionally, network interfaces in Linux are enumerated as eth[0123…], but these names do not necessarily correspond to actual labels on the chassis. \ **getadapter**\ help customer to get predictable network device name and some other network adapter information before provision or network configuration.
|
||||
Traditionally, network interfaces in Linux are enumerated as eth[0123...], but these names do not necessarily correspond to actual labels on the chassis. \ **getadapter**\ help customer to get predictable network device name and some other network adapter information before provision or network configuration.
|
||||
|
||||
\ **getadapter**\ use genesis to collect network adapters information, so that mean it need to restart the target node.
|
||||
|
||||
|
||||
@ -41,7 +41,7 @@ blade specific:
|
||||
===============
|
||||
|
||||
|
||||
\ **getmacs**\ \ *noderange*\ [\ **-V**\ | \ **-**\ **-verbose**\ ] [\ **-d**\ ] [\ **-**\ **-arp**\ ] [\ **-i**\ \ *ethN*\ |\ *enN*\ ]
|
||||
\ **getmacs**\ \ *noderange*\ [\ **-V**\ | \ **-**\ **-verbose**\ ] [\ **-d**\ ] [\ **-**\ **-arp**\ ] [\ **-i**\ \ *ethN*\ | \ *enN*\ ]
|
||||
|
||||
|
||||
|
||||
|
||||
@ -66,13 +66,16 @@ OPTIONS
|
||||
\ **-t**\ Specify the \ **type**\ of the target object.
|
||||
|
||||
Supported types:
|
||||
\ **dc**\ - Data Center (For type of 'dc', all the elements belongs to the data
|
||||
center will be listed.)
|
||||
\ **cl**\ - Cluster
|
||||
\ **sd**\ - Storage Domain (To get the status of Storage Doamin, show it from
|
||||
\ *data center*\ it attached to.
|
||||
\ **nw**\ - Network
|
||||
\ **tpl**\ - Template
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
B<dc> - Data Center (For type of 'dc', all the elements belongs to the data center will be listed.)
|
||||
B<cl> - Cluster
|
||||
B<sd> - Storage Domain (To get the status of Storage Doamin, show it from I<data center> it attached to.
|
||||
B<nw> - Network
|
||||
B<tpl> - Template
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -29,7 +29,7 @@ DESCRIPTION
|
||||
***********
|
||||
|
||||
|
||||
The \ **rmkitcomp**\ command removes kit components from an xCAT osimage. All the kit component attribute values that are contained in the osimage will be removed, and the kit comoponent meta rpm and package rpm could be uninstalled by <-u|-**\ **-uninstall> option.
|
||||
The \ **rmkitcomp**\ command removes kit components from an xCAT osimage. All the kit component attribute values that are contained in the osimage will be removed, and the kit comoponent meta rpm and package rpm could be uninstalled by \ **-u|-**\ **-uninstall**\ option.
|
||||
|
||||
Note: The xCAT support for Kits is only available for Linux operating systems.
|
||||
|
||||
|
||||
@ -49,7 +49,7 @@ OPTIONS
|
||||
|
||||
\ **-h | -help**\ Display usage message.
|
||||
|
||||
\ **-v | -version **\ Command Version.
|
||||
\ **-v | -version**\ Command Version.
|
||||
|
||||
\ **-V | -verbose**\ Verbose output.
|
||||
|
||||
|
||||
@ -159,14 +159,18 @@ file. ospkgs postscript will normally remove all the existing rpm
|
||||
repositories before adding server:/install/<os>/<arch/ as the new repository.
|
||||
To preserve the existing repositories, you can run the following command instead:
|
||||
|
||||
updatenode noderange -P "ospkgs --keeprepo,otherpkgs"
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
updatenode noderange -P "ospkgs --keeprepo,otherpkgs"
|
||||
|
||||
|
||||
\ **For AIX systems:**\
|
||||
|
||||
Note: The updatenode command is used to update AIX diskful nodes only. For updating diskless AIX nodes refer to the xCAT for AIX update documentation and use the xCAT mknimimage command.
|
||||
For information on updating software on AIX cluster:
|
||||
For diskful installs, read:
|
||||
XCAT_AIX_RTE_Diskfull_Nodes
|
||||
XCAT_AIX_RTE_Diskful_Nodes
|
||||
For diskless installs, read:
|
||||
XCAT_AIX_Diskless_Nodes
|
||||
|
||||
|
||||
@ -249,9 +249,9 @@ standard output or standard error is displayed.
|
||||
EXECUTEALWAYS:
|
||||
/tmp/myscript
|
||||
APPEND:
|
||||
/custom/mypasswd -> /etc/passwd
|
||||
/custom/mygroups -> /etc/group
|
||||
/custom/myshadow -> /etc/shadow
|
||||
/custom/mypasswd -> /etc/passwd
|
||||
/custom/mygroups -> /etc/group
|
||||
/custom/myshadow -> /etc/shadow
|
||||
|
||||
Note: no order can be assumed by the order that the EXECUTE,EXECUTEALWAYS and APPEND clause fall in the synclist file.
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ SYNOPSIS
|
||||
********
|
||||
|
||||
|
||||
\ **tabprune**\ [\ **eventlog | auditlog**\ ] [\ **-V**\ ] [\ **-i**\ \ *recid*\ |\ **-n**\ \ *number of records*\ | \ **-p**\ \ *percentage*\ | \ **-d**\ \ *number of days*\ | \ **-a**\ ]
|
||||
\ **tabprune**\ [\ **eventlog | auditlog**\ ] [\ **-V**\ ] [\ **-i**\ \ *recid*\ | \ **-n**\ \ *number of records*\ | \ **-p**\ \ *percentage*\ | \ **-d**\ \ *number of days*\ | \ **-a**\ ]
|
||||
|
||||
\ **tabprune**\ \ *tablename*\ \ **-a**\
|
||||
|
||||
|
||||
@ -57,19 +57,19 @@ It will then run wcons on the nodes.
|
||||
|
||||
\ **-o | -**\ **-osver**\
|
||||
|
||||
Specifies which os version to provision. If unspecified, the current node os setting is used. Will be ignored if [\ *-O*\ |\ *--osimage*\ ] is specified or nodetype.provmethod=\ *osimage*\ .
|
||||
Specifies which os version to provision. If unspecified, the current node os setting is used. Will be ignored if [\ *-O*\ | \ *--osimage*\ ] is specified or nodetype.provmethod=\ *osimage*\ .
|
||||
|
||||
|
||||
|
||||
\ **-p | -**\ **-profile**\
|
||||
|
||||
Specifies what profile should be used of the operating system. If not specified the current node profile setting is used. Will be ignored if [\ *-O*\ |\ *--osimage*\ ] is specified or nodetype.provmethod=\ *osimage*\ .
|
||||
Specifies what profile should be used of the operating system. If not specified the current node profile setting is used. Will be ignored if [\ **-O | -**\ **-osimage**\ ] is specified or nodetype.provmethod=\ *osimage*\ .
|
||||
|
||||
|
||||
|
||||
\ **-a | -**\ **-arch**\
|
||||
|
||||
Specifies what architecture of the OS to provision. Typically this is unneeded, but if provisioning between x86_64 and x86 frequently, this may be a useful flag. Will be ignored if [\ *-O*\ |\ *--osimage*\ ] is specified or nodetype.provmethod=\ *osimage*\ .
|
||||
Specifies what architecture of the OS to provision. Typically this is unneeded, but if provisioning between x86_64 and x86 frequently, this may be a useful flag. Will be ignored if [\ **-O | -**\ **-osimage**\ ] is specified or nodetype.provmethod=\ *osimage*\ .
|
||||
|
||||
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ The trace message includes: The name of the called subroutine; The arguments whi
|
||||
|
||||
The flag \ **-c**\ is used to specify the subroutine list for \ **subroutine calling trace**\ , it can only work with \ **-f**\ . The value of \ **-c**\ can be a configuration file or a subroutine list.
|
||||
\ **configuration file**\ : a file contains multiple lines of \ **SUBROUTINE_DEFINITION**\
|
||||
\ **subroutine list**\ : \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION**\ |...
|
||||
\ **subroutine list**\ : \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\
|
||||
|
||||
\ **SUBROUTINE_DEFINITION**\ : is the element for the \ **-c**\ to specify the subroutine list.
|
||||
|
||||
@ -109,7 +109,7 @@ OPTIONS
|
||||
xCAT_plugin::DBobjectdefs(defls,process_request)
|
||||
xCAT::DBobjUtils(getobjdefs)
|
||||
|
||||
\ **subroutine list**\ : a string like \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION**\ |...
|
||||
\ **subroutine list**\ : a string like \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\
|
||||
e.g.
|
||||
"(plugin_command)|xCAT_plugin::DBobjectdefs(defls,process_request)|xCAT::DBobjUtils(getobjdefs)"
|
||||
|
||||
@ -131,32 +131,62 @@ EXAMPLES
|
||||
|
||||
|
||||
1. Enable the \ **subroutine calling trace**\ for all the subroutines in the xcatd and plugin modules.
|
||||
xcatdebug -f enable
|
||||
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
xcatdebug -f enable
|
||||
|
||||
|
||||
|
||||
|
||||
2. Enable the \ **subroutine calling trace**\ for the subroutines configured in the /opt/xcat/share/xcat/samples/tracelevel0
|
||||
xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0
|
||||
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0
|
||||
|
||||
|
||||
|
||||
|
||||
3. Enable the \ **subroutine calling trace**\ for the plugin_command in xcatd and defls,process_request in the xCAT_plugin::DBobjectdefs module.
|
||||
xcatdebug -f enable -c "xCAT_plugin::DBobjectdefs(defls,process_request)|(plugin_command)"
|
||||
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
xcatdebug -f enable -c "xCAT_plugin::DBobjectdefs(defls,process_request)|(plugin_command)"
|
||||
|
||||
|
||||
|
||||
|
||||
4. Disable the \ **subroutine calling trace**\ for all the subroutines which have been enabled by \ **xcatdebug -f enable**\ .
|
||||
xcatdebug -f disable
|
||||
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
xcatdebug -f disable
|
||||
|
||||
|
||||
|
||||
|
||||
5. Enable the \ **commented trace log**\
|
||||
xcatdebug -d enable
|
||||
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
xcatdebug -d enable
|
||||
|
||||
|
||||
|
||||
|
||||
6. Enable both the \ **subroutine calling trace**\ and \ **commented trace log**\
|
||||
xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0 -d enable
|
||||
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0 -d enable
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,238 +0,0 @@
|
||||
Remove xCAT
|
||||
===========
|
||||
|
||||
Backup xCAT User Data
|
||||
---------------------
|
||||
|
||||
Before removing xCAT, recommend to backup xCAT database. It's convenient to restore xCAT management environment in the future if needed. ::
|
||||
|
||||
dumpxCATdb -p <path_to_save_the_database>
|
||||
|
||||
For more information of ``dumpxCATdb``, please refer to :doc:`command dumpxCATdb </guides/admin-guides/references/man/dumpxCATdb.1>`. For how to restore xcat DB, please refer to `Restore xCAT User Data`_.
|
||||
|
||||
Clean Up xCAT Related Configuration
|
||||
-----------------------------------
|
||||
|
||||
1. To clean up the node information from dhcp ::
|
||||
|
||||
makedhcp -d -a
|
||||
|
||||
2. To clean up the node information in tftpboot ::
|
||||
|
||||
nodeset all offline
|
||||
|
||||
3. To clean up the node information from ``/etc/hosts`` (optional)
|
||||
|
||||
Keep xCAT nodes information in ``/etc/hosts`` is harmless. But if really need to remove them from ``/etc/hosts``, you can edit ``/etc/hosts`` by 'vi' directly, or using xCAT command ``makehosts``. ::
|
||||
|
||||
makehosts -d all
|
||||
|
||||
4. To clean up the node information from DNS (optional)
|
||||
|
||||
After removing all the nodes from ``/etc/hosts``, run below command to clean up the node information from DNS. ::
|
||||
|
||||
makedns -n
|
||||
|
||||
Stop xCAT Service
|
||||
-----------------
|
||||
|
||||
1. Stop xCAT service ::
|
||||
|
||||
service xcatd stop
|
||||
|
||||
2. Stop xCAT related services(Optional)
|
||||
|
||||
XCAT uses various network services on the management node and service nodes, the network services setup by xCAT may need to be cleaned up on the management node and service nodes before uninstalling xCAT.
|
||||
|
||||
* **NFS** : Stop nfs service, unexport all the file systems exported by xCAT, and remove the xCAT file systems from ``/etc/exports``.
|
||||
* **HTTP**: Stop http service, remove the xcat.conf in the http configuration directory.
|
||||
* **TFTP**: Stop tftp service, remove the tftp files created by xCAT in tftp directory.
|
||||
* **DHCP**: Stop dhcp service, remove the configuration made by xCAT in dhcp configuration files.
|
||||
* **DNS** : Stop the named service, remove the named entries created by xCAT from the named database.
|
||||
|
||||
Remove xCAT Files
|
||||
-----------------
|
||||
|
||||
1. Remove the xCAT RPMs
|
||||
|
||||
There is no easy way to distinct all the packages depending by xCAT. For packages shipped by xCAT, you can remove them by the commands below.
|
||||
|
||||
[RHEL and SLES] ::
|
||||
|
||||
rpm -qa |grep -i xcat
|
||||
|
||||
[Ubuntu] ::
|
||||
|
||||
dpkg -l | awk '/xcat/ { print $2 }'
|
||||
|
||||
If you want to remove more cleanly. below list maybe helpful for you. They are the packages list of xcat installation tarball. These list are the whole RPMs list, it's possible for some RPMs not to be installed due to them are not suitable for your environment. Please do judgment by yourself.
|
||||
|
||||
* XCAT Core Packages list (xcat-core):
|
||||
|
||||
[RHEL and SLES] ::
|
||||
|
||||
perl-xCAT
|
||||
xCAT
|
||||
xCAT-buildkit
|
||||
xCAT-client
|
||||
xCAT-confluent
|
||||
xCAT-genesis-scripts-ppc64
|
||||
xCAT-genesis-scripts-x86_64
|
||||
xCAT-server
|
||||
xCATsn
|
||||
xCAT-SoftLayer
|
||||
xCAT-test
|
||||
xCAT-vlan
|
||||
|
||||
[Ubuntu] ::
|
||||
|
||||
perl-xcat
|
||||
xcat
|
||||
xcat-buildkit
|
||||
xcat-client
|
||||
xcat-confluent
|
||||
xcat-genesis-scripts
|
||||
xcat-server
|
||||
xcatsn
|
||||
xcat-test
|
||||
xcat-vlan
|
||||
|
||||
* XCAT Dependency Packages (xcat-dep):
|
||||
|
||||
[RHEL and SLES] ::
|
||||
|
||||
conserver-xcat
|
||||
cpio
|
||||
cpio-lang
|
||||
elilo-xcat
|
||||
esxboot-xcat
|
||||
fping
|
||||
ganglia-devel
|
||||
ganglia-gmetad
|
||||
ganglia-gmond
|
||||
ganglia-gmond-modules-python
|
||||
ganglia-web
|
||||
grub2-xcat
|
||||
ipmitool-xcat
|
||||
libconfuse
|
||||
libconfuse-devel
|
||||
libganglia
|
||||
lldpd
|
||||
net-snmp-perl
|
||||
perl-AppConfig
|
||||
perl-Compress-Raw-Zlib
|
||||
perl-Crypt-Blowfish
|
||||
perl-Crypt-CBC
|
||||
perl-Crypt-Rijndael
|
||||
perl-Crypt-SSLeay
|
||||
perl-DBD-DB2
|
||||
perl-DBD-DB2Lite
|
||||
perl-DBD-Pg
|
||||
perl-DBD-SQLite
|
||||
perl-Expect
|
||||
perl-HTML-Form
|
||||
perl-IO-Compress-Base
|
||||
perl-IO-Compress-Zlib
|
||||
perl-IO-Socket-SSL
|
||||
perl-IO-Stty
|
||||
perl-IO-Tty
|
||||
perl-JSON
|
||||
perl-Net-DNS
|
||||
perl-Net-Telnet
|
||||
perl-SOAP-Lite
|
||||
perl-Test-Manifest
|
||||
perl-version
|
||||
perl-XML-Simple
|
||||
pyodbc
|
||||
rrdtool
|
||||
scsi-target-utils
|
||||
stunnel
|
||||
syslinux-xcat
|
||||
systemconfigurator
|
||||
systemimager-client
|
||||
systemimager-common
|
||||
systemimager-server
|
||||
xCAT-genesis-base-ppc64
|
||||
xCAT-genesis-base-x86_64
|
||||
xCAT-genesis-x86_64
|
||||
xCAT-UI-deps
|
||||
xnba-kvm
|
||||
xnba-undi
|
||||
yaboot-xcat
|
||||
zhcp
|
||||
|
||||
[Ubuntu] ::
|
||||
|
||||
conserver-xcat
|
||||
elilo-xcat
|
||||
grub2-xcat
|
||||
ipmitool-xcat
|
||||
syslinux
|
||||
syslinux-extlinux
|
||||
syslinux-xcat
|
||||
xcat-genesis-base-amd64
|
||||
xcat-genesis-base-ppc64
|
||||
xnba-undi
|
||||
|
||||
Along with xCAT development, above list maybe change, you can get the latest list through below links:
|
||||
|
||||
|
||||
* XCAT Core Packages List (xcat-core)
|
||||
|
||||
[RHEL and SLES] ::
|
||||
|
||||
http://xcat.org/files/xcat/repos/yum/<version>/xcat-core/
|
||||
|
||||
[Ubuntu] ::
|
||||
|
||||
http://xcat.org/files/xcat/repos/apt/<version>/xcat-core/
|
||||
|
||||
* XCAT Dependency Packages (xcat-dep)
|
||||
|
||||
`RPM Packages List (RHEL and SLES) <http://xcat.org/files/xcat/repos/yum/xcat-dep/>`_
|
||||
|
||||
`Debian Packages List (Ubuntu) <http://xcat.org/files/xcat/repos/apt/xcat-dep/>`_
|
||||
|
||||
|
||||
Generally, we use ``yum install xCAT`` to install xCAT, so these are some RPMs shipped by operating system are installed during xCAT installation. We don't have an easy way to find out all of them, but keep these RPMs are harmless.
|
||||
|
||||
|
||||
2. Remove xCAT certificate file ::
|
||||
|
||||
rm -rf /root/.xcat
|
||||
|
||||
3. Remove xCAT data file
|
||||
|
||||
By default, xCAT use SQLite, remove SQLite data file under ``/etc/xcat/``. ::
|
||||
|
||||
rm -rf /etc/xcat
|
||||
|
||||
4. Remove xCAT related file(Optional)
|
||||
|
||||
XCAT has ever operated below directory when it was running. Do judgment by yourself before removing these directory, to avoid removing some directories used for other purpose in your environment. ::
|
||||
|
||||
/install
|
||||
/tftpboot
|
||||
/etc/yum.repos.d/xCAT-*
|
||||
/etc/sysconfig/xcat
|
||||
/etc/apache2/conf.d/xCAT-*
|
||||
/etc/logrotate.d/xCAT-*
|
||||
/etc/rsyslogd.d/xCAT-*
|
||||
/var/log/xcat
|
||||
/opt/xcat/
|
||||
/mnt/xcat
|
||||
|
||||
Remove Databases
|
||||
----------------
|
||||
|
||||
* For PostgreSQL: See :doc:`Removing xCAT DB from PostgreSQL </guides/admin-guides/large_clusters/databases/postgres_remove>`.
|
||||
* For MySQL/MariaDB: See :doc:`Removing xCAT DB from MySQL/MariaDB </guides/admin-guides/large_clusters/databases/mysql_remove>`.
|
||||
|
||||
Restore xCAT User Data
|
||||
----------------------
|
||||
|
||||
If need to restore xCAT environment, after :doc:`xCAT software installation </guides/install-guides/index>`, you can restore xCAT DB by data files dumped in the past. ::
|
||||
|
||||
restorexCATdb -p <path_to_backup_saved_for_restore>
|
||||
|
||||
For more information of ``restorexCATdb``, please refer to :doc:`command restorexCATdb </guides/admin-guides/references/man/restorexCATdb.1>`.
|
||||
@ -1,3 +1,5 @@
|
||||
.. _install_guides:
|
||||
|
||||
Install Guides
|
||||
==============
|
||||
|
||||
|
||||
@ -5,4 +5,3 @@ Security Notices
|
||||
:maxdepth: 2
|
||||
|
||||
2016/index.rst
|
||||
2015/index.rst
|
||||
|
||||
@ -8,7 +8,7 @@ B<buildkit> [B<-?>|B<-h>|B<--help>] [B<-v>|B<--version>]
|
||||
|
||||
To build a new Kit
|
||||
|
||||
B<buildkit> [B<-V>|B<--verbose]> I<subcommand> [I<kit_name>] [I<repo_name>|B<all>] [B<-l>|B<--kitloc> I<kit_location>]
|
||||
B<buildkit> [B<-V>|B<--verbose]> I<subcommand> [I<kit_name>] [I<repo_name> | B<all>] [B<-l>|B<--kitloc> I<kit_location>]
|
||||
|
||||
To add packages to an existing Kit.
|
||||
|
||||
@ -240,7 +240,7 @@ B<buildkit chkconfig>
|
||||
|
||||
B<buildkit listrepo>
|
||||
|
||||
B<buildkit buildrepo all >
|
||||
B<buildkit buildrepo all>
|
||||
|
||||
B<buildkit buildtar>
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ B<geninitrd> [B<-h> | B<--help>]
|
||||
|
||||
Generate the initrd for the osimage: B<imagename> which is an xCAT object of I<osimage> type.
|
||||
|
||||
B<Diskfull Osimage>
|
||||
B<Diskful Osimage>
|
||||
|
||||
=over 2
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ B<getadapter> [B<-h>|B<--help>|B<-v>|B<--version>|B<-V>]
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
Traditionally, network interfaces in Linux are enumerated as eth[0123…], but these names do not necessarily correspond to actual labels on the chassis. B<getadapter> help customer to get predictable network device name and some other network adapter information before provision or network configuration.
|
||||
Traditionally, network interfaces in Linux are enumerated as eth[0123...], but these names do not necessarily correspond to actual labels on the chassis. B<getadapter> help customer to get predictable network device name and some other network adapter information before provision or network configuration.
|
||||
|
||||
B<getadapter> use genesis to collect network adapters information, so that mean it need to restart the target node.
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ B<getmacs> I<noderange> [B<-V>| B<--verbose>] [B<-f>] [B<-d>] [B<--arp>] | [B<-D
|
||||
|
||||
=head2 blade specific:
|
||||
|
||||
B<getmacs> I<noderange> [B<-V>| B<--verbose>] [B<-d>] [B<--arp>] [B<-i> I<ethN>|I<enN>]
|
||||
B<getmacs> I<noderange> [B<-V>| B<--verbose>] [B<-d>] [B<--arp>] [B<-i> I<ethN> | I<enN>]
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
|
||||
@ -42,11 +42,10 @@ The target object to display.
|
||||
Specify the B<type> of the target object.
|
||||
|
||||
Supported types:
|
||||
B<dc> - Data Center (For type of 'dc', all the elements belongs to the data
|
||||
center will be listed.)
|
||||
|
||||
B<dc> - Data Center (For type of 'dc', all the elements belongs to the data center will be listed.)
|
||||
B<cl> - Cluster
|
||||
B<sd> - Storage Domain (To get the status of Storage Doamin, show it from
|
||||
I<data center> it attached to.
|
||||
B<sd> - Storage Domain (To get the status of Storage Doamin, show it from I<data center> it attached to.
|
||||
B<nw> - Network
|
||||
B<tpl> - Template
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ B<rmkitcomp> [B<-V>|B<--verbose>] [B<-u>|B<--uninstall>] [B<-f>|B<--force>] [B<-
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<rmkitcomp> command removes kit components from an xCAT osimage. All the kit component attribute values that are contained in the osimage will be removed, and the kit comoponent meta rpm and package rpm could be uninstalled by <-u|--uninstall> option.
|
||||
The B<rmkitcomp> command removes kit components from an xCAT osimage. All the kit component attribute values that are contained in the osimage will be removed, and the kit comoponent meta rpm and package rpm could be uninstalled by B<-u|--uninstall> option.
|
||||
|
||||
Note: The xCAT support for Kits is only available for Linux operating systems.
|
||||
|
||||
|
||||
@ -26,7 +26,7 @@ I<filename> is the path name of the Perl module or command to be registered.
|
||||
|
||||
B<-h | -help> Display usage message.
|
||||
|
||||
B<-v | -version > Command Version.
|
||||
B<-v | -version> Command Version.
|
||||
|
||||
B<-V | -verbose> Verbose output.
|
||||
|
||||
|
||||
@ -119,14 +119,14 @@ file. ospkgs postscript will normally remove all the existing rpm
|
||||
repositories before adding server:/install/<os>/<arch/ as the new repository.
|
||||
To preserve the existing repositories, you can run the following command instead:
|
||||
|
||||
updatenode noderange -P "ospkgs --keeprepo,otherpkgs"
|
||||
updatenode noderange -P "ospkgs --keeprepo,otherpkgs"
|
||||
|
||||
B<For AIX systems:>
|
||||
|
||||
Note: The updatenode command is used to update AIX diskful nodes only. For updating diskless AIX nodes refer to the xCAT for AIX update documentation and use the xCAT mknimimage command.
|
||||
For information on updating software on AIX cluster:
|
||||
For diskful installs, read:
|
||||
XCAT_AIX_RTE_Diskfull_Nodes
|
||||
XCAT_AIX_RTE_Diskful_Nodes
|
||||
For diskless installs, read:
|
||||
XCAT_AIX_Diskless_Nodes
|
||||
|
||||
|
||||
@ -200,9 +200,9 @@ For example, your rsynclist file may look like this:
|
||||
EXECUTEALWAYS:
|
||||
/tmp/myscript
|
||||
APPEND:
|
||||
/custom/mypasswd -> /etc/passwd
|
||||
/custom/mygroups -> /etc/group
|
||||
/custom/myshadow -> /etc/shadow
|
||||
/custom/mypasswd -> /etc/passwd
|
||||
/custom/mygroups -> /etc/group
|
||||
/custom/myshadow -> /etc/shadow
|
||||
|
||||
Note: no order can be assumed by the order that the EXECUTE,EXECUTEALWAYS and APPEND clause fall in the synclist file.
|
||||
|
||||
|
||||
@ -4,9 +4,9 @@ B<tabprune> - Deletes records from the eventlog,auditlog,isnm_perf,isnm_perf_sum
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
B<tabprune> [B<eventlog | auditlog>] [B<-V>] [B<-i> I<recid> |B<-n> I<number of records> | B<-p> I<percentage> | B<-d> I<number of days> | B<-a>]
|
||||
B<tabprune> [B<eventlog | auditlog>] [B<-V>] [B<-i> I<recid> | B<-n> I<number of records> | B<-p> I<percentage> | B<-d> I<number of days> | B<-a>]
|
||||
|
||||
B<tabprune> I<tablename> B<-a>
|
||||
B<tabprune> I<tablename> B<-a>
|
||||
|
||||
B<tabprune> [B<-h>|B<--help>] [B<-v>|B<--version>]
|
||||
|
||||
|
||||
@ -31,16 +31,16 @@ Display version.
|
||||
|
||||
=item B<-o>|B<--osver>
|
||||
|
||||
Specifies which os version to provision. If unspecified, the current node os setting is used. Will be ignored if [I<-O>|I<--osimage>] is specified or nodetype.provmethod=I<osimage>.
|
||||
Specifies which os version to provision. If unspecified, the current node os setting is used. Will be ignored if [I<-O> | I<--osimage>] is specified or nodetype.provmethod=I<osimage>.
|
||||
|
||||
=item B<-p>|B<--profile>
|
||||
|
||||
Specifies what profile should be used of the operating system. If not specified the current node profile setting is used. Will be ignored if [I<-O>|I<--osimage>] is specified or nodetype.provmethod=I<osimage>.
|
||||
Specifies what profile should be used of the operating system. If not specified the current node profile setting is used. Will be ignored if [B<-O>|B<--osimage>] is specified or nodetype.provmethod=I<osimage>.
|
||||
|
||||
|
||||
=item B<-a>|B<--arch>
|
||||
|
||||
Specifies what architecture of the OS to provision. Typically this is unneeded, but if provisioning between x86_64 and x86 frequently, this may be a useful flag. Will be ignored if [I<-O>|I<--osimage>] is specified or nodetype.provmethod=I<osimage>.
|
||||
Specifies what architecture of the OS to provision. Typically this is unneeded, but if provisioning between x86_64 and x86 frequently, this may be a useful flag. Will be ignored if [B<-O>|B<--osimage>] is specified or nodetype.provmethod=I<osimage>.
|
||||
|
||||
=item B<-O>|B<--osimage>
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ The trace message includes: The name of the called subroutine; The arguments whi
|
||||
|
||||
The flag B<-c> is used to specify the subroutine list for B<subroutine calling trace>, it can only work with B<-f>. The value of B<-c> can be a configuration file or a subroutine list.
|
||||
B<configuration file>: a file contains multiple lines of B<SUBROUTINE_DEFINITION>
|
||||
B<subroutine list>: B<SUBROUTINE_DEFINITION>|B<SUBROUTINE_DEFINITION>|...
|
||||
B<subroutine list>: B<SUBROUTINE_DEFINITION>|B<SUBROUTINE_DEFINITION|...>
|
||||
|
||||
B<SUBROUTINE_DEFINITION>: is the element for the B<-c> to specify the subroutine list.
|
||||
|
||||
@ -90,7 +90,7 @@ B<configuration file>: a file contains multiple lines of B<SUBROUTINE_DEFINITION
|
||||
xCAT_plugin::DBobjectdefs(defls,process_request)
|
||||
xCAT::DBobjUtils(getobjdefs)
|
||||
|
||||
B<subroutine list>: a string like B<SUBROUTINE_DEFINITION>|B<SUBROUTINE_DEFINITION>|...
|
||||
B<subroutine list>: a string like B<SUBROUTINE_DEFINITION>|B<SUBROUTINE_DEFINITION|...>
|
||||
e.g.
|
||||
"(plugin_command)|xCAT_plugin::DBobjectdefs(defls,process_request)|xCAT::DBobjUtils(getobjdefs)"
|
||||
|
||||
@ -111,26 +111,32 @@ Note: The xcatd will be restarted for the performing of B<-d>
|
||||
|
||||
=item 1.
|
||||
Enable the B<subroutine calling trace> for all the subroutines in the xcatd and plugin modules.
|
||||
|
||||
xcatdebug -f enable
|
||||
|
||||
=item 2.
|
||||
Enable the B<subroutine calling trace> for the subroutines configured in the /opt/xcat/share/xcat/samples/tracelevel0
|
||||
|
||||
xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0
|
||||
|
||||
=item 3.
|
||||
Enable the B<subroutine calling trace> for the plugin_command in xcatd and defls,process_request in the xCAT_plugin::DBobjectdefs module.
|
||||
|
||||
xcatdebug -f enable -c "xCAT_plugin::DBobjectdefs(defls,process_request)|(plugin_command)"
|
||||
|
||||
=item 4.
|
||||
Disable the B<subroutine calling trace> for all the subroutines which have been enabled by B<xcatdebug -f enable>.
|
||||
|
||||
xcatdebug -f disable
|
||||
|
||||
=item 5.
|
||||
Enable the B<commented trace log>
|
||||
|
||||
xcatdebug -d enable
|
||||
|
||||
=item 6.
|
||||
Enable both the B<subroutine calling trace> and B<commented trace log>
|
||||
|
||||
xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0 -d enable
|
||||
|
||||
=back
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user