From 4ae0d45fde5b93368120fd68d85c08f4fae4de16 Mon Sep 17 00:00:00 2001 From: huweihua Date: Wed, 16 Dec 2015 02:55:05 -0500 Subject: [PATCH 1/4] restructure uninstall xcat doc --- .../maintenance/backup_restore_xcat.rst | 25 ++ .../install-guides/maintenance/index.rst | 8 + .../maintenance/uninstall_xcat.rst | 224 ++++++++++++++++++ 3 files changed, 257 insertions(+) create mode 100644 docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst create mode 100644 docs/source/guides/install-guides/maintenance/index.rst create mode 100644 docs/source/guides/install-guides/maintenance/uninstall_xcat.rst diff --git a/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst b/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst new file mode 100644 index 000000000..59bdbdf87 --- /dev/null +++ b/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst @@ -0,0 +1,25 @@ +Backup and Restore 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 + +For more information of on ``dumpxCATdb``, please refer to :doc:`dumpxCATdb `. + + + + +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 on ``restorexCATdb``, please refer to :doc:`restorexCATdb `. + diff --git a/docs/source/guides/install-guides/maintenance/index.rst b/docs/source/guides/install-guides/maintenance/index.rst new file mode 100644 index 000000000..b015e5ed5 --- /dev/null +++ b/docs/source/guides/install-guides/maintenance/index.rst @@ -0,0 +1,8 @@ +Maintenance +=========== + +.. toctree:: + :maxdepth: 2 + + backup_restore_xcat.rst + uninstall_xcat.rst diff --git a/docs/source/guides/install-guides/maintenance/uninstall_xcat.rst b/docs/source/guides/install-guides/maintenance/uninstall_xcat.rst new file mode 100644 index 000000000..8a2721aec --- /dev/null +++ b/docs/source/guides/install-guides/maintenance/uninstall_xcat.rst @@ -0,0 +1,224 @@ +Remove xCAT +=========== + +**We're sorry to see you go!** Here are some steps for removing the xCAT product. + +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) + + Keeping xCAT nodes information in ``/etc/hosts`` is harmless, but if you really want to remove them from ``/etc/hosts`` run: :: + + 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 lists 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//xcat-core/ + + [Ubuntu] :: + + http://xcat.org/files/xcat/repos/apt//xcat-core/ + + * 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. + + +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 +---------------- + +* :doc:`Removing xCAT DB from PostgreSQL `. + +* :doc:`Removing xCAT DB from MySQL/MariaDB `. + From 0d80c3b85d1299c3ec4efee1c88b1bf826b1ba0e Mon Sep 17 00:00:00 2001 From: huweihua Date: Wed, 16 Dec 2015 02:56:03 -0500 Subject: [PATCH 2/4] restructure uninstall xcat doc --- docs/source/guides/install-guides/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/guides/install-guides/index.rst b/docs/source/guides/install-guides/index.rst index c95091789..07a08b77d 100644 --- a/docs/source/guides/install-guides/index.rst +++ b/docs/source/guides/install-guides/index.rst @@ -7,4 +7,4 @@ Install Guides yum/index.rst zypper/index.rst apt/index.rst - common/uninstall_xcat.rst \ No newline at end of file + maintenance/index.rst From 785de20325b35c09d536b6caa60e2d5a0bfd7bbb Mon Sep 17 00:00:00 2001 From: huweihua Date: Thu, 24 Dec 2015 02:58:52 -0500 Subject: [PATCH 3/4] modify depending on comments --- .../maintenance/backup_restore_xcat.rst | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst b/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst index 59bdbdf87..285ba5773 100644 --- a/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst +++ b/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst @@ -1,25 +1,25 @@ Backup and Restore xCAT ======================= +It's useful to backup xcat data sometime. For example, you need to change management server and move xcat form one to another, or you need to make backups regularly and restore production environment for any accident. Below section will help you backup and restore xcat data. -Backup xCAT User Data ---------------------- +Backup User Data +---------------- -Before removing xCAT, recommend to backup xCAT database. It's convenient to restore xCAT management environment in the future if needed. :: +If need to backup xcat database, you can use :doc:`dumpxCATdb ` command like below. :: dumpxCATdb -p -For more information of on ``dumpxCATdb``, please refer to :doc:`dumpxCATdb `. +**[Note]** Maybe you need to dump some environment data for problem report when you hit defect, you can use :doc:`xcatsnap ` command like below. :: + + xcatsnap -B -d +Restore User Data +----------------- - -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 using the :doc:`restorexCATdb ` command pointing to the data files dumped in the past. :: restorexCATdb -p -For more information of on ``restorexCATdb``, please refer to :doc:`restorexCATdb `. From 99b89748149b1ed1161f4ef8dc9e8d309f3cd760 Mon Sep 17 00:00:00 2001 From: huweihua Date: Thu, 24 Dec 2015 03:09:39 -0500 Subject: [PATCH 4/4] modify depending on comments --- .../guides/install-guides/maintenance/backup_restore_xcat.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst b/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst index 285ba5773..47af4ffe9 100644 --- a/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst +++ b/docs/source/guides/install-guides/maintenance/backup_restore_xcat.rst @@ -1,7 +1,7 @@ Backup and Restore xCAT ======================= -It's useful to backup xcat data sometime. For example, you need to change management server and move xcat form one to another, or you need to make backups regularly and restore production environment for any accident. Below section will help you backup and restore xcat data. +It's useful to backup xcat data sometime. For example, you need to upgrading to another version of xCAT, or you need to change management server and move xcat form one to another, or you need to make backups regularly and restore production environment for any accident. Below section will help you backup and restore xcat data. Backup User Data ----------------