xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-07-22 20:31:09 +00:00
Code Issues Releases Wiki Activity

Merge pull request #1 from xcat2/master

Browse Source 
Update our xcat-core fork with latest from xcat2
This commit is contained in:
zVMopenstack
2016-07-25 14:51:50 -04:00
committed by GitHub
parent 340524b30f 20fb5d8d98
commit 72ae7657a1
884 changed files with 153374 additions and 144207 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Version
View File

@@ -1 +1 @@
2.12.1
2.12.2

88
build-debs-all
View File

@@ -1,88 +0,0 @@
#!/bin/bash
###########
#
# This script call make<package>deb and create the deb packages
# for xCAT
#
# Author: Leonardo Tonetto <tonetto@linux.vnet.ibm.com>
# Revisor: Adalberto Medeiros <adalbas@linux.vnet.ibm.com>
# Revisor2: Arif Ali <aali@ocf.co.uk>
#
# Input:
#
# $1 is the build type/location
# $2 is the string added to the debian/changelog of each package
#
############
##############
# Get input
##############
PKG_LOCATION=$1 # local | snap | alpha
if [ -z $PKG_LOCATION ]; then
PKG_LOCATION="local"
fi
BUILD_STRING=$2
if [ -z $BUILD_STRING ]; then
BUILD_STRING="Personal Build"
fi
XCAT_VERSION=`cat Version`
TRUNK_REVISION=`svnversion | cut -d ":" -f1`
CUR_DATE=`date +%Y%m%d`
VERSION="${XCAT_VERSION}-${PKG_LOCATION}${CUR_DATE}"
function makedeb {
SRC_ROOT=$1
PKG_LOCATION=$2
BUILD_STRING=$3
VERSION=$4
#
# Make DEBs
#
# build perl-xCAT - deps are libsoap-lite-perl, libdigest-sha1-perl, libdbi-perl
#
find $SRC_ROOT -maxdepth 2 -name debian -type d | while read DEBIAN_DIR
do
DIR=`echo ${DEBIAN_DIR} | sed -e 's/[/]debian$//'`
cd ${DIR}
dch -v $VERSION -b -c debian/changelog "$BUILD_STRING"
dpkg-buildpackage
cd -
RC=$?
if [ ${RC} -gt 0 ]
then
echo "Warning: ${DEBIAN_DIR} failed exit code ${RC}"
fi
done
#
# Clean up
#
# Eliminate unnecessary directories and debian/files made by dpkg-buildpackage
find $SRC_ROOT -maxdepth 3 -type d -name "xcat-*" | grep debian | xargs rm -rf
find $SRC_ROOT -maxdepth 3 -type f -name "files" | grep debian | xargs rm -f
}
# build all debian packages
packages="xCAT-client xCAT-nbroot xCAT-nbroot2 perl-xCAT xCAT-server xCAT-UI xCAT xCATsn xCAT-test xCAT-IBMhpc xCAT-rmc xCAT-vlan xCAT-confluent"
for file in `echo $packages`
do
makedeb $file $PKG_LOCATION "$BUILD_STRING" $VERSION
done
if [ -d debs ]; then
rm -rf debs
fi
mkdir debs
mv xcat* debs/
mv perl-xcat* debs/
echo $VERSION > latest_version
exit 0

26
build-ubunturepo
View File

@@ -35,8 +35,8 @@
printusage()
{
printf "Usage: %s {-c | -d} \n" $(basename $0) >&2
echo " -c : Build the xcat core packages and create the repo"
echo " -d : Create the xcat dep repo. Building the xcat dep packages can refer \"build-debs-all\" from svn"
echo " -c : Build the xcat-core packages and create the repo"
echo " -d : Create the xcat-dep repo."
}
# For the purpose of getting the distribution name
if [[ ! -f /etc/lsb-release ]]; then
@@ -223,7 +223,7 @@ then
if [ ! -d ../../$package_dir_name ];then
mkdir -p "../../$package_dir_name"
fi
packages="xCAT-client xCAT-genesis-scripts perl-xCAT xCAT-server xCAT xCATsn xCAT-test xCAT-buildkit xCAT-vlan xCAT-confluent"
packages="xCAT-client xCAT-genesis-scripts perl-xCAT xCAT-server xCAT xCATsn xCAT-test xCAT-buildkit xCAT-vlan xCAT-confluent xCAT-probe"
target_archs=(amd64 ppc64el)
for file in `echo $packages`
do
@@ -242,9 +242,29 @@ then
cd $file
dch -v $pkg_version -b -c debian/changelog $build_string
if [ "$target_arch" = "all" ]; then
#xcat probe use some functions shipped by xCAT, for below reasons we need to copy files to xCAT-probe directory
#1 make xcat probe code to be self-contained
#2 don't maintain two files for each script
#3 symbolic link can't work during package
if [ $file_low = "xcat-probe" ]; then
CURDIR=$(pwd)
mkdir -p ${CURDIR}/xCAT-probe/lib/perl/xCAT/
cp -f ${CURDIR}/perl-xCAT/xCAT/NetworkUtils.pm ${CURDIR}/xCAT-probe/lib/perl/xCAT/
cp -f ${CURDIR}/perl-xCAT/xCAT/GlobalDef.pm ${CURDIR}/xCAT-probe/lib/perl/xCAT/
fi
dpkg-buildpackage -uc -us
else
if [ "$file" = "xCAT-genesis-scripts" ]; then
CURDIR=$(pwd)
echo "Rename control file to build pkg: mv ${CURDIR}/debian/control-${target_arch} ${CURDIR}/debian/control"
mv ${CURDIR}/debian/control-${target_arch} ${CURDIR}/debian/control
fi
dpkg-buildpackage -uc -us -a$target_arch
if [ "$file" = "xCAT-genesis-scripts" ]; then
CURDIR=$(pwd)
echo "Move control file back: mv ${CURDIR}/debian/control ${CURDIR}/debian/control-${target_arch}"
mv ${CURDIR}/debian/control ${CURDIR}/debian/control-${target_arch}
fi
fi
rc=$?
if [ $rc -gt 0 ]; then

17
buildcore.sh
View File

@@ -67,7 +67,7 @@ if [ -z "$UP" ]; then
fi
# These are the rpms that should be built for each kind of xcat build
ALLBUILD="perl-xCAT xCAT-client xCAT-server xCAT-test xCAT-buildkit xCAT xCATsn xCAT-genesis-scripts xCAT-SoftLayer xCAT-vlan xCAT-confluent"
ALLBUILD="perl-xCAT xCAT-client xCAT-server xCAT-test xCAT-buildkit xCAT xCATsn xCAT-genesis-scripts xCAT-SoftLayer xCAT-vlan xCAT-confluent xCAT-probe"
ZVMBUILD="perl-xCAT xCAT-server xCAT-UI"
ZVMLINK="xCAT-client xCAT xCATsn"
# xCAT and xCATsn have PCM specific configuration - conserver-xcat, syslinux-xcat
@@ -175,6 +175,9 @@ function setversionvars {
VER=`cat Version`
SHORTVER=`cat Version|cut -d. -f 1,2`
SHORTSHORTVER=`cat Version|cut -d. -f 1`
BUILD_TIME=`date`
BUILD_MACHINE=`hostname`
COMMIT_ID=`git rev-parse --short HEAD`
}
@@ -288,7 +291,7 @@ if [ "$OSNAME" = "AIX" ]; then
fi
# Build the rest of the noarch rpms
for rpmname in xCAT-client xCAT-server xCAT-IBMhpc xCAT-rmc xCAT-UI xCAT-test xCAT-buildkit xCAT-SoftLayer xCAT-vlan xCAT-confluent; do
for rpmname in xCAT-client xCAT-server xCAT-IBMhpc xCAT-rmc xCAT-UI xCAT-test xCAT-buildkit xCAT-SoftLayer xCAT-vlan xCAT-confluent xCAT-probe; do
if [[ " $EMBEDBUILD " != *\ $rpmname\ * ]]; then continue; fi
if [ "$OSNAME" = "AIX" -a "$rpmname" = "xCAT-buildkit" ]; then continue; fi # do not build xCAT-buildkit on aix
if [ "$OSNAME" = "AIX" -a "$rpmname" = "xCAT-SoftLayer" ]; then continue; fi # do not build xCAT-softlayer on aix
@@ -504,6 +507,16 @@ if [ -n "$VERBOSEMODE" ]; then
else
verboseflag=""
fi
#
# Add a VERSION file into the tar.bz2 file to track information about the build
#
BUILDINFO=$XCATCORE/buildinfo
echo "VERSION=$VER" > $BUILDINFO
echo "BUILD_TIME=$BUILD_TIME" >> $BUILDINFO
echo "BUILD_MACHINE=$BUILD_MACHINE" >> $BUILDINFO
echo "COMMIT_ID=$COMMIT_ID" >> $BUILDINFO
echo "Creating $(dirname $DESTDIR)/$TARNAME ..."
if [[ -e $TARNAME ]]; then
mkdir -p previous

2
create_man_pages.py
View File

@@ -130,7 +130,7 @@ for component in COMPONENTS:
cmd = "perl -I %s/share/perl5 %s/bin/%s " %(prefix_path, prefix_path, POD2RST)
cmd += " --infile=%s --outfile=%s --title=%s.%s" %(pod_input, rst_output, title, man_ver)
print cmd
# print cmd
os.system(cmd)
if man_ver == '1' or man_ver == '8':
fix_vertical_bar(rst_output)

11
docs/README.md
View File

