Back Up and Restore the Director Undercloud
Back up and restore the director undercloud
Abstract
Chapter 1. Back Up the Undercloud
This guide describes how to back up the undercloud used in the Red Hat OpenStack Platform director. The undercloud is usually a single physical node (although high availability options exist using a two-node pacemaker cluster that runs director in a VM) that is used to deploy and manage your OpenStack environment.
1.1. Backup Considerations
Formulate a robust back up and recovery policy in order to minimize data loss and system downtime. When determining your back up strategy, you will need to answer the following questions:
- How quickly will you need to recover from data loss? If you cannot have data loss at all, you should include high availability in your deployment strategy, in addition to using backups. You’ll need to consider how long it will take to obtain the physical backup media (including from an offsite location, if used), and how many tape drives are available for restore operations.
- How many backups should you keep? You will need to consider legal and regulatory requirements that affect how long you are expected to store data.
- Should your backups be kept off-site? Storing your backup media offsite will help mitigate the risk of catastrophe befalling your physical location.
- How often should backups be tested? A robust back up strategy will include regular restoration tests of backed up data. This can help validate that the correct data is still being backed up, and that no corruption is being introduced during the back up or restoration processes. These drills should assume that they are being performed under actual disaster recovery conditions.
- What will be backed up? The following sections describe database and file-system backups for components, as well as information on recovering backups.
1.2. High Availability of the Undercloud node
You are free to consider your preferred high availability (HA) options for the Undercloud node; Red Hat does not prescribe any particular requirements for this. For example, you might consider running your Undercloud node as a highly available virtual machine within Red Hat Enterprise Virtualization (RHEV). You might also consider using physical nodes with Pacemaker providing HA for the required services.
When approaching high availability for your Undercloud node, you should consult the documentation and good practices of the solution you decide works best for your environment.
1.3. Backing up the undercloud
A full undercloud backup includes the following databases and files:
- All MariaDB databases on the undercloud node
- MariaDB configuration file on the undercloud (so that you can accurately restore databases)
-
The configuration data:
/etc -
Log data:
/var/log -
Image data:
/var/lib/glance -
Certificate generation data if using SSL:
/var/lib/certmonger -
Any container image data:
/var/lib/dockerand/var/lib/registry -
All swift data:
/srv/node -
All data in the stack user home directory:
/home/stack
Confirm that you have sufficient disk space available on the undercloud before performing the backup process. Expect the archive file to be at least 3.5 GB, if not larger.
Procedure
-
Log into the undercloud as the
rootuser. Back up the database:
# mysqldump --opt --all-databases > /root/undercloud-all-databases.sql
Archive the database backup and the configuration files:
# sudo tar --xattrs --ignore-failed-read -cf \ undercloud-backup-`date +%F`.tar \ /root/undercloud-all-databases.sql \ /etc \ /var/log \ /var/lib/glance \ /var/lib/certmonger \ /var/lib/docker \ /var/lib/registry \ /srv/node \ /root \ /home/stack-
The
--ignore-failed-readoption skips any directory that does not apply to your undercloud. -
The
--xattrsoption includes extended attributed, which are required to store metadata for Object Storage (swift).
This creates a file named
undercloud-backup-<date>.tar.gz, where<date>is the system date. Copy thistarfile to a secure location.-
The
1.4. Validate the Completed Backup
You can validate the success of the completed back up process by running and validating the restore process. See the next section for further details on restoring from backup.
Chapter 2. Restore the Undercloud
This section describes how to restore the undercloud used in the Red Hat OpenStack Platform Director.
2.1. Restoring the undercloud
The following restore procedure assumes your undercloud node has failed and is in an unrecoverable state. This procedure involves restoring the database and critical filesystems on a fresh installation. It assumes the following:
- You have re-installed the latest version of Red Hat Enterprise Linux 7.
- The hardware layout is the same.
- The hostname and undercloud settings of the machine are the same.
-
The backup archive has been copied to the
rootdirectory.
Procedure
-
Log into your undercloud as the
rootuser. Create the
stackuser:[root@director ~]# useradd stack
Set a password for the user:
[root@director ~]# passwd stack
Disable password requirements when using
sudo:[root@director ~]# echo "stack ALL=(root) NOPASSWD:ALL" | tee -a /etc/sudoers.d/stack [root@director ~]# chmod 0440 /etc/sudoers.d/stack
Register your system with the Content Delivery Network, entering your Customer Portal user name and password when prompted:
[root@director ~]# sudo subscription-manager register
Attach the Red Hat OpenStack Platform entitlement:
[root@director ~]# sudo subscription-manager attach --pool=Valid-Pool-Number-123456
Disable all default repositories, and then enable the required Red Hat Enterprise Linux repositories:
[root@director ~]# sudo subscription-manager repos --disable=* [root@director ~]# sudo subscription-manager repos --enable=rhel-7-server-rpms --enable=rhel-7-server-extras-rpms --enable=rhel-7-server-rh-common-rpms --enable=rhel-ha-for-rhel-7-server-rpms --enable=rhel-7-server-openstack-13-rpms
Perform an update on your system to make sure you have the latest base system packages:
[root@director ~]# sudo yum update -y [root@director ~]# sudo reboot
Ensure the time on your undercloud is synchronized. For example:
[root@director ~]# sudo yum install -y ntp [root@director ~]# sudo systemctl start ntpd [root@director ~]# sudo systemctl enable ntpd [root@director ~]# sudo ntpdate pool.ntp.org [root@director ~]# sudo systemctl restart ntpd
Create a temporary directory for the backup
[root@director ~]# mkdir /var/tmp/undercloud_backup
Extract the filesystem backup archive into the temporary directory:
[root@director ~]# sudo tar -xvf /root/undercloud-backup-[timestamp].tar -C /var/tmp/undercloud_backup --xattrs || true
Install
rsync:[root@director ~]# sudo yum -y install rsync
Synchronize the following directories with backup content:
[root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/home/stack/ /home/stack [root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/etc/haproxy/ /etc/haproxy/ [root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/etc/pki/instack-certs/ /etc/pki/instack-certs/ [root@director ~]# sudo mkdir -p /etc/puppet/hieradata/ [root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/etc/puppet/hieradata/ /etc/puppet/hieradata/ [root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/srv/node/ /srv/node/ [root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/var/lib/glance/ /var/lib/glance/
Install the
openstack-keystonepackage and synchronize its configuration data:[root@director ~]# sudo yum -y install openstack-keystone [root@director ~]# sudo rsync -a /var/tmp/undercloud_backup/etc/keystone/ /etc/keystone/
Install the
policycoreutils-pythonpackage:[root@director ~]# sudo yum -y install policycoreutils-python
If using SSL in the undercloud, refresh the CA certificates:
[root@director ~]# sudo semanage fcontext -a -t etc_t "/etc/pki/instack-certs(/.*)?" [root@director ~]# sudo restorecon -R /etc/pki/instack-certs [root@director ~]# sudo update-ca-trust extract
Install the database server and client tools:
[root@director ~]# sudo yum install -y mariadb mariadb-server python-tripleoclient
Start the database:
[root@director ~]# sudo systemctl start mariadb [root@director ~]# sudo systemctl enable mariadb
Increase the allowed packets to accommodate the size of our database backup:
[root@director ~]# mysql -uroot -e"set global max_allowed_packet = 1073741824;"
Restore the database backup:
[root@director ~]# mysql -u root < /var/tmp/undercloud_backup/root/undercloud-all-databases.sql
Restart Mariadb to refresh the permissions from the backup file:
[root@director ~]# sudo systemctl restart mariadb
Get a list of old user permissions:
[root@director ~]# mysql -e 'select host, user, password from mysql.user;'
Remove the old user permissions for each host listed. For example:
[root@director ~]# HOST="192.0.2.1" [root@director ~]# USERS=$(mysql -Nse "select user from mysql.user WHERE user != \"root\" and host = \"$HOST\";" | uniq | xargs) [root@director ~]# for USER in $USERS ; do mysql -e "drop user \"$USER\"@\"$HOST\"" || true ;done [root@director ~]# mysql -e 'flush privileges'
Install the
openstack-glancepackage and restore its file permissions:[root@director ~]# sudo yum install -y openstack-glance [root@director ~]# sudo chown -R glance: /var/lib/glance/images
Install the
openstack-swiftpackages and restore its file permissions:[root@director ~]# sudo yum install -y openstack-swift [root@director ~]# sudo chown -R swift: /srv/node
Switch to the new
stackuser:[root@director ~]# su - stack [stack@director ~]$
Run the undercloud installation command. Ensure to run it in the
stackuser’s home directory:[stack@director ~]$ openstack undercloud install
- Wait until the install completes. The undercloud automatically restores its connection to the overcloud. The nodes will continue to poll OpenStack Orchestration (heat) for pending tasks.
Synchronize the container data with backup content:
[root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/var/lib/docker/ /var/lib/docker/ [root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/var/lib/registry/ /var/lib/registry/ [root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/etc/docker/ /etc/docker/ [root@director ~]# sudo rsync -a -X /var/tmp/undercloud_backup/etc/docker-distribution/ /etc/docker-distribution/ [root@director ~]# sudo cp /var/tmp/undercloud_backup/etc/sysconfig/docker* /etc/sysconfig/. [root@director ~]# sudo systemctl restart docker docker-distribution
2.2. Validate the Completed Restore
Use the following commands to perform a healthcheck of your newly restored environment:
2.2.1. Check Identity Service (Keystone) Operation
This step validates Identity Service operations by querying for a list of users.
# source overcloudrc # openstack user list
When run from the controller, the output of this command should include a list of users created in your environment. This action demonstrates that keystone is running and successfully authenticating user requests. For example:
# openstack user list +----------------------------------+------------+---------+----------------------+ | id | name | enabled | email | +----------------------------------+------------+---------+----------------------+ | 9e47bb53bb40453094e32eccce996828 | admin | True | root@localhost | | 9fe2466f88cc4fa0ba69e59b47898829 | ceilometer | True | ceilometer@localhost | | 7a40d944e55d422fa4e85daf47e47c42 | cinder | True | cinder@localhost | | 3d2ed97538064f258f67c98d1912132e | demo | True | | | 756e73a5115d4e9a947d8aadc6f5ac22 | glance | True | glance@localhost | | f0d1fcee8f9b4da39556b78b72fdafb1 | neutron | True | neutron@localhost | | e9025f3faeee4d6bb7a057523576ea19 | nova | True | nova@localhost | | 65c60b1278a0498980b2dc46c7dcf4b7 | swift | True | swift@localhost | +----------------------------------+------------+---------+----------------------+
