diff --git a/docs/source/advanced/chain/chain_tasks.rst b/docs/source/advanced/chain/chain_tasks.rst index dc979ee71..4c840ef5f 100644 --- a/docs/source/advanced/chain/chain_tasks.rst +++ b/docs/source/advanced/chain/chain_tasks.rst @@ -11,7 +11,7 @@ Currently only the ``bmcsetup`` command is officially supplied by xCAT to run to runcmd=bmcsetup -**Note**: the command ``mknb `` is needed before reboot the node. +.. note:: The command ``mknb `` is needed before reboot the node. * runimage :: diff --git a/docs/source/advanced/confluent/server/confluent_server.rst b/docs/source/advanced/confluent/server/confluent_server.rst index 6bdecb832..8591055ee 100644 --- a/docs/source/advanced/confluent/server/confluent_server.rst +++ b/docs/source/advanced/confluent/server/confluent_server.rst @@ -56,7 +56,7 @@ The following example describes the steps for **rhels7.1** on **ppc64le**:: cd confluent-dep-rh7-ppc64le/ ./mklocalrepo.sh -**Note:** If the OS/architecture you are looking for is not provided under confluent-dep, send an email to the xcat-user mailing list: xcat-user@lists.sourceforge.net +.. note:: If the OS/architecture you are looking for is not provided under confluent-dep, send an email to the xcat-user mailing list: xcat-user@lists.sourceforge.net Install diff --git a/docs/source/advanced/docker/docker_registry.rst b/docs/source/advanced/docker/docker_registry.rst index 920629dc8..591f20d49 100644 --- a/docs/source/advanced/docker/docker_registry.rst +++ b/docs/source/advanced/docker/docker_registry.rst @@ -5,7 +5,7 @@ Docker Registry is a stateless, highly scalable server side application that sto This document describes how to set up a local private docker registry on Ubuntu 15.04 on x86_64. -**Note:** Ensure that docker registry is not already set up on this docker host. +.. note:: Ensure that docker registry is not already set up on this docker host. Setting Up Docker Host ---------------------- diff --git a/docs/source/advanced/docker/dockerized_xcat/setup_docker_host.rst b/docs/source/advanced/docker/dockerized_xcat/setup_docker_host.rst index 6ba2218cb..9ce4aa4e1 100644 --- a/docs/source/advanced/docker/dockerized_xcat/setup_docker_host.rst +++ b/docs/source/advanced/docker/dockerized_xcat/setup_docker_host.rst @@ -6,10 +6,7 @@ Install Docker Engine The Docker host to run xCAT Docker image should be a baremental or virtual server with Docker v1.10 or above installed. For the details on system requirements and Docker installation, refer to `Docker Installation Docs `_. -**Note:** - -1. **Docker image** can only run on **Docker host** with the same architecture. Since xCAT currently only ships x86_64 and ppc64le Docker images, running xCAT in Docker requires x86_64 or ppc64le **Docker hosts**. - +.. note:: Docker images can only run on Docker hosts with the same architecture. Since xCAT only ships x86_64 and ppc64le Docker images, running xCAT in Docker requires x86_64 or ppc64 Docker Hosts. Shutdown the SELinux/Apparmor on Docker host -------------------------------------------- diff --git a/docs/source/advanced/docker/lifecycle_management.rst b/docs/source/advanced/docker/lifecycle_management.rst index 869b57da9..9f7b8db7c 100644 --- a/docs/source/advanced/docker/lifecycle_management.rst +++ b/docs/source/advanced/docker/lifecycle_management.rst @@ -5,7 +5,15 @@ The Docker linux container technology is currently very popular. xCAT can help m This document describes how to use xCAT for docker management, from Docker Host setup to docker container operations. -**Note:** The document was verified with **Docker Version 1.10, 1.11** and **Docker API version 1.22.** The Docker Host was verified on **ubuntu14.04.3 x86_64**, **ubuntu15.10 x86_64**, **ubuntu16.04 x86_64** and **ubuntu16.04 ppc64el**. +.. note:: This document was verified with: + * Docker Version 1.10, 1.11 + * Docker API version 1.22 + + Docker Host has been verified on the following OS/ARCH combinations: + * Ubuntu 14.04.3,x86_64 + * Ubuntu 15.10,x86_64 + * Ubuntu 16.04,x86_64 + * Ubuntu 16.04,ppc64el Setting up Docker Host diff --git a/docs/source/advanced/domain_name_resolution/domain_name_resolution.rst b/docs/source/advanced/domain_name_resolution/domain_name_resolution.rst index 7311f53ae..6009eb083 100644 --- a/docs/source/advanced/domain_name_resolution/domain_name_resolution.rst +++ b/docs/source/advanced/domain_name_resolution/domain_name_resolution.rst @@ -30,7 +30,7 @@ Use the ``mkdef`` command to add additional networks to the xCAT database. (See mkdef -t network clusternet net=11.0.0.0 mask=255.255.0.0 gateway=11.0.0.254 domain=app.cluster.com -Note: The ``makedns`` command (mentioned below) will only add nodes into the DNS configuration if the network for the node is defined. +.. note:: The ``makedns`` command (mentioned below) will only add nodes into the DNS configuration if the network for the node is defined. If you want to use a different hostname domain or a different set of nameservers for nodes that are on a particular network, set those attributes in the corresponding network object: :: @@ -71,7 +71,7 @@ and the following entries will be added to **/etc/hosts**: :: This information is used by the ``makehosts`` command to add the additional interface hostnames etc. to the **/etc/hosts** file. It is also used by xCAT adapter configuration postscripts to automatically configure the additional network interfaces on the node. See the section (refer to :ref:`specifying_additional_network_interfaces_for_cluster_nodes` ). -Note that it is a convention of xCAT that for Linux systems the short hostname is the primary hostname for the node, and the long hostname is an alias. To have the long hostname be the primary hostname, you can use the -l option on the makehosts command. +.. note:: It is a convention of xCAT that for Linux systems the short hostname is the primary hostname for the node, and the long hostname is an alias. To have the long hostname be the primary hostname, you can use the -l option on the ``makehosts`` command. Preparing for Using a DNS ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -207,7 +207,7 @@ For example: :: The **** keyword will be interpreted as the value of the **** attribute of the node definition. The **** value for a node is the name of it's server as known by the node. This would be either the cluster-facing name of the service node or the cluster-facing name of the management node. -Note: for Linux, the site **nameservers** value must be set to **** before you run ``makedhcp``. +.. note:: The site **nameservers** value must be set to **** before you run ``makedhcp``. Make sure that the DNS service on the service nodes will be set up by xCAT. @@ -293,7 +293,7 @@ Setting individual nic attribute values The nic attribute values may be set using the ``chdef`` or ``mkdef`` commands. You can specify the nic* values when creating an xCAT node definition with ``mkdef`` or you can update an existing node definition using ``chdef``. -Note: ``chdef`` does not support using the "-m" and "-p" options to modify the nic* attributes. +.. note:: ``chdef`` does not support using the "-m" and "-p" options to modify the nic* attributes. nicips example: :: @@ -311,7 +311,7 @@ This value indicates that the hostname for **"eth1"** should be **"compute02-eth The suffixes provided may be any string that will conform to the DNS naming rules. -Important 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. +.. warning:: 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. nictypes example: :: diff --git a/docs/source/advanced/gpu/nvidia/management.rst b/docs/source/advanced/gpu/nvidia/management.rst index 38f28df0b..057c625e7 100644 --- a/docs/source/advanced/gpu/nvidia/management.rst +++ b/docs/source/advanced/gpu/nvidia/management.rst @@ -9,9 +9,7 @@ Example: :: node01: Tesla K80, 0322415075970, GPU-b4f79b83-c282-4409-a0e8-0da3e06a13c3 ... - - -**Note: The following commands are provided as convenience.** *Always consult the nvidia-smi manpage for the latest supported functions.* +.. warning:: The following commands are provided as convenience. Always consult the ``nvidia-smi`` manpage for the latest supported functions. Management ---------- diff --git a/docs/source/advanced/hamn/setup_ha_mgmt_node_with_shared_data.rst b/docs/source/advanced/hamn/setup_ha_mgmt_node_with_shared_data.rst index 5a2d7ae3f..a694ad0d6 100644 --- a/docs/source/advanced/hamn/setup_ha_mgmt_node_with_shared_data.rst +++ b/docs/source/advanced/hamn/setup_ha_mgmt_node_with_shared_data.rst @@ -46,7 +46,7 @@ You need to substitute the hostnames and ip address with your own values when se Configuring Shared Data ======================= -``Note``: Shared data itself needs high availability also, the shared data should not become a single point of failure. +.. note:: Shared data itself needs high availability also, the shared data should not become a single point of failure. The configuration procedure will be quite different based on the shared data mechanism that will be used. Configuring these shared data mechanisms is beyond the scope of this documentation. After the shared data mechanism is configured, the following xCAT directory structure should be on the shared data, if this is done before xCAT is installed, you need to create the directories manually; if this is done after xCAT is installed, the directories need to be copied to the shared data. :: @@ -57,7 +57,10 @@ The configuration procedure will be quite different based on the shared data mec /tftpboot -``Note``:For MySQL, the database directory is ``/var/lib/mysql``; for PostGreSQL, the database directory is ``/var/lib/pgsql``; for DB2, the database directory is specified with the site attribute databaseloc; for sqlite, the database directory is /etc/xcat, already listed above. +.. note:: * For MySQL, the database directory is ``/var/lib/mysql`` + * For PostGreSQL, the database directory is ``/var/lib/pgsql`` + * For DB2, the database directory is specified with the site attribute ``databaseloc`` + * For SQLite, the database directory is ``/etc/xcat`` Here is an example of how to make directories be shared data through NFS: :: @@ -67,7 +70,6 @@ Here is an example of how to make directories be shared data through NFS: :: mount -o rw :/dir4 / mount -o rw :/dir5 /tftpboot -``Note``: if you need to setup high availability for some other applications, like the HPC software stack, between the two xCAT management nodes, the applications data should be on the shared data. Setup xCAT on the Primary Management Node ========================================= @@ -260,9 +262,7 @@ Besides the files mentioned above, there may be some additional customization fi /etc/inittab (and more) -``Note``: -If the IBM HPC software stack is configured in your environment, execute additional steps required to copy additional data or configuration files for HAMN setup. -The dhcpsd.cnf should be synchronized between the primary management node and standby management node only when the DHCP configuration on the two management nodes are exactly the same. +.. note:: If the IBM HPC software stack is configured in your environment, execute additional steps required to copy additional data or configuration files for HAMN setup. The ``dhcpsd.cnf`` should be synchronized between the primary management node and standby management node only when the DHCP configuration on the two management nodes are exactly the same. Cluster Maintenance Considerations ================================== @@ -275,7 +275,7 @@ The standby management node should be taken into account when doing any maintena #. Reboot management nodes - In the primary management node needs to be rebooted, since the daemons are set to not auto start at boot time, and the shared data will not be mounted automatically, you should mount the shared data and start the daemons manually. -``Note``: after software upgrade, some services that were set to not autostart on boot might be started by the software upgrade process, or even set to autostart on boot, the admin should check the services on both primary and standby management node, if any of the services are set to autostart on boot, turn it off; if any of the services are started on the backup management node, stop the service. +.. note:: After software upgrade, some services that were set to not autostart on boot might be started by the software upgrade process, or even set to autostart on boot, the admin should check the services on both primary and standby management node, if any of the services are set to autostart on boot, turn it off; if any of the services are started on the backup management node, stop the service. At this point, the HA MN Setup is complete, and customer workloads and system administration can continue on the primary management node until a failure occurs. The xcatdb and files on the standby management node will continue to be synchronized until such a failure occurs. @@ -306,7 +306,7 @@ Here is an example of how to use this script: :: /opt/xcat/share/xcat/hamn/deactivate-mn -i eth1:2 -v 9.114.47.97 -**Notes**: This script will be over-written after xCAT is upgraded. If this script is customized, make sure backup it before upgrading xCAT. +.. warning:: This script will be over-written after xCAT is upgraded. If this script is customized, make sure to back it up before upgrading xCAT. On the current primary management node: @@ -317,13 +317,13 @@ If the management node is still available and running the cluster, perform the f rmhwconn cec,frame rmhwconn cec,frame -T fnm -#. Stop the xCAT daemon. - - ``Note``: xCAT must be stopped on all Service Nodes also, and LL if using the database. :: +#. Stop the xCAT daemon. :: service xcatd stop service dhcpd stop + .. note:: xCAT must be stopped on all Service Nodes as well. + #. unexport the xCAT NFS directories The exported xCAT NFS directories will prevent the shared data partitions from being unmounted, so the exported xCAT NFS directories should be unmounted before failover: :: @@ -372,7 +372,7 @@ Here is an example of how to use this script to make the machine be a primary ma /opt/xcat/share/xcat/hamn/activate-mn -i eth1:2 -v 9.114.47.97 -m 255.255.255.0 -**Notes**: This script will be over-written after xCAT is upgraded. If this script is customized, make sure backup it before upgrading xCAT. +.. warning:: This script will be over-written after xCAT is upgraded. If this script is customized, make sure to back it up before upgrading xCAT. On the new primary management node: @@ -509,7 +509,7 @@ The operating system is installed on the internal disks. If you place entries for the disk in ``/etc/fstab``, which is not required, ensure that the entries do not have the system automatically mount the disk. - ``Note``: Since the file systems will not be mounted automatically during system reboot, it implies that you need to manually mount the file systems after the primary management node reboot. Before mounting the file systems, stop xcat daemon first; after the file systems are mounted, start xcat daemon. + .. note:: Since the file systems will not be mounted automatically during system reboot this must be manually done and xCAT should be started **after** the filesystem is mounted. #. Verify the file systems on the primary management node. diff --git a/docs/source/advanced/hierarchy/provision/diskful_sn.rst b/docs/source/advanced/hierarchy/provision/diskful_sn.rst index e882a50b1..552d0f39a 100644 --- a/docs/source/advanced/hierarchy/provision/diskful_sn.rst +++ b/docs/source/advanced/hierarchy/provision/diskful_sn.rst @@ -6,7 +6,7 @@ Diskful (Stateful) Installation Any cluster using statelite compute nodes must use a stateful (diskful) Service Nodes. -**Note:** All xCAT Service Nodes must be at the exact same xCAT version as the xCAT Management Node. +.. note:: All xCAT Service Nodes must be at the exact same xCAT version as the xCAT Management Node. Configure ``otherpkgdir`` and ``otherpkglist`` for service node osimage ----------------------------------------------------------------------- @@ -50,7 +50,7 @@ Configure ``otherpkgdir`` and ``otherpkglist`` for service node osimage xcat/xcat-dep/rh7/x86_64/perl-Net-Telnet xcat/xcat-dep/rh7/x86_64/perl-Expect -**Note:** you will be installing the xCAT Service Node rpm xCATsn meta-package on the Service Node, not the xCAT Management Node meta-package. Do not install both. +.. note:: You will be installing the xCAT Service Node RPM ``xCATsn`` on the Service Node, not the xCAT Management Node RPM. Do not install both. Update the rhels6 RPM repository (rhels6 only) ---------------------------------------------- @@ -87,7 +87,7 @@ Update the rhels6 RPM repository (rhels6 only) createrepo \ -g repodata /98462d05248098ef1724eddb2c0a127954aade64d4bb7d4e693cff32ab1e463c-comps-rhel6-Server.xml -**Note:** you should use ``comps-rhel6-Server.xml`` with its key as the group file. +.. note:: You should use ``comps-rhel6-Server.xml`` with its key as the group file. Install Service Nodes --------------------- @@ -109,12 +109,7 @@ Watch the installation progress using either wcons or rcons: :: rcons tail -f /var/log/messages -Note: We have experienced one problem while trying to install RHEL6 diskful -Service Node working with SAS disks. The Service Node cannot reboots from SAS -disk after the RHEL6 operating system has been installed. We are waiting for -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. +.. note:: We have experienced one problem while trying to install RHEL6 diskful Service Node working with SAS disks. The Service Node cannot reboots from SAS disk after the RHEL6 operating system has been installed. We are waiting for 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 Diskful Image --------------------------------- diff --git a/docs/source/advanced/hierarchy/provision/diskless_sn.rst b/docs/source/advanced/hierarchy/provision/diskless_sn.rst index 95abb79e6..8825a1ad1 100644 --- a/docs/source/advanced/hierarchy/provision/diskless_sn.rst +++ b/docs/source/advanced/hierarchy/provision/diskless_sn.rst @@ -3,7 +3,7 @@ Diskless (Stateless) Installation ================================= -**Note: The stateless Service Node is not supported in ubuntu hierarchy cluster. For ubuntu, skip this section.** +.. note:: The stateless Service Node is not supported in Ubunti hierarchy cluster. For Ubunti, skip this section. If you want, your Service Nodes can be stateless (diskless). The Service Node must contain not only the OS, but also the xCAT software and its dependencies. @@ -56,7 +56,7 @@ When you run ``copycds``, xCAT will only create a Service Node stateful osimage postinstall rootimgdir - 1, Create the exlist, pkglist and otherpkglist file. +#. Create the exlist, pkglist and otherpkglist file. xCAT ships a basic requirements lists that will create a fully functional Service Node. However, you may want to customize your service node by adding additional operating system packages or modifying the files excluded by the exclude list. Check the below files to see if it meets your needs. :: @@ -95,9 +95,9 @@ When you run ``copycds``, xCAT will only create a Service Node stateful osimage xcat/xcat-dep/rh7/ppc64le/perl-Net-Telnet xcat/xcat-dep/rh7/ppc64le/perl-Expect - **Note:** you will be installing the xCAT Service Node rpm xCATsn meta-package on the Service Node, not the xCAT Management Node meta-package. Do not install both. +.. note:: You will be installing the xCAT Service Node RPM ``xCATsn`` on the Service Node, not the xCAT Management Node RPM. Do not install both. - 2, Create the postinstall script. +#. Create the postinstall script. xCAT ships a default postinstall script for stateless Service Node. You may also choose to create an appropriate /etc/fstab file in your Service Node image. : @@ -116,7 +116,7 @@ When you run ``copycds``, xCAT will only create a Service Node stateful osimage none /tmp tmpfs defaults,size=10m 0 2 none /var/tmp tmpfs defaults,size=10m 0 2 - 3, Modify the Service Node osimage definition with given attributes. +#. Modify the Service Node osimage definition with given attributes. :: diff --git a/docs/source/advanced/migration/migration.rst b/docs/source/advanced/migration/migration.rst index c93902f58..46d84c6af 100644 --- a/docs/source/advanced/migration/migration.rst +++ b/docs/source/advanced/migration/migration.rst @@ -26,7 +26,7 @@ Backup xCAT management node data to backup server: ~/.xcat /etc/xcat - **Notes**: backing up ``~/.xcat`` is for all users who have xCAT client certs. + .. note:: Backing up ``~/.xcat`` is for all users who have xCAT client certs. #. If there are customized files and directories for ``otherpkgdir``, ``pkgdir``, ``pkglist`` or ``template`` in some `osimage` definitions, backup these files and directories. for example: :: diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst index 39f523947..0efb5d793 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst @@ -3,10 +3,9 @@ By default, xCAT will install the operating system on the first disk and with default partitions layout in the node. However, you may choose to customize the disk partitioning during the install process and define a specific disk layout. You can do this in one of two ways: '**partition definition file**' or '**partition definition script**'. **Notes** +.. note:: ``partition definition file`` can be used for RedHat, SLES, and Ubuntu. Because disk configuraiton for Ubuntu is different from RedHat, there may be some special sections required for Ubuntu. -- 'Partition definition file' way can be used for RedHat, SLES and Ubuntu. -- 'partition definition script' way was tested only for RedHat and Ubuntu, use this feature on SLES at your own risk. -- Because disk configuration for ubuntu is different from RedHat, there maybe some section special for ubuntu. +.. warning:: ``partition definition script`` has only been tested on RedHat and Ubuntu, use at your own risk for SLES. .. END_Overview