@@ -13,10 +13,19 @@ The documentation project is written in restructured text (.rst) using Sphinx an
* Clone the project
* Using pip, install sphinx (See: http://pip.readthedocs.org/)
* Using pip, install or update sphinx (See: http://pip.readthedocs.org/)
```
pip install sphinx
```
or
```
pip install sphinx --upgrade
```
* Using pip, install ReadTheDocs theme
```
pip install sphinx_rtd_theme
```
* Build the Docs
```

81
docs/source/advanced/cluster_maintenance/compute_node/changing_hostname_ip.rst
View File

@@ -1,2 +1,81 @@
Changing the hostname/IP address
Changing the Hostname/IP address
================================
Background
----------
If the hostname or IP address has already been modified on compute nodes,
follow the steps to change the configuration in xcat.
Remove Old Provision Environment
--------------------------------
#. Remove the nodes from DNS configuration ::
makedns -d <noderange>
#. Remove the nodes from the DHCP configuration ::
makedhcp -d <noderange>
#. Remove the nodes from the conserver configuration ::
makeconservercf -d <noderange>
Change Definition
-----------------
#. Change netwoks table definitions ::
lsdef -t network -l
The output may be like ::
10_0_0_0-255_0_0_0 (network)
192_168_122_0-255_255_255_0 (network)
Change the networks table definitions, For example ``192_168_122_0-255_255_255_0``
is a original network configuration which should be modified to
``192_168_123_0-255_255_255_0``::
rmdef -t network 192_168_122_0-255_255_255_0
mkdef -t network 192_168_123_0-255_255_255_0 net=192.168.123.0 mask=255.255.255.0
#. Change the hostname in the xCAT database (This command only supports one node
at a time). For many nodes you will have to write a script. ::
# changes node1 to node2 in the database
chdef -t node -o node1 -n node2
#. Change the hostname and IP address in the ``/etc/hosts`` file
- If you do not use the hosts table in xCAT to create the ``/etc/hosts`` file,
edit the ``/etc/hosts`` file and change your hostname and IP address entries
directly.
- If you use the xCAT hosts table, and your nodes are defined by name in the
hosts table, the hosts table must be updated with the new names when
we changed the node name using ``chdef`` command. If the hosts tables contains
regular expression, you have to rewrite the regular expression to
match your new hostname and IP address.
- If these is no regular expression in the hosts table, you can run ::
# change the IP address for the new hostname in the hosts table.
nodech <newnodename> hosts.ip="x.xx.xx.xx"
# add hostname/IP records in /etc/hosts from the definition in the xCAT hosts
# table for the <noderange>
makehosts <noderange>
Update The Provision Environment
--------------------------------
#. Configure the new names in DNS ::
makedns -n
#. Configure the new names in DHCP ::
makedhcp -a
#. Configure the new names in conserver ::
makeconservercf

1
docs/source/advanced/cluster_maintenance/index.rst
View File

@@ -6,4 +6,5 @@ Cluster Maintenance
compute_node/index.rst
mgmt_node/index.rst
service_node/index.rst
sw_fw_inventory.rst

275
docs/source/advanced/cluster_maintenance/mgmt_node/changing_hostname_ip.rst
View File

@@ -1,4 +1,277 @@
Changing the hostname/IP address
================================
There may be times when it is required to change the hostname or IP address of the xCAT management nodes. This document helps to outline the steps required to ensure successfully changing this attribute on the management node.
Overview
--------
This document is intended to describe the steps that must be taken if you need
to change your Linux Management Node's hostname and/or IP address
after the cluster is installed and configured by xCAT. This documentation will
only cover the changes by xCAT and will not try to cover any other changes by
any other tools.
Backup your xCAT data
---------------------
Clean up the database by running ``tabprune`` command: ::
tabprune -a auditlog
tabprune -a eventlog
Now take a snapshot of the Management Node. This will also create a database
backup. You can use this data as reference if needed. ::
xcatsnap -d
Stop xCAT
---------
You need to stop the xcat daemon and any other applications that are using the
xCAT database on the Management Node and the Service Nodes. To determine your
database, run ::
lsxcatd -a | grep dbengine
To stop xCAT: ::
service xcatd stop
Stop The Database
-----------------
For all databases except SQlite, you should stop the database.
For example ::
service postgresql stop
service mysqld stop
Change the Management Hostname
-------------------------------
* hostname command ::
hostname <new_MN_name>
* Edit hostname configuration file
| Add hostname in ``/etc/hostname``
| Add HOSTNAME attribute in ``/etc/sysconfig/network`` (only for [RHEL])
Update Database Files
---------------------
You need to update the new MN hostname or IP address in several database
configuration files.
SQLite
^^^^^^
Nothing to do.
Postgresql
^^^^^^^^^^
- Edit ``/etc/xcat/cfgloc`` file, replace ``Pg:dbname=xcatdb;host=<old_MN_ip>|xcatadm|xcat20``
with ``Pg:dbname=xcatdb;host=<new_MN_ip>|xcatadm|xcat20``.
- Edit config database config file ``/var/lib/pgsql/data/pg_hba.conf``,
replace ``host all all <old_MN_ip>/32 md5``
with ``host all all <new_MN_ip>/32 md5``.
Mysql
^^^^^
Edit ``/etc/xcat/cfglooc``, replace ``mysql:dbname=xcatdb;host=<old_MN_ip>|xcatadmin|xcat20``
with ``mysql:dbname=xcatdb;host=<new_MN_ip>|xcatadmin|xcat20``.
Start the database
------------------
::
service postgresql start
service mysqld start
Start xCAT
::
service xcatd start
Verify your new database setup ::
lsxcatd -a | grep dbengine
tabdump site # if output exists
Change The Definition In xCAT Database
--------------------------------------
Change the site table master attribute
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
chdef -t site master=<new_MN_ip>
Change all IP address attribute relevant to the MN IP address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For example, old address was "10.6.0.1"
* Query the attributes with old address ::
lsdef -t node -l | grep "10.6.0.1"
# the output may looks like
conserver=10.6.0.1
conserver=10.6.0.1
conserver=10.6.0.1
conserver=10.6.0.1
nfsserver=10.6.0.1
servicenode=10.6.0.1
xcatmaster=10.6.0.1
kcmdline=quiet repo=http://10.6.0.1/install/rhels6/ppc64/ ks=http://10.6.0.1/install/autoinst
/slessn ksdevice=d6:92:39:bf:71:05
nfsserver=10.6.0.1
servicenode=10.6.0.1
tftpserver=10.6.0.1
xcatmaster=10.6.0.1
servicenode=10.6.0.1
xcatmaster=10.6.0.1
* As the attribute with the old IP address is list above, take conserver as
a example, query the nodes with ``conserver=10.6.0.1``.
::
lsdef -t node -w conserver="10.6.0.1"
# the output looks like
cn1 (node)
cn2 (node)
cn3 (node)
cn4 (node)
* Change the conserver address for cn1,cn2,cn3,cn4 ::
chdef -t node cn1-cn4 conserver=<new_ip_address>
Repeat the same process for the other attributes.
Change networks table
^^^^^^^^^^^^^^^^^^^^^^
Check your networks table to see if the network definitions are still correct,
if not edit accordingly ::
lsdef -t network -l
chdef -t network <key=value>
Check Result
^^^^^^^^^^^^^
You can check whether all the old address has been changed using ::
dumpxCATdb -P <new database backup path>
cd <new database backup path>
fgrep "10.6.0.1" *.csv
If the old address still exists in the ``*.csv` file, you can edit this file,
then use the following command to restore the records ::
tabrestore <xxx.csv>
Generate SSL credentials(optional)
----------------------------------
If you do not generate new credentials, skip this section.
If you decide generate new credentials, then you will use the following
command.
* Generate new credentials ::
xcatconfig -c
* Update the policy table with new MN name,
replace ``"1.4","old_MN_name",,,,,,"trusted",,`` with
``"1.4","new_MN_name",,,,,,"trusted",,``
* Setup up conserver with new credentials ::
makeconservercf
External DNS Server Changed
---------------------------
* Update nameserver entries in ``/etc/resolv.conf``
* Update nameserver attribute in ``site`` table ::
chdef -t site -o clustersite nameservers="new_ip_address1,new_ip_address2"
* Update site forwarders in DB ::
chdef -t site -o clustersite forwarders="new_ip_address1,new_ip_address2"
* Run command ``makedns -n``
Domain Name Changed
-------------------
Change the entries in ``/etc/hosts``.
Change the ``/etc/resolv.conf``, forwarders attribute in site table. ::
lsdef -t site -o clustersite -i forwarders
chdef -t site -o clustersite forwarders <new list>
Change the domain name in the xCAT database site table. ::
chdef -t site -o clustersite domain=<new_domainname>
From xCAT 2.8, multiple domains is supported in the cluster. Update the
networks table definition. ::
lsdef -t network -l
chdef -t network -o <network_name> ddnsdomain=<new_domainname1,new_domainname2>
Update the Provision Environment
--------------------------------
Determine if the Management node is defined in the database, assuming it was
done correctly using xcatconfig -m, by running: ::
lsdef __mgmtnode
If it exists, then use the return name and do the following:
- Remove the MN from DNS configuration ::
makedns -d <old_MN_name>
- Remove the MN from the DHCP configuration ::
makedns -d <old_MN_name>
- Remove the MN from the conserver configuration ::
makedns -d <old_MN_name>
- Change the MN name in the xCAT database ::
chdef -t node -o <old_MN_name> -n <new_MN_name>
- Add the new MN to DNS ::
makedns -n
- Add the MN to dhcp ::
makedhcp -a
- Add the MN to conserver ::
makeconservercf
Update the genesis packages
---------------------------
Run ``mknb <arch>`` after changing the ip of MN.

60
docs/source/advanced/cluster_maintenance/service_node/changing_hostname_ip.rst Normal file
View File

@@ -0,0 +1,60 @@
Changing the Hostname/IP address
================================
Change compute node definition relevant to the service node
-----------------------------------------------------------
Change the settings in database. Below shows a method to find out where the old
IP address settings (take 10.6.0.1 as a example) are used in Hierarchy
environment.
* Query the old attribute ::
lsdef -t node -l | grep "10.6.0.1"
# below is output of the above command. We can find out that nfsserver
# and servicenode are using the old IP address setting.
nfsserver=10.6.0.1
servicenode=10.6.0.1
* Query the nodes whose nfsserver is 10.6.0.1 ::
lsdef -w nfsserver==10.6.0.1
# below is output of the above command
cn1 (node)
cn2 (node)
cn3 (node)
cn4 (node)
* Change the nfsserver address for cn1,cn2,cn3,cn4 by running the following
command: ::
chdef -t node cn1-cn4 nfsserver=<new service node IP addresss>
Database Connection Changes
---------------------------
Granting or revoking access privilege in the database for the service node.
* For mysql, please refer to :ref:`grante_revoke_mysql_access_label`.
.. There is no procedure in old document on sourceforge for postgress to
grant or revoke the access privilege for service node.
* For postgress, please refer to `TODO <https://localhost/todo>`_.
Update Provision Environment on Service Node
--------------------------------------------
If you are using service nodes to install the nodes and using ``/etc/hosts``
for hostname resolution, you need to copy the new ``/etc/hosts`` from the
management node to the service nodes, then run ``makedns -n`` on the service
nodes. For example: ::
xdcp <servicenodes> /etc/hosts /etc/hosts
xdsh <servicenodes> makedns -n
Reinstall the nodes to pick up all changes ::
nodeset <noderange> osimage=<osimagename>
Then use your normal command to install the nodes like rinstall, rnetboot, etc.

7
docs/source/advanced/cluster_maintenance/service_node/index.rst Normal file
View File

@@ -0,0 +1,7 @@
Service Node
============
.. toctree::
:maxdepth: 2
changing_hostname_ip.rst

5
docs/source/advanced/docker/dockerized_xcat/run_xcat_in_docker_compose.rst
View File

@@ -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>`_

16
docs/source/advanced/docker/lifecycle_management.rst
View File

@@ -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

2
docs/source/advanced/domain_name_resolution/domain_name_resolution.rst
View File

@@ -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: ::

2
docs/source/advanced/hamn/high_available_management_node.rst
View File

@@ -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`

2
docs/source/advanced/hamn/setup_ha_mgmt_node_with_raid1_and_disks_move.rst
View File

@@ -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
============================================

2
docs/source/advanced/hierarchy/databases/mysql_configure.rst
View File

@@ -24,6 +24,8 @@ where the /tmp/servicenodes contains a host per line: ::
**While not recommended**, if you wish to manually migrate your xCAT database, see the following documentation:
`Manually set up MySQL <https://sourceforge.net/p/xcat/wiki/Setting_Up_MySQL_as_the_xCAT_DB/#configure-mysql-manually>`_
.. _grante_revoke_mysql_access_label:
Granting/Revoking access to the database for Service Node Clients
-----------------------------------------------------------------

2
docs/source/advanced/hierarchy/databases/mysql_remove.rst
View File

@@ -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)

7
docs/source/advanced/hierarchy/provision/diskful_sn.rst
View File

@@ -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:

1
docs/source/advanced/index.rst
View File

@@ -22,5 +22,4 @@ Advanced Topics
softlayer/index.rst
switches/index.rst
sysclone/index.rst
webservices/index.rst
zones/index.rst

9
docs/source/advanced/mixed_cluster/power/diskful.rst
View File

@@ -44,6 +44,15 @@ Create a node definition for the x86_64 compute node, here is a sample: ::
serialport=0
serialspeed=115200
Verify the genesis packages:
* **[RHEL/SLES]**: ``rpm -qa | grep -i genesis``
* **[Ubuntu]**: ``dpkg -l | grep -i genesis``
If missing, install the packages ``xCAT-genesis-base`` and ``xCAT-genesis-scripts`` from ``xcat-deps`` repository and run ``mknb <arch>`` to create the genesis network boot root image.
Provision the node using the following commands: ::
# The following prepares the boot files in /install and /tftpboot

2
docs/source/advanced/mixed_cluster/support_matrix.rst
View File

@@ -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

2
docs/source/advanced/networks/infiniband/mlnxofed_ib_known_issue.rst
View File

@@ -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>`.

2
docs/source/advanced/networks/infiniband/switch_configuration.rst
View File

@@ -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: ::

1
docs/source/advanced/restapi/restapi_resource/restapi_reference.rst
View File

@@ -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...}.
```````````````````````````````````````````````````````````````````````

4
docs/source/advanced/restapi/restapi_setup/restapi_setup.rst
View File

@@ -3,7 +3,7 @@ Enable the HTTPS service for REST API
To improve the security between the REST API client and server, enabling the HTTPS service on the xCAT MN is recommended. And the REST API client should use the 'https' to access web server instead of the 'http'.
* **[RHEL6 (x86_64/ppc64) and RHEL5 (x86_64)]** ::
* **[RHEL6/7 (x86_64/ppc64) and RHEL5 (x86_64)]** ::
yum install mod_ssl
service httpd restart
@@ -16,7 +16,7 @@ To improve the security between the REST API client and server, enabling the HTT
rpm -e --nodeps httpd.ppc64
rpm -i httpd.ppc mod_ssl.ppc
* **[SLES10/11 (x86_64/ppc64)]** ::
* **[SLES10/11/12 (x86_64/ppc64)]** ::
a2enmod ssl
a2enflag SSL

2
docs/source/advanced/sysclone/sysclone.rst
View File

@@ -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.

39
docs/source/conf.py
View File

@@ -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

255
docs/source/developers/doc_guidelines.rst
View File

@@ -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

36
docs/source/developers/guides/docs/doc_guidelines.rst
View File

@@ -62,10 +62,28 @@ Enumerated List
2. Item 2
a) item a
Include another file
--------------------
To add contents of a document file inside another file, use ``.. include::``. This is usefull when a common information needs to be displayed in multiple files, whithout the use of a hyperlink.
::
.. include:: config_common.rst
``Note:`` Do not put customized link targets, such as ``.. _my_link_taget:`` inside the file to be included. If you do, a warning for a duplicate label will be displayed during the documentation build process.
Index file
----------
Index.rst files contain the ``.. toctree::`` tag. Files listed under that tag will have links to them displayed in the left side navigation area. If a documentation file does not wish to be accessbile from the navigation area, do not list it under the ``.. toctree::``.
``Note:`` If a file is not listed under the ``.. toctree::`` it might generate a warning during the documentation build ``WARNING: document isn't included in any toctree``. To eliminate such warning, add the file to the ``exclude_patterns`` list in the ``docs/source/conf.py`` file. However, do not add a file to the ``exclude_patterns`` list if it contains a customized link target, such as ``.. _my_link_taget:``. This link target will not be visible to other files and a ``WARNING: undefined label:`` will be displayed during the documentation build.
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 +103,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 +113,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 +121,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 +139,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 +151,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
..

2
docs/source/guides/admin-guides/basic_concepts/global_cfg/index.rst
View File

@@ -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.

2
docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst
View File

@@ -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

4
docs/source/guides/admin-guides/manage_clusters/common/deployment/deploy_os.rst
View File

@@ -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

2
docs/source/guides/admin-guides/manage_clusters/common/deployment/install_new_kernel.rst
View File

@@ -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.

2
docs/source/guides/admin-guides/manage_clusters/common/deployment/prepostscripts/post_script.rst
View File

@@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2
docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst
View File

@@ -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 ::

2
docs/source/guides/admin-guides/manage_clusters/common/updatenode.rst
View File

@@ -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
-------------------------------------------

3
docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/config_environment.rst
View File

@@ -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
``````````

6
docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst
View File

@@ -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
docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/deploy_os.rst
View File

@@ -1,2 +1,3 @@
.. _deploy_os:
.. include:: ../../common/deployment/deploy_os.rst

25
docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/FAQ.rst
View File

@@ -45,6 +45,31 @@ rpower fails with "Error: internal error: process exited while connecting to mon
Then reboot the hypervisor...
rmigrate fails with "Error: libvirt error code: 38, message: unable to connect to server at 'c910f05c35:49152': No route to host."
----------------------------------------------------------------------------------------------------------------------------------
**Issue**: ::
#rmigrate vm1 kvmhost2
vm1: Error: libvirt error code: 38, message: unable to connect to server at 'kvmhost2:49152': No route to host: Failed migration of vm1 from kvmhost1 to kvmhost2
**Solution**:
Usually caused by active firewall. To disable the firewall issue: ::
systemctl disable firewalld
rmigrate fails with "Error: 38, message: failed to create directory '<dir-name>': File exists: Unknown issue libvirt error code."
---------------------------------------------------------------------------------------------------------------------------------
**Issue**: ::
#rmigrate vm1 kvmhost2
vm1: Error: 38, message: failed to create directory '<dir-name>': File exists: Unknown issue libvirt error code.
**Solution**:
Ususally happens when `nfs:` is specified for vmstorage attribute but that NFS directory is no longer mounted. Make sure the directory /var/lib/xcat/pools is empty on the destination kvmhost.
Error: Cannot communicate via libvirt to kvmhost1
-------------------------------------------------

2
docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/powerKVM.rst
View File

@@ -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:

4
docs/source/guides/admin-guides/references/man1/buildkit.1.rst
View File

@@ -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**\

2
docs/source/guides/admin-guides/references/man1/geninitrd.1.rst
View File

@@ -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'),

2
docs/source/guides/admin-guides/references/man1/getadapter.1.rst
View File

@@ -29,7 +29,7 @@ DESCRIPTION
***********
Traditionally, network interfaces in Linux are enumerated as eth[0123<EFBFBD>], 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.

2
docs/source/guides/admin-guides/references/man1/getmacs.1.rst
View File

@@ -41,7 +41,7 @@ blade specific:
===============
\ **getmacs**\ \ *noderange*\ [\ **-V**\ | \ **-**\ **-verbose**\ ] [\ **-d**\ ] [\ **-**\ **-arp**\ ] [\ **-i**\ \ *ethN*\ |\ *enN*\ ]
\ **getmacs**\ \ *noderange*\ [\ **-V**\ | \ **-**\ **-verbose**\ ] [\ **-d**\ ] [\ **-**\ **-arp**\ ] [\ **-i**\ \ *ethN*\ | \ *enN*\ ]

47
docs/source/guides/admin-guides/references/man1/lsdef.1.rst
View File

