From 30dc706ece928cf4e9afbeee76e10dcaa41435d8 Mon Sep 17 00:00:00 2001 From: huweihua Date: Tue, 27 Oct 2015 03:55:14 -0400 Subject: [PATCH 1/8] add doc for uninstall xcat --- .../install-guides/common/uninstall_xcat.rst | 133 ++++++++++++++++++ docs/source/guides/install-guides/index.rst | 1 + 2 files changed, 134 insertions(+) create mode 100644 docs/source/guides/install-guides/common/uninstall_xcat.rst diff --git a/docs/source/guides/install-guides/common/uninstall_xcat.rst b/docs/source/guides/install-guides/common/uninstall_xcat.rst new file mode 100644 index 000000000..8581dca18 --- /dev/null +++ b/docs/source/guides/install-guides/common/uninstall_xcat.rst @@ -0,0 +1,133 @@ +Uninstall xCAT +============== + +Removing xCAT Trace +------------------- + +1. Backup your xCAT database ( if you want to keep it) :: + + dumpxCATdb -p + +2. Save your node information + + To create a stanza file of your node definitions (all group), run the following :: + + lsdef -z all > .stanza + +3. Save your networks information + + To create a stanza file of your network information, run the following :: + + lsdef -z -t network -l > .stanza + +4. Clean up tftpboot + + To clean up the node information in tftpboot :: + + nodeset all offline + +5. Cleanup dhcp + + You may want to remove all nodes from dhcp :: + + makedhcp -d + +6. Clean up ``/etc/hosts`` + + You may want to remove you cluster nodes from ``/etc/hosts``, you can edit ``/etc/hosts`` by 'vi' directly, or using xCAT command ``tabedit`` to remove all the nodes from the hosts table :: + + tabedit hosts + +7. Removing nodes from DNS + + After removing all the nodes from ``/etc/hosts`` and the ``hosts`` table :: + + makedns -n + +8. Stop xcatd :: + + service xcatd stop + +9. Clean up network 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. + +Removing xCAT RPMs +------------------ + +1. Removing the xCAT RPMs + + Get xCAT RPM list by ``rpm`` command then remove them one by one :: + + [root@server ~]# rpm -qa | grep xCAT + xCAT-2.10-snap201505271151.ppc64 + xCAT-client-2.10-snap201505271150.noarch + xCAT-genesis-scripts-ppc64-2.10-snap201505271151.noarch + xCAT-server-2.10-snap201505271151.noarch + xCAT-test-2.10-snap201505271151.noarch + xCAT-buildkit-2.10-snap201505271151.noarch + perl-xCAT-2.10-snap201505271150.noarch + xCAT-genesis-base-ppc64-2.10-snap201505172314.noarch + + [root@server ~]#rpm -e xCAT-genesis-scripts-ppc64-2.10-snap201505271151.noarch + [root@server ~]#rpm -e xCAT-genesis-base-ppc64-2.10-snap201505172314.noarch + .......... + +2. Removing OSS prerequisites installed for xCAT(Optional) :: + + rpm -e fping-2.2b1-1 + rpm -e perl-Digest-MD5-2.36-1 + rpm -e perl-Net_SSLeay.pm-1.30-1 + rpm -e perl-IO-Socket-SSL-1.06-1 + rpm -e perl-IO-Stty-.02-1 + rpm -e perl-IO-Tty-1.07-1 + rpm -e perl-Expect-1.21-1 + rpm -e conserver-8.1.16-2 + rpm -e expect-5.42.1-3 + rpm -e tk-8.4.7-3 + rpm -e tcl-8.4.7-3 + rpm -e perl-DBD-SQLite-1.13-1 + rpm -e perl-DBI-1.55-1 + ....... + +3. Removing root ssh keys(Optional) :: + + rm -rf $ROOTHOME/.ssh + + **[NOTE]** Be caution: do not remove the ``$ROOTHOME/.ssh`` if do not plan to remove ``/install/postscripts/_ssh`` directory + +4. Removing xCAT data directories :: + + rm -rf /install + rm -rf /tftpboot/xcat* + rm -rf /tftpboot/etc + rm -rf /etc/xcat + rm -rf /etc/sysconfig/xcat ( may not exist) + rm /mnt/xcat + + **[NOTE]** Remember to uninstall the packages ``elilo-xcat`` and ``xnba-undi``, otherwise the next time of xCAT installation will fail + +5. Removing Extraneous files :: + + rm /tmp/genimage* + rm /tmp/packimage* + rm /tmp/mknb* + rm /etc/yum.repos.d/* + +6. Clean up system files that were updated by xCAT (optional) + + There are multiple system configuration files that may have been updated while using xCAT to manage your cluster. In most cases you can determine what files have been updated by understanding the function of the commands that you run or by reading the xCAT documentation. There is no automated way to know what files should be cleaned up or removed. You will have to determine on a case by case basis whether or not a particular file should be updated to remove any leftover entries. + +Removing Databases +------------------ + +* For PostgreSQL: See :ref:`Removing xCAT DB from PostgreSQL ` +* For MySQL/MariaDB: See :ref:`Removing xCAT DB from MySQL/MariaDB ` + + diff --git a/docs/source/guides/install-guides/index.rst b/docs/source/guides/install-guides/index.rst index 8f9786b4e..c95091789 100644 --- a/docs/source/guides/install-guides/index.rst +++ b/docs/source/guides/install-guides/index.rst @@ -7,3 +7,4 @@ Install Guides yum/index.rst zypper/index.rst apt/index.rst + common/uninstall_xcat.rst \ No newline at end of file From 63998eb55828363a5470e9605a2b235fff405c95 Mon Sep 17 00:00:00 2001 From: huweihua Date: Tue, 3 Nov 2015 00:40:12 -0500 Subject: [PATCH 2/8] redo the doc --- .../install-guides/common/uninstall_xcat.rst | 160 ++++++++---------- 1 file changed, 71 insertions(+), 89 deletions(-) diff --git a/docs/source/guides/install-guides/common/uninstall_xcat.rst b/docs/source/guides/install-guides/common/uninstall_xcat.rst index 8581dca18..16be0c42b 100644 --- a/docs/source/guides/install-guides/common/uninstall_xcat.rst +++ b/docs/source/guides/install-guides/common/uninstall_xcat.rst @@ -1,54 +1,46 @@ -Uninstall xCAT -============== +Remove xCAT +=========== -Removing xCAT Trace -------------------- +Backup xCAT User Data +--------------------- -1. Backup your xCAT database ( if you want to keep it) :: +Before removing xCAT, recommand to backup xCAT database. It's convenient to restore xCAT management environment in the future if needed :: - dumpxCATdb -p + dumpxCATdb -p -2. Save your node information +For more information of ``dumpxCATdb``, please refer to :doc:`command dumpxCATdb `. For how to restore xcat DB, please refer to `Restore xCAT User Data`_ - To create a stanza file of your node definitions (all group), run the following :: +Clean Up xCAT Related Configuration +----------------------------------- - lsdef -z all > .stanza +1. To clean up the node information from dhcp :: -3. Save your networks information + makedhcp -d all - To create a stanza file of your network information, run the following :: - - lsdef -z -t network -l > .stanza - -4. Clean up tftpboot - - To clean up the node information in tftpboot :: +2. To clean up the node information in tftpboot :: nodeset all offline -5. Cleanup dhcp +3. To clean up the node information from ``/etc/hosts`` (optional) - You may want to remove all nodes from dhcp :: + 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`` :: - makedhcp -d + makehosts -d all -6. Clean up ``/etc/hosts`` +4. To clean up the node information from DNS (optional) - You may want to remove you cluster nodes from ``/etc/hosts``, you can edit ``/etc/hosts`` by 'vi' directly, or using xCAT command ``tabedit`` to remove all the nodes from the hosts table :: - - tabedit hosts - -7. Removing nodes from DNS - - After removing all the nodes from ``/etc/hosts`` and the ``hosts`` table :: + After removing all the nodes from ``/etc/hosts``, run below command to clean up the node information from DNS :: makedns -n -8. Stop xcatd :: +Stop xCAT Service +----------------- + +1. Stop xCAT service :: service xcatd stop -9. Clean up network services(Optional) +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. @@ -58,76 +50,66 @@ Removing xCAT Trace * **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. -Removing xCAT RPMs ------------------- +Remove xCAT files +----------------- -1. Removing the xCAT RPMs +1. Remove the xCAT RPMs + +Generally, we use ``yum install xCAT`` to install xCAT. There isn't an easy way to remove all RPMs installed by xCAT(include xcat-core and xcat-dep). we have to remove the RPMs one by one. In addition to this, you have to make judgment by yourself before removing some dependance package, to avoid removing some files used by other application too in your environment. - Get xCAT RPM list by ``rpm`` command then remove them one by one :: +You can obtain the RPM list from below link: + + 1). xCAT Core Packages (xcat-core): - [root@server ~]# rpm -qa | grep xCAT - xCAT-2.10-snap201505271151.ppc64 - xCAT-client-2.10-snap201505271150.noarch - xCAT-genesis-scripts-ppc64-2.10-snap201505271151.noarch - xCAT-server-2.10-snap201505271151.noarch - xCAT-test-2.10-snap201505271151.noarch - xCAT-buildkit-2.10-snap201505271151.noarch - perl-xCAT-2.10-snap201505271150.noarch - xCAT-genesis-base-ppc64-2.10-snap201505172314.noarch - - [root@server ~]#rpm -e xCAT-genesis-scripts-ppc64-2.10-snap201505271151.noarch - [root@server ~]#rpm -e xCAT-genesis-base-ppc64-2.10-snap201505172314.noarch - .......... + `RPM Packages (RHEL and SLES) `_ + + `Debian Packages (Ubuntu) `_ + + 2). xCAT Dependency Packages (xcat-dep): + + `RPM Packages (RHEL and SLES) `_ + + `Debian Packages (Ubuntu) `_ + +2. Remove xCAT certificate file :: -2. Removing OSS prerequisites installed for xCAT(Optional) :: + rm -rf $ROOTHOME/.xcat + rm -rf /root/.xcat - rpm -e fping-2.2b1-1 - rpm -e perl-Digest-MD5-2.36-1 - rpm -e perl-Net_SSLeay.pm-1.30-1 - rpm -e perl-IO-Socket-SSL-1.06-1 - rpm -e perl-IO-Stty-.02-1 - rpm -e perl-IO-Tty-1.07-1 - rpm -e perl-Expect-1.21-1 - rpm -e conserver-8.1.16-2 - rpm -e expect-5.42.1-3 - rpm -e tk-8.4.7-3 - rpm -e tcl-8.4.7-3 - rpm -e perl-DBD-SQLite-1.13-1 - rpm -e perl-DBI-1.55-1 - ....... +3. Remove xCAT data file :: -3. Removing root ssh keys(Optional) :: - - rm -rf $ROOTHOME/.ssh - - **[NOTE]** Be caution: do not remove the ``$ROOTHOME/.ssh`` if do not plan to remove ``/install/postscripts/_ssh`` directory - -4. Removing xCAT data directories :: - - rm -rf /install - rm -rf /tftpboot/xcat* - rm -rf /tftpboot/etc rm -rf /etc/xcat - rm -rf /etc/sysconfig/xcat ( may not exist) - rm /mnt/xcat - - **[NOTE]** Remember to uninstall the packages ``elilo-xcat`` and ``xnba-undi``, otherwise the next time of xCAT installation will fail - -5. Removing Extraneous files :: - rm /tmp/genimage* - rm /tmp/packimage* - rm /tmp/mknb* - rm /etc/yum.repos.d/* +4. Remove xCAT related file(Optional) -6. Clean up system files that were updated by xCAT (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 :: - There are multiple system configuration files that may have been updated while using xCAT to manage your cluster. In most cases you can determine what files have been updated by understanding the function of the commands that you run or by reading the xCAT documentation. There is no automated way to know what files should be cleaned up or removed. You will have to determine on a case by case basis whether or not a particular file should be updated to remove any leftover entries. + /isntall + /tftpboot + /etc/yum.repos.d/* + /etc/sysconfig/xcat + /etc/apache2/conf.d/xcat* + /etc/logrotate.d/xcat* + /etc/rsyslogd.d/xcat* + /var/log/xcat + /opt/xcat/ + /mnt/xcat + /tmp/genimage* + /tmp/genimage* + /tmp/packimage* + /tmp/mknb* -Removing Databases ------------------- +Remove Databases +---------------- -* For PostgreSQL: See :ref:`Removing xCAT DB from PostgreSQL ` -* For MySQL/MariaDB: See :ref:`Removing xCAT DB from MySQL/MariaDB ` +* For PostgreSQL: See :doc:`Removing xCAT DB from PostgreSQL ` +* For MySQL/MariaDB: See :doc:`Removing xCAT DB from MySQL/MariaDB ` +Restore xCAT User Data +---------------------- +If need to restore xCAT environment, after :doc:`xCAT software installation `, you can restore xCAT DB by data files dumped in the past :: + + restorexCATdb -p + +For more information of ``restorexCATdb``, please refer to :doc:`command restorexCATdb ` \ No newline at end of file From 90f816af248f82fd2fba06fef75f54f56780aeb3 Mon Sep 17 00:00:00 2001 From: huweihua Date: Tue, 3 Nov 2015 03:18:32 -0500 Subject: [PATCH 3/8] modify depending on GongJie 's comments --- .../install-guides/common/uninstall_xcat.rst | 171 +++++++++++++++--- 1 file changed, 147 insertions(+), 24 deletions(-) diff --git a/docs/source/guides/install-guides/common/uninstall_xcat.rst b/docs/source/guides/install-guides/common/uninstall_xcat.rst index 16be0c42b..3e6be56f1 100644 --- a/docs/source/guides/install-guides/common/uninstall_xcat.rst +++ b/docs/source/guides/install-guides/common/uninstall_xcat.rst @@ -54,29 +54,156 @@ Remove xCAT files ----------------- 1. Remove the xCAT RPMs - -Generally, we use ``yum install xCAT`` to install xCAT. There isn't an easy way to remove all RPMs installed by xCAT(include xcat-core and xcat-dep). we have to remove the RPMs one by one. In addition to this, you have to make judgment by yourself before removing some dependance package, to avoid removing some files used by other application too in your environment. -You can obtain the RPM list from below link: + There isn't an easy way to remove all RPMs installed because of xCAT. you can just remove the RPMs calculated by below command. Depending on the past experience, it's safe. + + [RHEL and SLES] :: - 1). xCAT Core Packages (xcat-core): + rpm -qa |grep -i xcat + + [Ubuntu] :: - `RPM Packages (RHEL and SLES) `_ - - `Debian Packages (Ubuntu) `_ - - 2). xCAT Dependency Packages (xcat-dep): + dpkg -l | awk '{ print $2 }' |grep -i xcat + + 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: + - `RPM Packages (RHEL and SLES) `_ +* xCAT Core Packages list (xcat-core) + + [RHEL and SLES] :: + + http://xcat.org/files/xcat/repos/yum//xcat-core/ + + [Ubuntu] :: + + http://xcat.org/files/xcat/repos/apt//xcat-core/ - `Debian Packages (Ubuntu) `_ +* xCAT Dependency Packages (xcat-dep) + + `RPM Packages List (RHEL and SLES) `_ + `Debian Packages List (Ubuntu) `_ + + + Generally, we use ``yum install xCAT`` to install xCAT. so these are some RMPs shipped by operating system are installed during xCAT installation. We don't have a easy way to find out all of them, but keep these RPMs is harmless. + + 2. Remove xCAT certificate file :: - rm -rf $ROOTHOME/.xcat rm -rf /root/.xcat -3. Remove xCAT data file :: +3. Remove xCAT data file + + By default, xCAT use SQLite, remove SQLite data file under ``/etc/xcat/`` :: rm -rf /etc/xcat @@ -84,20 +211,16 @@ You can obtain the RPM list from below link: 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 :: - /isntall + /install /tftpboot - /etc/yum.repos.d/* + /etc/yum.repos.d/xCAT-* /etc/sysconfig/xcat - /etc/apache2/conf.d/xcat* - /etc/logrotate.d/xcat* - /etc/rsyslogd.d/xcat* + /etc/apache2/conf.d/xCAT-* + /etc/logrotate.d/xCAT-* + /etc/rsyslogd.d/xCAT-* /var/log/xcat /opt/xcat/ - /mnt/xcat - /tmp/genimage* - /tmp/genimage* - /tmp/packimage* - /tmp/mknb* + /mnt/xcat Remove Databases ---------------- @@ -110,6 +233,6 @@ Restore xCAT User Data If need to restore xCAT environment, after :doc:`xCAT software installation `, you can restore xCAT DB by data files dumped in the past :: - restorexCATdb -p + restorexCATdb -p For more information of ``restorexCATdb``, please refer to :doc:`command restorexCATdb ` \ No newline at end of file From d2c8bbaf0376c93d8bae911d4ca41b41718410bb Mon Sep 17 00:00:00 2001 From: huweihua Date: Tue, 10 Nov 2015 21:10:52 -0500 Subject: [PATCH 4/8] change makedhcp attribute according tingting's comments --- docs/source/guides/install-guides/common/uninstall_xcat.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/guides/install-guides/common/uninstall_xcat.rst b/docs/source/guides/install-guides/common/uninstall_xcat.rst index 3e6be56f1..b872ab206 100644 --- a/docs/source/guides/install-guides/common/uninstall_xcat.rst +++ b/docs/source/guides/install-guides/common/uninstall_xcat.rst @@ -15,7 +15,7 @@ Clean Up xCAT Related Configuration 1. To clean up the node information from dhcp :: - makedhcp -d all + makedhcp -d -a 2. To clean up the node information in tftpboot :: From f7ca1365473194e909e5e943ea12ccbe56fbf18d Mon Sep 17 00:00:00 2001 From: huweihua Date: Wed, 11 Nov 2015 21:08:07 -0500 Subject: [PATCH 5/8] modify depending on gongjie's commnets --- .../guides/install-guides/common/uninstall_xcat.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/guides/install-guides/common/uninstall_xcat.rst b/docs/source/guides/install-guides/common/uninstall_xcat.rst index b872ab206..bb47afb25 100644 --- a/docs/source/guides/install-guides/common/uninstall_xcat.rst +++ b/docs/source/guides/install-guides/common/uninstall_xcat.rst @@ -4,7 +4,7 @@ Remove xCAT Backup xCAT User Data --------------------- -Before removing xCAT, recommand to backup xCAT database. It's convenient to restore xCAT management environment in the future if needed :: +Before removing xCAT, recommend to backup xCAT database. It's convenient to restore xCAT management environment in the future if needed :: dumpxCATdb -p @@ -55,7 +55,7 @@ Remove xCAT files 1. Remove the xCAT RPMs - There isn't an easy way to remove all RPMs installed because of xCAT. you can just remove the RPMs calculated by below command. Depending on the past experience, it's safe. + 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] :: @@ -63,7 +63,7 @@ Remove xCAT files [Ubuntu] :: - dpkg -l | awk '{ print $2 }' |grep -i xcat + 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. @@ -194,7 +194,7 @@ Remove xCAT files `Debian Packages List (Ubuntu) `_ - Generally, we use ``yum install xCAT`` to install xCAT. so these are some RMPs shipped by operating system are installed during xCAT installation. We don't have a easy way to find out all of them, but keep these RPMs is harmless. + 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 :: From 3fe527cbb1151d33aa97a00af10589f868e42fe9 Mon Sep 17 00:00:00 2001 From: huweihua Date: Sun, 13 Dec 2015 21:23:53 -0500 Subject: [PATCH 6/8] modify punctuation mark --- .../install-guides/common/uninstall_xcat.rst | 61 +++++++++---------- 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/docs/source/guides/install-guides/common/uninstall_xcat.rst b/docs/source/guides/install-guides/common/uninstall_xcat.rst index bb47afb25..c512c3ce5 100644 --- a/docs/source/guides/install-guides/common/uninstall_xcat.rst +++ b/docs/source/guides/install-guides/common/uninstall_xcat.rst @@ -4,56 +4,56 @@ 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 :: +Before removing xCAT, recommend to backup xCAT database. It's convenient to restore xCAT management environment in the future if needed. :: dumpxCATdb -p -For more information of ``dumpxCATdb``, please refer to :doc:`command dumpxCATdb `. For how to restore xcat DB, please refer to `Restore xCAT User Data`_ +For more information of ``dumpxCATdb``, please refer to :doc:`command dumpxCATdb `. 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 :: +1. To clean up the node information from dhcp. :: makedhcp -d -a -2. To clean up the node information in tftpboot :: +2. To clean up the node information in tftpboot. :: nodeset all offline -3. To clean up the node information from ``/etc/hosts`` (optional) +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`` :: + 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) +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 :: + 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 :: +1. Stop xCAT service. :: service xcatd stop -2. Stop xCAT related services(Optional) +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. + 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. +* **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 +Remove xCAT Files ----------------- -1. Remove the xCAT RPMs +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. @@ -177,7 +177,7 @@ Remove xCAT files Along with xCAT development, above list maybe change, you can get the latest list through below links: -* xCAT Core Packages list (xcat-core) +* XCAT Core Packages List (xcat-core) [RHEL and SLES] :: @@ -187,29 +187,28 @@ Remove xCAT files http://xcat.org/files/xcat/repos/apt//xcat-core/ -* xCAT Dependency Packages (xcat-dep) - +* XCAT Dependency Packages (xcat-dep) `RPM Packages List (RHEL and SLES) `_ `Debian Packages List (Ubuntu) `_ - 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. + 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 :: +2. Remove xCAT certificate file. :: rm -rf /root/.xcat -3. Remove xCAT data file +3. Remove xCAT data file. - By default, xCAT use SQLite, remove SQLite data file under ``/etc/xcat/`` :: + By default, xCAT use SQLite, remove SQLite data file under ``/etc/xcat/``. :: rm -rf /etc/xcat -4. Remove xCAT related file(Optional) +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 :: + 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 @@ -225,14 +224,14 @@ Remove xCAT files Remove Databases ---------------- -* For PostgreSQL: See :doc:`Removing xCAT DB from PostgreSQL ` -* For MySQL/MariaDB: See :doc:`Removing xCAT DB from MySQL/MariaDB ` +* For PostgreSQL: See :doc:`Removing xCAT DB from PostgreSQL `. +* For MySQL/MariaDB: See :doc:`Removing xCAT DB from MySQL/MariaDB `. Restore xCAT User Data ---------------------- -If need to restore xCAT environment, after :doc:`xCAT software installation `, you can restore xCAT DB by data files dumped in the past :: +If need to restore xCAT environment, after :doc:`xCAT software installation `, you can restore xCAT DB by data files dumped in the past. :: restorexCATdb -p -For more information of ``restorexCATdb``, please refer to :doc:`command restorexCATdb ` \ No newline at end of file +For more information of ``restorexCATdb``, please refer to :doc:`command restorexCATdb `. From 24a8fc853b18ce432880fd8e26ade67bb086f0d0 Mon Sep 17 00:00:00 2001 From: huweihua Date: Sun, 13 Dec 2015 22:11:12 -0500 Subject: [PATCH 7/8] modify format --- .../install-guides/common/uninstall_xcat.rst | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/source/guides/install-guides/common/uninstall_xcat.rst b/docs/source/guides/install-guides/common/uninstall_xcat.rst index c512c3ce5..81f2116d4 100644 --- a/docs/source/guides/install-guides/common/uninstall_xcat.rst +++ b/docs/source/guides/install-guides/common/uninstall_xcat.rst @@ -67,7 +67,7 @@ Remove xCAT Files 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): + * XCAT Core Packages list (xcat-core): [RHEL and SLES] :: @@ -97,7 +97,7 @@ Remove xCAT Files xcat-test xcat-vlan -* xCAT Dependency Packages (xcat-dep): + * XCAT Dependency Packages (xcat-dep): [RHEL and SLES] :: @@ -177,20 +177,21 @@ Remove xCAT Files Along with xCAT development, above list maybe change, you can get the latest list through below links: -* XCAT Core Packages List (xcat-core) + * XCAT Core Packages List (xcat-core) - [RHEL and SLES] :: + [RHEL and SLES] :: - http://xcat.org/files/xcat/repos/yum//xcat-core/ + http://xcat.org/files/xcat/repos/yum//xcat-core/ - [Ubuntu] :: + [Ubuntu] :: - http://xcat.org/files/xcat/repos/apt//xcat-core/ + http://xcat.org/files/xcat/repos/apt//xcat-core/ -* XCAT Dependency Packages (xcat-dep) - `RPM Packages List (RHEL and SLES) `_ + * XCAT Dependency Packages (xcat-dep) + + `RPM Packages List (RHEL and SLES) `_ - `Debian Packages List (Ubuntu) `_ + `Debian Packages List (Ubuntu) `_ 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. From 8285ff5e16d54294b34db520765c29f8b582b387 Mon Sep 17 00:00:00 2001 From: huweihua Date: Sun, 13 Dec 2015 22:26:51 -0500 Subject: [PATCH 8/8] modify punctuation mark --- .../install-guides/common/uninstall_xcat.rst | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/guides/install-guides/common/uninstall_xcat.rst b/docs/source/guides/install-guides/common/uninstall_xcat.rst index 81f2116d4..6e04ddb6b 100644 --- a/docs/source/guides/install-guides/common/uninstall_xcat.rst +++ b/docs/source/guides/install-guides/common/uninstall_xcat.rst @@ -13,21 +13,21 @@ For more information of ``dumpxCATdb``, please refer to :doc:`command dumpxCATdb Clean Up xCAT Related Configuration ----------------------------------- -1. To clean up the node information from dhcp. :: +1. To clean up the node information from dhcp :: makedhcp -d -a -2. To clean up the node information in tftpboot. :: +2. To clean up the node information in tftpboot :: nodeset all offline -3. To clean up the node information from ``/etc/hosts`` (optional). +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). +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. :: @@ -36,11 +36,11 @@ Clean Up xCAT Related Configuration Stop xCAT Service ----------------- -1. Stop xCAT service. :: +1. Stop xCAT service :: service xcatd stop -2. Stop xCAT related services(Optional). +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. @@ -53,7 +53,7 @@ Stop xCAT Service Remove xCAT Files ----------------- -1. Remove the xCAT RPMs. +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. @@ -197,17 +197,17 @@ Remove xCAT Files 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. :: +2. Remove xCAT certificate file :: rm -rf /root/.xcat -3. Remove xCAT data file. +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). +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. ::