Questo contenuto non è disponibile nella lingua selezionata.

Chapter 12. Backing up Satellite Server and Capsule Server


You can back up your Satellite deployment to ensure the continuity of your Red Hat Satellite deployment and associated data in case a disaster occurs. If your deployment uses custom configurations, you must consider how to handle these custom configurations when you plan your backup and disaster recovery policy.

Note

If you create a new instance of the Satellite Server, decommission the old instances after restoring the backup. Cloned instances are not supposed to run in parallel in a production environment.

To create a backup of your Satellite Server or Capsule Server and all associated data, use the satellite-maintain backup command. Backing up to a separate storage device on a separate system is highly recommended.

Satellite services are unavailable during the backup. Therefore, you must ensure that no other tasks are scheduled by other administrators. You can schedule a backup by using cron. For more information, see the Section 12.7, “Example of a weekly full backup followed by daily incremental backups”.

During offline backups, the services are inactive and Satellite is in a maintenance mode. All the traffic from outside on port 443 is rejected by a firewall to ensure there are no modifications triggered.

A backup contains sensitive information from the /root/ssl-build directory. For example, it can contain hostnames, ssh keys, request files and SSL certificates. You must encrypt or move the backup to a secure location to minimize the risk of damage or unauthorized access to the hosts.

12.1. Estimating the size of a backup

The full backup creates uncompressed archives of PostgreSQL and Pulp database files, and Satellite configuration files. Compression occurs after the archives are created to decrease the time when Satellite services are unavailable.

A full backup requires space to store the following data:

  • Uncompressed Satellite database and configuration files
  • Compressed Satellite database and configuration files
  • An extra 20% of the total estimated space to ensure a reliable backup
Note

Backups do not include container images for Red Hat Lightspeed in Satellite.

Procedure

  1. Enter the du command to estimate the size of uncompressed directories containing Satellite database and configuration files:

    # du -sh /var/lib/pgsql/data /var/lib/pulp
    100G    /var/lib/pgsql/data
    100G	/var/lib/pulp
    
    # du -csh /var/lib/tftpboot /etc /root/ssl-build \
    /var/www/html/pub /opt/puppetlabs
    16M   /var/lib/tftpboot
    37M   /etc
    900K  /root/ssl-build
    100K  /var/www/html/pub
    2M    /opt/puppetlabs
    942M  total
    Copy to Clipboard Toggle word wrap
  2. Calculate how much space is required to store the compressed data.

    The following table describes the compression ratio of all data items included in the backup:

    Expand
    Table 12.1. Backup data compression ratio
    Data typeDirectoryRatioExample results

    PostgreSQL database files

    /var/lib/pgsql/data

    80 – 85%

    100 GB 20 GB

    Pulp RPM files

    /var/lib/pulp

    (not compressed)

    100 GB

    Configuration files

    /var/lib/tftpboot

    /etc

    /root/ssl-build

    /var/www/html/pub

    /opt/puppetlabs

    85%

    942 MB 141 MB

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

  3. To calculate the amount of available space you require to store a backup, calculate the sum of the estimated values of compressed and uncompressed backup data, and add an extra 20% to ensure a reliable backup.

    This example requires 201 GB plus 120 GB for the uncompressed and compressed backup data, 321 GB in total. With 64 GB of extra space, 385 GB must be allocated for the backup location.

12.2. Offline backup and online backup

You can perform an offline backup or an online backup to back up your Satellite Server.

There are two main methods of backing up Satellite Server:

  • Offline backup

    All Satellite services are shut down during an offline backup.

  • Online backup

    Only Satellite services that affect the consistency of the backup, including all background workers, are shut down while the backup process is running. Online backups check for consistency and require more time than offline backups.

For more information about each of these methods, you can view the usage statements for each backup method.

  • Offline backup:

    # satellite-maintain backup offline --help
    Copy to Clipboard Toggle word wrap
  • Online backup:

    # satellite-maintain backup online --help
    Copy to Clipboard Toggle word wrap

12.3. Directories created during backups

Satellite organizes backups in time-stamped subdirectories, which helps you identify and select the correct backup when restoring your system.

The satellite-maintain backup command creates a time-stamped subdirectory in the backup directory that you specify. The satellite-maintain backup command does not overwrite backups, therefore you must select the correct directory or subdirectory when restoring from a backup or an incremental backup. The satellite-maintain backup command stops and restarts services as required.

When you run the satellite-maintain backup offline command, the following default backup directories are created:

  • satellite-backup on Satellite
  • foreman-proxy-backup on Capsule

If you want to set a custom directory name, add the --preserve-directory option and add a directory name. The backup is then stored in the directory you provide in the command line. If you use the --preserve-directory option, no data is removed if the backup fails.

12.4. Performing a full backup of Satellite Server or Capsule Server

Red Hat Satellite uses the satellite-maintain backup command to make backups.

You can use the satellite-maintain backup command to back up remote databases.

Prerequisites

Warning

Request other users of Satellite Server or Capsule Server to save any changes and warn them that Satellite services are unavailable for the duration of the backup. Ensure no other tasks are scheduled for the same time as the backup.

Procedure

  • On Satellite Server, perform a full backup:

    # satellite-maintain backup offline /var/satellite-backup
    Copy to Clipboard Toggle word wrap
  • On Capsule Server, perform a full backup:

    # satellite-maintain backup offline /var/foreman-proxy-backup
    Copy to Clipboard Toggle word wrap