@@ -26,6 +26,9 @@ SYNOPSIS
[\ **-c | -**\ **-compress**\ ] [\ **-**\ **-osimage**\ ] [\ **-**\ **-nics**\ ] [[\ **-w**\ \ *attr*\ ==\ *val*\ ]
[\ **-w**\ \ *attr*\ =~\ *val*\ ] ...] [\ *noderange*\ ]
\ **lsdef**\ [\ **-l | -**\ **-long**\ ] [\ **-a | -**\ **-all**\ ] [\ **-t**\ \ *object-types*\ ] [\ **-z | -**\ **-stanza**\ ]
[\ **-i**\ \ *attr-list*\ ] [\ **-**\ **-template**\ [\ *template-object-name*\ ]]
***********
DESCRIPTION
@@ -33,7 +36,7 @@ DESCRIPTION
This command is used to display xCAT object definitions which are stored
in the xCAT database.
in the xCAT database and xCAT object definition templates shipped in xCAT.
*******
@@ -101,6 +104,12 @@ OPTIONS
\ **-**\ **-template**\ [\ *template-object-name*\ ]
Show the object definition templates \ *template-object-name*\ shipped in xCAT. If no \ *template-object-name*\ is specified, all the object definition templates of the specified type \ **-t**\ \ *object-types*\ will be listed. Use \ **-a|-**\ **-all**\ option to list all the object definition templates.
\ **-**\ **-osimage**\
Show all the osimage information for the node.
@@ -376,6 +385,42 @@ EXAMPLES
18.
To list all the object definition templates shipped in xCAT.
.. code-block:: perl
lsdef --template -a
19.
To display the details of "node" object definition template "ppc64le-template" shipped in xCAT.
.. code-block:: perl
lsdef -t node --template ppc64le-template
20.
To list all the "node" object definition templates shipped in xCAT.
.. code-block:: perl
lsdef -t node --template
*****
FILES

17
docs/source/guides/admin-guides/references/man1/lsve.1.rst
View File

@@ -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

4
docs/source/guides/admin-guides/references/man1/makentp.1.rst
View File

@@ -97,7 +97,7 @@ EXAMPLES
.. code-block:: perl
setupntp -a
makentp -a
@@ -108,7 +108,7 @@ FILES
*****
/opt/xcat/bin/setupntp
/opt/xcat/bin/makentp
********

32
docs/source/guides/admin-guides/references/man1/mkdef.1.rst
View File

@@ -21,7 +21,7 @@ SYNOPSIS
\ **mkdef**\ [\ **-h | -**\ **-help**\ ] [\ **-t**\ \ *object-types*\ ]
\ **mkdef**\ [\ **-V | -**\ **-verbose**\ ] [\ **-t**\ \ *object-types*\ ] [\ **-o**\ \ *object-names*\ ] [\ **-z | -**\ **-stanza**\ ] [\ **-d | -**\ **-dynamic**\ ] [\ **-f | -**\ **-force**\ ] [[\ **-w**\ \ *attr*\ ==\ *val*\ ] [\ **-w**\ \ *attr*\ =~\ *val*\ ] ...] [\ *noderange*\ ] [\ *attr*\ =\ *val*\ [\ *attr*\ =\ *val...*\ ]] [\ **-u**\ \ **provmethod**\ ={\ **install**\ | \ **netboot**\ | \ **statelite**\ } \ **profile=**\ \ *xxx*\ [\ **osvers=**\ \ *value*\ ] [\ **osarch=**\ \ *value*\ ]]
\ **mkdef**\ [\ **-V | -**\ **-verbose**\ ] [\ **-t**\ \ *object-types*\ ] [\ **-**\ **-template**\ \ *template-object-name*\ ] [\ **-o**\ \ *object-names*\ ] [\ **-z | -**\ **-stanza**\ ] [\ **-d | -**\ **-dynamic**\ ] [\ **-f | -**\ **-force**\ ] [[\ **-w**\ \ *attr*\ ==\ *val*\ ] [\ **-w**\ \ *attr*\ =~\ *val*\ ] ...] [\ *noderange*\ ] [\ *attr*\ =\ *val*\ [\ *attr*\ =\ *val...*\ ]] [\ **-u**\ \ **provmethod**\ ={\ **install**\ | \ **netboot**\ | \ **statelite**\ } \ **profile=**\ \ *xxx*\ [\ **osvers=**\ \ *value*\ ] [\ **osarch=**\ \ *value*\ ]]
***********
@@ -82,6 +82,12 @@ OPTIONS
\ **-**\ **-template**\ \ *template-object-name*\
Name of the xCAT shipped object definition template or an existing object, from which the new object definition will be created. The newly created object will inherit the attributes of the template definition unless the attribute is specified in the arguments of \ **mkdef**\ command. If there are a template and an existing object with the same name \ *template-object-name*\ , the tempalte object takes precedence over the existing object. For the details of xCAT shipped object definition templates, refer to the manpage of \ **-**\ **-template**\ option in lsdef(1)|lsdef.1.
\ **-V|-**\ **-verbose**\
Verbose mode.
@@ -280,6 +286,30 @@ EXAMPLES
13.
To create a PowerLE kvm node definition with the xCAT shipped template "ppc64lekvmguest-template".
.. code-block:: perl
mkdef -t node cn1 --template ppc64lekvmguest-template ip=1.1.1.1 mac=42:3d:0a:05:27:0b vmhost=1.1.0.1 vmnics=br0
14.
To create a node definition from an existing node definition "cn1"
.. code-block:: perl
mkdef -t node cn2 --template cn1 ip=1.1.1.2 mac=42:3d:0a:05:27:0c
*****
FILES

2
docs/source/guides/admin-guides/references/man1/packimage.1.rst
View File

@@ -62,7 +62,7 @@ OPTIONS
\ **-a**\ Architecture (ppc64,x86_64,etc)
\ **-m**\ Method (default cpio)
\ **-m**\ Method (cpio,txc,squashfs, default is cpio)
************

20
docs/source/guides/admin-guides/references/man1/rmigrate.1.rst
View File

@@ -36,6 +36,8 @@ For zVM:
\ **rmigrate**\ requests that a guest VM to be moved from the current hypervisor to another. It will request a live migration if possible. The vmstorage directory should be shared between the source and destination hypervisors.
Note: Make sure SELINUX is disabled and firewall is turned off on source and destination hypervisors.
For zVM:
========
@@ -97,17 +99,29 @@ This is used to determine the current host to migrate from.
1. To migrate kvm guest "kvm1" from hypervisor "hyp01" to hypervisor "hyp02", run:
\ **rmigrate**\ \ *kvm1*\ \ *hyp02*\
.. code-block:: perl
rmigrate kvm1 hyp02
2. To migrate kvm guest "kvm1" to hypervisor "hyp02", which is already on host "hyp02", enter:
\ **rmigrate**\ \ *kvm1*\ \ *hyp02*\
.. code-block:: perl
rmigrate kvm1 hyp02
zVM specific:
=============
\ **rmigrate**\ \ *ihost123*\ destination=\ *pokdev62*\
.. code-block:: perl
rmigrate ihost123 destination=pokdev62

2
docs/source/guides/admin-guides/references/man1/rmkitcomp.1.rst
View File

@@ -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.

37
docs/source/guides/admin-guides/references/man1/rscan.1.rst
View File

