Chapter 8. Backing Up and Restoring Satellite Server and Capsule Server

To Estimate the Size of a Backup

1. Enter the du command to estimate the space required to store uncompressed directories containing Satellite databases and configuration files, for example:

   # du -csh /var/lib/mongodb /var/lib/pgsql/data /var/lib/pulp \
   /etc /root/ssl-build /var/www/html/pub /opt/puppetlabs
   480G	/var/lib/mongodb
   100G    /var/lib/pgsql/data
   100G	/var/lib/pulp
   680G    total
   37M	/etc
   900K	/root/ssl-build
   100K	/var/www/html/pub
   2M	/opt/puppetlabs
   680GB   total

   In this example, the uncompressed backup data occupies 680 GB in total.

   Note

   The /opt/puppetlabs directory is used for Puppet 4. Use /var/lib/puppet for Puppet 3.

2. Calculate how much space is required to store the compressed data.

   Table 8.1, “Backup Data Compression Ratio” demonstrates compression ratio of all data items used in the backup.

   Table 8.1. Backup Data Compression Ratio

   Data type	Directory	Ratio	Example results
   MongoDB database files	/var/lib/mongodb	10 - 15%	480 GB 420 GB
   PostgreSQL database files	/var/lib/pgsql/data	15 - 20%	100 GB 80 GB
   Pulp RPM files	/var/lib/pulp	-	(not compressed)
   Configuration files	/etc /root-ssl/build /var/www/html/pub /opt/puppetlabs	5 - 10%	50 MB 45 MB

   In this example, the compressed backup data occupies 500 GB in total.

3. Calculate how much space is required to store a backup. Sum up the estimated values of compressed and uncompressed backup data and add extra 20% to ensure a reliable backup.

   This example requires 680 GB plus 500 GB for the uncompressed and compressed backup data, 1180 GB in total. With 240 GB of extra space, 1420 GB must be allocated for the backup location.

1. Ensure your backup location has enough disk space to store the backup. For more information, see Section 8.1.1, “Estimating the size of a Backup”.

2. Run the backup script:

   # satellite-backup backup_directory

   The satellite-backup script stops all services which could impact the backup, performs the backup, then restarts the required services. The script creates the target directory when trying to create a backup file if the target directory does not exist.

   This process can take a long time to complete, due to the amount of data to copy.

1. Ensure your backup location has enough disk space to store the backup. For more information, see Section 8.1.1, “Estimating the size of a Backup”.

2. Run the backup script:

   # satellite-backup --skip-pulp-content backup_directory

   The satellite-backup script stops all services which could impact the backup, performs the backup, then restarts the required services. The script creates the target directory when trying to create a backup file if the target directory does not exist.

1. Ensure your backup location has enough disk space to store the backup. For more information, see Section 8.1.1, “Estimating the size of a Backup”.

2. Run the backup script:

   With Pulp content:

   # satellite-backup backup_directory --incremental backup_directory/previous_time-stamped_subdirectory

   Without Pulp content:

   # satellite-backup backup_directory --skip-pulp-content --incremental backup_directory/previous_time-stamped_subdirectory

   The satellite-backup script stops all services which could impact the backup, performs the backup, then restarts the required services. If the target directory does not exist when trying to create a backup file the script creates it. It is possible to make incremental backups using a backup older than the previous backup as a starting point, but with a corresponding increase in time to make the backup.

1. Ensure your backup location has enough disk space to store the backup. For more information, see Section 8.1.1, “Estimating the size of a Backup”.

2. Run the backup script:

   # satellite-backup --online-backup /tmp/backup_directory

Rename a Satellite Server

1. On the Satellite Server, run the satellite-change-hostname script, providing the host’s new name, and Satellite credentials.

   # satellite-change-hostname new_satellite --username admin \
   --password password

   The message ***** Hostname change complete! ***** confirms that the rename completed successfully.

2. (Optional) If you have obtained a new X.509 certificate for the Satellite Server’s new host name, run the Satellite installation script to install the certificate. For more information on installing a custom X.509 certificate, see Configuring Satellite Server with a Custom Server Certificate in the Red Hat Satellite Installation Guide.