12.5. Performing a backup without Pulp content

You can perform an offline backup that excludes the contents of the Pulp directory. The backup without Pulp content is useful for debugging purposes and is only intended to provide access to configuration files without backing up the Pulp database. For production usecases, do not restore from a directory that does not contain Pulp content.

Warning

Request other users of Satellite Server or Capsule Server to save any changes and warn them that Satellite services are unavailable for the duration of the backup. Ensure no other tasks are scheduled for the same time as the backup.

Prerequisites

Procedure

  • To perform an offline backup without Pulp content, enter the following command:

    # satellite-maintain backup offline --skip-pulp-content /var/backup_directory
    Copy to Clipboard Toggle word wrap

12.6. Performing an incremental backup

Use this procedure to perform an offline backup of any changes since a previous backup.

To perform incremental backups, you must perform a full backup as a reference to create the first incremental backup of a sequence. Keep the most recent full backup and a complete sequence of incremental backups to restore from.

Warning

Request other users of Satellite Server or Capsule Server to save any changes and warn them that Satellite services are unavailable for the duration of the backup. Ensure no other tasks are scheduled for the same time as the backup.

Prerequisites

Procedure

  1. Perform a full offline backup:

    # satellite-maintain backup offline /var/backup_directory
    Copy to Clipboard Toggle word wrap
  2. Create a directory within your backup directory to store the first incremental backup:

    # satellite-maintain backup offline --incremental /var/backup_directory/full_backup /var/backup_directory
    Copy to Clipboard Toggle word wrap
  3. Create the second incremental backup by including the path to the first incremental backup to indicate the starting point for the next increment. This creates a directory for the second incremental backup in your backup directory:

    # satellite-maintain backup offline --incremental /var/backup_directory/first_incremental_backup /var/backup_directory
    Copy to Clipboard Toggle word wrap
  4. Optional: If you want to point to a different version of the backup, and make a series of increments with that version of the backup as the starting point, you can do this at any time. For example, if you want to make a new incremental backup from the full backup rather than the first or second incremental backup, point to the full backup directory:

    # satellite-maintain backup offline --incremental /var/backup_directory/full_backup /var/backup_directory
    Copy to Clipboard Toggle word wrap

12.7. Example of a weekly full backup followed by daily incremental backups

The following script performs a full backup on a Sunday followed by incremental backups for each of the following days. A new subdirectory is created for each day that an incremental backup is performed. The script requires a daily cron job.

#!/bin/bash -e
PATH=/sbin:/bin:/usr/sbin:/usr/bin
DESTINATION=/var/backup_directory
if [[ $(date +%w) == 0 ]]; then
  satellite-maintain backup offline --assumeyes $DESTINATION
else
  LAST=$(ls -td -- $DESTINATION/*/ | head -n 1)
  satellite-maintain backup offline --assumeyes --incremental "$LAST" $DESTINATION
fi
exit 0
Copy to Clipboard Toggle word wrap

Note that the satellite-maintain backup command requires /sbin and /usr/sbin directories to be in PATH and the --assumeyes option is used to skip the confirmation prompt.

12.8. Performing an online backup

You can perform an online backup to create a system backup while keeping most services running. This is useful when you need to maintain system availability during backup operations.

When you perform an online backup, most Satellite services remain running and usable. Background workers are shut down to ensure consistent backups. Operations that require background workers remain in pending state. The backup process ensures that the Pulp data (/var/lib/pulp) is not altered during the backup. Any changes to the Pulp data during the backup will result in restart of the backup process, taking additional time.

Warning

Request other users of Satellite Server or Capsule Server to save any changes and warn them that some Satellite services may be unavailable for the duration of the backup. Ensure no other tasks are scheduled for the same time as the backup.

Prerequisites

Procedure

  • On your Satellite Server, perform an online backup:

    # satellite-maintain backup online /var/backup_directory
    Copy to Clipboard Toggle word wrap

12.9. Creating a conventional backup

You can use conventional backup methods to back up your Satellite Server or Capsule Server.

Note

Stopping Satellite services is required when creating a snapshot or conventional backup. Do not stop Satellite services if you are using the satellite-maintain backup command to create a backup.

Procedure

  1. When creating a snapshot or conventional backup, stop all Satellite services:

    # satellite-maintain service stop
    Copy to Clipboard Toggle word wrap
  2. Create the snapshot or conventional backup. For more information, see Recovering and restoring a system in Red Hat Enterprise Linux 9 Configuring basic system settings.
  3. Start Satellite services after creating a snapshot or conventional backup:

    # satellite-maintain service start
    Copy to Clipboard Toggle word wrap
Red Hat logoGithubredditYoutubeTwitter

Formazione

Prova, acquista e vendi

Community

Informazioni sulla documentazione di Red Hat

Aiutiamo gli utenti Red Hat a innovarsi e raggiungere i propri obiettivi con i nostri prodotti e servizi grazie a contenuti di cui possono fidarsi. Esplora i nostri ultimi aggiornamenti.

Rendiamo l’open source più inclusivo

Red Hat si impegna a sostituire il linguaggio problematico nel codice, nella documentazione e nelle proprietà web. Per maggiori dettagli, visita il Blog di Red Hat.

Informazioni su Red Hat

Forniamo soluzioni consolidate che rendono più semplice per le aziende lavorare su piattaforme e ambienti diversi, dal datacenter centrale all'edge della rete.

Theme

© 2026 Red Hat
Torna in cima