@@ -35,7 +35,7 @@ The rscan command lists hardware information for each node managed by the hardwa
For the management module of blade, if the blade server is a Flex system P node, the fsp belongs to the blade server also will be scanned.
For the KVM host, all the KVM guests on the specified KVM host will be scanned. Note: currently rscan can only get the information of the "disk" device on the kvm guest with the underlying source as a "file" on the KVM host.
For the KVM host, all the KVM guests on the specified KVM host will be scanned.
Note: The first line of the output always contains information about the hardware control point. When using the rscan command to generate output for HMC or IVM hardware control points, it provides the FSPs and BPAs as part of the output. The only exception is the rscan -u flag which provides updates made hardware control point in the xCAT database.
@@ -55,7 +55,7 @@ OPTIONS
For the Flex system manager, both the blade server and fsp object of xCAT will be updated if the mpa and slot id are matched to the object which has been defined in the xCAT database.
For the KVM host, the information of the KVM guests which have been defined in xCAT database will be updated.
For KVM host, the information of the KVM guests which have been defined in xCAT database will be updated.
Note: only the matched object will be updated.
@@ -69,6 +69,8 @@ For KVM host, updates the information of the KVM guests which have been defined
\ **-z**\ Stanza formated output.
Note: For KVM host, -z is not a valid option for rscan.
************
RETURN VALUE
@@ -311,39 +313,12 @@ Output is similar to:
blade [SN#YL10JH184079] Matched To =>[cmm01node03]
8. To scan the KVM host "hyp01", list all the KVM guest information on the KVM host in stanza format and write the KVM guest information into xCAT database:
8. To scan the KVM host "hyp01", write the KVM guest information into xCAT database:
.. code-block:: perl
rscan hyp01 -z -w
Output is similar to:
.. code-block:: perl
kvm1
arch=x86_64
mac=
mgt=kvm
vmcpus=1
vmhost=hyp01
vmmemory=1024
vmnicnicmodel=virtio
vmnics=virbr0
vmstorage=/install/vms/kvm1.hda.qcow2
kvm2
arch=x86_64
mac=
mgt=kvm
vmcpus=2
vmhost=hyp01
vmmemory=1024
vmnicnicmodel=virtio
vmnics=virbr0
vmstorage=/install/vms/kvm2.hda.qcow2
rscan hyp01 -w
9. To update definitions of kvm guest, which is managed by hypervisor hyp01, enter:

2
docs/source/guides/admin-guides/references/man1/unregnotif.1.rst
View File

@@ -49,7 +49,7 @@ OPTIONS
\ **-h | -help**\ Display usage message.
\ **-v | -version **\ Command Version.
\ **-v | -version**\ Command Version.
\ **-V | -verbose**\ Verbose output.

8
docs/source/guides/admin-guides/references/man1/updatenode.1.rst
View File

@@ -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

6
docs/source/guides/admin-guides/references/man1/xdcp.1.rst
View File

@@ -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.

6
docs/source/guides/admin-guides/references/man5/auditlog.5.rst
View File

@@ -27,11 +27,7 @@ DESCRIPTION
***********
.. code-block:: perl
Audit Data log.
Audit Data log.
********************

2
docs/source/guides/admin-guides/references/man5/deps.5.rst
View File

@@ -56,7 +56,7 @@ deps Attributes:
\ **cmd**\
Comma-seperated list of which operation this dependency applies to.
Comma-separated list of which operation this dependency applies to.

2
docs/source/guides/admin-guides/references/man5/domain.5.rst
View File

@@ -44,7 +44,7 @@ domain Attributes:
\ **ou**\
For an LDAP described machine account (i.e. Active Directory), the orginaztional unit to place the system. If not set, defaults to cn=Computers,dc=your,dc=domain
For an LDAP described machine account (i.e. Active Directory), the organizational unit to place the system. If not set, defaults to cn=Computers,dc=your,dc=domain

6
docs/source/guides/admin-guides/references/man5/eventlog.5.rst
View File

@@ -104,11 +104,7 @@ eventlog Attributes:
\ **rawdata**\
.. code-block:: perl
The data that associated with the event.
The data that associated with the event.

9
docs/source/guides/admin-guides/references/man5/ipmi.5.rst
View File

@@ -44,20 +44,17 @@ ipmi Attributes:
\ **bmc**\
The hostname of the BMC adapater.
The hostname of the BMC adapter.
\ **bmcport**\
In systems with selectable shared/dedicated ethernet ports, this parameter can be used to specify the preferred port. 0 means use the shared port, 1 means dedicated, blank is to not assign.
.. code-block:: perl
In systems with selectable shared/dedicated ethernet ports,
this parameter can be used to specify the preferred port. 0
means use the shared port, 1 means dedicated, blank is to not
assign.
The following special cases exist for IBM System x servers:
For x3755 M3 systems, 0 means use the dedicated port, 1 means

2
docs/source/guides/admin-guides/references/man5/kvm_masterdata.5.rst
View File

@@ -27,7 +27,7 @@ DESCRIPTION
***********
Persistant store for KVM plugin for masters
Persistent store for KVM plugin for masters
**************************

2
docs/source/guides/admin-guides/references/man5/kvm_nodedata.5.rst
View File

@@ -27,7 +27,7 @@ DESCRIPTION
***********
Persistant store for KVM plugin, not intended for manual modification.
Persistent store for KVM plugin, not intended for manual modification.
************************

8
docs/source/guides/admin-guides/references/man5/linuximage.5.rst
View File

@@ -68,13 +68,13 @@ linuximage Attributes:
\ **pkgdir**\
The name of the directory where the distro packages are stored. It could be set multiple paths.The multiple paths must be seperated by ",". The first path in the value of osimage.pkgdir must be the OS base pkg dir path, such as pkgdir=/install/rhels6.2/x86_64,/install/updates . In the os base pkg path, there are default repository data. And in the other pkg path(s), the users should make sure there are repository data. If not, use "createrepo" command to create them. For ubuntu, multiple mirrors can be specified in the pkgdir attribute, the mirrors must be prefixed by the protocol(http/ssh) and delimited with "," between each other.
The name of the directory where the distro packages are stored. It could be set to multiple paths. The multiple paths must be separated by ",". The first path in the value of osimage.pkgdir must be the OS base pkg dir path, such as pkgdir=/install/rhels6.2/x86_64,/install/updates . In the os base pkg path, there are default repository data. And in the other pkg path(s), the users should make sure there are repository data. If not, use "createrepo" command to create them. For ubuntu, multiple mirrors can be specified in the pkgdir attribute, the mirrors must be prefixed by the protocol(http/ssh) and delimited with "," between each other.
\ **otherpkglist**\
The fully qualified name of the file that stores non-distro package lists that will be included in the image. It could be set multiple paths.The multiple paths must be seperated by ",".
The fully qualified name of the file that stores non-distro package lists that will be included in the image. It could be set to multiple paths. The multiple paths must be separated by ",".
@@ -92,7 +92,7 @@ linuximage Attributes:
\ **postinstall**\
The fully qualified name of the script file that will be run at the end of the genimage command. It could be set multiple paths.The multiple paths must be seperated by ",". It is used for diskless image only.
The fully qualified name of the script file that will be run at the end of the genimage command. It could be set to multiple paths. The multiple paths must be separated by ",". It is used for diskless image only.
@@ -158,7 +158,7 @@ linuximage Attributes:
\ **partitionfile**\
The path of the configuration file which will be used to partition the disk for the node. For stateful osimages,two types of files are supported: "<partition file absolute path>" which contains a partitioning definition that will be inserted directly into the generated autoinst configuration file and must be formatted for the corresponding OS installer (e.g. kickstart for RedHat, autoyast for SLES, pressed for Ubuntu). "s:<partitioning script absolute path>" which specifies a shell script that will be run from the OS installer configuration file %pre section; the script must write the correct partitioning definition into the file /tmp/partitionfile on the node which will be included into the configuration file during the install process. For statelite osimages, partitionfile should specify "<partition file absolute path>"; see the xCAT Statelite documentation for the xCAT defined format of this configuration file.For Ubuntu, besides "<partition file absolute path>" or "s:<partitioning script absolute path>", the disk name(s) to partition must be specified in traditional, non-devfs format, delimited with space, it can be specified in 2 forms: "d:<the absolute path of the disk name file>" which contains the disk name(s) to partition and "s:d:<the absolute path of the disk script>" which runs in pressed/early_command and writes the disk names into the "/tmp/install_disk" . To support other specific partition methods such as RAID or LVM in Ubuntu, some additional preseed values should be specified, these values can be specified with "c:<the absolute path of the additional pressed config file>" which contains the additional pressed entries in "d-i ..." form and "s:c:<the absolute path of the additional pressed config script>" which runs in pressed/early_command and set the preseed values with "debconf-set". The multiple values should be delimited with comma ","
The path of the configuration file which will be used to partition the disk for the node. For stateful osimages,two types of files are supported: "<partition file absolute path>" which contains a partitioning definition that will be inserted directly into the generated autoinst configuration file and must be formatted for the corresponding OS installer (e.g. kickstart for RedHat, autoyast for SLES, pressed for Ubuntu). "s:<partitioning script absolute path>" which specifies a shell script that will be run from the OS installer configuration file %pre section; the script must write the correct partitioning definition into the file /tmp/partitionfile on the node which will be included into the configuration file during the install process. For statelite osimages, partitionfile should specify "<partition file absolute path>"; see the xCAT Statelite documentation for the xCAT defined format of this configuration file.For Ubuntu, besides "<partition file absolute path>" or "s:<partitioning script absolute path>", the disk name(s) to partition must be specified in traditional, non-devfs format, delimited with space, it can be specified in 2 forms: "d:<the absolute path of the disk name file>" which contains the disk name(s) to partition and "s:d:<the absolute path of the disk script>" which runs in pressed/early_command and writes the disk names into the "/tmp/xcat.install_disk" . To support other specific partition methods such as RAID or LVM in Ubuntu, some additional preseed values should be specified, these values can be specified with "c:<the absolute path of the additional pressed config file>" which contains the additional pressed entries in "d-i ..." form and "s:c:<the absolute path of the additional pressed config script>" which runs in pressed/early_command and set the preseed values with "debconf-set". The multiple values should be delimited with comma ","

2
docs/source/guides/admin-guides/references/man5/mic.5.rst
View File

@@ -27,7 +27,7 @@ DESCRIPTION
***********
The host, slot id and configuraton of the mic (Many Integrated Core).
The host, slot id and configuration of the mic (Many Integrated Core).
***************

2
docs/source/guides/admin-guides/references/man5/monitoring.5.rst
View File

@@ -38,7 +38,7 @@ monitoring Attributes:
\ **name**\
The name of the mornitoring plug-in module. The plug-in must be put in /lib/perl/xCAT_monitoring/. See the man page for monstart for details.
The name of the monitoring plug-in module. The plug-in must be put in /opt/xcat/lib/perl/xCAT_monitoring/. See the man page for monstart for details.

2
docs/source/guides/admin-guides/references/man5/monsetting.5.rst
View File

@@ -38,7 +38,7 @@ monsetting Attributes:
\ **name**\
The name of the mornitoring plug-in module. The plug-in must be put in /lib/perl/xCAT_monitoring/. See the man page for monstart for details.
The name of the monitoring plug-in module. The plug-in must be put in /opt/xcat/lib/perl/xCAT_monitoring/. See the man page for monstart for details.

2
docs/source/guides/admin-guides/references/man5/mp.5.rst
View File

@@ -44,7 +44,7 @@ mp Attributes:
\ **mpa**\
The managment module used to control this blade.
The management module used to control this blade.

11
docs/source/guides/admin-guides/references/man5/mpa.5.rst
View File

@@ -63,9 +63,14 @@ mpa Attributes:
\ **slots**\
The number of available slots in the chassis. For PCM, this attribute is used to store the number of slots in the following format: <slot rows>,<slot columns>,<slot orientation> Where:
<slot rows> = number of rows of slots in chassis
<slot columns> = number of columns of slots in chassis
<slot orientation> = set to 0 if slots are vertical, and set to 1 if slots of horizontal
.. code-block:: perl
<slot rows> = number of rows of slots in chassis
<slot columns> = number of columns of slots in chassis
<slot orientation> = set to 0 if slots are vertical, and set to 1 if slots of horizontal

15
docs/source/guides/admin-guides/references/man5/nics.5.rst
View File

@@ -44,7 +44,8 @@ nics Attributes:
\ **nicips**\
Comma-separated list of IP addresses per NIC. To specify one ip address per NIC:
Comma-separated list of IP addresses per NIC.
To specify one ip address per NIC:
<nic1>!<ip1>,<nic2>!<ip2>,..., for example, eth0!10.0.0.100,ib0!11.0.0.100
To specify multiple ip addresses per NIC:
<nic1>!<ip1>|<ip2>,<nic2>!<ip1>|<ip2>,..., for example, eth0!10.0.0.100|fd55::214:5eff:fe15:849b,ib0!11.0.0.100|2001::214:5eff:fe15:849a. The xCAT object definition commands support to use nicips.<nicname> as the sub attributes.
@@ -57,7 +58,7 @@ nics Attributes:
Comma-separated list of hostname suffixes per NIC.
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!-eth0,ib0!-ib0
If multiple ip addresses are associcated with each NIC:
If multiple ip addresses are associated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6.
The xCAT object definition commands support to use nichostnamesuffixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnamesuffixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
@@ -69,7 +70,7 @@ nics Attributes:
Comma-separated list of hostname prefixes per NIC.
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!eth0-,ib0!ib-
If multiple ip addresses are associcated with each NIC:
If multiple ip addresses are associated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-.
The xCAT object definition commands support to use nichostnameprefixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnameprefixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
@@ -102,9 +103,9 @@ nics Attributes:
\ **nicaliases**\
Comma-separated list of hostname aliases for each NIC.
Format: eth0!<alias list>,eth1!<alias1 list>|<alias2 list>
For multiple aliases per nic use a space-separated list.
For example: eth0!moe larry curly,eth1!tom|jerry
Format: eth0!<alias list>,eth1!<alias1 list>|<alias2 list>
For multiple aliases per nic use a space-separated list.
For example: eth0!moe larry curly,eth1!tom|jerry
@@ -121,7 +122,7 @@ nics Attributes:
\ **nicdevices**\
Comma-separated list of NIC device per NIC, multiple ethernet devices can be bonded as bond device, these ethernet devices are separated by |. <nic1>!<dev1>|<dev3>,<nic2>!<dev2>, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices.<nicname> as the sub attributes.
Comma-separated list of NIC device per NIC, multiple ethernet devices can be bonded as bond device, these ethernet devices are separated by | . <nic1>!<dev1>|<dev3>,<nic2>!<dev2>, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices.<nicname> as the sub attributes.

2
docs/source/guides/admin-guides/references/man5/nodelist.5.rst
View File

@@ -50,7 +50,7 @@ nodelist Attributes:
\ **status**\
The current status of this node. This attribute will be set by xCAT software. Valid values: defined, booting, netbooting, booted, discovering, configuring, installing, alive, standingby, powering-off, unreachable. If blank, defined is assumed. The possible status change sequenses are: For installaton: defined->[discovering]->[configuring]->[standingby]->installing->booting->booted->[alive], For diskless deployment: defined->[discovering]->[configuring]->[standingby]->netbooting->booted->[alive], For booting: [alive/unreachable]->booting->[alive], For powering off: [alive]->powering-off->[unreachable], For monitoring: alive->unreachable. Discovering and configuring are for x Series dicovery process. Alive and unreachable are set only when there is a monitoring plug-in start monitor the node status for xCAT. Please note that the status values will not reflect the real node status if you change the state of the node from outside of xCAT (i.e. power off the node using HMC GUI).
The current status of this node. This attribute will be set by xCAT software. Valid values: defined, booting, netbooting, booted, discovering, configuring, installing, alive, standingby, powering-off, unreachable. If blank, defined is assumed. The possible status change sequences are: For installation: defined->[discovering]->[configuring]->[standingby]->installing->booting->booted->[alive], For diskless deployment: defined->[discovering]->[configuring]->[standingby]->netbooting->booted->[alive], For booting: [alive/unreachable]->booting->[alive], For powering off: [alive]->powering-off->[unreachable], For monitoring: alive->unreachable. Discovering and configuring are for x Series discovery process. Alive and unreachable are set only when there is a monitoring plug-in start monitor the node status for xCAT. Please note that the status values will not reflect the real node status if you change the state of the node from outside of xCAT (i.e. power off the node using HMC GUI).

17
docs/source/guides/admin-guides/references/man5/noderes.5.rst
View File

@@ -51,12 +51,17 @@ noderes Attributes:
\ **netboot**\
The type of network booting to use for this node. Valid values:
Arch OS valid netboot options
x86, x86_64 ALL pxe, xnba
ppc64 <=rhel6, <=sles11.3 yaboot
ppc64 >=rhels7, >=sles11.4 grub2,grub2-http,grub2-tftp
ppc64le NonVirtualize ALL petitboot
ppc64le PowerKVM Guest ALL grub2,grub2-http,grub2-tftp
.. code-block:: perl
Arch OS valid netboot options
x86, x86_64 ALL pxe, xnba
ppc64 <=rhel6, <=sles11.3 yaboot
ppc64 >=rhels7, >=sles11.4 grub2,grub2-http,grub2-tftp
ppc64le NonVirtualize ALL petitboot
ppc64le PowerKVM Guest ALL grub2,grub2-http,grub2-tftp

2
docs/source/guides/admin-guides/references/man5/osimage.5.rst
View File

@@ -122,7 +122,7 @@ osimage Attributes:
\ **postscripts**\
Comma separated list of scripts that should be run on this image after diskful installation or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute. See the site table runbootscripts attribute. Support will be added in the future for the postscripts attribute to run the scripts before the reboot in AIX.
Comma separated list of scripts that should be run on this image after diskful installation or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute. See the site table runbootscripts attribute.

2
docs/source/guides/admin-guides/references/man5/postscripts.5.rst
View File

@@ -44,7 +44,7 @@ postscripts Attributes:
\ **postscripts**\
Comma separated list of scripts that should be run on this node after diskful installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". xCAT automatically adds the postscripts from the xcatdefaults.postscripts attribute of the table to run first on the nodes after install or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute. Support will be added in the future for the postscripts attribute to run the scripts before the reboot in AIX.
Comma separated list of scripts that should be run on this node after diskful installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". xCAT automatically adds the postscripts from the xcatdefaults.postscripts attribute of the table to run first on the nodes after install or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute.

31
docs/source/guides/admin-guides/references/man5/prescripts.5.rst
View File

@@ -44,10 +44,9 @@ prescripts Attributes:
\ **begin**\
The scripts to be run at the beginning of the nodeset(Linux),
nimnodeset(AIX) or mkdsklsnode(AIX) command.
The scripts to be run at the beginning of the nodeset(Linux), nimnodeset(AIX) or mkdsklsnode(AIX) command.
The format is:
[action1:]s1,s2...[|action2:s3,s4,s5...]
[action1:]s1,s2...[| action2:s3,s4,s5...]
where:
- action1 and action2 for Linux are the nodeset actions specified in the command.
For AIX, action1 and action1 can be 'diskless' for mkdsklsnode command'
@@ -59,28 +58,20 @@ prescripts Attributes:
myscript1,myscript2 (all actions)
diskless:myscript1,myscript2 (AIX)
install:myscript1,myscript2|netboot:myscript3 (Linux)
.. code-block:: perl
All the scripts should be copied to /install/prescripts directory.
The following two environment variables will be passed to each script:
NODES a coma separated list of node names that need to run the script for
ACTION current nodeset action.
If '#xCAT setting:MAX_INSTANCE=number' is specified in the script, the script
will get invoked for each node in parallel, but no more than number of instances
will be invoked at at a time. If it is not specified, the script will be invoked
once for all the nodes.
All the scripts should be copied to /install/prescripts directory.
The following two environment variables will be passed to each script:
NODES a coma separated list of node names that need to run the script for
ACTION current nodeset action.
If '#xCAT setting:MAX_INSTANCE=number' is specified in the script, the script
will get invoked for each node in parallel, but no more than number of instances
will be invoked at at a time. If it is not specified, the script will be invoked
once for all the nodes.
\ **end**\
The scripts to be run at the end of the nodeset(Linux),
nimnodeset(AIX),or mkdsklsnode(AIX) command.
The format is the same as the 'begin' column.
The scripts to be run at the end of the nodeset(Linux), nimnodeset(AIX),or mkdsklsnode(AIX) command. The format is the same as the 'begin' column.

2
docs/source/guides/admin-guides/references/man5/routes.5.rst
View File

@@ -27,7 +27,7 @@ DESCRIPTION
***********
Describes the additional routes needed to be setup in the os routing table. These routes usually are used to connect the management node to the compute node using the servie node as gateway.
Describes the additional routes needed to be setup in the os routing table. These routes usually are used to connect the management node to the compute node using the service node as gateway.
******************

2
docs/source/guides/admin-guides/references/man5/site.5.rst
View File

@@ -307,7 +307,7 @@ site Attributes:
currently supported values:
'0': disable debug mode
'1': enable basic debug mode
'2': enalbe expert debug mode
'2': enable expert debug mode
For the details on 'basic debug mode' and 'expert debug mode',
please refer to xCAT documentation.

2
docs/source/guides/admin-guides/references/man5/statelite.5.rst
View File

@@ -50,7 +50,7 @@ statelite Attributes:
\ **statemnt**\
The persistant read/write area where a node's persistent files will be written to, e.g: 10.0.0.1/state/. The node name will be automatically added to the pathname, so 10.0.0.1:/state, will become 10.0.0.1:/state/<nodename>.
The persistent read/write area where a node's persistent files will be written to, e.g: 10.0.0.1/state/. The node name will be automatically added to the pathname, so 10.0.0.1:/state, will become 10.0.0.1:/state/<nodename>.

17
docs/source/guides/admin-guides/references/man5/storage.5.rst
View File

@@ -43,9 +43,14 @@ storage Attributes:
\ **osvolume**\
Specification of what storage to place the node OS image onto. Examples include:
localdisk (Install to first non-FC attached disk)
usbdisk (Install to first USB mass storage device seen)
wwn=0x50000393c813840c (Install to storage device with given WWN)
.. code-block:: perl
localdisk (Install to first non-FC attached disk)
usbdisk (Install to first USB mass storage device seen)
wwn=0x50000393c813840c (Install to storage device with given WWN)
@@ -93,9 +98,9 @@ storage Attributes:
\ **controller**\
The management address to attach/detach new volumes.
In the scenario involving multiple controllers, this data must be
passed as argument rather than by table value
The management address to attach/detach new volumes.
In the scenario involving multiple controllers, this data must be
passed as argument rather than by table value

6
docs/source/guides/admin-guides/references/man5/switches.5.rst
View File

@@ -56,7 +56,7 @@ switches Attributes:
\ **password**\
The password strinng for SNMPv3 or community string for SNMPv1/SNMPv2. Falls back to passwd table, and site snmpc value if using SNMPv1/SNMPv2.
The password string for SNMPv3 or community string for SNMPv1/SNMPv2. Falls back to passwd table, and site snmpc value if using SNMPv1/SNMPv2.
@@ -92,13 +92,13 @@ switches Attributes:
\ **protocol**\
Prorocol for running remote commands for the switch. The valid values are: ssh, telnet. ssh is the default. If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. The passwd.comments attribute is used for protocol.
Protocol for running remote commands for the switch. The valid values are: ssh, telnet. ssh is the default. If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. The passwd.comments attribute is used for protocol.
\ **switchtype**\
The type of switch. It is used to identify the file name that implements the functions for this swithc. The valid values are: Mellanox, Cisco, BNT and Juniper.
The type of switch. It is used to identify the file name that implements the functions for this switch. The valid values are: Mellanox, Cisco, BNT and Juniper.

8
docs/source/guides/admin-guides/references/man5/taskstate.5.rst
View File

@@ -19,7 +19,7 @@ SYNOPSIS
********
\ **taskstate Attributes:**\ \ *node*\ , \ *command*\ , \ *state*\ , \ *pid*\ , \ *reserve*\
\ **taskstate Attributes:**\ \ *node*\ , \ *command*\ , \ *state*\ , \ *pid*\ , \ *reserve*\ , \ *disable*\
***********
@@ -66,6 +66,12 @@ taskstate Attributes:
\ **disable**\
Set to 'yes' or '1' to comment out this row.
********
SEE ALSO

7
docs/source/guides/admin-guides/references/man5/vm.5.rst
View File

@@ -86,7 +86,7 @@ vm Attributes:
\ **cfgstore**\
Optional location for persistant storage separate of emulated hard drives for virtualization solutions that require persistant store to place configuration data
Optional location for persistent storage separate of emulated hard drives for virtualization solutions that require persistant store to place configuration data
@@ -128,7 +128,8 @@ vm Attributes:
\ **virtflags**\
General flags used by the virtualization method. For example, in Xen it could, among other things, specify paravirtualized setup, or direct kernel boot. For a hypervisor/dom0 entry, it is the virtualization method (i.e. "xen"). For KVM, the following flag=value pairs are recognized:
General flags used by the virtualization method.
For example, in Xen it could, among other things, specify paravirtualized setup, or direct kernel boot. For a hypervisor/dom0 entry, it is the virtualization method (i.e. "xen"). For KVM, the following flag=value pairs are recognized:
imageformat=[raw|fullraw|qcow2]
raw is a generic sparse file that allocates storage on demand
fullraw is a generic, non-sparse file that preallocates all space
@@ -190,7 +191,7 @@ vm Attributes:
\ **othersettings**\
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively,the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.

2
docs/source/guides/admin-guides/references/man5/vpd.5.rst
View File

@@ -62,7 +62,7 @@ vpd Attributes:
\ **asset**\
A field for administators to use to correlate inventory numbers they may have to accomodate
A field for administrators to use to correlate inventory numbers they may have to accommodate

14
docs/source/guides/admin-guides/references/man5/xcatdb.5.rst
View File

@@ -329,11 +329,7 @@ The tables are:
auditlog(5)|auditlog.5
.. code-block:: perl
Audit Data log.
Audit Data log.
@@ -441,13 +437,13 @@ kitrepo(5)|kitrepo.5
kvm_masterdata(5)|kvm_masterdata.5
Persistant store for KVM plugin for masters
Persistent store for KVM plugin for masters
kvm_nodedata(5)|kvm_nodedata.5
Persistant store for KVM plugin, not intended for manual modification.
Persistent store for KVM plugin, not intended for manual modification.
@@ -477,7 +473,7 @@ mac(5)|mac.5
mic(5)|mic.5
The host, slot id and configuraton of the mic (Many Integrated Core).
The host, slot id and configuration of the mic (Many Integrated Core).
@@ -645,7 +641,7 @@ rack(5)|rack.5
routes(5)|routes.5
Describes the additional routes needed to be setup in the os routing table. These routes usually are used to connect the management node to the compute node using the servie node as gateway.
Describes the additional routes needed to be setup in the os routing table. These routes usually are used to connect the management node to the compute node using the service node as gateway.

32
docs/source/guides/admin-guides/references/man7/boottarget.7.rst
View File

@@ -19,7 +19,7 @@ SYNOPSIS
********
\ **boottarget Attributes:**\ \ **\
\ **boottarget Attributes:**\ \ *bprofile*\ , \ *comments*\ , \ *initrd*\ , \ *kcmdline*\ , \ *kernel*\
***********
@@ -39,6 +39,36 @@ boottarget Attributes:
\ **bprofile**\ (boottarget.bprofile)
All nodes with a nodetype.profile value equal to this value and nodetype.os set to "boottarget", will use the associated kernel, initrd, and kcmdline.
\ **comments**\ (boottarget.comments)
Any user-written notes.
\ **initrd**\ (boottarget.initrd)
The initial ramdisk image that network boot actions should use (could be a DOS floppy or hard drive image if using memdisk as kernel)
\ **kcmdline**\ (boottarget.kcmdline)
Arguments to be passed to the kernel
\ **kernel**\ (boottarget.kernel)
The kernel that network boot actions should currently acquire and use. Note this could be a chained boot loader such as memdisk or a non-linux boot loader
********
SEE ALSO

6
docs/source/guides/admin-guides/references/man7/eventlog.7.rst
View File

@@ -107,11 +107,7 @@ eventlog Attributes:
\ **rawdata**\ (eventlog.rawdata)
.. code-block:: perl
The data that associated with the event.
The data that associated with the event.

340
docs/source/guides/admin-guides/references/man7/group.7.rst
View File

@@ -59,7 +59,7 @@ group Attributes:
\ **bmc**\ (ipmi.bmc)
The hostname of the BMC adapater.
The hostname of the BMC adapter.
@@ -71,87 +71,45 @@ group Attributes:
\ **bmcport**\ (ipmi.bmcport)
In systems with selectable shared/dedicated ethernet ports, this parameter can be used to specify the preferred port. 0 means use the shared port, 1 means dedicated, blank is to not assign.
.. code-block:: perl
In systems with selectable shared/dedicated ethernet ports,
this parameter can be used to specify the preferred port. 0
means use the shared port, 1 means dedicated, blank is to not
assign.
The following special cases exist for IBM System x servers:
For x3755 M3 systems, 0 means use the dedicated port, 1 means
shared, blank is to not assign.
For certain systems which have a mezzaine or ML2 adapter, there is a second
value to include:
For x3750 M4 (Model 8722):
0 2 1st 1Gbps interface for LOM
0 0 1st 10Gbps interface for LOM
0 3 2nd 1Gbps interface for LOM
0 1 2nd 10Gbps interface for LOM
For x3750 M4 (Model 8752), x3850/3950 X6, dx360 M4, x3550 M4, and x3650 M4:
0 Shared (1st onboard interface)
1 Dedicated
2 0 First interface on ML2 or mezzanine adapter
2 1 Second interface on ML2 or mezzanine adapter
2 2 Third interface on ML2 or mezzanine adapter
2 3 Fourth interface on ML2 or mezzanine adapter
@@ -267,7 +225,7 @@ group Attributes:
\ **dockerflag**\ (vm.othersettings)
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively,the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.
@@ -545,7 +503,7 @@ group Attributes:
\ **mpa**\ (mp.mpa)
The managment module used to control this blade.
The management module used to control this blade.
@@ -568,17 +526,12 @@ group Attributes:
.. code-block:: perl
Arch OS valid netboot options
x86, x86_64 ALL pxe, xnba
ppc64 <=rhel6, <=sles11.3 yaboot
ppc64 >=rhels7, >=sles11.4 grub2,grub2-http,grub2-tftp
ppc64le NonVirtualize ALL petitboot
ppc64le PowerKVM Guest ALL grub2,grub2-http,grub2-tftp
Arch OS valid netboot options
x86, x86_64 ALL pxe, xnba
ppc64 <=rhel6, <=sles11.3 yaboot
ppc64 >=rhels7, >=sles11.4 grub2,grub2-http,grub2-tftp
ppc64le NonVirtualize ALL petitboot
ppc64le PowerKVM Guest ALL grub2,grub2-http,grub2-tftp
@@ -598,142 +551,85 @@ group Attributes:
\ **nicaliases**\ (nics.nicaliases)
Comma-separated list of hostname aliases for each NIC.
.. code-block:: perl
Format: eth0!<alias list>,eth1!<alias1 list>|<alias2 list>
For multiple aliases per nic use a space-separated list.
For example: eth0!moe larry curly,eth1!tom|jerry
Format: eth0!<alias list>,eth1!<alias1 list>|<alias2 list>
For multiple aliases per nic use a space-separated list.
For example: eth0!moe larry curly,eth1!tom|jerry
\ **niccustomscripts**\ (nics.niccustomscripts)
Comma-separated list of custom scripts per NIC. <nic1>!<script1>,<nic2>!<script2>, e.g. eth0!configeth eth0, ib0!configib ib0. The xCAT object definition commands support to use niccustomscripts.<nicname> as the sub attribute
.
\ **nicdevices**\ (nics.nicdevices)
Comma-separated list of NIC device per NIC, multiple ethernet devices can be bonded as bond device, these ethernet devices are separated by |. <nic1>!<dev1>|<dev3>,<nic2>!<dev2>, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices.<nicname> as the sub attributes.
Comma-separated list of NIC device per NIC, multiple ethernet devices can be bonded as bond device, these ethernet devices are separated by | . <nic1>!<dev1>|<dev3>,<nic2>!<dev2>, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices.<nicname> as the sub attributes.
\ **nicextraparams**\ (nics.nicextraparams)
Comma-separated list of extra parameters that will be used for each NIC configuration.
.. code-block:: perl
If only one ip address is associated with each NIC:
<nic1>!<param1=value1 param2=value2>,<nic2>!<param3=value3>, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes.
If multiple ip addresses are associated with each NIC:
<nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
The xCAT object definition commands support to use nicextraparams.<nicname> as the sub attributes.
If only one ip address is associated with each NIC:
<nic1>!<param1=value1 param2=value2>,<nic2>!<param3=value3>, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes.
If multiple ip addresses are associated with each NIC:
<nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
The xCAT object definition commands support to use nicextraparams.<nicname> as the sub attributes.
\ **nichostnameprefixes**\ (nics.nichostnameprefixes)
Comma-separated list of hostname prefixes per NIC.
.. code-block:: perl
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!eth0-,ib0!ib-
If multiple ip addresses are associcated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-.
The xCAT object definition commands support to use nichostnameprefixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnameprefixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
Comma-separated list of hostname prefixes per NIC.
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!eth0-,ib0!ib-
If multiple ip addresses are associated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-.
The xCAT object definition commands support to use nichostnameprefixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnameprefixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
\ **nichostnamesuffixes**\ (nics.nichostnamesuffixes)
Comma-separated list of hostname suffixes per NIC.
.. code-block:: perl
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!-eth0,ib0!-ib0
If multiple ip addresses are associcated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6.
The xCAT object definition commands support to use nichostnamesuffixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnamesuffixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
Comma-separated list of hostname suffixes per NIC.
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!-eth0,ib0!-ib0
If multiple ip addresses are associated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6.
The xCAT object definition commands support to use nichostnamesuffixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnamesuffixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
\ **nicips**\ (nics.nicips)
Comma-separated list of IP addresses per NIC. To specify one ip address per NIC:
.. code-block:: perl
<nic1>!<ip1>,<nic2>!<ip2>,..., for example, eth0!10.0.0.100,ib0!11.0.0.100
To specify multiple ip addresses per NIC:
<nic1>!<ip1>|<ip2>,<nic2>!<ip1>|<ip2>,..., for example, eth0!10.0.0.100|fd55::214:5eff:fe15:849b,ib0!11.0.0.100|2001::214:5eff:fe15:849a. The xCAT object definition commands support to use nicips.<nicname> as the sub attributes.
Note: The primary IP address must also be stored in the hosts.ip attribute. The nichostnamesuffixes should specify one hostname suffix for each ip address.
Comma-separated list of IP addresses per NIC.
To specify one ip address per NIC:
<nic1>!<ip1>,<nic2>!<ip2>,..., for example, eth0!10.0.0.100,ib0!11.0.0.100
To specify multiple ip addresses per NIC:
<nic1>!<ip1>|<ip2>,<nic2>!<ip1>|<ip2>,..., for example, eth0!10.0.0.100|fd55::214:5eff:fe15:849b,ib0!11.0.0.100|2001::214:5eff:fe15:849a. The xCAT object definition commands support to use nicips.<nicname> as the sub attributes.
Note: The primary IP address must also be stored in the hosts.ip attribute. The nichostnamesuffixes should specify one hostname suffix for each ip address.
\ **nicnetworks**\ (nics.nicnetworks)
Comma-separated list of networks connected to each NIC.
.. code-block:: perl
If only one ip address is associated with each NIC:
<nic1>!<network1>,<nic2>!<network2>, for example, eth0!10_0_0_0-255_255_0_0, ib0!11_0_0_0-255_255_0_0
If multiple ip addresses are associated with each NIC:
<nic1>!<network1>|<network2>,<nic2>!<network1>|<network2>, for example, eth0!10_0_0_0-255_255_0_0|fd55:faaf:e1ab:336::/64,ib0!11_0_0_0-255_255_0_0|2001:db8:1:0::/64. The xCAT object definition commands support to use nicnetworks.<nicname> as the sub attributes.
If only one ip address is associated with each NIC:
<nic1>!<network1>,<nic2>!<network2>, for example, eth0!10_0_0_0-255_255_0_0, ib0!11_0_0_0-255_255_0_0
If multiple ip addresses are associated with each NIC:
<nic1>!<network1>|<network2>,<nic2>!<network1>|<network2>, for example, eth0!10_0_0_0-255_255_0_0|fd55:faaf:e1ab:336::/64,ib0!11_0_0_0-255_255_0_0|2001:db8:1:0::/64. The xCAT object definition commands support to use nicnetworks.<nicname> as the sub attributes.
\ **nicsadapter**\ (nics.nicsadapter)
Comma-separated list of extra parameters that will be used for each NIC configuration.
.. code-block:: perl
<nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
<nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
@@ -775,9 +671,7 @@ group Attributes:
.. code-block:: perl
localdisk (Install to first non-FC attached disk)
usbdisk (Install to first USB mass storage device seen)
wwn=0x50000393c813840c (Install to storage device with given WWN)
@@ -791,7 +685,7 @@ group Attributes:
\ **ou**\ (domain.ou)
For an LDAP described machine account (i.e. Active Directory), the orginaztional unit to place the system. If not set, defaults to cn=Computers,dc=your,dc=domain
For an LDAP described machine account (i.e. Active Directory), the organizational unit to place the system. If not set, defaults to cn=Computers,dc=your,dc=domain
@@ -857,7 +751,7 @@ group Attributes:
\ **postscripts**\ (postscripts.postscripts)
Comma separated list of scripts that should be run on this node after diskful installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". xCAT automatically adds the postscripts from the xcatdefaults.postscripts attribute of the table to run first on the nodes after install or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute. Support will be added in the future for the postscripts attribute to run the scripts before the reboot in AIX.
Comma separated list of scripts that should be run on this node after diskful installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". xCAT automatically adds the postscripts from the xcatdefaults.postscripts attribute of the table to run first on the nodes after install or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute.
@@ -875,73 +769,34 @@ group Attributes:
\ **prescripts-begin**\ (prescripts.begin)
The scripts to be run at the beginning of the nodeset(Linux),
.. code-block:: perl
nimnodeset(AIX) or mkdsklsnode(AIX) command.
The format is:
[action1:]s1,s2...[|action2:s3,s4,s5...]
where:
- action1 and action2 for Linux are the nodeset actions specified in the command.
For AIX, action1 and action1 can be 'diskless' for mkdsklsnode command'
and 'standalone for nimnodeset command.
- s1 and s2 are the scripts to run for action1 in order.
- s3, s4, and s5 are the scripts to run for actions2.
If actions are omitted, the scripts apply to all actions.
Examples:
myscript1,myscript2 (all actions)
diskless:myscript1,myscript2 (AIX)
install:myscript1,myscript2|netboot:myscript3 (Linux)
All the scripts should be copied to /install/prescripts directory.
The following two environment variables will be passed to each script:
NODES a coma separated list of node names that need to run the script for
ACTION current nodeset action.
If '#xCAT setting:MAX_INSTANCE=number' is specified in the script, the script
will get invoked for each node in parallel, but no more than number of instances
will be invoked at at a time. If it is not specified, the script will be invoked
once for all the nodes.
The scripts to be run at the beginning of the nodeset(Linux), nimnodeset(AIX) or mkdsklsnode(AIX) command.
The format is:
[action1:]s1,s2...[| action2:s3,s4,s5...]
where:
- action1 and action2 for Linux are the nodeset actions specified in the command.
For AIX, action1 and action1 can be 'diskless' for mkdsklsnode command'
and 'standalone for nimnodeset command.
- s1 and s2 are the scripts to run for action1 in order.
- s3, s4, and s5 are the scripts to run for actions2.
If actions are omitted, the scripts apply to all actions.
Examples:
myscript1,myscript2 (all actions)
diskless:myscript1,myscript2 (AIX)
install:myscript1,myscript2|netboot:myscript3 (Linux)
All the scripts should be copied to /install/prescripts directory.
The following two environment variables will be passed to each script:
NODES a coma separated list of node names that need to run the script for
ACTION current nodeset action.
If '#xCAT setting:MAX_INSTANCE=number' is specified in the script, the script
will get invoked for each node in parallel, but no more than number of instances
will be invoked at at a time. If it is not specified, the script will be invoked
once for all the nodes.
\ **prescripts-end**\ (prescripts.end)
The scripts to be run at the end of the nodeset(Linux),
.. code-block:: perl
nimnodeset(AIX),or mkdsklsnode(AIX) command.
The format is the same as the 'begin' column.
The scripts to be run at the end of the nodeset(Linux), nimnodeset(AIX),or mkdsklsnode(AIX) command. The format is the same as the 'begin' column.
@@ -965,7 +820,7 @@ group Attributes:
\ **protocol**\ (switches.protocol)
Prorocol for running remote commands for the switch. The valid values are: ssh, telnet. ssh is the default. If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. The passwd.comments attribute is used for protocol.
Protocol for running remote commands for the switch. The valid values are: ssh, telnet. ssh is the default. If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. The passwd.comments attribute is used for protocol.
@@ -1121,9 +976,7 @@ group Attributes:
.. code-block:: perl
<slot rows> = number of rows of slots in chassis
<slot columns> = number of columns of slots in chassis
<slot orientation> = set to 0 if slots are vertical, and set to 1 if slots of horizontal
@@ -1137,7 +990,7 @@ group Attributes:
\ **snmppassword**\ (switches.password)
The password strinng for SNMPv3 or community string for SNMPv1/SNMPv2. Falls back to passwd table, and site snmpc value if using SNMPv1/SNMPv2.
The password string for SNMPv3 or community string for SNMPv1/SNMPv2. Falls back to passwd table, and site snmpc value if using SNMPv1/SNMPv2.
@@ -1161,15 +1014,9 @@ group Attributes:
\ **storagcontroller**\ (storage.controller)
The management address to attach/detach new volumes.
.. code-block:: perl
In the scenario involving multiple controllers, this data must be
passed as argument rather than by table value
The management address to attach/detach new volumes.
In the scenario involving multiple controllers, this data must be
passed as argument rather than by table value
@@ -1217,7 +1064,7 @@ group Attributes:
\ **switchtype**\ (switches.switchtype)
The type of switch. It is used to identify the file name that implements the functions for this swithc. The valid values are: Mellanox, Cisco, BNT and Juniper.
The type of switch. It is used to identify the file name that implements the functions for this switch. The valid values are: Mellanox, Cisco, BNT and Juniper.
@@ -1313,7 +1160,7 @@ group Attributes:
\ **vmcfgstore**\ (vm.cfgstore)
Optional location for persistant storage separate of emulated hard drives for virtualization solutions that require persistant store to place configuration data
Optional location for persistent storage separate of emulated hard drives for virtualization solutions that require persistant store to place configuration data
@@ -1367,7 +1214,7 @@ group Attributes:
\ **vmothersetting**\ (vm.othersettings)
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively,the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.
@@ -1409,27 +1256,16 @@ group Attributes:
\ **vmvirtflags**\ (vm.virtflags)
General flags used by the virtualization method. For example, in Xen it could, among other things, specify paravirtualized setup, or direct kernel boot. For a hypervisor/dom0 entry, it is the virtualization method (i.e. "xen"). For KVM, the following flag=value pairs are recognized:
.. code-block:: perl
imageformat=[raw|fullraw|qcow2]
raw is a generic sparse file that allocates storage on demand
fullraw is a generic, non-sparse file that preallocates all space
qcow2 is a sparse, copy-on-write capable format implemented at the virtualization layer rather than the filesystem level
clonemethod=[qemu-img|reflink]
qemu-img allows use of qcow2 to generate virtualization layer copy-on-write
reflink uses a generic filesystem facility to clone the files on your behalf, but requires filesystem support such as btrfs
placement_affinity=[migratable|user_migratable|pinned]
General flags used by the virtualization method.
For example, in Xen it could, among other things, specify paravirtualized setup, or direct kernel boot. For a hypervisor/dom0 entry, it is the virtualization method (i.e. "xen"). For KVM, the following flag=value pairs are recognized:
imageformat=[raw|fullraw|qcow2]
raw is a generic sparse file that allocates storage on demand
fullraw is a generic, non-sparse file that preallocates all space
qcow2 is a sparse, copy-on-write capable format implemented at the virtualization layer rather than the filesystem level
clonemethod=[qemu-img|reflink]
qemu-img allows use of qcow2 to generate virtualization layer copy-on-write
reflink uses a generic filesystem facility to clone the files on your behalf, but requires filesystem support such as btrfs
placement_affinity=[migratable|user_migratable|pinned]

2
docs/source/guides/admin-guides/references/man7/monitoring.7.rst
View File

@@ -53,7 +53,7 @@ monitoring Attributes:
\ **name**\ (monitoring.name)
The name of the mornitoring plug-in module. The plug-in must be put in /lib/perl/xCAT_monitoring/. See the man page for monstart for details.
The name of the monitoring plug-in module. The plug-in must be put in /opt/xcat/lib/perl/xCAT_monitoring/. See the man page for monstart for details.

342
docs/source/guides/admin-guides/references/man7/node.7.rst
View File

@@ -71,7 +71,7 @@ node Attributes:
\ **bmc**\ (ipmi.bmc)
The hostname of the BMC adapater.
The hostname of the BMC adapter.
@@ -83,87 +83,45 @@ node Attributes:
\ **bmcport**\ (ipmi.bmcport)
In systems with selectable shared/dedicated ethernet ports, this parameter can be used to specify the preferred port. 0 means use the shared port, 1 means dedicated, blank is to not assign.
.. code-block:: perl
In systems with selectable shared/dedicated ethernet ports,
this parameter can be used to specify the preferred port. 0
means use the shared port, 1 means dedicated, blank is to not
assign.
The following special cases exist for IBM System x servers:
For x3755 M3 systems, 0 means use the dedicated port, 1 means
shared, blank is to not assign.
For certain systems which have a mezzaine or ML2 adapter, there is a second
value to include:
For x3750 M4 (Model 8722):
0 2 1st 1Gbps interface for LOM
0 0 1st 10Gbps interface for LOM
0 3 2nd 1Gbps interface for LOM
0 1 2nd 10Gbps interface for LOM
For x3750 M4 (Model 8752), x3850/3950 X6, dx360 M4, x3550 M4, and x3650 M4:
0 Shared (1st onboard interface)
1 Dedicated
2 0 First interface on ML2 or mezzanine adapter
2 1 Second interface on ML2 or mezzanine adapter
2 2 Third interface on ML2 or mezzanine adapter
2 3 Fourth interface on ML2 or mezzanine adapter
@@ -279,7 +237,7 @@ node Attributes:
\ **dockerflag**\ (vm.othersettings)
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively,the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.
@@ -545,7 +503,7 @@ node Attributes:
\ **mpa**\ (mp.mpa)
The managment module used to control this blade.
The management module used to control this blade.
@@ -568,17 +526,12 @@ node Attributes:
.. code-block:: perl
Arch OS valid netboot options
x86, x86_64 ALL pxe, xnba
ppc64 <=rhel6, <=sles11.3 yaboot
ppc64 >=rhels7, >=sles11.4 grub2,grub2-http,grub2-tftp
ppc64le NonVirtualize ALL petitboot
ppc64le PowerKVM Guest ALL grub2,grub2-http,grub2-tftp
Arch OS valid netboot options
x86, x86_64 ALL pxe, xnba
ppc64 <=rhel6, <=sles11.3 yaboot
ppc64 >=rhels7, >=sles11.4 grub2,grub2-http,grub2-tftp
ppc64le NonVirtualize ALL petitboot
ppc64le PowerKVM Guest ALL grub2,grub2-http,grub2-tftp
@@ -598,142 +551,85 @@ node Attributes:
\ **nicaliases**\ (nics.nicaliases)
Comma-separated list of hostname aliases for each NIC.
.. code-block:: perl
Format: eth0!<alias list>,eth1!<alias1 list>|<alias2 list>
For multiple aliases per nic use a space-separated list.
For example: eth0!moe larry curly,eth1!tom|jerry
Format: eth0!<alias list>,eth1!<alias1 list>|<alias2 list>
For multiple aliases per nic use a space-separated list.
For example: eth0!moe larry curly,eth1!tom|jerry
\ **niccustomscripts**\ (nics.niccustomscripts)
Comma-separated list of custom scripts per NIC. <nic1>!<script1>,<nic2>!<script2>, e.g. eth0!configeth eth0, ib0!configib ib0. The xCAT object definition commands support to use niccustomscripts.<nicname> as the sub attribute
.
\ **nicdevices**\ (nics.nicdevices)
Comma-separated list of NIC device per NIC, multiple ethernet devices can be bonded as bond device, these ethernet devices are separated by |. <nic1>!<dev1>|<dev3>,<nic2>!<dev2>, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices.<nicname> as the sub attributes.
Comma-separated list of NIC device per NIC, multiple ethernet devices can be bonded as bond device, these ethernet devices are separated by | . <nic1>!<dev1>|<dev3>,<nic2>!<dev2>, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices.<nicname> as the sub attributes.
\ **nicextraparams**\ (nics.nicextraparams)
Comma-separated list of extra parameters that will be used for each NIC configuration.
.. code-block:: perl
If only one ip address is associated with each NIC:
<nic1>!<param1=value1 param2=value2>,<nic2>!<param3=value3>, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes.
If multiple ip addresses are associated with each NIC:
<nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
The xCAT object definition commands support to use nicextraparams.<nicname> as the sub attributes.
If only one ip address is associated with each NIC:
<nic1>!<param1=value1 param2=value2>,<nic2>!<param3=value3>, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes.
If multiple ip addresses are associated with each NIC:
<nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
The xCAT object definition commands support to use nicextraparams.<nicname> as the sub attributes.
\ **nichostnameprefixes**\ (nics.nichostnameprefixes)
Comma-separated list of hostname prefixes per NIC.
.. code-block:: perl
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!eth0-,ib0!ib-
If multiple ip addresses are associcated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-.
The xCAT object definition commands support to use nichostnameprefixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnameprefixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
Comma-separated list of hostname prefixes per NIC.
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!eth0-,ib0!ib-
If multiple ip addresses are associated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-.
The xCAT object definition commands support to use nichostnameprefixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnameprefixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
\ **nichostnamesuffixes**\ (nics.nichostnamesuffixes)
Comma-separated list of hostname suffixes per NIC.
.. code-block:: perl
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!-eth0,ib0!-ib0
If multiple ip addresses are associcated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6.
The xCAT object definition commands support to use nichostnamesuffixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnamesuffixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
Comma-separated list of hostname suffixes per NIC.
If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!-eth0,ib0!-ib0
If multiple ip addresses are associated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6.
The xCAT object definition commands support to use nichostnamesuffixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnamesuffixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
\ **nicips**\ (nics.nicips)
Comma-separated list of IP addresses per NIC. To specify one ip address per NIC:
.. code-block:: perl
<nic1>!<ip1>,<nic2>!<ip2>,..., for example, eth0!10.0.0.100,ib0!11.0.0.100
To specify multiple ip addresses per NIC:
<nic1>!<ip1>|<ip2>,<nic2>!<ip1>|<ip2>,..., for example, eth0!10.0.0.100|fd55::214:5eff:fe15:849b,ib0!11.0.0.100|2001::214:5eff:fe15:849a. The xCAT object definition commands support to use nicips.<nicname> as the sub attributes.
Note: The primary IP address must also be stored in the hosts.ip attribute. The nichostnamesuffixes should specify one hostname suffix for each ip address.
Comma-separated list of IP addresses per NIC.
To specify one ip address per NIC:
<nic1>!<ip1>,<nic2>!<ip2>,..., for example, eth0!10.0.0.100,ib0!11.0.0.100
To specify multiple ip addresses per NIC:
<nic1>!<ip1>|<ip2>,<nic2>!<ip1>|<ip2>,..., for example, eth0!10.0.0.100|fd55::214:5eff:fe15:849b,ib0!11.0.0.100|2001::214:5eff:fe15:849a. The xCAT object definition commands support to use nicips.<nicname> as the sub attributes.
Note: The primary IP address must also be stored in the hosts.ip attribute. The nichostnamesuffixes should specify one hostname suffix for each ip address.
\ **nicnetworks**\ (nics.nicnetworks)
Comma-separated list of networks connected to each NIC.
.. code-block:: perl
If only one ip address is associated with each NIC:
<nic1>!<network1>,<nic2>!<network2>, for example, eth0!10_0_0_0-255_255_0_0, ib0!11_0_0_0-255_255_0_0
If multiple ip addresses are associated with each NIC:
<nic1>!<network1>|<network2>,<nic2>!<network1>|<network2>, for example, eth0!10_0_0_0-255_255_0_0|fd55:faaf:e1ab:336::/64,ib0!11_0_0_0-255_255_0_0|2001:db8:1:0::/64. The xCAT object definition commands support to use nicnetworks.<nicname> as the sub attributes.
If only one ip address is associated with each NIC:
<nic1>!<network1>,<nic2>!<network2>, for example, eth0!10_0_0_0-255_255_0_0, ib0!11_0_0_0-255_255_0_0
If multiple ip addresses are associated with each NIC:
<nic1>!<network1>|<network2>,<nic2>!<network1>|<network2>, for example, eth0!10_0_0_0-255_255_0_0|fd55:faaf:e1ab:336::/64,ib0!11_0_0_0-255_255_0_0|2001:db8:1:0::/64. The xCAT object definition commands support to use nicnetworks.<nicname> as the sub attributes.
\ **nicsadapter**\ (nics.nicsadapter)
Comma-separated list of extra parameters that will be used for each NIC configuration.
.. code-block:: perl
<nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
<nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
@@ -781,9 +677,7 @@ node Attributes:
.. code-block:: perl
localdisk (Install to first non-FC attached disk)
usbdisk (Install to first USB mass storage device seen)
wwn=0x50000393c813840c (Install to storage device with given WWN)
@@ -797,7 +691,7 @@ node Attributes:
\ **ou**\ (domain.ou)
For an LDAP described machine account (i.e. Active Directory), the orginaztional unit to place the system. If not set, defaults to cn=Computers,dc=your,dc=domain
For an LDAP described machine account (i.e. Active Directory), the organizational unit to place the system. If not set, defaults to cn=Computers,dc=your,dc=domain
@@ -863,7 +757,7 @@ node Attributes:
\ **postscripts**\ (postscripts.postscripts)
Comma separated list of scripts that should be run on this node after diskful installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". xCAT automatically adds the postscripts from the xcatdefaults.postscripts attribute of the table to run first on the nodes after install or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute. Support will be added in the future for the postscripts attribute to run the scripts before the reboot in AIX.
Comma separated list of scripts that should be run on this node after diskful installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". xCAT automatically adds the postscripts from the xcatdefaults.postscripts attribute of the table to run first on the nodes after install or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute.
@@ -881,73 +775,34 @@ node Attributes:
\ **prescripts-begin**\ (prescripts.begin)
The scripts to be run at the beginning of the nodeset(Linux),
.. code-block:: perl
nimnodeset(AIX) or mkdsklsnode(AIX) command.
The format is:
[action1:]s1,s2...[|action2:s3,s4,s5...]
where:
- action1 and action2 for Linux are the nodeset actions specified in the command.
For AIX, action1 and action1 can be 'diskless' for mkdsklsnode command'
and 'standalone for nimnodeset command.
- s1 and s2 are the scripts to run for action1 in order.
- s3, s4, and s5 are the scripts to run for actions2.
If actions are omitted, the scripts apply to all actions.
Examples:
myscript1,myscript2 (all actions)
diskless:myscript1,myscript2 (AIX)
install:myscript1,myscript2|netboot:myscript3 (Linux)
All the scripts should be copied to /install/prescripts directory.
The following two environment variables will be passed to each script:
NODES a coma separated list of node names that need to run the script for
ACTION current nodeset action.
If '#xCAT setting:MAX_INSTANCE=number' is specified in the script, the script
will get invoked for each node in parallel, but no more than number of instances
will be invoked at at a time. If it is not specified, the script will be invoked
once for all the nodes.
The scripts to be run at the beginning of the nodeset(Linux), nimnodeset(AIX) or mkdsklsnode(AIX) command.
The format is:
[action1:]s1,s2...[| action2:s3,s4,s5...]
where:
- action1 and action2 for Linux are the nodeset actions specified in the command.
For AIX, action1 and action1 can be 'diskless' for mkdsklsnode command'
and 'standalone for nimnodeset command.
- s1 and s2 are the scripts to run for action1 in order.
- s3, s4, and s5 are the scripts to run for actions2.
If actions are omitted, the scripts apply to all actions.
Examples:
myscript1,myscript2 (all actions)
diskless:myscript1,myscript2 (AIX)
install:myscript1,myscript2|netboot:myscript3 (Linux)
All the scripts should be copied to /install/prescripts directory.
The following two environment variables will be passed to each script:
NODES a coma separated list of node names that need to run the script for
ACTION current nodeset action.
If '#xCAT setting:MAX_INSTANCE=number' is specified in the script, the script
will get invoked for each node in parallel, but no more than number of instances
will be invoked at at a time. If it is not specified, the script will be invoked
once for all the nodes.
\ **prescripts-end**\ (prescripts.end)
The scripts to be run at the end of the nodeset(Linux),
.. code-block:: perl
nimnodeset(AIX),or mkdsklsnode(AIX) command.
The format is the same as the 'begin' column.
The scripts to be run at the end of the nodeset(Linux), nimnodeset(AIX),or mkdsklsnode(AIX) command. The format is the same as the 'begin' column.
@@ -977,7 +832,7 @@ node Attributes:
\ **protocol**\ (switches.protocol)
Prorocol for running remote commands for the switch. The valid values are: ssh, telnet. ssh is the default. If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. The passwd.comments attribute is used for protocol.
Protocol for running remote commands for the switch. The valid values are: ssh, telnet. ssh is the default. If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. The passwd.comments attribute is used for protocol.
@@ -1133,9 +988,7 @@ node Attributes:
.. code-block:: perl
<slot rows> = number of rows of slots in chassis
<slot columns> = number of columns of slots in chassis
<slot orientation> = set to 0 if slots are vertical, and set to 1 if slots of horizontal
@@ -1149,7 +1002,7 @@ node Attributes:
\ **snmppassword**\ (switches.password)
The password strinng for SNMPv3 or community string for SNMPv1/SNMPv2. Falls back to passwd table, and site snmpc value if using SNMPv1/SNMPv2.
The password string for SNMPv3 or community string for SNMPv1/SNMPv2. Falls back to passwd table, and site snmpc value if using SNMPv1/SNMPv2.
@@ -1173,7 +1026,7 @@ node Attributes:
\ **status**\ (nodelist.status)
The current status of this node. This attribute will be set by xCAT software. Valid values: defined, booting, netbooting, booted, discovering, configuring, installing, alive, standingby, powering-off, unreachable. If blank, defined is assumed. The possible status change sequenses are: For installaton: defined->[discovering]->[configuring]->[standingby]->installing->booting->booted->[alive], For diskless deployment: defined->[discovering]->[configuring]->[standingby]->netbooting->booted->[alive], For booting: [alive/unreachable]->booting->[alive], For powering off: [alive]->powering-off->[unreachable], For monitoring: alive->unreachable. Discovering and configuring are for x Series dicovery process. Alive and unreachable are set only when there is a monitoring plug-in start monitor the node status for xCAT. Please note that the status values will not reflect the real node status if you change the state of the node from outside of xCAT (i.e. power off the node using HMC GUI).
The current status of this node. This attribute will be set by xCAT software. Valid values: defined, booting, netbooting, booted, discovering, configuring, installing, alive, standingby, powering-off, unreachable. If blank, defined is assumed. The possible status change sequences are: For installation: defined->[discovering]->[configuring]->[standingby]->installing->booting->booted->[alive], For diskless deployment: defined->[discovering]->[configuring]->[standingby]->netbooting->booted->[alive], For booting: [alive/unreachable]->booting->[alive], For powering off: [alive]->powering-off->[unreachable], For monitoring: alive->unreachable. Discovering and configuring are for x Series discovery process. Alive and unreachable are set only when there is a monitoring plug-in start monitor the node status for xCAT. Please note that the status values will not reflect the real node status if you change the state of the node from outside of xCAT (i.e. power off the node using HMC GUI).
@@ -1185,15 +1038,9 @@ node Attributes:
\ **storagcontroller**\ (storage.controller)
The management address to attach/detach new volumes.
.. code-block:: perl
In the scenario involving multiple controllers, this data must be
passed as argument rather than by table value
The management address to attach/detach new volumes.
In the scenario involving multiple controllers, this data must be
passed as argument rather than by table value
@@ -1241,7 +1088,7 @@ node Attributes:
\ **switchtype**\ (switches.switchtype)
The type of switch. It is used to identify the file name that implements the functions for this swithc. The valid values are: Mellanox, Cisco, BNT and Juniper.
The type of switch. It is used to identify the file name that implements the functions for this switch. The valid values are: Mellanox, Cisco, BNT and Juniper.
@@ -1349,7 +1196,7 @@ node Attributes:
\ **vmcfgstore**\ (vm.cfgstore)
Optional location for persistant storage separate of emulated hard drives for virtualization solutions that require persistant store to place configuration data
Optional location for persistent storage separate of emulated hard drives for virtualization solutions that require persistant store to place configuration data
@@ -1403,7 +1250,7 @@ node Attributes:
\ **vmothersetting**\ (vm.othersettings)
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively,the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.
This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host.
@@ -1445,27 +1292,16 @@ node Attributes:
\ **vmvirtflags**\ (vm.virtflags)
General flags used by the virtualization method. For example, in Xen it could, among other things, specify paravirtualized setup, or direct kernel boot. For a hypervisor/dom0 entry, it is the virtualization method (i.e. "xen"). For KVM, the following flag=value pairs are recognized:
.. code-block:: perl
imageformat=[raw|fullraw|qcow2]
raw is a generic sparse file that allocates storage on demand
fullraw is a generic, non-sparse file that preallocates all space
qcow2 is a sparse, copy-on-write capable format implemented at the virtualization layer rather than the filesystem level
clonemethod=[qemu-img|reflink]
qemu-img allows use of qcow2 to generate virtualization layer copy-on-write
reflink uses a generic filesystem facility to clone the files on your behalf, but requires filesystem support such as btrfs
placement_affinity=[migratable|user_migratable|pinned]
General flags used by the virtualization method.
For example, in Xen it could, among other things, specify paravirtualized setup, or direct kernel boot. For a hypervisor/dom0 entry, it is the virtualization method (i.e. "xen"). For KVM, the following flag=value pairs are recognized:
imageformat=[raw|fullraw|qcow2]
raw is a generic sparse file that allocates storage on demand
fullraw is a generic, non-sparse file that preallocates all space
qcow2 is a sparse, copy-on-write capable format implemented at the virtualization layer rather than the filesystem level
clonemethod=[qemu-img|reflink]
qemu-img allows use of qcow2 to generate virtualization layer copy-on-write
reflink uses a generic filesystem facility to clone the files on your behalf, but requires filesystem support such as btrfs
placement_affinity=[migratable|user_migratable|pinned]

10
docs/source/guides/admin-guides/references/man7/osimage.7.rst
View File

@@ -261,7 +261,7 @@ osimage Attributes:
\ **otherpkglist**\ (linuximage.otherpkglist)
The fully qualified name of the file that stores non-distro package lists that will be included in the image. It could be set multiple paths.The multiple paths must be seperated by ",".
The fully qualified name of the file that stores non-distro package lists that will be included in the image. It could be set to multiple paths. The multiple paths must be separated by ",".
@@ -279,7 +279,7 @@ osimage Attributes:
\ **partitionfile**\ (linuximage.partitionfile, winimage.partitionfile)
The path of the configuration file which will be used to partition the disk for the node. For stateful osimages,two types of files are supported: "<partition file absolute path>" which contains a partitioning definition that will be inserted directly into the generated autoinst configuration file and must be formatted for the corresponding OS installer (e.g. kickstart for RedHat, autoyast for SLES, pressed for Ubuntu). "s:<partitioning script absolute path>" which specifies a shell script that will be run from the OS installer configuration file %pre section; the script must write the correct partitioning definition into the file /tmp/partitionfile on the node which will be included into the configuration file during the install process. For statelite osimages, partitionfile should specify "<partition file absolute path>"; see the xCAT Statelite documentation for the xCAT defined format of this configuration file.For Ubuntu, besides "<partition file absolute path>" or "s:<partitioning script absolute path>", the disk name(s) to partition must be specified in traditional, non-devfs format, delimited with space, it can be specified in 2 forms: "d:<the absolute path of the disk name file>" which contains the disk name(s) to partition and "s:d:<the absolute path of the disk script>" which runs in pressed/early_command and writes the disk names into the "/tmp/install_disk" . To support other specific partition methods such as RAID or LVM in Ubuntu, some additional preseed values should be specified, these values can be specified with "c:<the absolute path of the additional pressed config file>" which contains the additional pressed entries in "d-i ..." form and "s:c:<the absolute path of the additional pressed config script>" which runs in pressed/early_command and set the preseed values with "debconf-set". The multiple values should be delimited with comma ","
The path of the configuration file which will be used to partition the disk for the node. For stateful osimages,two types of files are supported: "<partition file absolute path>" which contains a partitioning definition that will be inserted directly into the generated autoinst configuration file and must be formatted for the corresponding OS installer (e.g. kickstart for RedHat, autoyast for SLES, pressed for Ubuntu). "s:<partitioning script absolute path>" which specifies a shell script that will be run from the OS installer configuration file %pre section; the script must write the correct partitioning definition into the file /tmp/partitionfile on the node which will be included into the configuration file during the install process. For statelite osimages, partitionfile should specify "<partition file absolute path>"; see the xCAT Statelite documentation for the xCAT defined format of this configuration file.For Ubuntu, besides "<partition file absolute path>" or "s:<partitioning script absolute path>", the disk name(s) to partition must be specified in traditional, non-devfs format, delimited with space, it can be specified in 2 forms: "d:<the absolute path of the disk name file>" which contains the disk name(s) to partition and "s:d:<the absolute path of the disk script>" which runs in pressed/early_command and writes the disk names into the "/tmp/xcat.install_disk" . To support other specific partition methods such as RAID or LVM in Ubuntu, some additional preseed values should be specified, these values can be specified with "c:<the absolute path of the additional pressed config file>" which contains the additional pressed entries in "d-i ..." form and "s:c:<the absolute path of the additional pressed config script>" which runs in pressed/early_command and set the preseed values with "debconf-set". The multiple values should be delimited with comma ","
or
@@ -295,7 +295,7 @@ osimage Attributes:
\ **pkgdir**\ (linuximage.pkgdir)
The name of the directory where the distro packages are stored. It could be set multiple paths.The multiple paths must be seperated by ",". The first path in the value of osimage.pkgdir must be the OS base pkg dir path, such as pkgdir=/install/rhels6.2/x86_64,/install/updates . In the os base pkg path, there are default repository data. And in the other pkg path(s), the users should make sure there are repository data. If not, use "createrepo" command to create them. For ubuntu, multiple mirrors can be specified in the pkgdir attribute, the mirrors must be prefixed by the protocol(http/ssh) and delimited with "," between each other.
The name of the directory where the distro packages are stored. It could be set to multiple paths. The multiple paths must be separated by ",". The first path in the value of osimage.pkgdir must be the OS base pkg dir path, such as pkgdir=/install/rhels6.2/x86_64,/install/updates . In the os base pkg path, there are default repository data. And in the other pkg path(s), the users should make sure there are repository data. If not, use "createrepo" command to create them. For ubuntu, multiple mirrors can be specified in the pkgdir attribute, the mirrors must be prefixed by the protocol(http/ssh) and delimited with "," between each other.
@@ -313,13 +313,13 @@ osimage Attributes:
\ **postinstall**\ (linuximage.postinstall)
The fully qualified name of the script file that will be run at the end of the genimage command. It could be set multiple paths.The multiple paths must be seperated by ",". It is used for diskless image only.
The fully qualified name of the script file that will be run at the end of the genimage command. It could be set to multiple paths. The multiple paths must be separated by ",". It is used for diskless image only.
\ **postscripts**\ (osimage.postscripts)
Comma separated list of scripts that should be run on this image after diskful installation or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute. See the site table runbootscripts attribute. Support will be added in the future for the postscripts attribute to run the scripts before the reboot in AIX.
Comma separated list of scripts that should be run on this image after diskful installation or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute. For AIX, use the postbootscripts attribute. See the site table runbootscripts attribute.

12
docs/source/guides/admin-guides/references/man8/mknb.8.rst
View File

@@ -27,14 +27,14 @@ DESCRIPTION
***********
The \ **mknb**\ command is run by xCAT automatically, when xCAT is installed on the management node.
The \ **mknb**\ command is run by xCAT automatically when xCAT is installed on the management node.
It creates a network boot root image (used for node discovery, BMC programming, and flashing)
for the same architecture that the management node is. So you normally do not need to run the \ **mknb**\
command yourself.
for the same architecture that the management node is. So you normally do not need to run the
\ **mknb**\ command yourself.
If you do run \ **mknb**\ to add custom utilities to your boot root image, and you have an xCAT Hierarchical Cluster with service nodes that each have a local /tftpboot directory (site sharedtftp=0), you will also need to copy the generated root image to each service node.
If you make custom changes to the network boot root image, you will need to run \ **mknb**\ again to regenerate the diskless image to include your changes. If you have an xCAT Hierarchical Cluster with Service Nodes having local /tftpboot directories (site.sharedtftp=0), you will need to copy the generated root image to each Service Node.
Presently, only the arch x86_64 is supported.
Presently, the architectures x86_64 and ppc64 are supported. For ppc64le, use the ppc64 architecture.
*******
@@ -45,7 +45,7 @@ OPTIONS
\ *arch*\
The hardware architecture for which to build the boot image: x86_64
The hardware architecture for which to build the boot image.

8
docs/source/guides/admin-guides/references/man8/nodeset.8.rst
View File

@@ -19,7 +19,7 @@ Name
****************
\ **nodeset**\ \ *noderange*\ [\ **boot**\ | \ **stat**\ | \ **iscsiboot**\ | \ **offline**\ | \ **runcmd=bmcsetup**\ | \ **osimage**\ [=\ *imagename*\ ] | \ **shell**\ | \ **shutdown**\ ]
\ **nodeset**\ \ *noderange*\ [\ **boot**\ | \ **stat**\ | \ **offline**\ | \ **runcmd=bmcsetup**\ | \ **osimage**\ [=\ *imagename*\ ] | \ **shell**\ | \ **shutdown**\ ]
\ **nodeset**\ \ *noderange*\ \ **osimage**\ [=\ *imagename*\ ] [\ **-**\ **-noupdateinitrd**\ ] [\ **-**\ **-ignorekernelchk**\ ]
@@ -50,7 +50,7 @@ Assume that /tftpboot is the root for tftpd (set in site(5)|site.5).
\ **nodeset**\ only sets the next boot state, but does not reboot.
\ **nodeset**\ is called by rinstall and winstall and is also called by the
\ **nodeset**\ is called by \ **rinstall**\ and \ **winstall**\ and is also called by the
installation process remotely to set the boot state back to "boot".
A user can supply their own scripts to be run on the mn or on the service node (if a hierarchical cluster) for a node when the nodeset command is run. Such scripts are called \ **prescripts**\ . They should be copied to /install/prescripts dirctory. A table called \ *prescripts*\ is used to specify the scripts and their associated actions. The scripts to be run at the beginning of the nodeset command are stored in the 'begin' column of \ *prescripts*\ table. The scripts to be run at the end of the nodeset command are stored in the 'end' column of \ *prescripts*\ table. You can run 'tabdump -d prescripts' command for details. The following two environment variables will be passed to each script: NODES contains all the names of the nodes that need to run the script for and ACTION contains the current nodeset action. If \ *#xCAT setting:MAX_INSTANCE=number*\ is specified in the script, the script will get invoked for each node in parallel, but no more than \ *number*\ of instances will be invoked at at a time. If it is not specified, the script will be invoked once for all the nodes.
@@ -82,8 +82,8 @@ A user can supply their own scripts to be run on the mn or on the service node (
\ **-**\ **-noupdateinitrd**\
Skip the rebuilding of initrd when the 'netdrivers', 'drvierupdatesrc' or 'osupdatename' were set for injecting new drviers to initrd. But, the geninitrd command
should be run to rebuild the initrd for new drivers injecting. This is used to improve the performance of nodeset command.
Skip the rebuilding of initrd when the 'netdrivers', 'drvierupdatesrc' or 'osupdatename' were set for injecting new drivers to initrd. But, the \ **geninitrd**\ command
should be run to rebuild the initrd for new drivers injecting. This is used to improve the performance of \ **nodeset**\ command.

62
docs/source/guides/admin-guides/references/man8/rinstall.8.rst
View File

@@ -19,7 +19,11 @@ Name
****************
\ **rinstall**\ [\ **-O | -**\ **-osimage**\ ] [\ **-c | -**\ **-console**\ ] [\ *noderange*\ ]
\ **rinstall**\ \ *noderange*\ \ **boot**\ | \ **shell**\ | \ **runcmd=bmcsetup**\ [\ **-c | -**\ **-console**\ ] [\ **-V | -**\ **-verbose**\ ]
\ **rinstall**\ \ *noderange*\ \ **osimage**\ =\ *imagename*\ | [\ **-O**\ ] \ *imagename*\ [\ **-**\ **-ignorekernelchk**\ ] [\ **-c | -**\ **-console**\ ] [\ **-u | -**\ **-uefimode**\ ] [\ **-V | -**\ **-verbose**\ ]
\ **rinstall**\ [\ **-h | -**\ **-help | -v | -**\ **-version**\ ]
*******************
@@ -27,9 +31,9 @@ Name
*******************
\ **rinstall**\ is a convenience command that will change tables as requested for operating system version, profile, and architecture, call \ **nodeset**\ to modify the network boot configuration, call \ **rsetboot**\ net to set the next boot over network (only support nodes with "nodetype.mgt=ipmi", for other nodes, make sure the correct boot order has been set before \ **rinstall**\ ), and \ **rpower**\ to begin a boot cycle.
\ **rinstall**\ is a convenience command to begin OS provision on a noderange(support nodes with "nodetype.mgt=ipmi,blade,hmc,ivm,fsp,kvm,esx,rhevm").
If [\ **-O | -**\ **-osimage**\ ] is specified or nodetype.provmethod=\ **osimage**\ is set, provision the noderange with the osimage specified/configured, ignore the table change options if specified.
If \ **osimage**\ =\ *imagename*\ | \ **-O**\ \ *imagename*\ is specified or nodetype.provmethod=\ **osimage**\ is set, provision the noderange with the osimage specified/configured.
If -c is specified, it will then run rcons on the node. This is allowed only if one node in the noderange. If need consoles on multiple nodes , see winstall(8)|winstall.8.
@@ -40,6 +44,44 @@ If -c is specified, it will then run rcons on the node. This is allowed only if
\ **boot**\
Instruct network boot loader to be skipped, generally meaning boot to hard disk
\ **osimage | osimage=**\ \ *imagename*\ |\ **-O**\ \ *imagename*\
Prepare server for installing a node using the specified os image. The os image is defined in the \ *osimage*\ table and \ *linuximage*\ table. If the <imagename> is omitted, the os image name will be obtained from \ *nodetype.provmethod*\ for the node.
\ **-**\ **-ignorekernelchk**\
Skip the kernel version checking when injecting drivers from osimage.driverupdatesrc. That means all drivers from osimage.driverupdatesrc will be injected to initrd for the specific target kernel.
\ **runimage**\ =\ *task*\
If you would like to run a task after deployment, you can define that task with this attribute.
\ **runcmd=bmcsetup**\
This instructs the node to boot to the xCAT nbfs environment and proceed to configure BMC
for basic remote access. This causes the IP, netmask, gateway, username, and password to be programmed according to the configuration table.
\ **shell**\
This instructs tho node to boot to the xCAT genesis environment, and present a shell prompt on console.
The node will also be able to be sshed into and have utilities such as wget, tftp, scp, nfs, and cifs. It will have storage drivers available for many common systems.
\ **-h | -**\ **-help**\
Display usage message.
@@ -52,15 +94,21 @@ If -c is specified, it will then run rcons on the node. This is allowed only if
\ **-O | -**\ **-osimage**\
\ **-u | -**\ **-uefimode**\
Specifies the osimage to provision.
For BMC-based servers, to specify the next boot mode to be "UEFI Mode".
\ **-V | -**\ **-Verbose**\
Verbose output.
\ **-c | -**\ **-console**\
Requests that rinstall runs rcons once the provision starts. This will only work if there is only one node in the noderange. See winstall(8)|winstall.8 for starting nsoles on multiple nodes.
Requests that rinstall runs rcons once the provision starts. This will only work if there is only one node in the noderange. See winstall(8)|winstall.8 for starting consoles on multiple nodes.
@@ -86,7 +134,7 @@ If -c is specified, it will then run rcons on the node. This is allowed only if
.. code-block:: perl
rinstall node1-node20 -O rhels6.4-ppc64-netboot-compute
rinstall node1-node20 osimage=rhels6.4-ppc64-netboot-compute

2
docs/source/guides/admin-guides/references/man8/tabprune.8.rst
View 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**\

79
docs/source/guides/admin-guides/references/man8/winstall.8.rst
View File

@@ -19,9 +19,11 @@ Name
****************
\ **winstall**\ [\ **-o | -**\ **-osver**\ ] [\ **-p | -**\ **-profile**\ ] [\ **-a | -**\ **-arch**\ ] [\ *noderange*\ ]
\ **rinstall**\ \ *noderange*\ \ **boot**\ | \ **shell**\ | \ **runcmd=bmcsetup**\ [\ **-c | -**\ **-console**\ ] [\ **-V | -**\ **-verbose**\ ]
\ **winstall**\ [\ **-O | -**\ **-osimage**\ ] [\ *noderange*\ ]
\ **rinstall**\ \ *noderange*\ \ **osimage**\ =\ *imagename*\ | [\ **-O**\ ] \ *imagename*\ [\ **-**\ **-ignorekernelchk**\ ] [\ **-c | -**\ **-console**\ ] [\ **-u | -**\ **-uefimode**\ ] [\ **-V | -**\ **-verbose**\ ]
\ **rinstall**\ [\ **-h | -**\ **-help | -v | -**\ **-version**\ ]
*******************
@@ -29,10 +31,9 @@ Name
*******************
\ **winstall**\ is a convenience tool that will change attributes as requested for operating system version, profile, and architecture, call \ **nodeset**\ to modify the network boot configuration, call \ **rsetboot**\ net to set the next boot over network (only support nodes
with "nodetype.mgt=ipmi", for other nodes, make sure the correct boot order has been set before \ **winstall**\ ), and \ **rpower**\ to begin a boot cycle.
\ **winstall**\ is a convenience command to begin OS provision on a noderange(support nodes with "nodetype.mgt=ipmi,blade,hmc,ivm,fsp,kvm,esx,rhevm").
If [\ **-O | -**\ **-osimage**\ ] is specified or nodetype.provmethod=\ *osimage*\ is set, provision the noderange with the osimage specified/configured, ignore the table change options if specified.
If \ **osimage**\ =\ *imagename*\ | \ **-O**\ \ *imagename*\ is specified or nodetype.provmethod=\ **osimage**\ is set, provision the noderange with the osimage specified/configured.
It will then run wcons on the nodes.
@@ -43,6 +44,44 @@ It will then run wcons on the nodes.
\ **boot**\
Instruct network boot loader to be skipped, generally meaning boot to hard disk
\ **osimage | osimage=**\ \ *imagename*\ |\ **-O**\ \ *imagename*\
Prepare server for installing a node using the specified os image. The os image is defined in the \ *osimage*\ table and \ *linuximage*\ table. If the <imagename> is omitted, the os image name will be obtained from \ *nodetype.provmethod*\ for the node.
\ **-**\ **-ignorekernelchk**\
Skip the kernel version checking when injecting drivers from osimage.driverupdatesrc. That means all drivers from osimage.driverupdatesrc will be injected to initrd for the specific target kernel.
\ **runimage**\ =\ *task*\
If you would like to run a task after deployment, you can define that task with this attribute.
\ **runcmd=bmcsetup**\
This instructs the node to boot to the xCAT nbfs environment and proceed to configure BMC
for basic remote access. This causes the IP, netmask, gateway, username, and password to be programmed according to the configuration table.
\ **shell**\
This instructs tho node to boot to the xCAT genesis environment, and present a shell prompt on console.
The node will also be able to be sshed into and have utilities such as wget, tftp, scp, nfs, and cifs. It will have storage drivers available for many common systems.
\ **-h | -**\ **-help**\
Display usage message.
@@ -55,27 +94,21 @@ It will then run wcons on the nodes.
\ **-o | -**\ **-osver**\
\ **-u | -**\ **-uefimode**\
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*\ .
For BMC-based servers, to specify the next boot mode to be "UEFI Mode".
\ **-p | -**\ **-profile**\
\ **-V | -**\ **-Verbose**\
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*\ .
Verbose output.
\ **-a | -**\ **-arch**\
\ **-c | -**\ **-console**\
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*\ .
\ **-O | -**\ **-osimage**\
Specifies the osimage to provision.
Requests that rinstall runs rcons once the provision starts. This will only work if there is only one node in the noderange. See winstall(8)|winstall.8 for starting consoles on multiple nodes.
@@ -96,17 +129,7 @@ It will then run wcons on the nodes.
2. Provision nodes 1 through 20, forcing rhels5.1 and compute profile.
.. code-block:: perl
winstall node1-node20 -o rhels5.1 -p compute
3. Provision nodes 1 through 20 with the osimage rhels6.4-ppc64-netboot-compute.
2. Provision nodes 1 through 20 with the osimage rhels6.4-ppc64-netboot-compute.
.. code-block:: perl

58
docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst
View File

@@ -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

2
docs/source/guides/install-guides/apt/update_xcat.rst
View File

@@ -3,6 +3,6 @@ Updating xCAT
If at a later date you want to update xCAT, first, update the software repositories and then run: ::
apt-get update
apt-get upgrade xcat
apt-get --only-upgrade install xcat*

238
docs/source/guides/install-guides/common/uninstall_xcat.rst
View File

@@ -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>`.

8
docs/source/guides/install-guides/common_sections.rst
View File

@@ -188,22 +188,22 @@ xCAT is started automatically after the installation, but the following commands
* start xCAT: ::
service xcatd start
[systemd] systemctl xcatd.service start
[systemd] systemctl start xcatd.service
* stop xCAT: ::
service xcatd stop
[systemd] systemctl xcatd.service stop
[systemd] systemctl stop xcatd.service
* restart xCAT: ::
service xcatd restart
[systemd] systemctl xcatd.service restart
[systemd] systemctl restart xcatd.service
* check xCAT status: ::
service xcatd status
[systemd] systemctl xcatd.service status
[systemd] systemctl status xcatd.service
.. END_verifying_xcat

Some files were not shown because too many files have changed in this diff Show More