3. On all Capsule Servers and hosts registered to the Satellite Server, reinstall the bootstrap RPM and re-register them to the Satellite Server. Substitute the example organization and environment values with those matching your environment.

   1.  

      # yum remove -y katello-ca-consumer*

   2.  

      # rpm -Uvh http://new-satellite.example.com/pub/katello-ca-consumer-latest.noarch.rpm

   3.  

      # subscription-manager register --org="Default_Organization" \
      --environment="Library" \
      --force

   Use of the Red Hat Satellite remote execution feature is recommended for this step. For more information, see Configuring and Running Remote Commands in Managing Hosts.

4. Reattach subscriptions to all Capsule Servers and hosts registered to the Satellite Server, then refresh the subscription.

   1.  

      # subscription-manager refresh

   2.  

      # yum repolist

   Use of the Red Hat Satellite remote execution feature is recommended for this step. For more information, see Configuring and Running Remote Commands in Managing Hosts.

5. On all Capsule Servers, re-run the Satellite installation script to update references to the new host name.

   # satellite-installer --foreman-proxy-content-parent-fqdn new-satellite.example.com \
   --foreman-proxy-foreman-base-url  https://new-satellite.example.com \
   --foreman-proxy-trusted-hosts new-satellite.example.com

6. On the Satellite Server, synchronize content for each Capsule Server.

   1. List all Capsule Servers with their ID numbers:

      # hammer capsule list

   2. Enter the following command for each Capsule Server:

      # hammer capsule content synchronize --id capsule_id_number

Renaming a Capsule Server:

1. On Satellite Server, create a new certificates archive file.

   1. If you are using the default Satellite Server certificate:

      # capsule-certs-generate --capsule-fqdn new-capsule.example.com \
      --certs-tar /root/new-capsule.example.com-certs.tar

      Ensure that you enter the full path to the .tar file.

   2. If you are using a custom X.509 certificate on the Capsule Server, see Create the Capsule Server’s Certificate Archive File in the Red Hat Satellite Installation Guide.

2. On Satellite Server, copy the certificates archive file to the Capsule Server, providing the root user’s password when prompted. In this example the archive file is copied to the root user’s home directory, but you may prefer to copy it elsewhere.

   # scp /root/new-capsule.example.com-certs.tar root@capsule.example.com:

3. On the Capsule Server, run the satellite-change-hostname script, providing the host’s new name, Satellite credentials, and certificates archive filename.

   # satellite-change-hostname new_capsule --username admin \
   --password password \
   --certs-tar /root/new-capsule.example.com-certs.tar

   Ensure that you enter the full path to the .tar file.

   The message ***** Hostname change complete! ***** confirms that the rename completed successfully.

4. Optional: If you have obtained a new X.509 certificate in the Capsule Server’s new host name, run the Satellite installation script to install the certificate. For more information on installing a custom X.509 certificate, see Configuring Satellite Server with a Custom Server Certificate in the Red Hat Satellite Installation Guide.

5. On all hosts registered to the Capsule Server, reinstall the bootstrap RPM and re-register them to the Capsule Server. Substitute the example organization and environment values with those matching your environment.

   # yum remove -y katello-ca-consumer*

   # rpm -Uvh http://new-capsule.example.com/pub/katello-ca-consumer-latest.noarch.rpm

   # subscription-manager register --org="Default_Organization" \
   --environment="Library" \
   --force

   Use of the Red Hat Satellite remote execution feature is recommended for this step. For more information, see Running Jobs on Hosts in Managing Hosts.

6. Reattach subscriptions to all hosts registered to the Capsule Server, then refresh the subscription.

   # subscription-manager refresh

   # yum repolist

7. Edit the Capsule Server’s name.

   1. In the Satellite web UI, navigate to Infrastructure > Capsules.
   2. Find the Capsule Server in the list, and click Edit in that row.
   3. Edit the Name and URL fields to match the Capsule Server’s new host name, then click Submit.
8. On your DNS server, add a record for the Capsule Server’s new host name, and delete the record for the previous host name.