2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-08-18 09:10:23 +00:00

Merge pull request #541 from hu-weihua/removexcat

Restructure 'remove xcat' document
This commit is contained in:
Victor Hu
2015-12-30 21:56:52 -05:00
4 changed files with 258 additions and 1 deletions

View File

@@ -7,4 +7,4 @@ Install Guides
yum/index.rst
zypper/index.rst
apt/index.rst
common/uninstall_xcat.rst
maintenance/index.rst

View File

@@ -0,0 +1,25 @@
Backup and Restore xCAT
=======================
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
----------------
If need to backup xcat database, you can use :doc:`dumpxCATdb </guides/admin-guides/references/man1/dumpxCATdb.1>` command like below. ::
dumpxCATdb -p <path_to_save_the_database>
**[Note]** Maybe you need to dump some environment data for problem report when you hit defect, you can use :doc:`xcatsnap </guides/admin-guides/references/man8/xcatsnap.8>` command like below. ::
xcatsnap -B -d <path_to_save_the_data>
Restore User Data
-----------------
If need to restore xCAT environment, after :doc:`xCAT software installation </guides/install-guides/index>`, you can restore xCAT DB using the :doc:`restorexCATdb </guides/admin-guides/references/man1/restorexCATdb.1>` command pointing to the data files dumped in the past. ::
restorexCATdb -p <path_to_save_the_database>

View File

@@ -0,0 +1,8 @@
Maintenance
===========
.. toctree::
:maxdepth: 2
backup_restore_xcat.rst
uninstall_xcat.rst

View File

@@ -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/<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
----------------
* :doc:`Removing xCAT DB from PostgreSQL </advanced/hierarchy/databases/postgres_remove>`.
* :doc:`Removing xCAT DB from MySQL/MariaDB </advanced/hierarchy/databases/mysql_remove>`.